Skip to main content

LayoutDetectionConfig

Struct LayoutDetectionConfig 

Source
pub struct LayoutDetectionConfig {
    pub score_threshold: f32,
    pub max_elements: usize,
    pub class_thresholds: Option<HashMap<String, f32>>,
    pub class_merge_modes: Option<HashMap<String, MergeBboxMode>>,
    pub layout_nms: bool,
    pub nms_threshold: f32,
    pub layout_unclip_ratio: Option<UnclipRatio>,
}
Expand description

Configuration for layout detection task.

Fields§

§score_threshold: f32

Default score threshold for detection (default: 0.5)

§max_elements: usize

Maximum number of layout elements (default: 100)

§class_thresholds: Option<HashMap<String, f32>>

Per-class score thresholds (overrides score_threshold for specific classes) PP-StructureV3 defaults:

  • paragraph_title: 0.3
  • formula: 0.3
  • text: 0.4
  • seal: 0.45
  • others: 0.5
§class_merge_modes: Option<HashMap<String, MergeBboxMode>>

Per-class bounding box merge modes

§layout_nms: bool

Enable NMS for layout detection (default: true)

§nms_threshold: f32

NMS threshold (default: 0.5)

§layout_unclip_ratio: Option<UnclipRatio>

Unclip ratio for expanding/shrinking bounding boxes (PP-StructureV3) Default: [1.0, 1.0] (no change)

Implementations§

Source§

impl LayoutDetectionConfig

Source

pub fn with_pp_structurev3_thresholds() -> LayoutDetectionConfig

Creates a config with PP-StructureV3 default class thresholds.

PP-StructureV3 uses different thresholds for different element types:

  • paragraph_title: 0.3
  • formula: 0.3
  • text: 0.4
  • seal: 0.45
  • others: 0.5 (default)
Source

pub fn with_pp_doclayoutv2_defaults() -> LayoutDetectionConfig

Creates a config with PP-DocLayoutV2 default thresholds and merge modes.

These defaults are aligned with OpenOCR/OpenDoc’s pipeline config: OpenOCR/configs/rec/unirec/opendoc_pipeline.yml.

Notes:

  • The postprocessor applies score_threshold before per-class thresholds, so we set it to the minimum per-class threshold (0.4) to avoid dropping valid candidates early.
  • class_merge_modes is populated for all labels so merge behavior is deterministic.
Source

pub fn with_pp_doclayoutv3_defaults() -> LayoutDetectionConfig

Creates a config with PP-DocLayoutV3 defaults (0.3 threshold + PP-DocLayout merge modes).

PP-DocLayoutV3 keeps the same label set as PP-DocLayoutV2 but uses a lower global threshold in the reference pipeline.

Source

pub fn with_pp_structurev3_defaults() -> LayoutDetectionConfig

Creates a config with PP-StructureV3 default thresholds, merge modes, and unclip ratio.

Merge modes follow standard configuration:

  • “large”: paragraph_title, image, formula, chart
  • “union”: all other PP-DocLayout_plus-L classes
Source

pub fn get_class_threshold(&self, class_name: &str) -> f32

Gets the threshold for a specific class.

Returns the class-specific threshold if configured, otherwise the default threshold.

Source

pub fn get_class_merge_mode(&self, class_name: &str) -> MergeBboxMode

Gets the merge mode for a specific class.

Returns the class-specific merge mode if configured, otherwise Large (default).

Trait Implementations§

Source§

impl Clone for LayoutDetectionConfig

Source§

fn clone(&self) -> LayoutDetectionConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConfigValidator for LayoutDetectionConfig

Source§

fn validate(&self) -> Result<(), ConfigError>

Validates the configuration. Read more
Source§

fn get_defaults() -> LayoutDetectionConfig

Returns the default configuration. Read more
Source§

fn validate_batch_size(&self, batch_size: usize) -> Result<(), ConfigError>

Validates a batch size. Read more
Source§

fn validate_batch_size_with_limits( &self, batch_size: usize, max_batch_size: usize, ) -> Result<(), ConfigError>

Validates a batch size against limits. Read more
Source§

fn validate_model_path(&self, path: &Path) -> Result<(), ConfigError>

Validates a model path. Read more
Source§

fn validate_image_dimensions( &self, width: u32, height: u32, ) -> Result<(), ConfigError>

Validates image dimensions. Read more
Source§

fn validate_confidence_threshold( &self, threshold: f32, ) -> Result<(), ConfigError>

Validates a confidence threshold. Read more
Source§

fn validate_memory_limit(&self, limit_mb: usize) -> Result<(), ConfigError>

Validates a memory limit. Read more
Source§

fn validate_thread_count(&self, thread_count: usize) -> Result<(), ConfigError>

Validates thread count. Read more
Source§

fn validate_f32_range( &self, value: f32, min: f32, max: f32, field_name: &str, ) -> Result<(), ConfigError>

Validates a float value is within a specified range. Read more
Source§

fn validate_positive_f32( &self, value: f32, field_name: &str, ) -> Result<(), ConfigError>

Validates a float value is positive. Read more
Source§

fn validate_positive_usize( &self, value: usize, field_name: &str, ) -> Result<(), ConfigError>

Validates a usize value is positive. Read more
Source§

impl Debug for LayoutDetectionConfig

Source§

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

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

impl Default for LayoutDetectionConfig

Source§

fn default() -> LayoutDetectionConfig

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

impl<'de> Deserialize<'de> for LayoutDetectionConfig

Source§

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

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

impl Serialize for LayoutDetectionConfig

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> ConfigDefaults for T
where T: ConfigValidator,

Source§

fn defaults() -> T

Return the recommended defaults for this configuration type.
Source§

impl<T> ConfigValidatorExt for T
where T: ConfigValidator,

Source§

fn validate_and_wrap_ocr_error(self) -> Result<Self, OCRError>
where Self: Sized,

Validates configuration and wraps any errors into OCRError::ConfigError. Read more
Source§

fn validate_and_wrap_generic(self) -> Result<Self, Box<dyn Error + Sync + Send>>
where Self: Sized,

Validates configuration and wraps any errors into a generic error. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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