Skip to main content

GeometryStats

Struct GeometryStats 

Source
pub struct GeometryStats {
    pub header_y: f32,
    pub doc_footer_y: f32,
    pub left_x: f32,
    pub right_x: f32,
    pub per_page_footer_y: Vec<Option<f32>>,
    pub source_pages: u32,
    pub page_dimensions: PageDimensions,
    pub column_layout: ColumnLayout,
    pub heatmap: DensityGrid,
    pub diagnostic: GeometryDiagnostic,
}
Expand description

Document-level geometry: five lines defining six regions on the page, plus the column layout and a downsampled persistent heatmap.

Coordinate convention: PDF/Tika points, y increasing downward. header_y < doc_footer_y; left_x < right_x. Body region is header_y <= y < doc_footer_yleft_x < x < right_x.

Fields§

§header_y: f32

Top boundary of body. Body at y > header_y; header zone at y < header_y.

§doc_footer_y: f32

Bottom boundary of body at the document level. Body at y < doc_footer_y; below is the doc-level footer zone (running footer chrome + bottom margin). Per-page footers (variable footnotes) are captured separately via per_page_footer_y and are always at y <= doc_footer_y.

§left_x: f32

Horizontal body bounds. Body at left_x < x < right_x; outside is margin.

§right_x: f32§per_page_footer_y: Vec<Option<f32>>

Per-page footer line, indexed by sample-page order (one entry per page in source_pages). Some(y): per-page body bottom; always <= doc_footer_y by construction. None: page has no detectable body in its bottom half (e.g., references-only page, near-empty page, cover page with no body content). Downstream consumers should fall back to doc_footer_y for None entries.

§source_pages: u32

Number of pages stacked into the heatmap and analyzed for per-page footers. Capped at config.page_analysis_count; may be less for short docs.

§page_dimensions: PageDimensions

Page dimensions used for the heatmap (max across sampled pages).

§column_layout: ColumnLayout

Detected column structure inside the body region.

§heatmap: DensityGrid

Downsampled persistence of the bbox-stacking heatmap. See DensityGrid doc. Available to downstream pipes (e.g., Page Outlier Detection) as the document’s spatial signature.

§diagnostic: GeometryDiagnostic

Diagnostic summary of the walks and per-page analysis.

Trait Implementations§

Source§

impl Clone for GeometryStats

Source§

fn clone(&self) -> GeometryStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GeometryStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GeometryStats

Source§

fn default() -> GeometryStats

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GeometryStats

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GeometryStats

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.