Struct opencv::face::Facemark

pub struct Facemark { /* private fields */ }

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<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.

Trait Implementations

impl AlgorithmTrait for Facemark

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for Facemark

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

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.

impl Boxed for Facemark

unsafe fn from_raw(ptr: <Facemark as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <Facemark as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <Facemark as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <Facemark as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for Facemark

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Facemark

fn drop(&mut self)

Executes the destructor for this type.

impl FacemarkTrait for Facemark

fn as_raw_mut_Facemark(&mut self) -> *mut c_void

fn load_model(&mut self, model: &str) -> Result<()>

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

fn fit( &mut self, image: &impl ToInputArray, faces: &impl ToInputArray, landmarks: &mut impl ToOutputArray ) -> Result<bool>

Detect facial landmarks from an image.

impl FacemarkTraitConst for Facemark

fn as_raw_Facemark(&self) -> *const c_void

impl From<Facemark> for Algorithm

fn from(s: Facemark) -> Self

Converts to this type from the input type.

impl From<FacemarkAAM> for Facemark

fn from(s: FacemarkAAM) -> Self

Converts to this type from the input type.

impl From<FacemarkKazemi> for Facemark

fn from(s: FacemarkKazemi) -> Self

Converts to this type from the input type.

impl From<FacemarkLBF> for Facemark

fn from(s: FacemarkLBF) -> Self

Converts to this type from the input type.

impl From<FacemarkTrain> for Facemark

fn from(s: FacemarkTrain) -> Self

Converts to this type from the input type.

impl TryFrom<Facemark> for FacemarkAAM

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Facemark) -> Result<Self>

Performs the conversion.

impl TryFrom<Facemark> for FacemarkKazemi

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Facemark) -> Result<Self>

Performs the conversion.

impl TryFrom<Facemark> for FacemarkLBF

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Facemark) -> Result<Self>

Performs the conversion.

impl TryFrom<Facemark> for FacemarkTrain

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: Facemark) -> Result<Self>

Performs the conversion.

impl Send for Facemark