Struct FREAK

pub struct FREAK { /* private fields */ }

Class implementing the FREAK (Fast Retina Keypoint) keypoint descriptor, described in AOV12 .

The algorithm propose a novel keypoint descriptor inspired by the human visual system and more precisely the retina, coined Fast Retina Key- point (FREAK). A cascade of binary strings is computed by efficiently comparing image intensities over a retinal sampling pattern. FREAKs are in general faster to compute with lower memory load and also more robust than SIFT, SURF or BRISK. They are competitive alternatives to existing keypoints in particular for embedded applications.

Note:

• An example on how to use the FREAK descriptor can be found at opencv_source_code/samples/cpp/freak_demo.cpp

Implementations

impl FREAK

pub const NB_SCALES: i32 = 64i32

pub const NB_PAIRS: i32 = 512i32

pub const NB_ORIENPAIRS: i32 = 45i32

pub fn create( orientation_normalized: bool, scale_normalized: bool, pattern_scale: f32, n_octaves: i32, selected_pairs: &Vector<i32>, ) -> Result<Ptr<FREAK>>

Parameters

• orientationNormalized: Enable orientation normalization.
• scaleNormalized: Enable scale normalization.
• patternScale: Scaling of the description pattern.
• nOctaves: Number of octaves covered by the detected keypoints.
• selectedPairs: (Optional) user defined selected pairs indexes,

C++ default parameters

• orientation_normalized: true
• scale_normalized: true
• pattern_scale: 22.0f
• n_octaves: 4
• selected_pairs: std::vector()

pub fn create_def() -> Result<Ptr<FREAK>>

Parameters

• orientationNormalized: Enable orientation normalization.
• scaleNormalized: Enable scale normalization.
• patternScale: Scaling of the description pattern.
• nOctaves: Number of octaves covered by the detected keypoints.
• selectedPairs: (Optional) user defined selected pairs indexes,

Note

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

• orientation_normalized: true
• scale_normalized: true
• pattern_scale: 22.0f
• n_octaves: 4
• selected_pairs: std::vector()

Trait Implementations

impl AlgorithmTrait for FREAK

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 FREAK

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 Boxed for FREAK

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for FREAK

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

Formats the value using the given formatter.

impl Drop for FREAK

fn drop(&mut self)

Executes the destructor for this type.

impl FREAKTrait for FREAK

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

fn set_orientation_normalized( &mut self, orientation_normalized: bool, ) -> Result<()>

fn set_scale_normalized(&mut self, scale_normalized: bool) -> Result<()>

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

fn set_n_octaves(&mut self, n_octaves: i32) -> Result<()>

impl FREAKTraitConst for FREAK

fn as_raw_FREAK(&self) -> *const c_void

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

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

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

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

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

impl Feature2DTrait for FREAK

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 FREAK

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<FREAK> for Algorithm

fn from(s: FREAK) -> Self

Converts to this type from the input type.

impl From<FREAK> for Feature2D

fn from(s: FREAK) -> Self

Converts to this type from the input type.

impl Send for FREAK