Struct opencv::features2d::BRISK

pub struct BRISK { /* fields omitted */ }

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

Methods

impl BRISK

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

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

impl BRISK

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

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: &VectorOffloat,
    number_list: &VectorOfint,
    d_max: f32,
    d_min: f32,
    index_change: &VectorOfint
) -> Result<PtrOfBRISK>

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: &VectorOffloat,
    number_list: &VectorOfint,
    d_max: f32,
    d_min: f32,
    index_change: &VectorOfint
) -> Result<PtrOfBRISK>

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

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

Trait Implementations

impl Algorithm for BRISK

fn as_raw_Algorithm(&self) -> *mut c_void

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

Clears the algorithm state

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 Feature2D for BRISK

fn as_raw_Feature2D(&self) -> *mut c_void

fn detect(
    &mut self,
    image: &Mat,
    keypoints: &mut VectorOfKeyPoint,
    mask: &Mat
) -> Result<()>

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

fn detect_multiple(
    &mut self,
    images: &VectorOfMat,
    keypoints: &mut VectorOfVectorOfKeyPoint,
    masks: &VectorOfMat
) -> Result<()>

Parameters * images: Image set. * keypoints: The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] . * masks: Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

fn compute(
    &mut self,
    image: &Mat,
    keypoints: &mut VectorOfKeyPoint,
    descriptors: &mut Mat
) -> Result<()>

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

fn compute_multiple(
    &mut self,
    images: &VectorOfMat,
    keypoints: &mut VectorOfVectorOfKeyPoint,
    descriptors: &mut VectorOfMat
) -> Result<()>

Parameters * images: Image set. * keypoints: Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation). * descriptors: Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

fn detect_and_compute(
    &mut self,
    image: &Mat,
    mask: &Mat,
    keypoints: &mut VectorOfKeyPoint,
    descriptors: &mut Mat,
    use_provided_keypoints: bool
) -> Result<()>

Detects keypoints and computes the descriptors

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

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

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

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

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

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

Return true if detector object is empty

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

impl Send for BRISK

impl Drop for BRISK

fn drop(&mut self)

Executes the destructor for this type.