opencv::xfeatures2d

Struct LATCH

source
pub struct LATCH { /* private fields */ }
Expand description

latch Class for computing the LATCH descriptor. If you find this code useful, please add a reference to the following paper in your work: Gil Levi and Tal Hassner, “LATCH: Learned Arrangements of Three Patch Codes”, arXiv preprint arXiv:1501.03719, 15 Jan. 2015

LATCH is a binary descriptor based on learned comparisons of triplets of image patches.

  • bytes is the size of the descriptor - can be 64, 32, 16, 8, 4, 2 or 1
  • rotationInvariance - whether or not the descriptor should compansate for orientation changes.
  • half_ssd_size - the size of half of the mini-patches size. For example, if we would like to compare triplets of patches of size 7x7x then the half_ssd_size should be (7-1)/2 = 3.
  • sigma - sigma value for GaussianBlur smoothing of the source image. Source image will be used without smoothing in case sigma value is 0.

Note: the descriptor can be coupled with any keypoint extractor. The only demand is that if you use set rotationInvariance = True then you will have to use an extractor which estimates the patch orientation (in degrees). Examples for such extractors are ORB and SIFT.

Note: a complete example can be found under /samples/cpp/tutorial_code/xfeatures2D/latch_match.cpp

Implementations§

source§

impl LATCH

source

pub fn create( bytes: i32, rotation_invariance: bool, half_ssd_size: i32, sigma: f64, ) -> Result<Ptr<LATCH>>

§C++ default parameters
  • bytes: 32
  • rotation_invariance: true
  • half_ssd_size: 3
  • sigma: 2.0
source

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

§Note

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

  • bytes: 32
  • rotation_invariance: true
  • half_ssd_size: 3
  • sigma: 2.0

Trait Implementations§

source§

impl AlgorithmTrait for LATCH

source§

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

source§

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

Clears the algorithm state
source§

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

Reads algorithm parameters from a file storage
source§

impl AlgorithmTraitConst for LATCH

source§

fn as_raw_Algorithm(&self) -> *const c_void

source§

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<()>

Stores algorithm parameters in a file storage Read more
source§

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<()>

👎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>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
source§

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>

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

source§

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

Wrap the specified raw pointer Read more
source§

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

Return the underlying raw pointer while consuming this wrapper. Read more
source§

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

Return the underlying raw pointer. Read more
source§

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

Return the underlying mutable raw pointer Read more
source§

impl Debug for LATCH

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for LATCH

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Feature2DTrait for LATCH

source§

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<()>

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<()>

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<()>

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<()>

@overload Read more
source§

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<()>

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<()>

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<()>

Detects keypoints and computes the descriptors Read more
source§

fn read(&mut self, file_name: &str) -> Result<()>

source§

fn read_from_node(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>

source§

impl Feature2DTraitConst for LATCH

source§

fn as_raw_Feature2D(&self) -> *const c_void

source§

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

source§

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

source§

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

source§

fn write(&self, file_name: &str) -> Result<()>

source§

fn write_to_storage(&self, unnamed: &mut impl FileStorageTrait) -> Result<()>

source§

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

Return true if detector object is empty
source§

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

source§

fn write_to_storage_with_name( &self, fs: &mut impl FileStorageTrait, name: &str, ) -> Result<()>

source§

fn write_to_storage_ptr_with_name( &self, fs: &Ptr<FileStorage>, name: &str, ) -> Result<()>

source§

impl From<LATCH> for Algorithm

source§

fn from(s: LATCH) -> Self

Converts to this type from the input type.
source§

impl From<LATCH> for Feature2D

source§

fn from(s: LATCH) -> Self

Converts to this type from the input type.
source§

impl LATCHTrait for LATCH

source§

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

source§

fn set_bytes(&mut self, bytes: i32) -> Result<()>

source§

fn set_rotation_invariance(&mut self, rotation_invariance: bool) -> Result<()>

source§

fn set_half_ss_dsize(&mut self, half_ssd_size: i32) -> Result<()>

source§

fn set_sigma(&mut self, sigma: f64) -> Result<()>

source§

impl LATCHTraitConst for LATCH

source§

impl Send for LATCH

Auto Trait Implementations§

§

impl Freeze for LATCH

§

impl RefUnwindSafe for LATCH

§

impl !Sync for LATCH

§

impl Unpin for LATCH

§

impl UnwindSafe for LATCH

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Mat> ModifyInplace for Mat
where Mat: Boxed,

source§

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 unsafe in a general case as it leads to having non-exclusive mutable access to the internal data, but it can be useful for some performance sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.