Struct BinaryDescriptor

pub struct BinaryDescriptor { /* private fields */ }

Class implements both functionalities for detection of lines and computation of their binary descriptor.

Class’ interface is mainly based on the ones of classical detectors and extractors, such as Feature2d’s [features2d_main] and [features2d_match]. Retrieved information about lines is stored in line_descriptor::KeyLine objects.

Implementations

impl BinaryDescriptor

pub fn new( parameters: &impl BinaryDescriptor_ParamsTraitConst, ) -> Result<BinaryDescriptor>

Constructor

Parameters

• parameters: configuration parameters BinaryDescriptor::Params

If no argument is provided, constructor sets default values (see comments in the code snippet in previous section). Default values are strongly recommended.

C++ default parameters

• parameters: BinaryDescriptor::Params()

pub fn new_def() -> Result<BinaryDescriptor>

Constructor

Parameters

• parameters: configuration parameters BinaryDescriptor::Params

If no argument is provided, constructor sets default values (see comments in the code snippet in previous section). Default values are strongly recommended.

Note

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

• parameters: BinaryDescriptor::Params()

pub fn create_binary_descriptor() -> Result<Ptr<BinaryDescriptor>>

Create a BinaryDescriptor object with default parameters (or with the ones provided) and return a smart pointer to it

pub fn create_binary_descriptor_1( parameters: impl BinaryDescriptor_ParamsTrait, ) -> Result<Ptr<BinaryDescriptor>>

Trait Implementations

impl AlgorithmTrait for BinaryDescriptor

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

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

Clears the algorithm state

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

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for BinaryDescriptor

fn as_raw_Algorithm(&self) -> *const c_void

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

Stores algorithm parameters in a file storage

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

Stores algorithm parameters in a file storage

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

@deprecated

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:

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

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

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).

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.

impl BinaryDescriptorTrait for BinaryDescriptor

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

fn get_num_of_octaves(&mut self) -> Result<i32>

Get current number of octaves

fn set_num_of_octaves(&mut self, octaves: i32) -> Result<()>

Set number of octaves

fn get_width_of_band(&mut self) -> Result<i32>

Get current width of bands

fn set_width_of_band(&mut self, width: i32) -> Result<()>

Set width of bands

fn get_reduction_ratio(&mut self) -> Result<i32>

Get current reduction ratio (used in Gaussian pyramids)

fn set_reduction_ratio(&mut self, r_ratio: i32) -> Result<()>

Set reduction ratio (used in Gaussian pyramids)

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

Read parameters from a FileNode object and store them

fn detect_1( &mut self, image: &impl MatTraitConst, keypoints: &mut Vector<KeyLine>, mask: &impl MatTraitConst, ) -> Result<()>

Requires line detection

fn detect_def_1( &mut self, image: &impl MatTraitConst, keypoints: &mut Vector<KeyLine>, ) -> Result<()>

Requires line detection

impl BinaryDescriptorTraitConst for BinaryDescriptor

fn as_raw_BinaryDescriptor(&self) -> *const c_void

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

Store parameters to a FileStorage object

fn detect( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, masks: &Vector<Mat>, ) -> Result<()>

Requires line detection

fn detect_def( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, ) -> Result<()>

@overload

fn compute( &self, image: &impl MatTraitConst, keylines: &mut Vector<KeyLine>, descriptors: &mut impl MatTrait, return_float_descr: bool, ) -> Result<()>

Requires descriptors computation

fn compute_def( &self, image: &impl MatTraitConst, keylines: &mut Vector<KeyLine>, descriptors: &mut impl MatTrait, ) -> Result<()>

Requires descriptors computation

fn compute_1( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, descriptors: &mut Vector<Mat>, return_float_descr: bool, ) -> Result<()>

Requires descriptors computation

fn compute_def_1( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, descriptors: &mut Vector<Mat>, ) -> Result<()>

@overload

fn descriptor_size(&self) -> Result<i32>

Return descriptor size

fn descriptor_type(&self) -> Result<i32>

Return data type

fn default_norm(&self) -> Result<i32>

returns norm mode

fn apply( &self, image: &impl ToInputArray, mask: &impl ToInputArray, keylines: &mut Vector<KeyLine>, descriptors: &mut impl ToOutputArray, use_provided_key_lines: bool, return_float_descr: bool, ) -> Result<()>

Define operator ‘()’ to perform detection of KeyLines and computation of descriptors in a row.

fn apply_def( &self, image: &impl ToInputArray, mask: &impl ToInputArray, keylines: &mut Vector<KeyLine>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

Define operator ‘()’ to perform detection of KeyLines and computation of descriptors in a row.

impl Boxed for BinaryDescriptor

unsafe fn from_raw( ptr: <BinaryDescriptor as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw( self, ) -> <BinaryDescriptor as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <BinaryDescriptor as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <BinaryDescriptor as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for BinaryDescriptor

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

Formats the value using the given formatter.

impl Drop for BinaryDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl From<BinaryDescriptor> for Algorithm

fn from(s: BinaryDescriptor) -> Self

Converts to this type from the input type.

impl Send for BinaryDescriptor