Class cv::face::BasicFaceRecognizer#

#include <opencv2/face/facerec.hpp>

Collaboration diagram for cv::face::BasicFaceRecognizer:

Public Member Functions#

Public Member Functions inherited from cv::face::FaceRecognizer

Return	Name	Description
`bool`	`empty()`
`String`	`getLabelInfo(int label)`	Gets string information by label.
`std::vector< int >`	`getLabelsByString(const String & str)`	Gets vector of labels by string.
`double`	`getThreshold()`	threshold parameter accessor - required for default BestMinDist collector
`int`	`predict(InputArray src)`
`void`	`predict(` `InputArray src,` `int & label,` `double & confidence )`	Predicts a label and associated confidence (e.g. distance) for a given input image.
`void`	`predict(` `InputArray src,` `Ptr< PredictCollector > collector )`	if implemented - send all result of prediction to collector that can be used for somehow custom result handling
`void`	`read(const FileNode & fn)`
`void`	`read(const String & filename)`	Loads a FaceRecognizer and its model state.
`void`	`setLabelInfo(` `int label,` `const String & strInfo )`	Sets string info for the specified model’s label.
`void`	`setThreshold(double val)`	Sets threshold of model.
`void`	`train(` `InputArrayOfArrays src,` `InputArray labels )`	Trains a FaceRecognizer with given data and associated labels.
`void`	`update(` `InputArrayOfArrays src,` `InputArray labels )`	Updates a FaceRecognizer with given data and associated labels.
`void`	`write(const String & filename)`	Saves a FaceRecognizer and its model state.
`void`	`write(FileStorage & fs)`

Public Member Functions inherited from cv::Algorithm

Return	Name	Description
	`Algorithm()`
	`~Algorithm()`
`void`	`clear()`	Clears the algorithm state.
`bool`	`empty()`	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
`String`	`getDefaultName()`
`void`	`read(const FileNode & fn)`	Reads algorithm parameters from a file storage.
`void`	`save(const String & filename)`
`void`	`write(` `const Ptr< FileStorage > & fs,` `const String & name = String() )`
`void`	`write(FileStorage & fs)`	Stores algorithm parameters in a file storage.
`void`	`write(` `FileStorage & fs,` `const String & name )`

Static Public Member Functions#

Static Public Member Functions inherited from cv::Algorithm

Return	Name	Description
`static Ptr< _Tp >`	`load(` `const String & filename,` `const String & objname = String() )`	Loads algorithm from the file.
`static Ptr< _Tp >`	`loadFromString(` `const String & strModel,` `const String & objname = String() )`	Loads algorithm from a String.
`static Ptr< _Tp >`	`read(const FileNode & fn)`	Reads algorithm from the file node.

Additional Inherited Members#

Member Function Documentation#

empty()#

bool cv::face::BasicFaceRecognizer::empty()

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

getEigenValues()#

cv::Mat cv::face::BasicFaceRecognizer::getEigenValues()

getEigenVectors()#

cv::Mat cv::face::BasicFaceRecognizer::getEigenVectors()

getLabels()#

cv::Mat cv::face::BasicFaceRecognizer::getLabels()

getMean()#

cv::Mat cv::face::BasicFaceRecognizer::getMean()

getNumComponents()#

int cv::face::BasicFaceRecognizer::getNumComponents()

See also

setNumComponents

getProjections()#

std::vector< cv::Mat > cv::face::BasicFaceRecognizer::getProjections()

getThreshold()#

double cv::face::BasicFaceRecognizer::getThreshold()

See also

setThreshold

read()#

void cv::face::BasicFaceRecognizer::read(const FileNode & fn)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

read()#

void cv::face::BasicFaceRecognizer::read(const String & filename)

Loads a FaceRecognizer and its model state.

Loads a persisted model and state from a given XML or YAML file . Every FaceRecognizer has to overwrite FaceRecognizer::load(FileStorage& fs) to enable loading the model state. FaceRecognizer::load(FileStorage& fs) in turn gets called by FaceRecognizer::load(const String& filename), to ease saving a model.

setNumComponents()#

void cv::face::BasicFaceRecognizer::setNumComponents(int val)

See also

getNumComponents

setThreshold()#

void cv::face::BasicFaceRecognizer::setThreshold(double val)

See also

getThreshold

write()#

void cv::face::BasicFaceRecognizer::write(const String & filename)

Saves a FaceRecognizer and its model state.

Saves this model to a given filename, either as XML or YAML. Every FaceRecognizer overwrites FaceRecognizer::save(FileStorage& fs) to save the internal model state. FaceRecognizer::save(const String& filename) saves the state of a model to the given filename.

The suffix const means that prediction does not affect the internal model state, so the method can be safely called from within different threads.

Parameters

filename — The filename to store this FaceRecognizer to (either XML/YAML).

write()#

void cv::face::BasicFaceRecognizer::write(FileStorage & fs)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Saves this model to a given FileStorage.

Parameters

fs — The FileStorage to store this FaceRecognizer to.

Member Data Documentation#

_eigenvalues#

Mat cv::face::BasicFaceRecognizer::_eigenvalues

_eigenvectors#

Mat cv::face::BasicFaceRecognizer::_eigenvectors

_labels#

Mat cv::face::BasicFaceRecognizer::_labels

_mean#

Mat cv::face::BasicFaceRecognizer::_mean

_num_components#

int cv::face::BasicFaceRecognizer::_num_components

_projections#

std::vector< Mat > cv::face::BasicFaceRecognizer::_projections

_threshold#

double cv::face::BasicFaceRecognizer::_threshold

Source file#

The documentation for this class was generated from the following file:

opencv2/face/facerec.hpp