Skip to main content

DetectorConfig

Struct DetectorConfig 

Source
#[non_exhaustive]
pub struct DetectorConfig { pub strategy: DetectionStrategy, pub threshold: Threshold, pub multiscale: MultiscaleConfig, pub upscale: UpscaleConfig, pub orientation_method: OrientationMethod, pub merge_radius: f32, }
Expand description

High-level detection configuration.

Build one with DetectorConfig::chess, DetectorConfig::chess_multiscale, DetectorConfig::radon, or DetectorConfig::radon_multiscale and tweak only the fields you need. The detector translates this into the low-level ChessParams / RadonDetectorParams consumed by chess-corners-core at the detection boundary.

§Common knobs

These fields are the primary surface for most callers:

  • strategy — choose ChESS or Radon and configure its parameters.
  • threshold — control how many corners are returned: lower Relative fraction or Absolute floor → more candidates; higher → fewer, stronger ones.
  • multiscale — enable coarse-to-fine pyramid detection (Pyramid) or keep it off (SingleScale).
  • upscale — pre-pipeline integer bilinear upscaling for low-resolution inputs where corners have fewer than 5 px of ring support. Disabled by default.
  • orientation_method — how corner axis orientations are estimated when building descriptors.

§Advanced tuning

  • merge_radius — duplicate-suppression radius across pyramid levels. See the field docs below.

Fields (Non-exhaustive)§

This struct is marked as 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.
§strategy: DetectionStrategy

Detector dispatch: ChESS or Radon, each carrying its own tuning.

§threshold: Threshold

Acceptance threshold. Same enum is honoured by both detectors.

§multiscale: MultiscaleConfig

Coarse-to-fine multiscale configuration. SingleScale skips the pyramid entirely. Honoured by both strategies.

§upscale: UpscaleConfig

Pre-pipeline integer upscaling. Disabled skips the stage.

§orientation_method: OrientationMethod

Orientation-fit method used when building corner descriptors.

§merge_radius: f32

Advanced tuning. Merge radius in base-image pixels for cross-level and cross-seed duplicate suppression. After seeds detected at coarser pyramid levels are refined into the base image, any two refined positions within this radius are merged into a single output corner. Default is 3.0 px. Increase if you see duplicate detections near the same physical corner; decrease if distinct corners closer than 2·merge_radius pixels are being merged.

Implementations§

Source§

impl DetectorConfig

Source

pub fn chess() -> Self

Single-scale ChESS preset.

Source

pub fn chess_multiscale() -> Self

Three-level coarse-to-fine ChESS preset.

Source

pub fn radon() -> Self

Whole-image Radon detector preset. Single-scale; use Self::radon_multiscale for coarse-to-fine Radon detection on larger frames.

Source

pub fn radon_multiscale() -> Self

Coarse-to-fine Radon preset. Measure against Self::radon on your target frame sizes; this preset trades more configuration machinery for less full-resolution detector work on large frames.

Source

pub fn with_chess<F: FnOnce(&mut ChessConfig)>(self, f: F) -> Self

Set the active strategy to ChESS and apply f to the nested config. If the current strategy is already ChESS, mutate it in place. Otherwise, replace the strategy with ChessConfig::default and apply f.

Top-level fields (threshold, multiscale, upscale, orientation_method, merge_radius) are untouched. When switching strategies, prefer the preset constructors — Radon uses Relative(0.01) thresholds while ChESS uses Absolute(0.0).

Source

pub fn with_radon<F: FnOnce(&mut RadonConfig)>(self, f: F) -> Self

Mirror of Self::with_chess for the Radon strategy.

Source

pub fn with_threshold(self, threshold: Threshold) -> Self

Replace the acceptance threshold.

Source

pub fn with_multiscale(self, multiscale: MultiscaleConfig) -> Self

Replace the multiscale configuration.

Source

pub fn with_upscale(self, upscale: UpscaleConfig) -> Self

Replace the upscale configuration.

Source

pub fn with_orientation_method(self, method: OrientationMethod) -> Self

Replace the orientation-fit method used when building descriptors.

Source

pub fn with_merge_radius(self, radius: f32) -> Self

Replace the merge radius for cross-level duplicate suppression.

Trait Implementations§

Source§

impl Clone for DetectorConfig

Source§

fn clone(&self) -> DetectorConfig

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 DetectorConfig

Source§

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

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

impl Default for DetectorConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for DetectorConfig

Source§

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

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

impl PartialEq for DetectorConfig

Source§

fn eq(&self, other: &DetectorConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for DetectorConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for DetectorConfig

Source§

impl StructuralPartialEq for DetectorConfig

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, 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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,