pub struct ArucoDetector { /* private fields */ }
Expand description

The main functionality of ArucoDetector class is detection of markers in an image with detectMarkers() method.

After detecting some markers in the image, you can try to find undetected markers from this dictionary with refineDetectedMarkers() method.

See also

DetectorParameters, RefineParameters

Implementations§

source§

impl ArucoDetector

source

pub fn new( dictionary: &Dictionary, detector_params: &DetectorParameters, refine_params: RefineParameters ) -> Result<ArucoDetector>

Basic ArucoDetector constructor

Parameters
  • dictionary: indicates the type of markers that will be searched
  • detectorParams: marker detection parameters
  • refineParams: marker refine detection parameters
C++ default parameters
  • dictionary: getPredefinedDictionary(cv::aruco::DICT_4X4_50)
  • detector_params: DetectorParameters()
  • refine_params: RefineParameters()
source

pub fn new_def() -> Result<ArucoDetector>

Basic ArucoDetector constructor

Parameters
  • dictionary: indicates the type of markers that will be searched
  • detectorParams: marker detection parameters
  • refineParams: marker refine detection parameters
Note

This alternative version of [new] function uses the following default values for its arguments:

  • dictionary: getPredefinedDictionary(cv::aruco::DICT_4X4_50)
  • detector_params: DetectorParameters()
  • refine_params: RefineParameters()

Trait Implementations§

source§

impl AlgorithmTrait for ArucoDetector

source§

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

source§

fn clear(&mut self) -> Result<()>

Clears the algorithm state
source§

fn read(&mut self, fn_: &FileNode) -> Result<()>

Reads algorithm parameters from a file storage
source§

impl AlgorithmTraitConst for ArucoDetector

source§

fn as_raw_Algorithm(&self) -> *const c_void

source§

fn write(&self, fs: &mut FileStorage) -> Result<()>

Stores algorithm parameters in a file storage
source§

fn write_1(&self, fs: &mut FileStorage, name: &str) -> Result<()>

Stores algorithm parameters in a file storage Read more
source§

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated Read more
source§

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments: Read more
source§

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
source§

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).
source§

fn get_default_name(&self) -> Result<String>

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.
source§

impl ArucoDetectorTrait for ArucoDetector

source§

fn as_raw_mut_ArucoDetector(&mut self) -> *mut c_void

source§

fn set_dictionary(&mut self, dictionary: &Dictionary) -> Result<()>

source§

fn set_detector_parameters( &mut self, detector_parameters: &DetectorParameters ) -> Result<()>

source§

fn set_refine_parameters( &mut self, refine_parameters: RefineParameters ) -> Result<()>

source§

fn write_1(&mut self, fs: &mut FileStorage, name: &str) -> Result<()>

simplified API for language bindings
source§

fn read(&mut self, fn_: &FileNode) -> Result<()>

Reads algorithm parameters from a file storage
source§

impl ArucoDetectorTraitConst for ArucoDetector

source§

fn as_raw_ArucoDetector(&self) -> *const c_void

source§

fn detect_markers( &self, image: &impl ToInputArray, corners: &mut impl ToOutputArray, ids: &mut impl ToOutputArray, rejected_img_points: &mut impl ToOutputArray ) -> Result<()>

Basic marker detection Read more
source§

fn detect_markers_def( &self, image: &impl ToInputArray, corners: &mut impl ToOutputArray, ids: &mut impl ToOutputArray ) -> Result<()>

Basic marker detection Read more
source§

fn refine_detected_markers( &self, image: &impl ToInputArray, board: &Board, detected_corners: &mut impl ToInputOutputArray, detected_ids: &mut impl ToInputOutputArray, rejected_corners: &mut impl ToInputOutputArray, camera_matrix: &impl ToInputArray, dist_coeffs: &impl ToInputArray, recovered_idxs: &mut impl ToOutputArray ) -> Result<()>

Refine not detected markers based on the already detected and the board layout Read more
source§

fn refine_detected_markers_def( &self, image: &impl ToInputArray, board: &Board, detected_corners: &mut impl ToInputOutputArray, detected_ids: &mut impl ToInputOutputArray, rejected_corners: &mut impl ToInputOutputArray ) -> Result<()>

Refine not detected markers based on the already detected and the board layout Read more
source§

fn get_dictionary(&self) -> Result<Dictionary>

source§

fn get_detector_parameters(&self) -> Result<DetectorParameters>

source§

fn get_refine_parameters(&self) -> Result<RefineParameters>

source§

fn write(&self, fs: &mut FileStorage) -> Result<()>

Stores algorithm parameters in a file storage
source§

impl Boxed for ArucoDetector

source§

unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer Read more
source§

fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper. Read more
source§

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer. Read more
source§

fn as_raw_mut(&mut self) -> *mut c_void

Return the underlying mutable raw pointer Read more
source§

impl Debug for ArucoDetector

source§

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

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

impl Drop for ArucoDetector

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl From<ArucoDetector> for Algorithm

source§

fn from(s: ArucoDetector) -> Self

Converts to this type from the input type.
source§

impl Send for ArucoDetector

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.