Struct RegularGridParams 

#[non_exhaustive]
pub struct RegularGridParams {
    pub pipeline: SquareGridParams,
    pub canonicalize_top_left: bool,
    pub prune_disconnected: bool,
}

Tuning knobs for RegularGridDetector.

#[non_exhaustive]: new knobs may land in future releases. Build fully-specified instances with RegularGridParams::new or start from RegularGridParams::default and override fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pipeline: SquareGridParams

Core seed → grow → extend → fill → validate tuning. The internal regular-grid policy fills in the pattern hooks; this struct carries the geometric knobs only.

The boundary-extension strategy lives on SquareGridParams::extension (an ExtensionStrategy) — it is the single source of truth and is honoured directly. Use Self::with_extension to override it builder-style.

canonicalize_top_left: bool

When true, detect_regular_grid canonicalises the labelled grid to a visual top-left origin (+i → right, +j → down in pixel space) before returning. When false, the grid keeps the orientation BFS-grow produced (still rebased to (0, 0)).

prune_disconnected: bool

When true, detect_regular_grid drops corners not 4-connected to the largest labelled component. Off-grid spurious points and bridged sub-grids both manifest as extra components; pruning is a pattern-agnostic precision guard.

Implementations

impl RegularGridParams

pub fn new(pipeline: SquareGridParams) -> Self

Construct params from a SquareGridParams, defaulting the canonicalize_top_left and prune_disconnected toggles to their Default values (true for both).

The struct is #[non_exhaustive], so this named constructor (or RegularGridParams::default) is the supported way to build one outside the crate. Layer the with_* builders on top to override individual fields. The boundary-extension strategy is configured via SquareGridParams::extension inside pipeline, or builder-style with Self::with_extension.

pub fn with_extension(self, extension: ExtensionStrategy) -> Self

Override the boundary-extension strategy. Builder-style setter that writes SquareGridParams::extension inside pipeline — the single source of truth for the extension stage.

pub fn with_canonicalize_top_left(self, on: bool) -> Self

Override the top-left canonicalisation toggle. Builder-style setter; see Self::with_extension.

pub fn with_prune_disconnected(self, on: bool) -> Self

Override the connectivity-pruning toggle. Builder-style setter; see Self::with_extension.

Trait Implementations

impl Clone for RegularGridParams

fn clone(&self) -> RegularGridParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegularGridParams

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

Formats the value using the given formatter.

impl Default for RegularGridParams

fn default() -> Self

Returns the “default value” for a type.