Struct TextRegion 

pub struct TextRegion {
    pub bounding_box: BoundingBox,
    pub dt_poly: Option<BoundingBox>,
    pub rec_poly: Option<BoundingBox>,
    pub text: Option<Arc<str>>,
    pub confidence: Option<f32>,
    pub orientation_angle: Option<f32>,
    pub word_boxes: Option<Vec<BoundingBox>>,
    pub label: Option<Arc<str>>,
}

A text region containing detection and recognition results.

This struct groups together all the information related to a single detected text region, including the bounding box, recognized text, confidence score, orientation angle, and optional word-level boxes for fine-grained text localization. This design eliminates the need for parallel vectors and provides better ergonomics for iterating over text regions.

Fields

bounding_box: BoundingBox

The bounding box of the detected text region.

dt_poly: Option<BoundingBox>

Detection polygon (dt_polys in overall OCR). When available, this preserves the original detection polygon before any layout-guided refinement. Defaults to the same as bounding_box.

rec_poly: Option<BoundingBox>

Recognition polygon (rec_polys in overall OCR). After layout-guided refinement, this may differ from dt_poly.

text: Option<Arc<str>>

The recognized text, if recognition was successful. None indicates that recognition failed or was filtered out due to low confidence.

confidence: Option<f32>

The confidence score for the recognized text. None indicates that recognition failed or was filtered out due to low confidence.

orientation_angle: Option<f32>

The text line orientation angle, if orientation classification was performed. None indicates that orientation classification was not performed or failed.

word_boxes: Option<Vec<BoundingBox>>

Word-level bounding boxes within this text region (optional). Only populated when word-level detection is enabled. Each box corresponds to a word or character in the recognized text.

label: Option<Arc<str>>

Label indicating the type of this text region. Used to distinguish between normal text and special content like formulas. Common values: “formula”, “text”, “seal”, etc. PaddleX: corresponds to rec_labels in OCR results.

Implementations

impl TextRegion

pub fn new(bounding_box: BoundingBox) -> TextRegion

Creates a new TextRegion with the given bounding box.

The text, confidence, orientation_angle, word_boxes, and label are initially set to None.

pub fn with_recognition( bounding_box: BoundingBox, text: Option<Arc<str>>, confidence: Option<f32>, ) -> TextRegion

Creates a new TextRegion with detection and recognition results.

pub fn with_all( bounding_box: BoundingBox, text: Option<Arc<str>>, confidence: Option<f32>, orientation_angle: Option<f32>, ) -> TextRegion

Creates a new TextRegion with all fields specified.

pub fn has_text(&self) -> bool

Returns true if this text region has recognized text.

pub fn has_confidence(&self) -> bool

Returns true if this text region has a confidence score.

pub fn has_orientation(&self) -> bool

Returns true if this text region has an orientation angle.

pub fn has_word_boxes(&self) -> bool

Returns true if this text region has word-level boxes.

pub fn text_with_confidence(&self) -> Option<(&str, f32)>

Returns the text and confidence as a tuple if both are available.

pub fn has_label(&self) -> bool

Returns true if this text region has a label.

pub fn is_formula(&self) -> bool

Returns true if this text region is labeled as a formula.

pub fn with_label(self, label: Option<&str>) -> TextRegion

Sets the label for this text region.

Trait Implementations

impl Clone for TextRegion

fn clone(&self) -> TextRegion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextRegion

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextRegion

fn deserialize<__D>( __deserializer: __D, ) -> Result<TextRegion, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TextRegion

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.