Struct opencv::xfeatures2d::TBMR
source · pub struct TBMR { /* private fields */ }
Expand description
Class implementing the Tree Based Morse Regions (TBMR) as described in Najman2014 extended with scaled extraction ability.
§Parameters
- min_area: prune areas smaller than minArea
- max_area_relative: prune areas bigger than maxArea = max_area_relative * input_image_size
- scale_factor: scale factor for scaled extraction.
- n_scales: number of applications of the scale factor (octaves).
Note: This algorithm is based on Component Tree (Min/Max) as well as MSER but uses a Morse-theory approach to extract features.
Features are ellipses (similar to MSER, however a MSER feature can never be a TBMR feature and vice versa).
Implementations§
source§impl TBMR
impl TBMR
sourcepub fn create(
min_area: i32,
max_area_relative: f32,
scale_factor: f32,
n_scales: i32
) -> Result<Ptr<TBMR>>
pub fn create( min_area: i32, max_area_relative: f32, scale_factor: f32, n_scales: i32 ) -> Result<Ptr<TBMR>>
§C++ default parameters
- min_area: 60
- max_area_relative: 0.01f
- scale_factor: 1.25f
- n_scales: -1
sourcepub fn create_def() -> Result<Ptr<TBMR>>
pub fn create_def() -> Result<Ptr<TBMR>>
§Note
This alternative version of TBMR::create function uses the following default values for its arguments:
- min_area: 60
- max_area_relative: 0.01f
- scale_factor: 1.25f
- n_scales: -1
Trait Implementations§
source§impl AffineFeature2DTrait for TBMR
impl AffineFeature2DTrait for TBMR
fn as_raw_mut_AffineFeature2D(&mut self) -> *mut c_void
source§fn detect(
&mut self,
image: &impl ToInputArray,
keypoints: &mut Vector<Elliptic_KeyPoint>,
mask: &impl ToInputArray
) -> Result<()>
fn detect( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<Elliptic_KeyPoint>, mask: &impl ToInputArray ) -> Result<()>
Detects keypoints in the image using the wrapped detector and
performs affine adaptation to augment them with their elliptic regions. Read more
source§fn detect_def(
&mut self,
image: &impl ToInputArray,
keypoints: &mut Vector<Elliptic_KeyPoint>
) -> Result<()>
fn detect_def( &mut self, image: &impl ToInputArray, keypoints: &mut Vector<Elliptic_KeyPoint> ) -> Result<()>
Detects keypoints in the image using the wrapped detector and
performs affine adaptation to augment them with their elliptic regions. Read more
source§fn detect_and_compute(
&mut self,
image: &impl ToInputArray,
mask: &impl ToInputArray,
keypoints: &mut Vector<Elliptic_KeyPoint>,
descriptors: &mut impl ToOutputArray,
use_provided_keypoints: bool
) -> Result<()>
fn detect_and_compute( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, keypoints: &mut Vector<Elliptic_KeyPoint>, descriptors: &mut impl ToOutputArray, use_provided_keypoints: bool ) -> Result<()>
Detects keypoints and computes descriptors for their surrounding
regions, after warping them into circles. Read more
source§fn detect_and_compute_def(
&mut self,
image: &impl ToInputArray,
mask: &impl ToInputArray,
keypoints: &mut Vector<Elliptic_KeyPoint>,
descriptors: &mut impl ToOutputArray
) -> Result<()>
fn detect_and_compute_def( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, keypoints: &mut Vector<Elliptic_KeyPoint>, descriptors: &mut impl ToOutputArray ) -> Result<()>
Detects keypoints and computes descriptors for their surrounding
regions, after warping them into circles. Read more
source§impl AffineFeature2DTraitConst for TBMR
impl AffineFeature2DTraitConst for TBMR
fn as_raw_AffineFeature2D(&self) -> *const c_void
source§impl AlgorithmTrait for TBMR
impl AlgorithmTrait for TBMR
source§impl AlgorithmTraitConst for TBMR
impl AlgorithmTraitConst for TBMR
fn as_raw_Algorithm(&self) -> *const c_void
source§fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>
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<()>
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<()>
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<()>
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>
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<()>
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>
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 TBMR
impl Boxed for TBMR
source§unsafe fn from_raw(ptr: <TBMR as OpenCVFromExtern>::ExternReceive) -> Self
unsafe fn from_raw(ptr: <TBMR as OpenCVFromExtern>::ExternReceive) -> Self
Wrap the specified raw pointer Read more
source§fn into_raw(self) -> <TBMR as OpenCVTypeExternContainer>::ExternSendMut
fn into_raw(self) -> <TBMR as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying raw pointer while consuming this wrapper. Read more
source§fn as_raw(&self) -> <TBMR as OpenCVTypeExternContainer>::ExternSend
fn as_raw(&self) -> <TBMR as OpenCVTypeExternContainer>::ExternSend
Return the underlying raw pointer. Read more
source§fn as_raw_mut(&mut self) -> <TBMR as OpenCVTypeExternContainer>::ExternSendMut
fn as_raw_mut(&mut self) -> <TBMR as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying mutable raw pointer Read more
source§impl Feature2DTrait for TBMR
impl Feature2DTrait for TBMR
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<()>
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<()>
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<()>
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<()>
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<()>
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<()>
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<()>
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<()>
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
fn read(&mut self, file_name: &str) -> Result<()>
fn read_from_node(&mut self, unnamed: &impl FileNodeTraitConst) -> Result<()>
source§impl Feature2DTraitConst for TBMR
impl Feature2DTraitConst for TBMR
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 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<()>
source§impl From<TBMR> for AffineFeature2D
impl From<TBMR> for AffineFeature2D
source§impl TBMRTrait for TBMR
impl TBMRTrait for TBMR
fn as_raw_mut_TBMR(&mut self) -> *mut c_void
fn set_min_area(&mut self, min_area: i32) -> Result<()>
fn set_max_area_relative(&mut self, max_area: f32) -> Result<()>
fn set_scale_factor(&mut self, scale_factor: f32) -> Result<()>
fn set_n_scales(&mut self, n_scales: i32) -> Result<()>
source§impl TBMRTraitConst for TBMR
impl TBMRTraitConst for TBMR
fn as_raw_TBMR(&self) -> *const c_void
fn get_min_area(&self) -> Result<i32>
fn get_max_area_relative(&self) -> Result<f32>
fn get_scale_factor(&self) -> Result<f32>
fn get_n_scales(&self) -> Result<i32>
source§impl TryFrom<AffineFeature2D> for TBMR
impl TryFrom<AffineFeature2D> for TBMR
impl Send for TBMR
Auto Trait Implementations§
impl Freeze for TBMR
impl RefUnwindSafe for TBMR
impl !Sync for TBMR
impl Unpin for TBMR
impl UnwindSafe for TBMR
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
source§unsafe fn modify_inplace<Res>(
&mut self,
f: impl FnOnce(&Mat, &mut Mat) -> Res
) -> Res
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 of course unsafe as it breaks the Rust aliasing rules, but it might be useful for some performance
sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold
. Read more