Skip to main content

DetectConfig

ringgrid

Struct DetectConfig 

Source 
pub struct DetectConfig {
Show 19 fields
    pub marker_scale: MarkerScalePrior,
    pub outer_estimation: OuterEstimationConfig,
    pub proposal: ProposalConfig,
    pub seed_proposals: SeedProposalParams,
    pub edge_sample: EdgeSampleConfig,
    pub decode: DecodeConfig,
    pub marker_spec: MarkerSpec,
    pub inner_fit: InnerFitConfig,
    pub circle_refinement: CircleRefinementMethod,
    pub projective_center: ProjectiveCenterParams,
    pub completion: CompletionParams,
    pub min_semi_axis: f64,
    pub max_semi_axis: f64,
    pub max_aspect_ratio: f64,
    pub dedup_radius: f64,
    pub use_global_filter: bool,
    pub ransac_homography: RansacHomographyConfig,
    pub board: BoardLayout,
    pub self_undistort: SelfUndistortConfig,

}
Expand description

Top-level detection configuration.

Contains all parameters that control the detection pipeline. Use one of the recommended constructors rather than constructing directly:

These constructors auto-derive scale-dependent parameters (proposal radii, edge search windows, validation bounds) from the board geometry and marker scale prior. Individual fields can be tuned after construction.

Fields§

§marker_scale: MarkerScalePrior

Marker diameter prior (range) in working-frame pixels.

§outer_estimation: OuterEstimationConfig

Outer edge estimation configuration (anchored on marker_scale).

§proposal: ProposalConfig

Proposal generation configuration.

§seed_proposals: SeedProposalParams

Seed-injection controls for multi-pass proposal generation.

§edge_sample: EdgeSampleConfig

Radial edge sampling configuration.

§decode: DecodeConfig

Marker decode configuration.

§marker_spec: MarkerSpec

Marker geometry specification and estimator controls.

§inner_fit: InnerFitConfig

Robust inner ellipse fitting controls shared across pipeline stages.

§circle_refinement: CircleRefinementMethod

Post-fit circle refinement method selector.

§projective_center: ProjectiveCenterParams

Projective-center recovery controls.

§completion: CompletionParams

Homography-guided completion controls.

§min_semi_axis: f64

Minimum semi-axis for a valid outer ellipse.

§max_semi_axis: f64

Maximum semi-axis for a valid outer ellipse.

§max_aspect_ratio: f64

Maximum aspect ratio (a/b) for a valid ellipse.

§dedup_radius: f64

NMS dedup radius for final markers (pixels).

§use_global_filter: bool

Enable global homography filtering (requires board spec).

§ransac_homography: RansacHomographyConfig

RANSAC homography configuration.

§board: BoardLayout

Board layout: marker positions and geometry.

§self_undistort: SelfUndistortConfig

Self-undistort estimation controls.

Implementations§

Source§

impl DetectConfig

Source

pub fn from_target_and_scale_prior( board: BoardLayout, marker_scale: MarkerScalePrior, ) -> Self

Build a configuration with scale-dependent parameters derived from a marker diameter range and a runtime target layout.

This is the recommended constructor for library users. After calling it, individual fields can be overridden as needed.

Source

pub fn from_target(board: BoardLayout) -> Self

Build a configuration from target layout and default marker scale prior.

Source

pub fn from_target_and_marker_diameter( board: BoardLayout, diameter_px: f32, ) -> Self

Build a configuration from target layout and a fixed marker diameter hint.

Source

pub fn set_marker_scale_prior(&mut self, marker_scale: MarkerScalePrior)

Update marker scale prior and re-derive all scale-coupled parameters.

Source

pub fn set_marker_diameter_hint_px(&mut self, diameter_px: f32)

Update marker scale prior from a fixed marker diameter hint.

Trait Implementations§

Source§

impl Clone for DetectConfig

Source§

fn clone(&self) -> DetectConfig

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 Debug for DetectConfig

Source§

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

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

impl Default for DetectConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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<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