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

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§

source§

impl BinaryDescriptor

source

pub fn new(parameters: &BinaryDescriptor_Params) -> 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()
source

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

source

pub fn create_binary_descriptor_1( parameters: BinaryDescriptor_Params ) -> Result<Ptr<BinaryDescriptor>>

Trait Implementations§

source§

impl AlgorithmTrait for BinaryDescriptor

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 BinaryDescriptor

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 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 BinaryDescriptorTrait for BinaryDescriptor

source§

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

source§

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

Get current number of octaves
source§

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

Set number of octaves Read more
source§

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

Get current width of bands
source§

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

Set width of bands Read more
source§

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

Get current reduction ratio (used in Gaussian pyramids)
source§

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

Set reduction ratio (used in Gaussian pyramids) Read more
source§

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

Read parameters from a FileNode object and store them Read more
source§

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

Requires line detection Read more
source§

impl BinaryDescriptorTraitConst for BinaryDescriptor

source§

fn as_raw_BinaryDescriptor(&self) -> *const c_void

source§

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

Store parameters to a FileStorage object Read more
source§

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

Requires line detection Read more
source§

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

Requires descriptors computation Read more
source§

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

Requires descriptors computation Read more
source§

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

Return descriptor size
source§

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

Return data type
source§

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

returns norm mode
source§

fn apply( &self, image: &dyn ToInputArray, mask: &dyn ToInputArray, keylines: &mut Vector<KeyLine>, descriptors: &mut dyn 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. Read more
source§

impl Boxed for BinaryDescriptor

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 Drop for BinaryDescriptor

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl From<BinaryDescriptor> for Algorithm

source§

fn from(s: BinaryDescriptor) -> Self

Converts to this type from the input type.
source§

impl Send for BinaryDescriptor

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.