Class FaceLandmarkNet

Hierarchy

FaceLandmark68Net
- FaceLandmarkNet

Index

Constructors

constructor

Properties

Accessors

faceFeatureExtractor

Constructors

constructor

new FaceLandmarkNet(faceFeatureExtractor?: FaceFeatureExtractor): FaceLandmarkNet

Inherited from FaceLandmark68Net.constructor

Overrides FaceProcessor.constructor
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68Net.ts:5
Parameters
- Default value faceFeatureExtractor: FaceFeatureExtractor = new FaceFeatureExtractor()
Returns FaceLandmarkNet

Properties

Protected _faceFeatureExtractor

_faceFeatureExtractor: IFaceFeatureExtractor<FaceFeatureExtractorParams>

Protected _name

_name: string

Protected _paramMappings

_paramMappings: ParamMapping[]

Protected _params

_params: NetParams | undefined

isLoaded

isLoaded: boolean

paramMappings

paramMappings: ParamMapping[]

params

params: NetParams | undefined

Accessors

faceFeatureExtractor

get faceFeatureExtractor(): IFaceFeatureExtractor<FaceFeatureExtractorParams>

Inherited from FaceProcessor.faceFeatureExtractor
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:27
Returns IFaceFeatureExtractor<FaceFeatureExtractorParams>

Methods

detectLandmarks

detectLandmarks(input: TNetInput): Promise<FaceLandmarks68 | FaceLandmarks68[]>

Inherited from FaceLandmark68NetBase.detectLandmarks
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68NetBase.ts:73
Parameters
- input: TNetInput
Returns Promise<FaceLandmarks68 | FaceLandmarks68[]>

dispose

dispose(throwOnRedispose?: boolean): void

Inherited from FaceProcessor.dispose

Overrides NeuralNetwork.dispose
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:51
Parameters
- Default value throwOnRedispose: boolean = true
Returns void

extractClassifierParams

extractClassifierParams(weights: Float32Array): object

Inherited from FaceProcessor.extractClassifierParams
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:62
Parameters
- weights: Float32Array
Returns object

Protected extractParams

extractParams(weights: Float32Array): object

Inherited from FaceProcessor.extractParams

Overrides NeuralNetwork.extractParams
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:75
Parameters
- weights: Float32Array
Returns object

Protected extractParamsFromWeigthMap

extractParamsFromWeigthMap(weightMap: tf.NamedTensorMap): object

Inherited from FaceProcessor.extractParamsFromWeigthMap

Overrides NeuralNetwork.extractParamsFromWeigthMap
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:66
Parameters
- weightMap: tf.NamedTensorMap
Returns object

extractWeights

extractWeights(weights: Float32Array): void

Inherited from NeuralNetwork.extractWeights
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:33
Parameters
- weights: Float32Array
Returns void

forward

forward(input: TNetInput): Promise<tf.Tensor2D>

Inherited from FaceLandmark68NetBase.forward
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68NetBase.ts:69
Parameters
- input: TNetInput
Returns Promise<tf.Tensor2D>

forwardInput

forwardInput(input: NetInput): tf.Tensor2D

Inherited from FaceLandmark68NetBase.forwardInput
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68NetBase.ts:58
Parameters
- input: NetInput
Returns tf.Tensor2D

freeze

freeze(): void

Inherited from NeuralNetwork.freeze
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:26
Returns void

Protected getClassifierChannelsIn

getClassifierChannelsIn(): number

Inherited from FaceLandmark68Net.getClassifierChannelsIn

Overrides FaceProcessor.getClassifierChannelsIn
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68Net.ts:15
Returns number

Protected getClassifierChannelsOut

getClassifierChannelsOut(): number

Inherited from FaceLandmark68NetBase.getClassifierChannelsOut

Overrides FaceProcessor.getClassifierChannelsOut
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68NetBase.ts:102
Returns number

Protected getDefaultModelName

getDefaultModelName(): string

Inherited from FaceLandmark68Net.getDefaultModelName

Overrides FaceProcessor.getDefaultModelName
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68Net.ts:11
Returns string

getFrozenParams

getFrozenParams(): object[]

Inherited from NeuralNetwork.getFrozenParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:21
Returns object[]

getParamFromPath

getParamFromPath(paramPath: string): tf.Tensor

Inherited from NeuralNetwork.getParamFromPath
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:11
Parameters
- paramPath: string
Returns tf.Tensor

getParamList

getParamList(): object[]

Inherited from NeuralNetwork.getParamList
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:13
Returns object[]

getTrainableParams

getTrainableParams(): object[]

Inherited from NeuralNetwork.getTrainableParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:17
Returns object[]

load

load(weightsOrUrl: Float32Array | string | undefined): Promise<void>

Inherited from NeuralNetwork.load
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:29
Parameters
- weightsOrUrl: Float32Array | string | undefined
Returns Promise<void>

loadClassifierParams

loadClassifierParams(weights: Float32Array): void

Inherited from FaceProcessor.loadClassifierParams
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:56
Parameters
- weights: Float32Array
Returns void

loadFromDisk

loadFromDisk(filePath: string | undefined): Promise<void>

Inherited from NeuralNetwork.loadFromDisk
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:31
Parameters
- filePath: string | undefined
Returns Promise<void>

loadFromUri

loadFromUri(uri: string | undefined): Promise<void>

Inherited from NeuralNetwork.loadFromUri
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:30
Parameters
- uri: string | undefined
Returns Promise<void>

loadFromWeightMap

loadFromWeightMap(weightMap: tf.NamedTensorMap): void

Inherited from NeuralNetwork.loadFromWeightMap
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:32
Parameters
- weightMap: tf.NamedTensorMap
Returns void

postProcess

postProcess(output: tf.Tensor2D, inputSize: number, originalDimensions: IDimensions[]): tf.Tensor2D

Inherited from FaceLandmark68NetBase.postProcess
- Defined in face-api.js/src/faceLandmarkNet/FaceLandmark68NetBase.ts:13
Parameters
- output: tf.Tensor2D
- inputSize: number
- originalDimensions: IDimensions[]
Returns tf.Tensor2D

reassignParamFromPath

reassignParamFromPath(paramPath: string, tensor: tf.Tensor): void

Inherited from NeuralNetwork.reassignParamFromPath
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:12
Parameters
- paramPath: string
- tensor: tf.Tensor
Returns void

runNet

runNet(input: NetInput | tf.Tensor4D): tf.Tensor2D

Inherited from FaceProcessor.runNet
- Defined in face-api.js/src/faceProcessor/FaceProcessor.ts:35
Parameters
- input: NetInput | tf.Tensor4D
Returns tf.Tensor2D

serializeParams

serializeParams(): Float32Array

Inherited from NeuralNetwork.serializeParams
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:28
Returns Float32Array

variable

variable(): void

Inherited from NeuralNetwork.variable
- Defined in tfjs-image-recognition-base/build/commonjs/NeuralNetwork.d.ts:25
Returns void

Generated using TypeDoc