OpenCV for Unity  2.6.3
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.10.0/index.html ) for the details of the argument of the method.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OpenCVForUnity.FaceModule.Facemark Class Reference

Abstract base class for all facemark models. More...

Inheritance diagram for OpenCVForUnity.FaceModule.Facemark:
OpenCVForUnity.CoreModule.Algorithm OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject OpenCVForUnity.FaceModule.FacemarkKazemi OpenCVForUnity.FaceModule.FacemarkTrain OpenCVForUnity.FaceModule.FacemarkAAM OpenCVForUnity.FaceModule.FacemarkLBF

Public Member Functions

void loadModel (string model)
 A function to load the trained model before the fitting process. More...
 
bool fit (Mat image, MatOfRect faces, List< MatOfPoint2f > landmarks)
 Detect facial landmarks from an image. More...
 
- Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
IntPtr getNativeObjAddr ()
 
virtual void clear ()
 Clears the algorithm state. More...
 
virtual bool empty ()
 Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read. More...
 
void save (string filename)
 
virtual string getDefaultName ()
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 
void ThrowIfDisposed ()
 

Static Public Member Functions

static new Facemark __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 
 DisposableOpenCVObject (IntPtr ptr)
 
 DisposableOpenCVObject (bool isEnabledDispose)
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 
 DisposableObject (bool isEnabledDispose)
 

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

Abstract base class for all facemark models.

To utilize this API in your program, please take a look at the tutorial_table_of_content_facemark

Description

Facemark is a base class which provides universal access to any specific facemark algorithm. Therefore, the users should declare a desired algorithm before they can use it in their application.

Here is an example on how to declare a facemark algorithm:

// Using Facemark in your code:
Ptr&lt;Facemark&gt; facemark = createFacemarkLBF();

The typical pipeline for facemark detection is as follows:

Member Function Documentation

◆ __fromPtr__()

static new Facemark OpenCVForUnity.FaceModule.Facemark.__fromPtr__ ( IntPtr  addr)
static

◆ Dispose()

override void OpenCVForUnity.FaceModule.Facemark.Dispose ( bool  disposing)
protectedvirtual

◆ fit()

bool OpenCVForUnity.FaceModule.Facemark.fit ( Mat  image,
MatOfRect  faces,
List< MatOfPoint2f landmarks 
)

Detect facial landmarks from an image.

Parameters
imageInput image.
facesOutput of the function which represent region of interest of the detected faces. Each face is stored in cv::Rect container.
landmarksThe detected landmark points for each faces.
&lt;B&gt;Example of usage&lt;/B&gt;
Mat image = imread("image.jpg");
std::vector&lt;Rect&gt; faces;
std::vector&lt;std::vector&lt;Point2f&gt; &gt; landmarks;
facemark-&gt;fit(image, faces, landmarks);

◆ loadModel()

void OpenCVForUnity.FaceModule.Facemark.loadModel ( string  model)

A function to load the trained model before the fitting process.

Parameters
modelA string represent the filename of a trained model.
&lt;B&gt;Example of usage&lt;/B&gt;
facemark-&gt;loadModel("../data/lbf.model");

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