Struct opencv::features2d::BRISK

pub struct BRISK { /* fields omitted */ }

Class implementing the BRISK keypoint detector and descriptor extractor, described in LCS11 .

Implementations

impl BRISK

pub fn as_raw_BRISK(&self) -> *const c_void

pub fn as_raw_mut_BRISK(&mut self) -> *mut c_void

impl BRISK

pub fn create(
    thresh: i32,
    octaves: i32,
    pattern_scale: f32
) -> Result<Ptr<BRISK>>

The BRISK constructor

Parameters

• thresh: AGAST detection threshold score.
• octaves: detection octaves. Use 0 to do single scale.
• patternScale: apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

C++ default parameters

• thresh: 30
• octaves: 3
• pattern_scale: 1.0f

pub fn create_with_pattern(
    radius_list: &Vector<f32>,
    number_list: &Vector<i32>,
    d_max: f32,
    d_min: f32,
    index_change: &Vector<i32>
) -> Result<Ptr<BRISK>>

The BRISK constructor for a custom pattern

Parameters

• radiusList: defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
• numberList: defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
• dMax: threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
• dMin: threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
• indexChange: index remapping of the bits.

C++ default parameters

• d_max: 5.85f
• d_min: 8.2f
• index_change: std::vector()

pub fn create_with_pattern_threshold_octaves(
    thresh: i32,
    octaves: i32,
    radius_list: &Vector<f32>,
    number_list: &Vector<i32>,
    d_max: f32,
    d_min: f32,
    index_change: &Vector<i32>
) -> Result<Ptr<BRISK>>

The BRISK constructor for a custom pattern, detection threshold and octaves

Parameters

• thresh: AGAST detection threshold score.
• octaves: detection octaves. Use 0 to do single scale.
• radiusList: defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).
• numberList: defines the number of sampling points on the sampling circle. Must be the same size as radiusList..
• dMax: threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).
• dMin: threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).
• indexChange: index remapping of the bits.

C++ default parameters

• d_max: 5.85f
• d_min: 8.2f
• index_change: std::vector()

Trait Implementations

impl AlgorithmTrait for BRISK

pub fn as_raw_Algorithm(&self) -> *const c_void

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

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

Clears the algorithm state

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

Stores algorithm parameters in a file storage

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

simplified API for language bindings Stores algorithm parameters in a file storage

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

Reads algorithm parameters from a file storage

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

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

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

pub 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 BRISKTrait for BRISK

pub fn as_raw_BRISK(&self) -> *const c_void

pub fn as_raw_mut_BRISK(&mut self) -> *mut c_void

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

pub fn set_threshold(&mut self, threshold: i32) -> Result<()>

Set detection threshold.

pub fn get_threshold(&self) -> Result<i32>

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

Set detection octaves.

pub fn get_octaves(&self) -> Result<i32>

impl Boxed for BRISK

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

Wrap the specified raw pointer

pub fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

pub fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Drop for BRISK

pub fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for BRISK

pub fn as_raw_Feature2D(&self) -> *const c_void

pub fn as_raw_mut_Feature2D(&mut self) -> *mut c_void

pub fn detect(
    &mut self,
    image: &dyn ToInputArray,
    keypoints: &mut Vector<KeyPoint>,
    mask: &dyn ToInputArray
) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

pub fn detect_multiple(
    &mut self,
    images: &dyn ToInputArray,
    keypoints: &mut Vector<Vector<KeyPoint>>,
    masks: &dyn ToInputArray
) -> Result<()>

Detects keypoints in an image (first variant) or image set (second variant).

pub fn compute(
    &mut self,
    image: &dyn ToInputArray,
    keypoints: &mut Vector<KeyPoint>,
    descriptors: &mut dyn ToOutputArray
) -> Result<()>

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

pub fn compute_multiple(
    &mut self,
    images: &dyn ToInputArray,
    keypoints: &mut Vector<Vector<KeyPoint>>,
    descriptors: &mut dyn ToOutputArray
) -> Result<()>

Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

pub fn detect_and_compute(
    &mut self,
    image: &dyn ToInputArray,
    mask: &dyn ToInputArray,
    keypoints: &mut Vector<KeyPoint>,
    descriptors: &mut dyn ToOutputArray,
    use_provided_keypoints: bool
) -> Result<()>

Detects keypoints and computes the descriptors

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

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

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

pub fn write(&self, file_name: &str) -> Result<()>

pub fn read(&mut self, file_name: &str) -> Result<()>

pub fn write_1(&self, unnamed: &mut FileStorage) -> Result<()>

pub fn read_1(&mut self, unnamed: &FileNode) -> Result<()>

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

Return true if detector object is empty

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

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

C++ default parameters

impl Send for BRISK