Struct Detector 

pub struct Detector { /* private fields */ }

The primary entry point for the Locus perception library.

Detector encapsulates the entire detection pipeline. For concurrent multi-frame detection, construct with a max_concurrent_frames > 1 via DetectorBuilder::with_max_concurrent_frames and call Detector::detect_concurrent.

Implementations

impl Detector

pub fn new() -> Self

Create a new detector with the default configuration.

pub fn builder() -> DetectorBuilder

Returns a builder to configure a new detector.

pub fn with_config(config: DetectorConfig) -> Self

Create a detector with custom pipeline configuration.

pub fn state(&self) -> &FrameContext

Access the internal frame context (for advanced inspection or FFI).

pub fn engine(&self) -> &LocusEngine

Access the shared engine (for advanced FFI use only).

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.

pub fn detect_concurrent( &self, frames: &[ImageView<'_>], intrinsics: Option<&CameraIntrinsics>, tag_size: Option<f64>, pose_mode: PoseEstimationMode, ) -> Vec<Result<Vec<Detection>, DetectorError>>

Detect tags in multiple frames concurrently using Rayon.

Delegates to the internal LocusEngine pool. The pool is sized to max_concurrent_frames at construction time (see DetectorBuilder::with_max_concurrent_frames). Telemetry is not available via this method.

pub fn set_families(&mut self, families: &[TagFamily])

Clear all decoders and set new ones based on tag families.

pub fn config(&self) -> DetectorConfig

Get the current detector configuration.

Trait Implementations

impl Default for Detector

fn default() -> Self

Returns the “default value” for a type.