3DiVi Face SDK  3.24.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups
VDT.FaceRecognition.SDK.Capturer Class Reference

Interface object for detecting or tracking of faces in the images or video sequences. More...

Public Types

enum  CapturerType { CapturerType.CAPTURER_TYPE_FRONTAL = 0, CapturerType.CAPTURER_TYPE_LEFT_PROFILE = 1, CapturerType.CAPTURER_TYPE_RIGHT_PROFILE = 2 }
 Capturer types (see also RawSample.SampleType). More...
 

Public Member Functions

List< RawSamplecapture (RawImage image)
 Capture faces in a given image or video frame. More...
 
List< RawSamplecapture (byte[] data)
 Capture faces in a given image or video frame. More...
 
RawSample manualCapture (RawImage image, float left_eye_x, float left_eye_y, float right_eye_x, float right_eye_y)
 Create a sample manually with the marked eye positions. More...
 
RawSample manualCapture (RawImage image, List< Point > points)
 Create a sample manually with the marked positions of all points. Used only to adjust the position of points. More...
 
RawSample manualCapture (byte[] data, float left_eye_x, float left_eye_y, float right_eye_x, float right_eye_y)
 Create a sample manually with the marked eye positions. More...
 
RawSample manualCapture (byte[] data, List< Point > points)
 Create a sample manually with the marked positions of all points. Used only to adjust the position of points. More...
 
void resetHistory ()
 Forget all previous frames and faces (only affects trackers).
 
CapturerType getType ()
 Get a capturer type. More...
 
void setParameter (string parameter, double value)
 Change the parameter value in runtime. More...
 
- Public Member Functions inherited from VDT.FaceRecognition.SDK.IDisposableObject
virtual void Dispose ()
 Release internal object.
 

Additional Inherited Members

- Properties inherited from VDT.FaceRecognition.SDK.IDisposableObject
bool isDisposed [get]
 True if internal object already disposed.
 

Detailed Description

Interface object for detecting or tracking of faces in the images or video sequences.

Member Enumeration Documentation

Capturer types (see also RawSample.SampleType).

Enumerator
CAPTURER_TYPE_FRONTAL 

Only frontal-oriented faces will be captured.

CAPTURER_TYPE_LEFT_PROFILE 

Only left-profile-oriented faces will be captured.

CAPTURER_TYPE_RIGHT_PROFILE 

Only right-profile-oriented faces will be captured.

Member Function Documentation

List<RawSample> VDT.FaceRecognition.SDK.Capturer.capture ( RawImage  image)
inline

Capture faces in a given image or video frame.

Parameters
[in]imageImage or videoframe.
Returns
List of captured face samples.
Warning
Gray-scale images are not supported by the objects created with some configuration files.
List<RawSample> VDT.FaceRecognition.SDK.Capturer.capture ( byte[]  data)
inline

Capture faces in a given image or video frame.

Parameters
[in]dataAn array of bytes of the encoded image or videoframe with 8 or 24 bits per pixel. Supported formats are JPEG, PNG, TIF and BMP.
Returns
List of captured face samples.
Warning
Gray-scale images are not supported by the objects created with some configuration files.
CapturerType VDT.FaceRecognition.SDK.Capturer.getType ( )
inline

Get a capturer type.

Returns
Type of the capturer.
RawSample VDT.FaceRecognition.SDK.Capturer.manualCapture ( RawImage  image,
float  left_eye_x,
float  left_eye_y,
float  right_eye_x,
float  right_eye_y 
)
inline

Create a sample manually with the marked eye positions.

Parameters
[in]imageImage.
[in]left_eye_xX coordinate of the left eye.
[in]left_eye_yY coordinate of the left eye.
[in]right_eye_xX coordinate of the right eye.
[in]right_eye_yY coordinate of the right eye.
Returns
Captured face sample.
RawSample VDT.FaceRecognition.SDK.Capturer.manualCapture ( RawImage  image,
List< Point points 
)
inline

Create a sample manually with the marked positions of all points. Used only to adjust the position of points.

Warning
For recognition methods 7.7, 6.7, 8.7: samples that are created with this member function do not contain enough information about facial landmarks (even if given points are from the FDA points set), so the FDA algorithm will be rerun during the Recognizer.processing. If you use this member function in order to avoid using RawSample.save and store the image on your own, then use the new serialization functions: RawSample.saveWithoutImage and FacerecService.loadRawSampleWithoutImage.
Parameters
[in]imageImage.
[in]pointsList of points. It should be the same size, and the points should be in the same order as in the list from RawSample.getLandmarks from the original sample.
Returns
Captured face sample.
RawSample VDT.FaceRecognition.SDK.Capturer.manualCapture ( byte[]  data,
float  left_eye_x,
float  left_eye_y,
float  right_eye_x,
float  right_eye_y 
)
inline

Create a sample manually with the marked eye positions.

Parameters
[in]dataAn array of bytes of the encoded image or videoframe with 8 or 24 bits per pixel. Supported formats are JPEG, PNG, TIF and BMP.
[in]left_eye_xX coordinate of the left eye.
[in]left_eye_yY coordinate of the left eye.
[in]right_eye_xX coordinate of the right eye.
[in]right_eye_yY coordinate of the right eye.
Returns
Captured face sample.
RawSample VDT.FaceRecognition.SDK.Capturer.manualCapture ( byte[]  data,
List< Point points 
)
inline

Create a sample manually with the marked positions of all points. Used only to adjust the position of points.

Warning
For recognition methods 7.7, 6.7, 8.7: samples that are created with this member function do not contain enough information about facial landmarks (even if given points are from the FDA points set), so the FDA algorithm will be rerun during the Recognizer.processing. If you use this member function in order to avoid using RawSample.save and store the image on your own, then use the new serialization functions: RawSample.saveWithoutImage and FacerecService.loadRawSampleWithoutImage.
Parameters
[in]dataAn array of bytes of the encoded image or videoframe with 8 or 24 bits per pixel. Supported formats are JPEG, PNG, TIF and BMP.
[in]pointsList of points. It should be the same size, and the points should be in the same order as in the list from RawSample.getLandmarks from the original sample.
Returns
Captured face sample.
void VDT.FaceRecognition.SDK.Capturer.setParameter ( string  parameter,
double  value 
)
inline

Change the parameter value in runtime.

Parameters
[in]parameterParameter name (tag name in the .xml config file).
[in]valueNew parameter value.