VGG

Struct VGG 

Source
pub struct VGG { /* private fields */ }
Expand description

Class implementing VGG (Oxford Visual Geometry Group) descriptor trained end to end using “Descriptor Learning Using Convex Optimisation” (DLCO) aparatus described in Simonyan14.

§Parameters

  • desc: type of descriptor to use, VGG::VGG_120 is default (120 dimensions float) Available types are VGG::VGG_120, VGG::VGG_80, VGG::VGG_64, VGG::VGG_48

  • isigma: gaussian kernel value for image blur (default is 1.4f)

  • img_normalize: use image sample intensity normalization (enabled by default)

  • use_orientation: sample patterns using keypoints orientation, enabled by default

  • scale_factor: adjust the sampling window of detected keypoints to 64.0f (VGG sampling window) 6.25f is default and fits for KAZE, SURF detected keypoints window ratio 6.75f should be the scale for SIFT detected keypoints window ratio 5.00f should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints window ratio 0.75f should be the scale for ORB keypoints ratio

  • dsc_normalize: clamp descriptors to 255 and convert to uchar CV_8UC1 (disabled by default)

Implementations§

Source§

impl VGG

Source

pub fn create( desc: i32, isigma: f32, img_normalize: bool, use_scale_orientation: bool, scale_factor: f32, dsc_normalize: bool, ) -> Result<Ptr<VGG>>

§C++ default parameters
  • desc: VGG::VGG_120
  • isigma: 1.4f
  • img_normalize: true
  • use_scale_orientation: true
  • scale_factor: 6.25f
  • dsc_normalize: false
Source

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

§Note

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

  • desc: VGG::VGG_120
  • isigma: 1.4f
  • img_normalize: true
  • use_scale_orientation: true
  • scale_factor: 6.25f
  • dsc_normalize: false

Trait Implementations§

Source§

impl AlgorithmTrait for VGG

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 VGG

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 VGG

Source§

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

Wrap the specified raw pointer Read more
Source§

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

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

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

Return the underlying raw pointer. Read more
Source§

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

Return the underlying mutable raw pointer Read more
Source§

impl Debug for VGG

Source§

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

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

impl Drop for VGG

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Feature2DTrait for VGG

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

Detects keypoints in an image (first variant) or image set (second variant). 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 VGG

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

Source§

fn from(s: VGG) -> Self

Converts to this type from the input type.
Source§

impl From<VGG> for Feature2D

Source§

fn from(s: VGG) -> Self

Converts to this type from the input type.
Source§

impl VGGTrait for VGG

Source§

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

Source§

fn set_sigma(&mut self, isigma: f32) -> Result<()>

Source§

fn set_use_normalize_image(&mut self, img_normalize: bool) -> Result<()>

Source§

fn set_use_scale_orientation( &mut self, use_scale_orientation: bool, ) -> Result<()>

Source§

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

Source§

fn set_use_normalize_descriptor(&mut self, dsc_normalize: bool) -> Result<()>

Source§

impl VGGTraitConst for VGG

Source§

impl Send for VGG

Auto Trait Implementations§

§

impl Freeze for VGG

§

impl RefUnwindSafe for VGG

§

impl !Sync for VGG

§

impl Unpin for VGG

§

impl UnwindSafe for VGG

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.