[−][src]Trait opencv::line_descriptor::prelude::BinaryDescriptorTrait

pub trait BinaryDescriptorTrait: AlgorithmTrait {
    fn as_raw_BinaryDescriptor(&self) -> *const c_void;

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

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

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

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

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

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

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

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

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

    fn detect(
        &mut self, 
        image: &Mat, 
        keypoints: &mut Vector<KeyLine>, 
        mask: &Mat
    ) -> Result<()> { ... }

    fn detect_1(
        &self, 
        images: &Vector<Mat>, 
        keylines: &mut Vector<Vector<KeyLine>>, 
        masks: &Vector<Mat>
    ) -> Result<()> { ... }

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

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

    fn descriptor_size(&self) -> Result<i32> { ... }

    fn descriptor_type(&self) -> Result<i32> { ... }

    fn default_norm(&self) -> Result<i32> { ... }
}

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 @ref features2d_main and @ref features2d_match. Retrieved information about lines is stored in line_descriptor::KeyLine objects.

Required methods

fn as_raw_BinaryDescriptor(&self) -> *const c_void

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

Loading content...

Provided methods

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

Parameters

  • octaves: 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

Parameters

  • width: 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)

Parameters

  • rRatio: reduction ratio

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

Read parameters from a FileNode object and store them

Parameters

  • fn: source FileNode file

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

Store parameters to a FileStorage object

Parameters

  • fs: output FileStorage file

fn detect(
    &mut self,
    image: &Mat,
    keypoints: &mut Vector<KeyLine>,
    mask: &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

C++ default parameters

  • mask: Mat()

fn detect_1(
    &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()

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

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

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

Loading content...

Implementors

Loading content...