FaceRecognizer Class

Abstract base class for all face recognition models. All face recognition models in OpenCV are derived from the abstract base class FaceRecognizer, which provides a unified access to all face recongition algorithms in OpenCV.

Inheritance Hierarchy

SystemObject
  OpenCvSharpDisposableObject
    OpenCvSharpDisposableCvObject
      OpenCvSharpAlgorithm
        OpenCvSharp.FaceFaceRecognizer
          OpenCvSharp.FaceBasicFaceRecognizer
          OpenCvSharp.FaceLBPHFaceRecognizer

Namespace: OpenCvSharp.Face
Assembly: OpenCvSharp (in OpenCvSharp.dll) Version: 3.4.1.20180605-33-CaRLSharp

Syntax

C++

JavaScript

Copy

public class FaceRecognizer : Algorithm

Public Class FaceRecognizer
	Inherits Algorithm

public ref class FaceRecognizer : public Algorithm

type FaceRecognizer =  
    class
        inherit Algorithm
    end

OpenCvSharp.Face.FaceRecognizer = function();

Type.createClass(
	'OpenCvSharp.Face.FaceRecognizer',
	OpenCvSharp.Algorithm);

The FaceRecognizer type exposes the following members.

Constructors

	Name	Description
	FaceRecognizer	Initializes a new instance of the FaceRecognizer class

Top

Properties

	Name	Description
	AllocatedMemory	Gets or sets a memory address allocated by AllocMemory. (Inherited from DisposableObject.)
	AllocatedMemorySize	Gets or sets the byte length of the allocated memory (Inherited from DisposableObject.)
	CvPtr	Native pointer of OpenCV structure (Inherited from DisposableCvObject.)
	Empty	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read (Inherited from Algorithm.)
	IsDisposed	Gets a value indicating whether this instance has been disposed. (Inherited from DisposableObject.)
	IsEnabledDispose	Gets or sets a value indicating whether you permit disposing this instance. (Inherited from DisposableObject.)

Top

Methods

	Name	Description
	AllocGCHandle	Pins the object to be allocated by cvSetData. (Inherited from DisposableObject.)
	AllocMemory	Allocates the specified size of memory. (Inherited from DisposableObject.)
	Dispose	Releases the resources (Inherited from DisposableObject.)
	DisposeManaged	Releases managed resources (Overrides DisposableObjectDisposeManaged.)
	DisposeUnmanaged	releases unmanaged resources (Inherited from DisposableCvObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Destructor (Inherited from DisposableObject.)
	GetDefaultName	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. (Inherited from Algorithm.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLabelInfo	Gets string information by label. If an unknown label id is provided or there is no label information associated with the specified label id the method returns an empty string.
	GetLabelsByString	Gets vector of labels by string. The function searches for the labels containing the specified sub-string in the associated string info.
	GetThreshold	threshold parameter accessor - required for default BestMinDist collector
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyMemoryPressure	Notifies the allocated size of memory. (Inherited from DisposableObject.)
	Predict(InputArray)	Gets a prediction from a FaceRecognizer.
	Predict(InputArray, Int32, Double)	Predicts the label and confidence for a given sample.
	Read(String)	Deserializes this object from a given filename.
	Read(FileNode)	Deserializes this object from a given cv::FileNode. (Overrides AlgorithmRead(FileNode).)
	Save	Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage fs). (Inherited from Algorithm.)
	SetLabelInfo	Sets string info for the specified model's label. The string info is replaced by the provided value if it was set before for the specified label.
	SetThreshold	Sets threshold of model
	ThrowIfDisposed	If this object is disposed, then ObjectDisposedException is thrown. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Train	Trains a FaceRecognizer with given data and associated labels.
	Update	Updates a FaceRecognizer with given data and associated labels.
	Write(String)	Serializes this object to a given filename.
	Write(FileStorage)	Serializes this object to a given cv::FileStorage. (Overrides AlgorithmWrite(FileStorage).)

Top

Fields

	Name	Description
	dataHandle	Gets or sets a handle which allocates using cvSetData. (Inherited from DisposableObject.)
	ptr	Data pointer (Inherited from DisposableCvObject.)

Top

Reference

OpenCvSharp.Face Namespace