Struct BRISK

pub struct BRISK { /* private fields */ }

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

Implementations

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

Note

This alternative version of BRISK::create function uses the following default values for its arguments:

• 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_def( radius_list: &Vector<f32>, number_list: &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.

Note

This alternative version of BRISK::create_with_pattern function uses the following default values for its arguments:

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

pub fn create_with_pattern_threshold_octaves_def( thresh: i32, octaves: i32, radius_list: &Vector<f32>, number_list: &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.

Note

This alternative version of BRISK::create_with_pattern_threshold_octaves function uses the following default values for its arguments:

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

Trait Implementations

impl AlgorithmTrait for BRISK

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

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

Clears the algorithm state

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

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for BRISK

fn as_raw_Algorithm(&self) -> *const c_void

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

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

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

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

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

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

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

Set detection threshold.

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

Set detection octaves.

fn set_pattern_scale(&mut self, pattern_scale: f32) -> Result<()>

Set detection patternScale.

impl BRISKTraitConst for BRISK

fn as_raw_BRISK(&self) -> *const c_void

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

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

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

fn get_pattern_scale(&self) -> Result<f32>

impl Boxed for BRISK

unsafe fn from_raw(ptr: <BRISK as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <BRISK as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for BRISK

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for BRISK

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for BRISK

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

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

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

fn detect_def( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, ) -> Result<()>

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

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

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

fn detect_multiple_def( &mut self, images: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>>, ) -> Result<()>

@overload

fn compute( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, descriptors: &mut impl ToOutputArray, ) -> 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: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

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

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

Detects keypoints and computes the descriptors

fn detect_and_compute_def( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, keypoints: &mut Vector<KeyPoint>, descriptors: &mut impl ToOutputArray, ) -> Result<()>

Detects keypoints and computes the descriptors

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

fn read_from_node(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>

impl Feature2DTraitConst for BRISK

fn as_raw_Feature2D(&self) -> *const c_void

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 write_to_storage(&self, unnamed: &mut impl FileStorageTrait) -> Result<()>

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

Return true if detector object is empty

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

fn write_to_storage_with_name( &self, fs: &mut impl FileStorageTrait, name: &str, ) -> Result<()>

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

impl From<BRISK> for Algorithm

fn from(s: BRISK) -> Self

Converts to this type from the input type.

impl From<BRISK> for Feature2D

fn from(s: BRISK) -> Self

Converts to this type from the input type.

impl TryFrom<Feature2D> for BRISK

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Feature2D) -> Result<Self>

Performs the conversion.

impl Send for BRISK