Struct opencv::xfeatures2d::SIFT

pub struct SIFT { /* fields omitted */ }

Class for extracting keypoints and computing descriptors using the Scale Invariant Feature Transform (SIFT) algorithm by D. Lowe Lowe04 .

Methods

impl SIFT

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

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

impl SIFT

pub fn create(
    nfeatures: i32,
    n_octave_layers: i32,
    contrast_threshold: f64,
    edge_threshold: f64,
    sigma: f64
) -> Result<PtrOfSIFT>

Parameters

• nfeatures: The number of best features to retain. The features are ranked by their scores (measured in SIFT algorithm as the local contrast)

• nOctaveLayers: The number of layers in each octave. 3 is the value used in D. Lowe paper. The number of octaves is computed automatically from the image resolution.

• contrastThreshold: The contrast threshold used to filter out weak features in semi-uniform (low-contrast) regions. The larger the threshold, the less features are produced by the detector.

• edgeThreshold: The threshold used to filter out edge-like features. Note that the its meaning is different from the contrastThreshold, i.e. the larger the edgeThreshold, the less features are filtered out (more features are retained).

• sigma: The sigma of the Gaussian applied to the input image at the octave #0. If your image is captured with a weak camera with soft lenses, you might want to reduce the number.

C++ default parameters

• nfeatures: 0
• n_octave_layers: 3
• contrast_threshold: 0.04
• edge_threshold: 10
• sigma: 1.6

Trait Implementations

impl AlgorithmTrait for SIFT

fn as_raw_Algorithm(&self) -> *mut c_void

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

Clears the algorithm state

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

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &PtrOfFileStorage, name: &str) -> Result<()>

simplified API for language bindings Stores algorithm parameters in a file storage

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

Reads algorithm parameters from a file storage

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 Drop for SIFT

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for SIFT

fn as_raw_Feature2D(&self) -> *mut c_void

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

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

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

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

fn compute(
    &mut self,
    image: &dyn ToInputArray,
    keypoints: &mut VectorOfKeyPoint,
    descriptors: &mut dyn 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: &dyn ToInputArray,
    keypoints: &mut VectorOfVectorOfKeyPoint,
    descriptors: &mut dyn 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: &dyn ToInputArray,
    mask: &dyn ToInputArray,
    keypoints: &mut VectorOfKeyPoint,
    descriptors: &mut dyn ToOutputArray,
    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 write_1(&self, unnamed: &mut FileStorage) -> Result<()>

fn read_1(&mut self, unnamed: &FileNode) -> Result<()>

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

Return true if detector object is empty

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

fn write_2(&self, fs: &PtrOfFileStorage, name: &str) -> Result<()>

C++ default parameters * name: String()

impl SIFTTrait for SIFT

fn as_raw_SIFT(&self) -> *mut c_void

impl Send for SIFT