org.bytedeco.opencv.opencv_face

Class Facemark

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_face.Facemark

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FacemarkKazemi, FacemarkTrain

@Namespace(value="cv::face")
 @Properties(inherit=opencv_face.class)
public class Facemark
extends Algorithm

\brief Abstract base class for all facemark models

To utilize this API in your program, please take a look at the \ref 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<Facemark> facemark = createFacemarkLBF();

The typical pipeline for facemark detection is as follows: - Load the trained model using Facemark::loadModel. - Perform the fitting on an image via Facemark::fit.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Facemark(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	fit(Mat image, RectVector faces, Point2fVectorVector landmarks) \brief Detect facial landmarks from an image.
void	loadModel(BytePointer model) \brief A function to load the trained model before the fitting process.
void	loadModel(String model)

Methods inherited from class org.bytedeco.opencv.opencv_core.Algorithm

clear, empty, getDefaultName, position, read, save, save, write, write, write

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Facemark

public Facemark(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

loadModel

public void loadModel(@opencv_core.Str
                      BytePointer model)

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

Parameters:

model - A string represent the filename of a trained model.

Example of usage

    facemark->loadModel("../data/lbf.model");
    

loadModel

public void loadModel(@opencv_core.Str
                      String model)

fit

@Cast(value="bool")
public boolean fit(@ByVal
                                       Mat image,
                                       @ByRef
                                       RectVector faces,
                                       @ByRef
                                       Point2fVectorVector landmarks)

\brief Detect facial landmarks from an image.

Parameters:

image - Input image.

faces - Output of the function which represent region of interest of the detected faces. Each face is stored in cv::Rect container.

landmarks - The detected landmark points for each faces.

Example of usage

    Mat image = imread("image.jpg");
    std::vector<Rect> faces;
    std::vector<std::vector<Point2f> > landmarks;
    facemark->fit(image, faces, landmarks);