Struct opencv::face::LBPHFaceRecognizer
source · pub struct LBPHFaceRecognizer { /* private fields */ }
Implementations§
source§impl LBPHFaceRecognizer
impl LBPHFaceRecognizer
sourcepub fn create(
radius: i32,
neighbors: i32,
grid_x: i32,
grid_y: i32,
threshold: f64
) -> Result<Ptr<LBPHFaceRecognizer>>
pub fn create( radius: i32, neighbors: i32, grid_x: i32, grid_y: i32, threshold: f64 ) -> Result<Ptr<LBPHFaceRecognizer>>
§Parameters
- radius: The radius used for building the Circular Local Binary Pattern. The greater the radius, the smoother the image but more spatial information you can get.
- neighbors: The number of sample points to build a Circular Local Binary Pattern from. An
appropriate value is to use
8
sample points. Keep in mind: the more sample points you include, the higher the computational cost. - grid_x: The number of cells in the horizontal direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.
- grid_y: The number of cells in the vertical direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.
- threshold: The threshold applied in the prediction. If the distance to the nearest neighbor is larger than the threshold, this method returns -1.
§Notes:
- The Circular Local Binary Patterns (used in training and prediction) expect the data given as grayscale images, use cvtColor to convert between the color spaces.
- This model supports updating.
§Model internal data:
- radius see LBPHFaceRecognizer::create.
- neighbors see LBPHFaceRecognizer::create.
- grid_x see LLBPHFaceRecognizer::create.
- grid_y see LBPHFaceRecognizer::create.
- threshold see LBPHFaceRecognizer::create.
- histograms Local Binary Patterns Histograms calculated from the given training data (empty if none was given).
- labels Labels corresponding to the calculated Local Binary Patterns Histograms.
§C++ default parameters
- radius: 1
- neighbors: 8
- grid_x: 8
- grid_y: 8
- threshold: DBL_MAX
sourcepub fn create_def() -> Result<Ptr<LBPHFaceRecognizer>>
pub fn create_def() -> Result<Ptr<LBPHFaceRecognizer>>
§Parameters
- radius: The radius used for building the Circular Local Binary Pattern. The greater the radius, the smoother the image but more spatial information you can get.
- neighbors: The number of sample points to build a Circular Local Binary Pattern from. An
appropriate value is to use
8
sample points. Keep in mind: the more sample points you include, the higher the computational cost. - grid_x: The number of cells in the horizontal direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.
- grid_y: The number of cells in the vertical direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.
- threshold: The threshold applied in the prediction. If the distance to the nearest neighbor is larger than the threshold, this method returns -1.
§Notes:
- The Circular Local Binary Patterns (used in training and prediction) expect the data given as grayscale images, use cvtColor to convert between the color spaces.
- This model supports updating.
§Model internal data:
- radius see LBPHFaceRecognizer::create.
- neighbors see LBPHFaceRecognizer::create.
- grid_x see LLBPHFaceRecognizer::create.
- grid_y see LBPHFaceRecognizer::create.
- threshold see LBPHFaceRecognizer::create.
- histograms Local Binary Patterns Histograms calculated from the given training data (empty if none was given).
- labels Labels corresponding to the calculated Local Binary Patterns Histograms.
§Note
This alternative version of LBPHFaceRecognizer::create function uses the following default values for its arguments:
- radius: 1
- neighbors: 8
- grid_x: 8
- grid_y: 8
- threshold: DBL_MAX
Trait Implementations§
source§impl AlgorithmTrait for LBPHFaceRecognizer
impl AlgorithmTrait for LBPHFaceRecognizer
source§impl AlgorithmTraitConst for LBPHFaceRecognizer
impl AlgorithmTraitConst for LBPHFaceRecognizer
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 LBPHFaceRecognizer
impl Boxed for LBPHFaceRecognizer
source§unsafe fn from_raw(
ptr: <LBPHFaceRecognizer as OpenCVFromExtern>::ExternReceive
) -> Self
unsafe fn from_raw( ptr: <LBPHFaceRecognizer as OpenCVFromExtern>::ExternReceive ) -> Self
Wrap the specified raw pointer Read more
source§fn into_raw(
self
) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSendMut
fn into_raw( self ) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying raw pointer while consuming this wrapper. Read more
source§fn as_raw(
&self
) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSend
fn as_raw( &self ) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSend
Return the underlying raw pointer. Read more
source§fn as_raw_mut(
&mut self
) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSendMut
fn as_raw_mut( &mut self ) -> <LBPHFaceRecognizer as OpenCVTypeExternContainer>::ExternSendMut
Return the underlying mutable raw pointer Read more
source§impl Debug for LBPHFaceRecognizer
impl Debug for LBPHFaceRecognizer
source§impl Drop for LBPHFaceRecognizer
impl Drop for LBPHFaceRecognizer
source§impl FaceRecognizerTrait for LBPHFaceRecognizer
impl FaceRecognizerTrait for LBPHFaceRecognizer
fn as_raw_mut_FaceRecognizer(&mut self) -> *mut c_void
source§fn train(
&mut self,
src: &impl ToInputArray,
labels: &impl ToInputArray
) -> Result<()>
fn train( &mut self, src: &impl ToInputArray, labels: &impl ToInputArray ) -> Result<()>
Trains a FaceRecognizer with given data and associated labels. Read more
source§fn update(
&mut self,
src: &impl ToInputArray,
labels: &impl ToInputArray
) -> Result<()>
fn update( &mut self, src: &impl ToInputArray, labels: &impl ToInputArray ) -> Result<()>
Updates a FaceRecognizer with given data and associated labels. Read more
source§fn read(&mut self, filename: &str) -> Result<()>
fn read(&mut self, filename: &str) -> Result<()>
Loads a FaceRecognizer and its model state. Read more
source§fn read_1(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>
fn read_1(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>
Loads a FaceRecognizer and its model state. Read more
source§impl FaceRecognizerTraitConst for LBPHFaceRecognizer
impl FaceRecognizerTraitConst for LBPHFaceRecognizer
fn as_raw_FaceRecognizer(&self) -> *const c_void
source§fn predict_label(&self, src: &impl ToInputArray) -> Result<i32>
fn predict_label(&self, src: &impl ToInputArray) -> Result<i32>
Predicts a label and associated confidence (e.g. distance) for a given input image. Read more
source§fn predict(
&self,
src: &impl ToInputArray,
label: &mut i32,
confidence: &mut f64
) -> Result<()>
fn predict( &self, src: &impl ToInputArray, label: &mut i32, confidence: &mut f64 ) -> Result<()>
Predicts a label and associated confidence (e.g. distance) for a given input image. Read more
source§fn predict_collect(
&self,
src: &impl ToInputArray,
collector: Ptr<PredictCollector>
) -> Result<()>
fn predict_collect( &self, src: &impl ToInputArray, collector: Ptr<PredictCollector> ) -> Result<()>
if implemented - send all result of prediction to collector that can be used for somehow custom result handling Read more
source§fn write(&self, filename: &str) -> Result<()>
fn write(&self, filename: &str) -> Result<()>
Saves a FaceRecognizer and its model state. Read more
source§fn write_1(&self, fs: &mut impl FileStorageTrait) -> Result<()>
fn write_1(&self, fs: &mut impl FileStorageTrait) -> Result<()>
Saves a FaceRecognizer and its model state. Read more
source§fn empty(&self) -> Result<bool>
fn empty(&self) -> Result<bool>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
source§fn get_label_info(&self, label: i32) -> Result<String>
fn get_label_info(&self, label: i32) -> Result<String>
Gets string information by label. Read more
source§fn get_labels_by_string(&self, str: &str) -> Result<Vector<i32>>
fn get_labels_by_string(&self, str: &str) -> Result<Vector<i32>>
Gets vector of labels by string. Read more
source§fn get_threshold(&self) -> Result<f64>
fn get_threshold(&self) -> Result<f64>
threshold parameter accessor - required for default BestMinDist collector
source§impl From<LBPHFaceRecognizer> for Algorithm
impl From<LBPHFaceRecognizer> for Algorithm
source§fn from(s: LBPHFaceRecognizer) -> Self
fn from(s: LBPHFaceRecognizer) -> Self
Converts to this type from the input type.
source§impl From<LBPHFaceRecognizer> for FaceRecognizer
impl From<LBPHFaceRecognizer> for FaceRecognizer
source§fn from(s: LBPHFaceRecognizer) -> Self
fn from(s: LBPHFaceRecognizer) -> Self
Converts to this type from the input type.
source§impl LBPHFaceRecognizerTrait for LBPHFaceRecognizer
impl LBPHFaceRecognizerTrait for LBPHFaceRecognizer
fn as_raw_mut_LBPHFaceRecognizer(&mut self) -> *mut c_void
source§impl LBPHFaceRecognizerTraitConst for LBPHFaceRecognizer
impl LBPHFaceRecognizerTraitConst for LBPHFaceRecognizer
source§impl TryFrom<FaceRecognizer> for LBPHFaceRecognizer
impl TryFrom<FaceRecognizer> for LBPHFaceRecognizer
impl Send for LBPHFaceRecognizer
Auto Trait Implementations§
impl Freeze for LBPHFaceRecognizer
impl RefUnwindSafe for LBPHFaceRecognizer
impl !Sync for LBPHFaceRecognizer
impl Unpin for LBPHFaceRecognizer
impl UnwindSafe for LBPHFaceRecognizer
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