Struct opencv::xfeatures2d::BEBLID

pub struct BEBLID { /* private fields */ }

Class implementing BEBLID (Boosted Efficient Binary Local Image Descriptor), described in Suarez2020BEBLID .

BEBLID \cite Suarez2020BEBLID is a efficient binary descriptor learned with boosting. It is able to describe keypoints from any detector just by changing the scale_factor parameter. In several benchmarks it has proved to largely improve other binary descriptors like ORB or BRISK with the same efficiency. BEBLID describes using the difference of mean gray values in different regions of the image around the KeyPoint, the descriptor is specifically optimized for image matching and patch retrieval addressing the asymmetries of these problems.

If you find this code useful, please add a reference to the following paper:

Iago Suárez, Ghesn Sfeir, José M. Buenaposada, and Luis Baumela. BEBLID: Boosted efficient binary local image descriptor. Pattern Recognition Letters, 133:366–372, 2020.

The descriptor was trained using 1 million of randomly sampled pairs of patches (20% positives and 80% negatives) from the Liberty split of the UBC datasets \cite winder2007learning as described in the paper Suarez2020BEBLID. You can check in the AKAZE example how well BEBLID works. Detecting 10000 keypoints with ORB and describing with BEBLID obtains 561 inliers (75%) whereas describing with ORB obtains only 493 inliers (63%).

Implementations

impl BEBLID

pub fn create(scale_factor: f32, n_bits: i32) -> Result<Ptr<BEBLID>>

Creates the BEBLID descriptor.

Parameters

• scale_factor: Adjust the sampling window around detected keypoints:

• 1.00f should be the scale for ORB keypoints
• 6.75f should be the scale for SIFT detected keypoints
• 6.25f is default and fits for KAZE, SURF detected keypoints
• 5.00f should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints

• n_bits: Determine the number of bits in the descriptor. Should be either BEBLID::SIZE_512_BITS or BEBLID::SIZE_256_BITS.

C++ default parameters

• n_bits: BEBLID::SIZE_512_BITS

pub fn create_def(scale_factor: f32) -> Result<Ptr<BEBLID>>

Creates the BEBLID descriptor.

Parameters

• scale_factor: Adjust the sampling window around detected keypoints:

• 1.00f should be the scale for ORB keypoints
• 6.75f should be the scale for SIFT detected keypoints
• 6.25f is default and fits for KAZE, SURF detected keypoints
• 5.00f should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints

• n_bits: Determine the number of bits in the descriptor. Should be either BEBLID::SIZE_512_BITS or BEBLID::SIZE_256_BITS.

Note

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

• n_bits: BEBLID::SIZE_512_BITS

Trait Implementations

impl AlgorithmTrait for BEBLID

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 BEBLID

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 BEBLIDTrait for BEBLID

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

fn set_scale_factor(&mut self, scale_factor: f32) -> Result<()>

impl BEBLIDTraitConst for BEBLID

fn as_raw_BEBLID(&self) -> *const c_void

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

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

impl Boxed for BEBLID

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for BEBLID

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

Formats the value using the given formatter.

impl Drop for BEBLID

fn drop(&mut self)

Executes the destructor for this type.

impl Feature2DTrait for BEBLID

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 BEBLID

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

fn from(s: BEBLID) -> Self

Converts to this type from the input type.

impl From<BEBLID> for Feature2D

fn from(s: BEBLID) -> Self

Converts to this type from the input type.

impl Send for BEBLID