Struct opencv::xfeatures2d::SURF

pub struct SURF { /* private fields */ }

Class for extracting Speeded Up Robust Features from an image Bay06 .

The algorithm parameters:

• member int extended
• 0 means that the basic descriptors (64 elements each) shall be computed
• 1 means that the extended descriptors (128 elements each) shall be computed
• member int upright
• 0 means that detector computes orientation of each feature.
• 1 means that the orientation is not computed (which is much, much faster). For example, if you match images from a stereo pair, or do image stitching, the matched features likely have very similar angles, and you can speed up feature extraction by setting upright=1.
• member double hessianThreshold Threshold for the keypoint detector. Only features, whose hessian is larger than hessianThreshold are retained by the detector. Therefore, the larger the value, the less keypoints you will get. A good default value could be from 300 to 500, depending from the image contrast.
• member int nOctaves The number of a gaussian pyramid octaves that the detector uses. It is set to 4 by default. If you want to get very large features, use the larger value. If you want just small features, decrease it.
• member int nOctaveLayers The number of images within each octave of a gaussian pyramid. It is set to 2 by default.

Note:

• An example using the SURF feature detector can be found at opencv_source_code/samples/cpp/generic_descriptor_match.cpp
• Another example using the SURF feature detector, extractor and matcher can be found at opencv_source_code/samples/cpp/matcher_simple.cpp

Implementations

impl SURF

pub fn create( hessian_threshold: f64, n_octaves: i32, n_octave_layers: i32, extended: bool, upright: bool ) -> Result<Ptr<SURF>>

Parameters

• hessianThreshold: Threshold for hessian keypoint detector used in SURF.
• nOctaves: Number of pyramid octaves the keypoint detector will use.
• nOctaveLayers: Number of octave layers within each octave.
• extended: Extended descriptor flag (true - use extended 128-element descriptors; false - use 64-element descriptors).
• upright: Up-right or rotated features flag (true - do not compute orientation of features; false - compute orientation).

C++ default parameters

• hessian_threshold: 100
• n_octaves: 4
• n_octave_layers: 3
• extended: false
• upright: false

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

Parameters

• hessianThreshold: Threshold for hessian keypoint detector used in SURF.
• nOctaves: Number of pyramid octaves the keypoint detector will use.
• nOctaveLayers: Number of octave layers within each octave.
• extended: Extended descriptor flag (true - use extended 128-element descriptors; false - use 64-element descriptors).
• upright: Up-right or rotated features flag (true - do not compute orientation of features; false - compute orientation).

Note

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

• hessian_threshold: 100
• n_octaves: 4
• n_octave_layers: 3
• extended: false
• upright: false

Trait Implementations

impl AlgorithmTrait for SURF

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 SURF

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 SURF

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for SURF

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

Formats the value using the given formatter.

impl Drop for SURF

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for SURF

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 SURF

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

fn from(s: SURF) -> Self

Converts to this type from the input type.

impl From<SURF> for Feature2D

fn from(s: SURF) -> Self

Converts to this type from the input type.

impl SURFTrait for SURF

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

fn set_hessian_threshold(&mut self, hessian_threshold: f64) -> Result<()>

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

fn set_n_octave_layers(&mut self, n_octave_layers: i32) -> Result<()>

fn set_extended(&mut self, extended: bool) -> Result<()>

fn set_upright(&mut self, upright: bool) -> Result<()>

impl SURFTraitConst for SURF

fn as_raw_SURF(&self) -> *const c_void

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

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

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

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

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

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

impl Send for SURF