Click or drag to resize

Facemark Class

Abstract base class for all facemark models. All facemark models in OpenCV are derived from the abstract base class Facemark, which provides a unified access to all facemark algorithms in OpenCV. To utilize this API in your program, please take a look at the @ref tutorial_table_of_content_facemark
Inheritance Hierarchy

Namespace:  OpenCvSharp.Face
Assembly:  OpenCvSharp (in OpenCvSharp.dll) Version: 3.4.1.20180605-33-CaRLSharp
Syntax
public abstract class Facemark : Algorithm

The Facemark type exposes the following members.

Constructors
  NameDescription
Protected methodFacemark
Initializes a new instance of the Facemark class
Top
Properties
  NameDescription
Protected propertyAllocatedMemory
Gets or sets a memory address allocated by AllocMemory.
(Inherited from DisposableObject.)
Protected propertyAllocatedMemorySize
Gets or sets the byte length of the allocated memory
(Inherited from DisposableObject.)
Public propertyCvPtr
Native pointer of OpenCV structure
(Inherited from DisposableCvObject.)
Public propertyEmpty
Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read
(Inherited from Algorithm.)
Public propertyIsDisposed
Gets a value indicating whether this instance has been disposed.
(Inherited from DisposableObject.)
Public propertyIsEnabledDispose
Gets or sets a value indicating whether you permit disposing this instance.
(Inherited from DisposableObject.)
Top
Methods
  NameDescription
Public methodAddTrainingSample
Add one training sample to the trainer.
Protected methodAllocGCHandle
Pins the object to be allocated by cvSetData.
(Inherited from DisposableObject.)
Protected methodAllocMemory
Allocates the specified size of memory.
(Inherited from DisposableObject.)
Public methodDispose
Releases the resources
(Inherited from DisposableObject.)
Protected methodDisposeManaged
Releases managed resources
(Inherited from DisposableObject.)
Protected methodDisposeUnmanaged
releases unmanaged resources
(Inherited from DisposableCvObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Destructor
(Inherited from DisposableObject.)
Public methodFit(InputArray, InputArray, InputOutputArray)
Trains a Facemark algorithm using the given dataset.
Public methodFit(InputArray, InputArray, InputOutputArray, IntPtr)
Trains a Facemark algorithm using the given dataset.
Public methodGetData
Get data from an algorithm
Public methodGetDefaultName
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.)
Public methodGetFaces(InputArray, OutputArray)
Detect faces from a given image using default or user defined face detector. Some Algorithm might not provide a default face detector.
Public methodGetFaces(InputArray, Rect)
Detect faces from a given image using default or user defined face detector. Some Algorithm might not provide a default face detector.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoadModel
A function to load the trained model before the fitting process.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNotifyMemoryPressure
Notifies the allocated size of memory.
(Inherited from DisposableObject.)
Public methodRead
Public methodSave
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.)
Public methodSetFaceDetector
Set a user defined face detector for the Facemark algorithm.
Public methodThrowIfDisposed
If this object is disposed, then ObjectDisposedException is thrown.
(Inherited from DisposableObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraining
Trains a Facemark algorithm using the given dataset. Before the training process, training samples should be added to the trainer using face::addTrainingSample function.
Public methodWrite
Top
Fields
  NameDescription
Protected fielddataHandle
Gets or sets a handle which allocates using cvSetData.
(Inherited from DisposableObject.)
Protected fieldptr
Data pointer
(Inherited from DisposableCvObject.)
Top
See Also