Struct StructureResult 

pub struct StructureResult {
    pub input_path: Arc<str>,
    pub index: usize,
    pub layout_elements: Vec<LayoutElement>,
    pub tables: Vec<TableResult>,
    pub formulas: Vec<FormulaResult>,
    pub text_regions: Option<Vec<TextRegion>>,
    pub orientation_angle: Option<f32>,
    pub region_blocks: Option<Vec<RegionBlock>>,
    pub rectified_img: Option<Arc<RgbImage>>,
}

Result of document structure analysis.

This struct contains all the results from analyzing a document’s structure, including layout elements, tables, formulas, and OCR results.

Coordinate System

The coordinate system of bounding boxes depends on which preprocessing was applied:

• No preprocessing: Boxes are in the original input image’s coordinate system.

• Orientation correction only (orientation_angle set, rectified_img is None): Boxes are transformed back to the original input image’s coordinate system.

• Rectification applied (rectified_img is Some): Boxes remain in the rectified image’s coordinate system. Neural network-based rectification (UVDoc) warps cannot be precisely inverted, so use rectified_img for visualization instead of the original image.

• Both orientation and rectification: Boxes are in the rectified coordinate system (rectification takes precedence since it’s applied after orientation correction).

Fields

input_path: Arc<str>

Path to the input image file

index: usize

Index of the image in a batch (0 for single image processing)

layout_elements: Vec<LayoutElement>

Detected layout elements (text regions, tables, figures, etc.)

tables: Vec<TableResult>

Recognized tables with their structure and content

formulas: Vec<FormulaResult>

Recognized mathematical formulas

text_regions: Option<Vec<TextRegion>>

OCR text regions (if OCR was integrated)

orientation_angle: Option<f32>

Document orientation angle (if orientation correction was used)

region_blocks: Option<Vec<RegionBlock>>

Detected region blocks for hierarchical ordering (PP-DocBlockLayout) When present, layout_elements are already sorted by region hierarchy

rectified_img: Option<Arc<RgbImage>>

Rectified image (if document rectification was used) Note: Bounding boxes are already transformed back to original coordinates for rotation, but for rectification (UVDoc), boxes are in the rectified image’s coordinate system. Use this image for visualization when rectification was applied.

Implementations

impl StructureResult

pub fn new(input_path: impl Into<Arc<str>>, index: usize) -> Self

Creates a new structure result.

pub fn with_layout_elements(self, elements: Vec<LayoutElement>) -> Self

Adds layout elements to the result.

pub fn with_tables(self, tables: Vec<TableResult>) -> Self

Adds tables to the result.

pub fn with_formulas(self, formulas: Vec<FormulaResult>) -> Self

Adds formulas to the result.

pub fn with_text_regions(self, regions: Vec<TextRegion>) -> Self

Adds OCR text regions to the result.

pub fn with_region_blocks(self, blocks: Vec<RegionBlock>) -> Self

Adds region blocks to the result (PP-DocBlockLayout).

Region blocks represent hierarchical groupings of layout elements. When set, layout_elements should already be sorted by region hierarchy.

pub fn to_markdown(&self) -> String

Converts the result to a Markdown string.

Follows PP-StructureV3’s formatting rules:

• DocTitle: # title
• ParagraphTitle: Auto-detect numbering (1.2.3 -> ###)
• Formula: $$latex$$
• Table: HTML with border
• Images: ![Figure](caption)

Note: Low-confidence text elements that overlap with table regions are filtered out to avoid duplicate content from table OCR.

pub fn to_html(&self) -> String

Converts the result to an HTML string.

Follows PP-StructureV3’s formatting rules with semantic HTML tags.

pub fn to_json_value(&self) -> Result<Value>

Converts the result to a JSON Value.

pub fn save_results( &self, output_dir: impl AsRef<Path>, to_json: bool, to_markdown: bool, to_html: bool, ) -> Result<()>

Saves the analysis results to the specified directory.

This generates:

• *_res.json: The full structured result
• *_res.md: A Markdown representation
• *_res.html: An HTML representation

Arguments

• to_html - If true, save an HTML representation.

Trait Implementations

impl Clone for StructureResult

fn clone(&self) -> StructureResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructureResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructureResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StructureResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.