Skip to content
opencv-wasm

face_LBPHFaceRecognizer_create

facefunctionOpenCV 5.0.0
import { face_LBPHFaceRecognizer_create } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSradius, neighbors, grid_x, grid_y
FUNCTIONface_LBPHFaceRecognizer_create
RETURN TYPEface_LBPHFaceRecognizer | null
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Create an owned face_LBPHFaceRecognizer instance with the supplied configuration.

face_LBPHFaceRecognizer_create(radius: number, neighbors: number, grid_x: number, grid_y: number, threshold: number): face_LBPHFaceRecognizer | null;
6 available overloads
face_LBPHFaceRecognizer_create(): face_LBPHFaceRecognizer | null;
face_LBPHFaceRecognizer_create(radius: number): face_LBPHFaceRecognizer | null;
face_LBPHFaceRecognizer_create(radius: number, neighbors: number): face_LBPHFaceRecognizer | null;
face_LBPHFaceRecognizer_create(radius: number, neighbors: number, grid_x: number): face_LBPHFaceRecognizer | null;
face_LBPHFaceRecognizer_create(radius: number, neighbors: number, grid_x: number, grid_y: number): face_LBPHFaceRecognizer | null;
face_LBPHFaceRecognizer_create(radius: number, neighbors: number, grid_x: number, grid_y: number, threshold: number): face_LBPHFaceRecognizer | null;
radius

The radius used for building the Circular Local Binary Pattern. The greater the radius, the smoother the image but more spatial information you can get.

neighbors

The number of sample points to build a Circular Local Binary Pattern from. An appropriate value is to use 8 sample points. Keep in mind: the more sample points you include, the higher the computational cost.

grid_x

The number of cells in the horizontal direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.

grid_y

The number of cells in the vertical direction, 8 is a common value used in publications. The more cells, the finer the grid, the higher the dimensionality of the resulting feature vector.

threshold

The threshold applied in the prediction. If the distance to the nearest neighbor is larger than the threshold, this method returns -1.

Notes:

  • The Circular Local Binary Patterns (used in training and prediction) expect the data given as grayscale images, use cvtColor to convert between the color spaces.
  • This model supports updating.

Model internal data:

  • radius see LBPHFaceRecognizer::create.
  • neighbors see LBPHFaceRecognizer::create.
  • grid_x see LLBPHFaceRecognizer::create.
  • grid_y see LBPHFaceRecognizer::create.
  • threshold see LBPHFaceRecognizer::create.
  • histograms Local Binary Patterns Histograms calculated from the given training data (empty if none was given).
  • labels Labels corresponding to the calculated Local Binary Patterns Histograms.
Returns

The face_LBPHFaceRecognizer | null result.

Upstream declaration ↗

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.