Struct opencv::features2d::BRISK
source · pub struct BRISK { /* private fields */ }
Expand description
Class implementing the BRISK keypoint detector and descriptor extractor, described in LCS11 .
Implementations§
source§impl BRISK
impl BRISK
sourcepub fn create_def() -> Result<Ptr<BRISK>>
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
sourcepub 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>>
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
()
sourcepub fn create_with_pattern_def(
radius_list: &Vector<f32>,
number_list: &Vector<i32>
) -> Result<Ptr<BRISK>>
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
()
sourcepub 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>>
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
()
sourcepub fn create_with_pattern_threshold_octaves_def(
thresh: i32,
octaves: i32,
radius_list: &Vector<f32>,
number_list: &Vector<i32>
) -> Result<Ptr<BRISK>>
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§
source§impl AlgorithmTrait for BRISK
impl AlgorithmTrait for BRISK
source§impl AlgorithmTraitConst for BRISK
impl AlgorithmTraitConst for BRISK
fn as_raw_Algorithm(&self) -> *const c_void
source§fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>
fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>
Stores algorithm parameters in a file storage
source§fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>
fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>
Stores algorithm parameters in a file storage Read more
source§fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>
fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>
@deprecated Read more
source§fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>
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: Read more
source§fn empty(&self) -> Result<bool>
fn empty(&self) -> Result<bool>
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
source§fn save(&self, filename: &str) -> Result<()>
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).
source§fn get_default_name(&self) -> Result<String>
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.
source§impl BRISKTrait for BRISK
impl BRISKTrait for BRISK
fn as_raw_mut_BRISK(&mut self) -> *mut c_void
source§impl BRISKTraitConst for BRISK
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>
source§impl Boxed for BRISK
impl Boxed for BRISK
source§unsafe fn from_raw(ptr: <BRISK as OpenCVFromExtern>::ExternReceive) -> Self
unsafe fn from_raw(ptr: <BRISK as OpenCVFromExtern>::ExternReceive) -> Self
Wrap the specified raw pointer Read more
source§fn into_raw(self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut
fn into_raw(self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying raw pointer while consuming this wrapper. Read more
source§fn as_raw(&self) -> <BRISK as OpenCVTypeExternContainer>::ExternSend
fn as_raw(&self) -> <BRISK as OpenCVTypeExternContainer>::ExternSend
Return the underlying raw pointer. Read more
source§fn as_raw_mut(&mut self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut
fn as_raw_mut(&mut self) -> <BRISK as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying mutable raw pointer Read more
source§impl Feature2DTrait for BRISK
impl Feature2DTrait for BRISK
fn as_raw_mut_Feature2D(&mut self) -> *mut c_void
source§fn detect(
&mut self,
image: &impl ToInputArray,
keypoints: &mut Vector<KeyPoint>,
mask: &impl ToInputArray
) -> Result<()>
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). Read more
source§fn detect_def(
&mut self,
image: &impl ToInputArray,
keypoints: &mut Vector<KeyPoint>
) -> Result<()>
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). Read more
source§fn detect_multiple(
&mut self,
images: &impl ToInputArray,
keypoints: &mut Vector<Vector<KeyPoint>>,
masks: &impl ToInputArray
) -> Result<()>
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). Read more
source§fn detect_multiple_def(
&mut self,
images: &impl ToInputArray,
keypoints: &mut Vector<Vector<KeyPoint>>
) -> Result<()>
fn detect_multiple_def( &mut self, images: &impl ToInputArray, keypoints: &mut Vector<Vector<KeyPoint>> ) -> Result<()>
@overload Read more
source§fn compute(
&mut self,
image: &impl ToInputArray,
keypoints: &mut Vector<KeyPoint>,
descriptors: &mut impl ToOutputArray
) -> Result<()>
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). Read more
source§fn compute_multiple(
&mut self,
images: &impl ToInputArray,
keypoints: &mut Vector<Vector<KeyPoint>>,
descriptors: &mut impl ToOutputArray
) -> Result<()>
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). Read more
source§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<()>
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 Read more
source§fn detect_and_compute_def(
&mut self,
image: &impl ToInputArray,
mask: &impl ToInputArray,
keypoints: &mut Vector<KeyPoint>,
descriptors: &mut impl ToOutputArray
) -> Result<()>
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 Read more
fn read(&mut self, file_name: &str) -> Result<()>
fn read_from_node(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>
source§impl Feature2DTraitConst for BRISK
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 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 Send for BRISK
Auto Trait Implementations§
impl Freeze for BRISK
impl RefUnwindSafe for BRISK
impl !Sync for BRISK
impl Unpin for BRISK
impl UnwindSafe for BRISK
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
source§unsafe fn modify_inplace<Res>(
&mut self,
f: impl FnOnce(&Mat, &mut Mat) -> Res
) -> Res
unsafe fn modify_inplace<Res>( &mut self, f: impl FnOnce(&Mat, &mut Mat) -> Res ) -> Res
Helper function to call OpenCV functions that allow in-place modification of a
Mat
or another similar object. By passing
a mutable reference to the Mat
to this function your closure will get called with the read reference and a write references
to the same Mat
. This is of course unsafe as it breaks the Rust aliasing rules, but it might be useful for some performance
sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold
. Read more