Trait opencv::prelude::BinaryDescriptorTraitConst

source · 
pub trait BinaryDescriptorTraitConst: AlgorithmTraitConst {

Show 13 methods    // Required method
    fn as_raw_BinaryDescriptor(&self) -> *const c_void;

    // Provided methods
    fn write(&self, fs: &mut FileStorage) -> Result<()> { ... }
    fn detect(
        &self,
        images: &Vector<Mat>,
        keylines: &mut Vector<Vector<KeyLine>>,
        masks: &Vector<Mat>
    ) -> Result<()> { ... }
    fn detect_def(
        &self,
        images: &Vector<Mat>,
        keylines: &mut Vector<Vector<KeyLine>>
    ) -> Result<()> { ... }
    fn compute(
        &self,
        image: &Mat,
        keylines: &mut Vector<KeyLine>,
        descriptors: &mut Mat,
        return_float_descr: bool
    ) -> Result<()> { ... }
    fn compute_def(
        &self,
        image: &Mat,
        keylines: &mut Vector<KeyLine>,
        descriptors: &mut Mat
    ) -> Result<()> { ... }
    fn compute_1(
        &self,
        images: &Vector<Mat>,
        keylines: &mut Vector<Vector<KeyLine>>,
        descriptors: &mut Vector<Mat>,
        return_float_descr: bool
    ) -> Result<()> { ... }
    fn compute_def_1(
        &self,
        images: &Vector<Mat>,
        keylines: &mut Vector<Vector<KeyLine>>,
        descriptors: &mut Vector<Mat>
    ) -> Result<()> { ... }
    fn descriptor_size(&self) -> Result<i32> { ... }
    fn descriptor_type(&self) -> Result<i32> { ... }
    fn default_norm(&self) -> Result<i32> { ... }
    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<()> { ... }
    fn apply_def(
        &self,
        image: &impl ToInputArray,
        mask: &impl ToInputArray,
        keylines: &mut Vector<KeyLine>,
        descriptors: &mut impl ToOutputArray
    ) -> Result<()> { ... }

}
Expand description

Constant methods for crate::line_descriptor::BinaryDescriptor

Required Methods§

source

fn as_raw_BinaryDescriptor(&self) -> *const c_void

Provided Methods§

source

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

Store parameters to a FileStorage object

Parameters
  • fs: output FileStorage file
source

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

Requires line detection

Parameters
  • image: input image
  • keypoints: vector that will store extracted lines for one or more images
  • mask: mask matrix to detect only KeyLines of interest
Overloaded parameters
  • images: input images
  • keylines: set of vectors that will store extracted lines for one or more images
  • masks: vector of mask matrices to detect only KeyLines of interest from each input image
C++ default parameters
  • masks: std::vector()
source

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

@overload

Parameters
  • images: input images
  • keylines: set of vectors that will store extracted lines for one or more images
  • masks: vector of mask matrices to detect only KeyLines of interest from each input image
Note

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

  • masks: std::vector()
source

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

Requires descriptors computation

Parameters
  • image: input image
  • keylines: vector containing lines for which descriptors must be computed
  • descriptors:
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
C++ default parameters
  • return_float_descr: false
source

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

Requires descriptors computation

Parameters
  • image: input image
  • keylines: vector containing lines for which descriptors must be computed
  • descriptors:
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
Note

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

  • return_float_descr: false
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

Parameters
  • image: input image
  • keylines: vector containing lines for which descriptors must be computed
  • descriptors:
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
Overloaded parameters
  • images: input images
  • keylines: set of vectors containing lines for which descriptors must be computed
  • descriptors:
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
C++ default parameters
  • return_float_descr: false
source

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

@overload

Parameters
  • images: input images
  • keylines: set of vectors containing lines for which descriptors must be computed
  • descriptors:
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
Note

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

  • return_float_descr: false
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: &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.

Parameters
  • image: input image
  • mask: mask matrix to select which lines in KeyLines must be accepted among the ones extracted (used when keylines is not empty)
  • keylines: vector that contains input lines (when filled, the detection part will be skipped and input lines will be passed as input to the algorithm computing descriptors)
  • descriptors: matrix that will store final descriptors
  • useProvidedKeyLines: flag (when set to true, detection phase will be skipped and only computation of descriptors will be executed, using lines provided in keylines)
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
C++ default parameters
  • use_provided_key_lines: false
  • return_float_descr: false
source

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.

Parameters
  • image: input image
  • mask: mask matrix to select which lines in KeyLines must be accepted among the ones extracted (used when keylines is not empty)
  • keylines: vector that contains input lines (when filled, the detection part will be skipped and input lines will be passed as input to the algorithm computing descriptors)
  • descriptors: matrix that will store final descriptors
  • useProvidedKeyLines: flag (when set to true, detection phase will be skipped and only computation of descriptors will be executed, using lines provided in keylines)
  • returnFloatDescr: flag (when set to true, original non-binary descriptors are returned)
Note

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

  • use_provided_key_lines: false
  • return_float_descr: false

Object Safety§

This trait is not object safe.

Implementors§