pub struct Detector { /* private fields */ }Expand description
The primary entry point for the Locus perception library.
Detector encapsulates the entire detection pipeline.
Implementations§
Source§impl Detector
impl Detector
Sourcepub fn builder() -> DetectorBuilder
pub fn builder() -> DetectorBuilder
Returns a builder to configure a new detector.
Sourcepub fn with_config(config: DetectorConfig) -> Self
pub fn with_config(config: DetectorConfig) -> Self
Create a detector with custom pipeline configuration.
Sourcepub fn state(&self) -> &DetectorState
pub fn state(&self) -> &DetectorState
Access the internal state (for advanced inspection or FFI).
Sourcepub fn set_families(&mut self, families: &[TagFamily])
pub fn set_families(&mut self, families: &[TagFamily])
Clear all decoders and set new ones based on tag families.
Sourcepub fn detect(
&mut self,
img: &ImageView<'_>,
intrinsics: Option<&CameraIntrinsics>,
tag_size: Option<f64>,
pose_mode: PoseEstimationMode,
debug_telemetry: bool,
) -> Result<DetectionBatchView<'_>, DetectorError>
pub fn detect( &mut self, img: &ImageView<'_>, intrinsics: Option<&CameraIntrinsics>, tag_size: Option<f64>, pose_mode: PoseEstimationMode, debug_telemetry: bool, ) -> Result<DetectionBatchView<'_>, DetectorError>
Detect tags in the provided image.
This method is the main execution pipeline.
§Errors
Returns DetectorError if the input image cannot be decimated, upscaled,
or if an intermediate image view cannot be constructed.
Sourcepub fn config(&self) -> &DetectorConfig
pub fn config(&self) -> &DetectorConfig
Get the current detector configuration.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for Detector
impl !RefUnwindSafe for Detector
impl Send for Detector
impl !Sync for Detector
impl Unpin for Detector
impl UnsafeUnpin for Detector
impl !UnwindSafe for Detector
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.