Struct opencv::line_descriptor::BinaryDescriptor
source · pub struct BinaryDescriptor { /* private fields */ }
Expand description
Class implements both functionalities for detection of lines and computation of their binary descriptor.
Class’ interface is mainly based on the ones of classical detectors and extractors, such as Feature2d’s [features2d_main] and [features2d_match]. Retrieved information about lines is stored in line_descriptor::KeyLine objects.
Implementations§
source§impl BinaryDescriptor
impl BinaryDescriptor
sourcepub fn new(parameters: &BinaryDescriptor_Params) -> Result<BinaryDescriptor>
pub fn new(parameters: &BinaryDescriptor_Params) -> Result<BinaryDescriptor>
Constructor
Parameters
- parameters: configuration parameters BinaryDescriptor::Params
If no argument is provided, constructor sets default values (see comments in the code snippet in previous section). Default values are strongly recommended.
C++ default parameters
- parameters: BinaryDescriptor::Params()
sourcepub fn create_binary_descriptor() -> Result<Ptr<BinaryDescriptor>>
pub fn create_binary_descriptor() -> Result<Ptr<BinaryDescriptor>>
Create a BinaryDescriptor object with default parameters (or with the ones provided) and return a smart pointer to it
pub fn create_binary_descriptor_1( parameters: BinaryDescriptor_Params ) -> Result<Ptr<BinaryDescriptor>>
Trait Implementations§
source§impl AlgorithmTrait for BinaryDescriptor
impl AlgorithmTrait for BinaryDescriptor
source§impl AlgorithmTraitConst for BinaryDescriptor
impl AlgorithmTraitConst for BinaryDescriptor
fn as_raw_Algorithm(&self) -> *const c_void
source§fn write(&self, fs: &mut FileStorage) -> Result<()>
fn write(&self, fs: &mut FileStorage) -> Result<()>
Stores algorithm parameters in a file storage
source§fn write_1(&self, fs: &mut FileStorage, name: &str) -> Result<()>
fn write_1(&self, fs: &mut FileStorage, 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 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 BinaryDescriptorTrait for BinaryDescriptor
impl BinaryDescriptorTrait for BinaryDescriptor
fn as_raw_mut_BinaryDescriptor(&mut self) -> *mut c_void
source§fn get_num_of_octaves(&mut self) -> Result<i32>
fn get_num_of_octaves(&mut self) -> Result<i32>
Get current number of octaves
source§fn get_width_of_band(&mut self) -> Result<i32>
fn get_width_of_band(&mut self) -> Result<i32>
Get current width of bands
source§fn get_reduction_ratio(&mut self) -> Result<i32>
fn get_reduction_ratio(&mut self) -> Result<i32>
Get current reduction ratio (used in Gaussian pyramids)
source§fn set_reduction_ratio(&mut self, r_ratio: i32) -> Result<()>
fn set_reduction_ratio(&mut self, r_ratio: i32) -> Result<()>
Set reduction ratio (used in Gaussian pyramids) Read more
source§impl BinaryDescriptorTraitConst for BinaryDescriptor
impl BinaryDescriptorTraitConst for BinaryDescriptor
fn as_raw_BinaryDescriptor(&self) -> *const c_void
source§fn write(&self, fs: &mut FileStorage) -> Result<()>
fn write(&self, fs: &mut FileStorage) -> Result<()>
Store parameters to a FileStorage object Read more
source§fn detect(
&self,
images: &Vector<Mat>,
keylines: &mut Vector<Vector<KeyLine>>,
masks: &Vector<Mat>
) -> Result<()>
fn detect( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, masks: &Vector<Mat> ) -> Result<()>
Requires line detection Read more
source§fn compute(
&self,
image: &Mat,
keylines: &mut Vector<KeyLine>,
descriptors: &mut Mat,
return_float_descr: bool
) -> Result<()>
fn compute( &self, image: &Mat, keylines: &mut Vector<KeyLine>, descriptors: &mut Mat, return_float_descr: bool ) -> Result<()>
Requires descriptors computation Read more
source§fn compute_1(
&self,
images: &Vector<Mat>,
keylines: &mut Vector<Vector<KeyLine>>,
descriptors: &mut Vector<Mat>,
return_float_descr: bool
) -> Result<()>
fn compute_1( &self, images: &Vector<Mat>, keylines: &mut Vector<Vector<KeyLine>>, descriptors: &mut Vector<Mat>, return_float_descr: bool ) -> Result<()>
Requires descriptors computation Read more
source§fn descriptor_size(&self) -> Result<i32>
fn descriptor_size(&self) -> Result<i32>
Return descriptor size
source§fn descriptor_type(&self) -> Result<i32>
fn descriptor_type(&self) -> Result<i32>
Return data type
source§fn default_norm(&self) -> Result<i32>
fn default_norm(&self) -> Result<i32>
returns norm mode
source§fn apply(
&self,
image: &dyn ToInputArray,
mask: &dyn ToInputArray,
keylines: &mut Vector<KeyLine>,
descriptors: &mut dyn ToOutputArray,
use_provided_key_lines: bool,
return_float_descr: bool
) -> Result<()>
fn apply( &self, image: &dyn ToInputArray, mask: &dyn ToInputArray, keylines: &mut Vector<KeyLine>, descriptors: &mut dyn ToOutputArray, use_provided_key_lines: bool, return_float_descr: bool ) -> Result<()>
Define operator ‘()’ to perform detection of KeyLines and computation of descriptors in a row. Read more
source§impl Boxed for BinaryDescriptor
impl Boxed for BinaryDescriptor
source§impl Drop for BinaryDescriptor
impl Drop for BinaryDescriptor
source§impl From<BinaryDescriptor> for Algorithm
impl From<BinaryDescriptor> for Algorithm
source§fn from(s: BinaryDescriptor) -> Self
fn from(s: BinaryDescriptor) -> Self
Converts to this type from the input type.
impl Send for BinaryDescriptor
Auto Trait Implementations§
impl RefUnwindSafe for BinaryDescriptor
impl !Sync for BinaryDescriptor
impl Unpin for BinaryDescriptor
impl UnwindSafe for BinaryDescriptor
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