ambiser
/
face-api
mirror of https://github.com/vladmandic/face-api.git
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

create api specs

pull/46/head
Vladimir Mandic 2021-03-14 08:47:38 -04:00
parent cd022855eb
commit 8bc4f095f4
96 changed files with 34305 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -9,7 +9,7 @@ Repository: **<git+https://github.com/vladmandic/face-api.git>**
## Changelog
### **HEAD -> master** 2021/03/09 mandic00@live.com
### **HEAD -> master** 2021/03/13 mandic00@live.com
### **1.0.2** 2021/03/09 mandic00@live.com

169
README.md
View File

@ -10,7 +10,14 @@
<br>
**Live Demo**: <https://vladmandic.github.io/face-api/example/webcam.html>
**Live Demo**: <https://vladmandic.github.io/face-api/demo/webcam.html>
<br>
## Documentation
- [**Tutorial**](TUTORIAL.md)
- [**API Specification**](https://justadudewhohacks.github.io/face-api.js/docs/globals.html)
<br>
@ -26,6 +33,7 @@ And since original Face-API was open-source, I've released this version as well
Changes ended up being too large for a simple pull request
and it ended up being a full-fledged version on its own
Plus many features were added since original inception
<br><hr><br>
@ -37,20 +45,25 @@ Plus many features were added since original inception
### Browser
Browser example that uses static images and showcases both models
as well as all of the extensions is included in `/example/index.html`
as well as all of the extensions is included in `/demo/index.html`
Example can be accessed directly using Git pages using URL:
<https://vladmandic.github.io/face-api/example/index.html>
<https://vladmandic.github.io/face-api/demo/index.html>
Browser example that uses live webcam is included in `/example/webcam.html`
Browser example that uses live webcam is included in `/demo/webcam.html`
Example can be accessed directly using Git pages using URL:
<https://vladmandic.github.io/face-api/example/webcam.html>
<https://vladmandic.github.io/face-api/demo/webcam.html>
<br>
**Demo using FaceAPI to process images**
*Note: Photos shown below are taken by me*
![screenshot](example/screenshot.png)
![screenshot](demo/screenshot-images.png)
**Demo using FaceAPI to process live webcam**
![screenshot](demo/screenshot-webcam.png)
<br>
@ -58,43 +71,49 @@ Example can be accessed directly using Git pages using URL:
Two NodeJS examples are:
- `/example/node-singleprocess.js`: Regular usage of `FaceAPI` from `NodeJS`
- `/example/node-multiprocess.js`: Multiprocessing showcase that uses pool of worker processes (`node-multiprocess-worker.js`
Main starts fixed pool of worker processes with each worker having it's instance of `FaceAPI`
Workers communicate with main when they are ready and main dispaches job to each ready worker until job queue is empty
- `/demo/node-singleprocess.js`:
Regular usage of `FaceAPI` from `NodeJS`
- `/demo/node-multiprocess.js`:
Multiprocessing showcase that uses pool of worker processes
(`node-multiprocess-worker.js`)
Main starts fixed pool of worker processes with each worker having
it's instance of `FaceAPI`
Workers communicate with main when they are ready and main dispaches
job to each ready worker until job queue is empty
```json
2020-12-08 08:30:01 INFO: @vladmandic/face-api version 0.9.1
2020-12-08 08:30:01 INFO: User: vlado Platform: linux Arch: x64 Node: v15.0.1
2020-12-08 08:30:01 INFO: FaceAPI multi-process test
2020-12-08 08:30:01 STATE: Main: started worker: 265238
2020-12-08 08:30:01 STATE: Main: started worker: 265244
2020-12-08 08:30:02 STATE: Worker: PID: 265238 TensorFlow/JS 2.7.0 FaceAPI 0.9.1 Backend: tensorflow
2020-12-08 08:30:02 STATE: Worker: PID: 265244 TensorFlow/JS 2.7.0 FaceAPI 0.9.1 Backend: tensorflow
2020-12-08 08:30:02 STATE: Main: dispatching to worker: 265238
2020-12-08 08:30:02 STATE: Main: dispatching to worker: 265244
2020-12-08 08:30:02 DATA: Worker received message: 265238 { image: 'example/sample (1).jpg' }
2020-12-08 08:30:02 DATA: Worker received message: 265244 { image: 'example/sample (2).jpg' }
2020-12-08 08:30:04 DATA: Main: worker finished: 265238 detected faces: 3
2020-12-08 08:30:04 STATE: Main: dispatching to worker: 265238
2020-12-08 08:30:04 DATA: Main: worker finished: 265244 detected faces: 3
2020-12-08 08:30:04 STATE: Main: dispatching to worker: 265244
2020-12-08 08:30:04 DATA: Worker received message: 265238 { image: 'example/sample (3).jpg' }
2020-12-08 08:30:04 DATA: Worker received message: 265244 { image: 'example/sample (4).jpg' }
2020-12-08 08:30:06 DATA: Main: worker finished: 265238 detected faces: 3
2020-12-08 08:30:06 STATE: Main: dispatching to worker: 265238
2020-12-08 08:30:06 DATA: Worker received message: 265238 { image: 'example/sample (5).jpg' }
2020-12-08 08:30:06 DATA: Main: worker finished: 265244 detected faces: 4
2020-12-08 08:30:06 STATE: Main: dispatching to worker: 265244
2020-12-08 08:30:06 DATA: Worker received message: 265244 { image: 'example/sample (6).jpg' }
2020-12-08 08:30:07 DATA: Main: worker finished: 265238 detected faces: 5
2020-12-08 08:30:07 STATE: Main: worker exit: 265238 0
2020-12-08 08:30:08 DATA: Main: worker finished: 265244 detected faces: 4
2020-12-08 08:30:08 INFO: Processed 12 images in 6826 ms
2020-12-08 08:30:08 STATE: Main: worker exit: 265244 0
2021-03-14 08:42:03 INFO: @vladmandic/face-api version 1.0.2
2021-03-14 08:42:03 INFO: User: vlado Platform: linux Arch: x64 Node: v15.7.0
2021-03-14 08:42:03 INFO: FaceAPI multi-process test
2021-03-14 08:42:03 STATE: Main: started worker: 1888019
2021-03-14 08:42:03 STATE: Main: started worker: 1888025
2021-03-14 08:42:04 STATE: Worker: PID: 1888025 TensorFlow/JS 3.3.0 FaceAPI 1.0.2 Backend: tensorflow
2021-03-14 08:42:04 STATE: Worker: PID: 1888019 TensorFlow/JS 3.3.0 FaceAPI 1.0.2 Backend: tensorflow
2021-03-14 08:42:04 STATE: Main: dispatching to worker: 1888019
2021-03-14 08:42:04 STATE: Main: dispatching to worker: 1888025
2021-03-14 08:42:04 DATA: Worker received message: 1888019 { image: 'demo/sample1.jpg' }
2021-03-14 08:42:04 DATA: Worker received message: 1888025 { image: 'demo/sample2.jpg' }
2021-03-14 08:42:06 DATA: Main: worker finished: 1888025 detected faces: 3
2021-03-14 08:42:06 STATE: Main: dispatching to worker: 1888025
2021-03-14 08:42:06 DATA: Worker received message: 1888025 { image: 'demo/sample3.jpg' }
2021-03-14 08:42:06 DATA: Main: worker finished: 1888019 detected faces: 3
2021-03-14 08:42:06 STATE: Main: dispatching to worker: 1888019
2021-03-14 08:42:06 DATA: Worker received message: 1888019 { image: 'demo/sample4.jpg' }
2021-03-14 08:42:07 DATA: Main: worker finished: 1888025 detected faces: 3
2021-03-14 08:42:07 STATE: Main: dispatching to worker: 1888025
2021-03-14 08:42:07 DATA: Worker received message: 1888025 { image: 'demo/sample5.jpg' }
2021-03-14 08:42:08 DATA: Main: worker finished: 1888019 detected faces: 4
2021-03-14 08:42:08 STATE: Main: dispatching to worker: 1888019
2021-03-14 08:42:08 DATA: Worker received message: 1888019 { image: 'demo/sample6.jpg' }
2021-03-14 08:42:09 DATA: Main: worker finished: 1888025 detected faces: 5
2021-03-14 08:42:09 STATE: Main: worker exit: 1888025 0
2021-03-14 08:42:09 DATA: Main: worker finished: 1888019 detected faces: 4
2021-03-14 08:42:09 INFO: Processed 15 images in 5944 ms
2021-03-14 08:42:09 STATE: Main: worker exit: 1888019 0
```
Note that `@tensorflow/tfjs-node` or `@tensorflow/tfjs-node-gpu` must be installed before using NodeJS example
Note that `@tensorflow/tfjs-node` or `@tensorflow/tfjs-node-gpu`
must be installed before using NodeJS example
<br><hr><br>
@ -127,7 +146,8 @@ Defaults are:
Bundled `TFJS` can be used directly via export: `faceapi.tf`
Reason for additional `nobundle` version is if you want to include a specific version of TFJS and not rely on pre-packaged one
Reason for additional `nobundle` version is if you want to
include a specific version of TFJS and not rely on pre-packaged one
`FaceAPI` is compatible with TFJS 2.0+
@ -302,21 +322,19 @@ npm run dev
By default it starts HTTP server on port 8000 and HTTPS server on port 8001 and can be accessed as:
- <https://localhost:8001/example/index.html>
- <https://localhost:8001/example/webcam.html>
- <https://localhost:8001/demo/index.html>
- <https://localhost:8001/demo/webcam.html>
```json
2021-01-10 08:39:00 INFO: @vladmandic/face-api version 0.10.2
2021-01-10 08:39:00 INFO: User: vlado Platform: linux Arch: x64 Node: v15.4.0
2021-01-10 08:39:00 INFO: Build: file startup all target: es2018
2021-01-10 08:39:00 STATE: HTTP server listening: 8000
2021-01-10 08:39:00 STATE: HTTP2 server listening: 8001
2021-01-10 08:39:00 STATE: Monitoring: [ 'package.json', 'config.js', 'example', 'src', [length]: 4 ]
2021-01-10 08:39:00 STATE: Monitoring: [ 'package.json', 'config.js', 'example', 'src', [length]: 4 ]
2021-01-10 08:39:01 STATE: Build for: browserBundle type: tfjs: { modules: 1253, moduleBytes: 3997175, imports: 7, importBytes: 276, outputBytes: 1565414, outputFiles: 'dist/tfjs.esm.js' }
2021-01-10 08:39:01 STATE: Build for: browserBundle type: iife: { imports: 160, importBytes: 1797487, outputBytes: 1699552, outputFiles: 'dist/face-api.js' }
2021-01-10 08:39:01 STATE: Build for: browserBundle type: esm: { imports: 160, importBytes: 1797487, outputBytes: 1697086, outputFiles: 'dist/face-api.esm.js' }
2021-01-10 08:39:01 INFO: Compile: [ 'src/index.ts', [length]: 1 ]
2021-03-14 08:41:09 INFO: @vladmandic/face-api version 1.0.2
2021-03-14 08:41:09 INFO: User: vlado Platform: linux Arch: x64 Node: v15.7.0
2021-03-14 08:41:09 INFO: Build: file startup all target: es2018
2021-03-14 08:41:09 STATE: HTTP server listening: 8000
2021-03-14 08:41:09 STATE: HTTP2 server listening: 8001
2021-03-14 08:41:09 STATE: Monitoring: [ 'package.json', 'demo', 'src', [length]: 3 ]
2021-03-14 08:41:10 STATE: Build for: browserBundle type: tfjs: { modules: 1258, moduleBytes: 4040087, imports: 7, importBytes: 276, outputBytes: 1072314, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:41:10 STATE: Build for: browserBundle type: iife: { imports: 160, importBytes: 1305679, outputBytes: 1151683, outputFiles: 'dist/face-api.js' }
2021-03-14 08:41:10 STATE: Build for: browserBundle type: esm: { imports: 160, importBytes: 1305679, outputBytes: 1151520, outputFiles: 'dist/face-api.esm.js' }
```
<br>
@ -349,26 +367,28 @@ npm run build
Build process uses script `build.js` that creates optimized build for each target:
```text
npm run build
> @vladmandic/face-api@0.8.9 build /home/vlado/dev/face-api
> rimraf dist/* && node ./build.js
> @vladmandic/face-api@1.0.2 build
> rimraf dist/* types/* typedoc/* && node server/build.js
```
```json
2021-01-10 08:42:01 INFO: @vladmandic/face-api version 0.10.2
2021-01-10 08:42:01 INFO: User: vlado Platform: linux Arch: x64 Node: v15.4.0
2021-01-10 08:42:01 INFO: Build: file startup all target: es2018
2021-01-10 08:42:01 STATE: Build for: node type: tfjs: { imports: 1, importBytes: 143, outputBytes: 1042, outputFiles: 'dist/tfjs.esm.js' }
2021-01-10 08:42:01 STATE: Build for: node type: node: { imports: 160, importBytes: 233115, outputBytes: 132266, outputFiles: 'dist/face-api.node.js' }
2021-01-10 08:42:01 STATE: Build for: nodeGPU type: tfjs: { imports: 1, importBytes: 147, outputBytes: 1046, outputFiles: 'dist/tfjs.esm.js' }
2021-01-10 08:42:01 STATE: Build for: nodeGPU type: node: { imports: 160, importBytes: 233119, outputBytes: 132274, outputFiles: 'dist/face-api.node-gpu.js' }
2021-01-10 08:42:01 STATE: Build for: browserNoBundle type: tfjs: { imports: 1, importBytes: 276, outputBytes: 244, outputFiles: 'dist/tfjs.esm.js' }
2021-01-10 08:42:01 STATE: Build for: browserNoBundle type: esm: { imports: 160, importBytes: 232317, outputBytes: 129069, outputFiles: 'dist/face-api.esm-nobundle.js' }
2021-01-10 08:42:01 STATE: Build for: browserBundle type: tfjs: { modules: 1253, moduleBytes: 3997175, imports: 7, importBytes: 276, outputBytes: 1565414, outputFiles: 'dist/tfjs.esm.js' }
2021-01-10 08:42:02 STATE: Build for: browserBundle type: iife: { imports: 160, importBytes: 1797487, outputBytes: 1699552, outputFiles: 'dist/face-api.js' }
2021-01-10 08:42:02 STATE: Build for: browserBundle type: esm: { imports: 160, importBytes: 1797487, outputBytes: 1697086, outputFiles: 'dist/face-api.esm.js' }
2021-01-10 08:42:02 INFO: Compile: [ 'src/index.ts', [length]: 1 ]```
2021-03-14 08:39:21 INFO: @vladmandic/face-api version 1.0.2
2021-03-14 08:39:21 INFO: User: vlado Platform: linux Arch: x64 Node: v15.7.0
2021-03-14 08:39:21 INFO: Build: file startup all target: es2018
2021-03-14 08:39:21 STATE: Build for: node type: tfjs: { imports: 1, importBytes: 143, outputBytes: 731, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:39:21 STATE: Build for: node type: node: { imports: 160, importBytes: 234096, outputBytes: 85371, outputFiles: 'dist/face-api.node.js' }
2021-03-14 08:39:21 STATE: Build for: nodeGPU type: tfjs: { imports: 1, importBytes: 147, outputBytes: 735, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:39:21 STATE: Build for: nodeGPU type: node: { imports: 160, importBytes: 234100, outputBytes: 85379, outputFiles: 'dist/face-api.node-gpu.js' }
2021-03-14 08:39:21 STATE: Build for: nodeCPU type: tfjs: { imports: 1, importBytes: 138, outputBytes: 726, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:39:21 STATE: Build for: nodeCPU type: node: { imports: 160, importBytes: 234091, outputBytes: 85370, outputFiles: 'dist/face-api.node-cpu.js' }
2021-03-14 08:39:21 STATE: Build for: browserNoBundle type: tfjs: { imports: 1, importBytes: 276, outputBytes: 244, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:39:21 STATE: Build for: browserNoBundle type: esm: { imports: 160, importBytes: 233609, outputBytes: 82634, outputFiles: 'dist/face-api.esm-nobundle.js' }
2021-03-14 08:39:22 STATE: Build for: browserBundle type: tfjs: { modules: 1258, moduleBytes: 4040087, imports: 7, importBytes: 276, outputBytes: 1072314, outputFiles: 'dist/tfjs.esm.js' }
2021-03-14 08:39:22 STATE: Build for: browserBundle type: iife: { imports: 160, importBytes: 1305679, outputBytes: 1151683, outputFiles: 'dist/face-api.js' }
2021-03-14 08:39:22 STATE: Build for: browserBundle type: esm: { imports: 160, importBytes: 1305679, outputBytes: 1151520, outputFiles: 'dist/face-api.esm.js' }
2021-03-14 08:39:22 INFO: Compile typings: [ 'src/index.ts', [length]: 1 ]
2021-03-14 08:39:27 INFO: Update Change log: [ '/home/vlado/dev/face-api/CHANGELOG.md', [length]: 1 ]
2021-03-14 08:39:27 INFO: Generate TypeDocs: [ 'src/index.ts', [length]: 1 ]
```
<br>
@ -379,14 +399,7 @@ npm run build
`FaceAPI` landmark model returns 68-point face mesh as detailed in the image below:
![facemesh](example/facemesh.png)
<br>
## Documentation
- [**Tutorial**](TUTORIAL.md)
- [**API Documentation**](https://justadudewhohacks.github.io/face-api.js/docs/globals.html)
![facemesh](demo/facemesh.png)
<br>

108
TUTORIAL.md
View File

@ -1,4 +1,4 @@
# FaceAPI Usage
# FaceAPI Tutorial
## Features
@ -38,7 +38,7 @@
All global neural network instances are exported via faceapi.nets:
``` javascript
```js
console.log(faceapi.nets)
// ageGenderNet
// faceExpressionNet
@ -54,7 +54,7 @@ To load a model, you have to provide the corresponding manifest.json file as wel
Assuming the models reside in **public/models**:
``` javascript
```js
await faceapi.nets.ssdMobilenetv1.loadFromUri('/models')
// accordingly for the other models:
// await faceapi.nets.faceLandmark68Net.loadFromUri('/models')
@ -64,26 +64,26 @@ await faceapi.nets.ssdMobilenetv1.loadFromUri('/models')
In a nodejs environment you can furthermore load the models directly from disk:
``` javascript
```js
await faceapi.nets.ssdMobilenetv1.loadFromDisk('./models')
```
You can also load the model from a tf.NamedTensorMap:
``` javascript
```js
await faceapi.nets.ssdMobilenetv1.loadFromWeightMap(weightMap)
```
Alternatively, you can also create own instances of the neural nets:
``` javascript
```js
const net = new faceapi.SsdMobilenetv1()
await net.loadFromUri('/models')
```
You can also load the weights as a Float32Array (in case you want to use the uncompressed models):
``` javascript
```js
// using fetch
net.load(await faceapi.fetchNetWeights('/models/face_detection_model.weights'))
@ -105,7 +105,7 @@ In the following **input** can be an HTML img, video or canvas element or the id
<canvas id="myCanvas" />
```
``` javascript
```js
const input = document.getElementById('myImg')
// const input = document.getElementById('myVideo')
// const input = document.getElementById('myCanvas')
@ -117,19 +117,19 @@ const input = document.getElementById('myImg')
Detect all faces in an image. Returns **Array<[FaceDetection](#interface-face-detection)>**:
``` javascript
```js
const detections = await faceapi.detectAllFaces(input)
```
Detect the face with the highest confidence score in an image. Returns **[FaceDetection](#interface-face-detection) | undefined**:
``` javascript
```js
const detection = await faceapi.detectSingleFace(input)
```
By default **detectAllFaces** and **detectSingleFace** utilize the SSD Mobilenet V1 Face Detector. You can specify the face detector by passing the corresponding options object:
``` javascript
```js
const detections1 = await faceapi.detectAllFaces(input, new faceapi.SsdMobilenetv1Options())
const detections2 = await faceapi.detectAllFaces(input, new faceapi.TinyFaceDetectorOptions())
```
@ -142,19 +142,19 @@ You can tune the options of each face detector as shown [here](#getting-started-
Detect all faces in an image + computes 68 Point Face Landmarks for each detected face. Returns **Array<[WithFaceLandmarks<WithFaceDetection<{}>>](#getting-started-utility-classes)>**:
``` javascript
```js
const detectionsWithLandmarks = await faceapi.detectAllFaces(input).withFaceLandmarks()
```
Detect the face with the highest confidence score in an image + computes 68 Point Face Landmarks for that face. Returns **[WithFaceLandmarks<WithFaceDetection<{}>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const detectionWithLandmarks = await faceapi.detectSingleFace(input).withFaceLandmarks()
```
You can also specify to use the tiny model instead of the default model:
``` javascript
```js
const useTinyModel = true
const detectionsWithLandmarks = await faceapi.detectAllFaces(input).withFaceLandmarks(useTinyModel)
```
@ -165,13 +165,13 @@ const detectionsWithLandmarks = await faceapi.detectAllFaces(input).withFaceLand
Detect all faces in an image + compute 68 Point Face Landmarks for each detected face. Returns **Array<[WithFaceDescriptor<WithFaceLandmarks<WithFaceDetection<{}>>>](#getting-started-utility-classes)>**:
``` javascript
```js
const results = await faceapi.detectAllFaces(input).withFaceLandmarks().withFaceDescriptors()
```
Detect the face with the highest confidence score in an image + compute 68 Point Face Landmarks and face descriptor for that face. Returns **[WithFaceDescriptor<WithFaceLandmarks<WithFaceDetection<{}>>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const result = await faceapi.detectSingleFace(input).withFaceLandmarks().withFaceDescriptor()
```
@ -181,13 +181,13 @@ const result = await faceapi.detectSingleFace(input).withFaceLandmarks().withFac
Detect all faces in an image + recognize face expressions of each face. Returns **Array<[WithFaceExpressions<WithFaceLandmarks<WithFaceDetection<{}>>>](#getting-started-utility-classes)>**:
``` javascript
```js
const detectionsWithExpressions = await faceapi.detectAllFaces(input).withFaceLandmarks().withFaceExpressions()
```
Detect the face with the highest confidence score in an image + recognize the face expressions for that face. Returns **[WithFaceExpressions<WithFaceLandmarks<WithFaceDetection<{}>>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const detectionWithExpressions = await faceapi.detectSingleFace(input).withFaceLandmarks().withFaceExpressions()
```
@ -195,13 +195,13 @@ const detectionWithExpressions = await faceapi.detectSingleFace(input).withFaceL
Detect all faces without face alignment + recognize face expressions of each face. Returns **Array<[WithFaceExpressions<WithFaceDetection<{}>>](#getting-started-utility-classes)>**:
``` javascript
```js
const detectionsWithExpressions = await faceapi.detectAllFaces(input).withFaceExpressions()
```
Detect the face with the highest confidence score without face alignment + recognize the face expression for that face. Returns **[WithFaceExpressions<WithFaceDetection<{}>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const detectionWithExpressions = await faceapi.detectSingleFace(input).withFaceExpressions()
```
@ -211,13 +211,13 @@ const detectionWithExpressions = await faceapi.detectSingleFace(input).withFaceE
Detect all faces in an image + estimate age and recognize gender of each face. Returns **Array<[WithAge<WithGender<WithFaceLandmarks<WithFaceDetection<{}>>>>](#getting-started-utility-classes)>**:
``` javascript
```js
const detectionsWithAgeAndGender = await faceapi.detectAllFaces(input).withFaceLandmarks().withAgeAndGender()
```
Detect the face with the highest confidence score in an image + estimate age and recognize gender for that face. Returns **[WithAge<WithGender<WithFaceLandmarks<WithFaceDetection<{}>>>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const detectionWithAgeAndGender = await faceapi.detectSingleFace(input).withFaceLandmarks().withAgeAndGender()
```
@ -225,13 +225,13 @@ const detectionWithAgeAndGender = await faceapi.detectSingleFace(input).withFace
Detect all faces without face alignment + estimate age and recognize gender of each face. Returns **Array<[WithAge<WithGender<WithFaceDetection<{}>>>](#getting-started-utility-classes)>**:
``` javascript
```js
const detectionsWithAgeAndGender = await faceapi.detectAllFaces(input).withAgeAndGender()
```
Detect the face with the highest confidence score without face alignment + estimate age and recognize gender for that face. Returns **[WithAge<WithGender<WithFaceDetection<{}>>>](#getting-started-utility-classes) | undefined**:
``` javascript
```js
const detectionWithAgeAndGender = await faceapi.detectSingleFace(input).withAgeAndGender()
```
@ -239,7 +239,7 @@ const detectionWithAgeAndGender = await faceapi.detectSingleFace(input).withAgeA
**Tasks can be composed as follows:**
``` javascript
```js
// all faces
await faceapi.detectAllFaces(input)
await faceapi.detectAllFaces(input).withFaceExpressions()
@ -265,7 +265,7 @@ To perform face recognition, one can use faceapi.FaceMatcher to compare referenc
First, we initialize the FaceMatcher with the reference data, for example we can simply detect faces in a **referenceImage** and match the descriptors of the detected faces to faces of subsequent images:
``` javascript
```js
const results = await faceapi
.detectAllFaces(referenceImage)
.withFaceLandmarks()
@ -282,7 +282,7 @@ const faceMatcher = new faceapi.FaceMatcher(results)
Now we can recognize a persons face shown in **queryImage1**:
``` javascript
```js
const singleResult = await faceapi
.detectSingleFace(queryImage1)
.withFaceLandmarks()
@ -296,7 +296,7 @@ if (singleResult) {
Or we can recognize all faces shown in **queryImage2**:
``` javascript
```js
const results = await faceapi
.detectAllFaces(queryImage2)
.withFaceLandmarks()
@ -310,7 +310,7 @@ results.forEach(fd => {
You can also create labeled reference descriptors as follows:
``` javascript
```js
const labeledDescriptors = [
new faceapi.LabeledFaceDescriptors(
'obama',
@ -331,7 +331,7 @@ const faceMatcher = new faceapi.FaceMatcher(labeledDescriptors)
Preparing the overlay canvas:
``` javascript
```js
const displaySize = { width: input.width, height: input.height }
// resize the overlay canvas to the input dimensions
const canvas = document.getElementById('overlay')
@ -340,7 +340,7 @@ faceapi.matchDimensions(canvas, displaySize)
face-api.js predefines some highlevel drawing functions, which you can utilize:
``` javascript
```js
/* Display detected face bounding boxes */
const detections = await faceapi.detectAllFaces(input)
// resize the detected boxes in case your displayed image has a different size than the original
@ -376,7 +376,7 @@ faceapi.draw.drawFaceExpressions(canvas, resizedResults, minProbability)
You can also draw boxes with custom text ([DrawBox](https://github.com/justadudewhohacks/tfjs-image-recognition-base/blob/master/src/draw/DrawBox.ts)):
``` javascript
```js
const box = { x: 50, y: 50, width: 100, height: 100 }
// see DrawBoxOptions below
const drawOptions = {
@ -389,7 +389,7 @@ drawBox.draw(document.getElementById('myCanvas'))
DrawBox drawing options:
``` javascript
```js
export interface IDrawBoxOptions {
boxColor?: string
lineWidth?: number
@ -400,7 +400,7 @@ export interface IDrawBoxOptions {
Finally you can draw custom text fields ([DrawTextField](https://github.com/justadudewhohacks/tfjs-image-recognition-base/blob/master/src/draw/DrawTextField.ts)):
``` javascript
```js
const text = [
'This is a textline!',
'This is another textline!'
@ -417,7 +417,7 @@ drawBox.draw(document.getElementById('myCanvas'))
DrawTextField drawing options:
``` javascript
```js
export interface IDrawTextFieldOptions {
anchorPosition?: AnchorPosition
backgroundColor?: string
@ -441,7 +441,7 @@ export enum AnchorPosition {
#### SsdMobilenetv1Options
``` javascript
```js
export interface ISsdMobilenetv1Options {
// minimum confidence threshold
// default: 0.5
@ -458,7 +458,7 @@ const options = new faceapi.SsdMobilenetv1Options({ minConfidence: 0.8 })
#### TinyFaceDetectorOptions
``` javascript
```js
export interface ITinyFaceDetectorOptions {
// size at which image is processed, the smaller the faster,
// but less precise in detecting smaller faces, must be divisible
@ -483,7 +483,7 @@ const options = new faceapi.TinyFaceDetectorOptions({ inputSize: 320 })
#### IBox
``` javascript
```js
export interface IBox {
x: number
y: number
@ -494,7 +494,7 @@ export interface IBox {
#### IFaceDetection
``` javascript
```js
export interface IFaceDetection {
score: number
box: Box
@ -503,7 +503,7 @@ export interface IFaceDetection {
#### IFaceLandmarks
``` javascript
```js
export interface IFaceLandmarks {
positions: Point[]
shift: Point
@ -512,7 +512,7 @@ export interface IFaceLandmarks {
#### WithFaceDetection
``` javascript
```js
export type WithFaceDetection<TSource> = TSource & {
detection: FaceDetection
}
@ -520,7 +520,7 @@ export type WithFaceDetection<TSource> = TSource & {
#### WithFaceLandmarks
``` javascript
```js
export type WithFaceLandmarks<TSource> = TSource & {
unshiftedLandmarks: FaceLandmarks
landmarks: FaceLandmarks
@ -533,7 +533,7 @@ export type WithFaceLandmarks<TSource> = TSource & {
#### WithFaceDescriptor
``` javascript
```js
export type WithFaceDescriptor<TSource> = TSource & {
descriptor: Float32Array
}
@ -541,7 +541,7 @@ export type WithFaceDescriptor<TSource> = TSource & {
#### WithFaceExpressions
``` javascript
```js
export type WithFaceExpressions<TSource> = TSource & {
expressions: FaceExpressions
}
@ -549,7 +549,7 @@ export type WithFaceExpressions<TSource> = TSource & {
#### WithAge
``` javascript
```js
export type WithAge<TSource> = TSource & {
age: number
}
@ -557,7 +557,7 @@ export type WithAge<TSource> = TSource & {
#### WithGender
``` javascript
```js
export type WithGender<TSource> = TSource & {
gender: Gender
genderProbability: number
@ -577,7 +577,7 @@ export enum Gender {
Instead of using the high level API, you can directly use the forward methods of each neural network:
``` javascript
```js
const detections1 = await faceapi.ssdMobilenetv1(input, options)
const detections2 = await faceapi.tinyFaceDetector(input, options)
const landmarks1 = await faceapi.detectFaceLandmarks(faceImage)
@ -587,7 +587,7 @@ const descriptor = await faceapi.computeFaceDescriptor(alignedFaceImage)
#### Extracting a Canvas for an Image Region
``` javascript
```js
const regionsToExtract = [
new faceapi.Rect(0, 0, 100, 100)
]
@ -598,7 +598,7 @@ const canvases = await faceapi.extractFaces(input, regionsToExtract)
#### Euclidean Distance
``` javascript
```js
// ment to be used for computing the euclidean distance between two face descriptors
const dist = faceapi.euclideanDistance([0, 0], [0, 10])
console.log(dist) // 10
@ -606,7 +606,7 @@ console.log(dist) // 10
#### Retrieve the Face Landmark Points and Contours
``` javascript
```js
const landmarkPositions = landmarks.positions
// or get the positions of individual contours,
@ -626,7 +626,7 @@ const rightEyeBrow = landmarks.getRightEyeBrow()
<img id="myImg" src="">
```
``` javascript
```js
const image = await faceapi.fetchImage('/images/example.png')
console.log(image instanceof HTMLImageElement) // true
@ -638,7 +638,7 @@ myImg.src = image.src
#### Fetching JSON
``` javascript
```js
const json = await faceapi.fetchJson('/files/example.json')
```
@ -649,7 +649,7 @@ const json = await faceapi.fetchJson('/files/example.json')
<input id="myFileUpload" type="file" onchange="uploadImage()" accept=".jpg, .jpeg, .png">
```
``` javascript
```js
async function uploadImage() {
const imgFile = document.getElementById('myFileUpload').files[0]
// create an HTMLImageElement from a Blob
@ -665,7 +665,7 @@ async function uploadImage() {
<video id="myVideo" src="media/example.mp4" />
```
``` javascript
```js
const canvas1 = faceapi.createCanvasFromMedia(document.getElementById('myImg'))
const canvas2 = faceapi.createCanvasFromMedia(document.getElementById('myVideo'))
```

0
example/facemesh.png → demo/facemesh.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

0
example/index.html → demo/index.html
View File

2
example/index.js → demo/index.js
View File

@ -6,7 +6,7 @@ const modelPath = 'https://vladmandic.github.io/face-api/model/'; // path to mod
const imgSize = 800; // maximum image size in pixels
const minScore = 0.3; // minimum score
const maxResults = 10; // maximum number of results to return
const samples = ['sample (1).jpg', 'sample (2).jpg', 'sample (3).jpg', 'sample (4).jpg', 'sample (5).jpg', 'sample (6).jpg']; // sample images to be loaded using http
const samples = ['sample1.jpg', 'sample2.jpg', 'sample3.jpg', 'sample4.jpg', 'sample5.jpg', 'sample6.jpg']; // sample images to be loaded using http
// helper function to pretty-print json object to string
function str(json) {

0
example/node-multiprocess-worker.js → demo/node-multiprocess-worker.js
View File

4
example/node-multiprocess.js → demo/node-multiprocess.js
View File

@ -7,7 +7,7 @@ const log = require('@vladmandic/pilogger'); // this is my simple logger with fe
const child_process = require('child_process');
// note that main process import faceapi or tfjs at all
const imgPathRoot = './example'; // modify to include your sample images
const imgPathRoot = './demo'; // modify to include your sample images
const numWorkers = 2; // how many workers will be started
const workers = []; // this holds worker processes
const images = []; // this holds queue of enumerated images
@ -58,7 +58,7 @@ async function main() {
// manage worker processes
for (let i = 0; i < numWorkers; i++) {
// create worker process
workers[i] = await child_process.fork('example/node-multiprocess-worker.js', ['special']);
workers[i] = await child_process.fork('demo/node-multiprocess-worker.js', ['special']);
// parse message that worker process sends back to main
// if message is ready, dispatch next image in queue
// if message is processing result, just print how many faces were detected

2
example/node-singleprocess.js → demo/node-singleprocess.js
View File

@ -10,7 +10,7 @@ const tf = require('@tensorflow/tfjs-node');
const faceapi = require('../dist/face-api.node.js'); // this is equivalent to '@vladmandic/faceapi'
const modelPathRoot = '../model';
const imgPathRoot = './example'; // modify to include your sample images
const imgPathRoot = './demo'; // modify to include your sample images
const minScore = 0.1;
const maxResults = 5;
let optionsSSDMobileNet;

0
example/sample (1).jpg → demo/sample1.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 141 KiB

0
example/sample (2).jpg → demo/sample2.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 178 KiB

After

Width:  |  Height:  |  Size: 178 KiB

0
example/sample (3).jpg → demo/sample3.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 216 KiB

After

Width:  |  Height:  |  Size: 216 KiB

0
example/sample (4).jpg → demo/sample4.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 206 KiB

After

Width:  |  Height:  |  Size: 206 KiB

0
example/sample (5).jpg → demo/sample5.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 162 KiB

After

Width:  |  Height:  |  Size: 162 KiB

0
example/sample (6).jpg → demo/sample6.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 295 KiB

After

Width:  |  Height:  |  Size: 295 KiB

0
example/screenshot.png → demo/screenshot-images.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 569 KiB

After

Width:  |  Height:  |  Size: 569 KiB

0
example/webcam.html → demo/webcam.html
View File

0
example/webcam.js → demo/webcam.js
View File

426
package-lock.json generated
View File

@ -29,6 +29,7 @@
"rimraf": "^3.0.2",
"simple-git": "^2.36.2",
"tslib": "^2.1.0",
"typedoc": "^0.20.31",
"typescript": "^4.2.3"
},
"engines": {
@ -813,6 +814,15 @@
"integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=",
"dev": true
},
"node_modules/at-least-node": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
"integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
"dev": true,
"engines": {
"node": ">= 4.0.0"
}
},
"node_modules/balanced-match": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
@ -976,6 +986,15 @@
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
"dev": true
},
"node_modules/colors": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz",
"integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==",
"dev": true,
"engines": {
"node": ">=0.1.90"
}
},
"node_modules/combined-stream": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
@ -1805,6 +1824,21 @@
"node": ">= 6"
}
},
"node_modules/fs-extra": {
"version": "9.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
"integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
"dev": true,
"dependencies": {
"at-least-node": "^1.0.0",
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
},
"engines": {
"node": ">=10"
}
},
"node_modules/fs-minipass": {
"version": "1.2.7",
"resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-1.2.7.tgz",
@ -1994,6 +2028,27 @@
"integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==",
"dev": true
},
"node_modules/handlebars": {
"version": "4.7.7",
"resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz",
"integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==",
"dev": true,
"dependencies": {
"minimist": "^1.2.5",
"neo-async": "^2.6.0",
"source-map": "^0.6.1",
"wordwrap": "^1.0.0"
},
"bin": {
"handlebars": "bin/handlebars"
},
"engines": {
"node": ">=0.4.7"
},
"optionalDependencies": {
"uglify-js": "^3.1.4"
}
},
"node_modules/has": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
@ -2147,6 +2202,15 @@
"integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==",
"dev": true
},
"node_modules/interpret": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz",
"integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==",
"dev": true,
"engines": {
"node": ">= 0.10"
}
},
"node_modules/is-arrayish": {
"version": "0.2.1",
"resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz",
@ -2395,6 +2459,18 @@
"integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==",
"dev": true
},
"node_modules/jsonfile": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
"integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
"dev": true,
"dependencies": {
"universalify": "^2.0.0"
},
"optionalDependencies": {
"graceful-fs": "^4.1.6"
}
},
"node_modules/levn": {
"version": "0.4.1",
"resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
@ -2454,6 +2530,24 @@
"node": ">=10"
}
},
"node_modules/lunr": {
"version": "2.3.9",
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
"dev": true
},
"node_modules/marked": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/marked/-/marked-2.0.1.tgz",
"integrity": "sha512-5+/fKgMv2hARmMW7DOpykr2iLhl0NgjyELk5yn92iE7z8Se1IS9n3UsFm86hFXIkvMBmVxki8+ckcpjBeyo/hw==",
"dev": true,
"bin": {
"marked": "bin/marked"
},
"engines": {
"node": ">= 8.16.2"
}
},
"node_modules/merge2": {
"version": "1.4.1",
"resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
@ -2590,6 +2684,12 @@
"ms": "^2.1.1"
}
},
"node_modules/neo-async": {
"version": "2.6.2",
"resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
"integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==",
"dev": true
},
"node_modules/node-fetch": {
"version": "2.6.1",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz",
@ -2819,6 +2919,30 @@
"wrappy": "1"
}
},
"node_modules/onigasm": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz",
"integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==",
"dev": true,
"dependencies": {
"lru-cache": "^5.1.1"
}
},
"node_modules/onigasm/node_modules/lru-cache": {
"version": "5.1.1",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz",
"integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==",
"dev": true,
"dependencies": {
"yallist": "^3.0.2"
}
},
"node_modules/onigasm/node_modules/yallist": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
"integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==",
"dev": true
},
"node_modules/optionator": {
"version": "0.9.1",
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz",
@ -3139,6 +3263,18 @@
"node": ">=8.10.0"
}
},
"node_modules/rechoir": {
"version": "0.6.2",
"resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
"integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
"dev": true,
"dependencies": {
"resolve": "^1.1.6"
},
"engines": {
"node": ">= 0.10"
}
},
"node_modules/regenerator-runtime": {
"version": "0.13.7",
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.7.tgz",
@ -3312,6 +3448,33 @@
"node": ">=8"
}
},
"node_modules/shelljs": {
"version": "0.8.4",
"resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
"integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
"dev": true,
"dependencies": {
"glob": "^7.0.0",
"interpret": "^1.0.0",
"rechoir": "^0.6.2"
},
"bin": {
"shjs": "bin/shjs"
},
"engines": {
"node": ">=4"
}
},
"node_modules/shiki": {
"version": "0.9.3",
"resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz",
"integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==",
"dev": true,
"dependencies": {
"onigasm": "^2.2.5",
"vscode-textmate": "^5.2.0"
}
},
"node_modules/signal-exit": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.3.tgz",
@ -3364,6 +3527,15 @@
"node": ">=8"
}
},
"node_modules/source-map": {
"version": "0.6.1",
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
"dev": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/spdx-correct": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
@ -3679,6 +3851,43 @@
"node": ">=8"
}
},
"node_modules/typedoc": {
"version": "0.20.31",
"resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.31.tgz",
"integrity": "sha512-36ADb6bdzmnGde6H3dlyMmof0y0ryRvSOhYh96bJHcYdJKipf5Ir4uduj+mZfshd8ktCGlLg48LfNTAE9PpIrQ==",
"dev": true,
"dependencies": {
"colors": "^1.4.0",
"fs-extra": "^9.1.0",
"handlebars": "^4.7.7",
"lodash": "^4.17.21",
"lunr": "^2.3.9",
"marked": "^2.0.1",
"minimatch": "^3.0.0",
"progress": "^2.0.3",
"shelljs": "^0.8.4",
"shiki": "^0.9.3",
"typedoc-default-themes": "^0.12.9"
},
"bin": {
"typedoc": "bin/typedoc"
},
"engines": {
"node": ">= 10.8.0"
},
"peerDependencies": {
"typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x"
}
},
"node_modules/typedoc-default-themes": {
"version": "0.12.9",
"resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.9.tgz",
"integrity": "sha512-Jd5fYTiqzinZdoIY382W7tQXTwAzWRdg8KbHfaxmb78m1/3jL9riXtk23oBOKwhi8GFVykCOdPzEJKY87/D0LQ==",
"dev": true,
"engines": {
"node": ">= 8"
}
},
"node_modules/typescript": {
"version": "4.2.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz",
@ -3692,6 +3901,19 @@
"node": ">=4.2.0"
}
},
"node_modules/uglify-js": {
"version": "3.13.1",
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.1.tgz",
"integrity": "sha512-EWhx3fHy3M9JbaeTnO+rEqzCe1wtyQClv6q3YWq0voOj4E+bMZBErVS1GAHPDiRGONYq34M1/d8KuQMgvi6Gjw==",
"dev": true,
"optional": true,
"bin": {
"uglifyjs": "bin/uglifyjs"
},
"engines": {
"node": ">=0.8.0"
}
},
"node_modules/unbox-primitive": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.0.tgz",
@ -3704,6 +3926,15 @@
"which-boxed-primitive": "^1.0.1"
}
},
"node_modules/universalify": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
"integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==",
"dev": true,
"engines": {
"node": ">= 10.0.0"
}
},
"node_modules/uri-js": {
"version": "4.4.1",
"resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
@ -3766,6 +3997,12 @@
"integrity": "sha512-u0Lw+IYlgbEJFF6/qAqG2d1jQmJl0eyAGJHoAJqr2HT4M2BNuQYSEiSE75f52pXHSJm8AlTjnLLbBFPrdz2hpA==",
"dev": true
},
"node_modules/vscode-textmate": {
"version": "5.2.0",
"resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz",
"integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==",
"dev": true
},
"node_modules/vscode-uri": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-2.1.2.tgz",
@ -3821,6 +4058,12 @@
"node": ">=0.10.0"
}
},
"node_modules/wordwrap": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
"integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=",
"dev": true
},
"node_modules/wrap-ansi": {
"version": "7.0.0",
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
@ -4529,6 +4772,12 @@
"integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=",
"dev": true
},
"at-least-node": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
"integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
"dev": true
},
"balanced-match": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
@ -4659,6 +4908,12 @@
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
"dev": true
},
"colors": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz",
"integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==",
"dev": true
},
"combined-stream": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
@ -5307,6 +5562,18 @@
"mime-types": "^2.1.12"
}
},
"fs-extra": {
"version": "9.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
"integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
"dev": true,
"requires": {
"at-least-node": "^1.0.0",
"graceful-fs": "^4.2.0",
"jsonfile": "^6.0.1",
"universalify": "^2.0.0"
}
},
"fs-minipass": {
"version": "1.2.7",
"resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-1.2.7.tgz",
@ -5457,6 +5724,19 @@
"integrity": "sha512-nTnJ528pbqxYanhpDYsi4Rd8MAeaBA67+RZ10CM1m3bTAVFEDcd5AuA4a6W5YkGZ1iNXHzZz8T6TBKLeBuNriQ==",
"dev": true
},
"handlebars": {
"version": "4.7.7",
"resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz",
"integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==",
"dev": true,
"requires": {
"minimist": "^1.2.5",
"neo-async": "^2.6.0",
"source-map": "^0.6.1",
"uglify-js": "^3.1.4",
"wordwrap": "^1.0.0"
}
},
"has": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz",
@ -5579,6 +5859,12 @@
"integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==",
"dev": true
},
"interpret": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz",
"integrity": "sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==",
"dev": true
},
"is-arrayish": {
"version": "0.2.1",
"resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz",
@ -5752,6 +6038,16 @@
"integrity": "sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==",
"dev": true
},
"jsonfile": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz",
"integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==",
"dev": true,
"requires": {
"graceful-fs": "^4.1.6",
"universalify": "^2.0.0"
}
},
"levn": {
"version": "0.4.1",
"resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz",
@ -5799,6 +6095,18 @@
"yallist": "^4.0.0"
}
},
"lunr": {
"version": "2.3.9",
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
"dev": true
},
"marked": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/marked/-/marked-2.0.1.tgz",
"integrity": "sha512-5+/fKgMv2hARmMW7DOpykr2iLhl0NgjyELk5yn92iE7z8Se1IS9n3UsFm86hFXIkvMBmVxki8+ckcpjBeyo/hw==",
"dev": true
},
"merge2": {
"version": "1.4.1",
"resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
@ -5915,6 +6223,12 @@
}
}
},
"neo-async": {
"version": "2.6.2",
"resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
"integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==",
"dev": true
},
"node-fetch": {
"version": "2.6.1",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz",
@ -6099,6 +6413,32 @@
"wrappy": "1"
}
},
"onigasm": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz",
"integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==",
"dev": true,
"requires": {
"lru-cache": "^5.1.1"
},
"dependencies": {
"lru-cache": {
"version": "5.1.1",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz",
"integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==",
"dev": true,
"requires": {
"yallist": "^3.0.2"
}
},
"yallist": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz",
"integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==",
"dev": true
}
}
},
"optionator": {
"version": "0.9.1",
"resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz",
@ -6334,6 +6674,15 @@
"picomatch": "^2.2.1"
}
},
"rechoir": {
"version": "0.6.2",
"resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
"integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
"dev": true,
"requires": {
"resolve": "^1.1.6"
}
},
"regenerator-runtime": {
"version": "0.13.7",
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.7.tgz",
@ -6453,6 +6802,27 @@
"integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
"dev": true
},
"shelljs": {
"version": "0.8.4",
"resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
"integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
"dev": true,
"requires": {
"glob": "^7.0.0",
"interpret": "^1.0.0",
"rechoir": "^0.6.2"
}
},
"shiki": {
"version": "0.9.3",
"resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz",
"integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==",
"dev": true,
"requires": {
"onigasm": "^2.2.5",
"vscode-textmate": "^5.2.0"
}
},
"signal-exit": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.3.tgz",
@ -6495,6 +6865,12 @@
}
}
},
"source-map": {
"version": "0.6.1",
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
"dev": true
},
"spdx-correct": {
"version": "3.1.1",
"resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz",
@ -6757,12 +7133,44 @@
"integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==",
"dev": true
},
"typedoc": {
"version": "0.20.31",
"resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.31.tgz",
"integrity": "sha512-36ADb6bdzmnGde6H3dlyMmof0y0ryRvSOhYh96bJHcYdJKipf5Ir4uduj+mZfshd8ktCGlLg48LfNTAE9PpIrQ==",
"dev": true,
"requires": {
"colors": "^1.4.0",
"fs-extra": "^9.1.0",
"handlebars": "^4.7.7",
"lodash": "^4.17.21",
"lunr": "^2.3.9",
"marked": "^2.0.1",
"minimatch": "^3.0.0",
"progress": "^2.0.3",
"shelljs": "^0.8.4",
"shiki": "^0.9.3",
"typedoc-default-themes": "^0.12.9"
}
},
"typedoc-default-themes": {
"version": "0.12.9",
"resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.9.tgz",
"integrity": "sha512-Jd5fYTiqzinZdoIY382W7tQXTwAzWRdg8KbHfaxmb78m1/3jL9riXtk23oBOKwhi8GFVykCOdPzEJKY87/D0LQ==",
"dev": true
},
"typescript": {
"version": "4.2.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz",
"integrity": "sha512-qOcYwxaByStAWrBf4x0fibwZvMRG+r4cQoTjbPtUlrWjBHbmCAww1i448U0GJ+3cNNEtebDteo/cHOR3xJ4wEw==",
"dev": true
},
"uglify-js": {
"version": "3.13.1",
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.13.1.tgz",
"integrity": "sha512-EWhx3fHy3M9JbaeTnO+rEqzCe1wtyQClv6q3YWq0voOj4E+bMZBErVS1GAHPDiRGONYq34M1/d8KuQMgvi6Gjw==",
"dev": true,
"optional": true
},
"unbox-primitive": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.0.tgz",
@ -6775,6 +7183,12 @@
"which-boxed-primitive": "^1.0.1"
}
},
"universalify": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz",
"integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==",
"dev": true
},
"uri-js": {
"version": "4.4.1",
"resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz",
@ -6837,6 +7251,12 @@
"integrity": "sha512-u0Lw+IYlgbEJFF6/qAqG2d1jQmJl0eyAGJHoAJqr2HT4M2BNuQYSEiSE75f52pXHSJm8AlTjnLLbBFPrdz2hpA==",
"dev": true
},
"vscode-textmate": {
"version": "5.2.0",
"resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz",
"integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==",
"dev": true
},
"vscode-uri": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-2.1.2.tgz",
@ -6880,6 +7300,12 @@
"integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
"dev": true
},
"wordwrap": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
"integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=",
"dev": true
},
"wrap-ansi": {
"version": "7.0.0",
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",

11
package.json
View File

@ -11,7 +11,7 @@
"bugs": {
"url": "https://github.com/vladmandic/face-api/issues"
},
"homepage": "https://vladmandic.github.io/face-api/example/webcam.html",
"homepage": "https://vladmandic.github.io/face-api/demo/webcam.html",
"license": "MIT",
"engines": {
"node": ">=12.0.0"
@ -21,11 +21,11 @@
"url": "git+https://github.com/vladmandic/face-api.git"
},
"scripts": {
"start": "node --trace-warnings example/node-singleprocess.js",
"start": "node --trace-warnings demo/node-singleprocess.js",
"dev": "npm install && node server/serve.js",
"build": "rimraf dist/* types/* && node server/build.js && node server/changelog.js",
"lint": "eslint src/**/* example/*.js server/*.js",
"test": "eslint src/**/* example/*.js server/*.js"
"build": "rimraf dist/* types/* typedoc/* && node server/build.js",
"lint": "eslint src/**/* demo/*.js server/*.js",
"test": "eslint src/**/* demo/*.js server/*.js"
},
"keywords": [
"tensorflow",
@ -60,6 +60,7 @@
"rimraf": "^3.0.2",
"simple-git": "^2.36.2",
"tslib": "^2.1.0",
"typedoc": "^0.20.31",
"typescript": "^4.2.3"
}
}

26
server/build.js
View File

@ -7,6 +7,8 @@
const esbuild = require('esbuild');
const ts = require('typescript');
const log = require('@vladmandic/pilogger');
const TypeDoc = require('typedoc');
const changelog = require('./changelog');
const banner = { js: `
/*
@ -16,6 +18,8 @@ const banner = { js: `
*/
` };
let td = null;
// tsc configuration
const tsconfig = {
noEmitOnError: false,
@ -185,8 +189,20 @@ function compile(fileNames, options) {
}
}
async function typedoc(entryPoint) {
log.info('Generate TypeDocs:', entryPoint);
if (!td) {
td = new TypeDoc.Application();
td.options.addReader(new TypeDoc.TSConfigReader());
td.bootstrap({ entryPoints: entryPoint });
}
const project = td.convert();
const result = project ? await td.generateDocs(project, 'typedoc') : null;
if (result) log.warn('TypeDoc:', result);
}
// rebuild on file change
async function build(f, msg) {
async function build(f, msg, dev = false) {
log.info('Build: file', msg, f, 'target:', common.target);
try {
// rebuild all target groups and types
@ -206,8 +222,12 @@ async function build(f, msg) {
if (require.main === module) process.exit(1);
}
// generate typings
compile(targets.browserBundle.esm.entryPoints, tsconfig);
if (!dev) {
// generate typings & typedoc only when run as explict build
await compile(targets.browserBundle.esm.entryPoints, tsconfig);
await changelog.update('../CHANGELOG.md');
await typedoc(targets.browserBundle.esm.entryPoints);
}
if (require.main === module) process.exit(0);
}

14
server/changelog.js
View File

@ -48,15 +48,11 @@ async function update(f) {
const name = path.join(__dirname, f);
fs.writeFileSync(name, text);
logger.state('Change log updated:', name);
logger.info('Update Change log:', [name]);
}
exports.update = update;
try {
if (require.main === module) {
update('../CHANGELOG.md');
}
} catch {
//
if (require.main === module) {
update('../CHANGELOG.md');
} else {
exports.update = update;
}

8
server/serve.js
View File

@ -27,12 +27,12 @@ const options = {
key: fs.readFileSync('server/https.key'),
cert: fs.readFileSync('server/https.crt'),
root: '..',
default: 'example/index.html',
default: 'demo/index.html',
httpPort: 8000,
httpsPort: 8001,
insecureHTTPParser: false,
minElapsed: 2,
monitor: ['package.json', 'example', 'src'],
monitor: ['package.json', 'demo', 'src'],
};
// just some predefined mime types
@ -58,7 +58,7 @@ const mime = {
let last = Date.now();
async function buildAll(evt, msg) {
const now = Date.now();
if ((now - last) > options.minElapsed) build.build(evt, msg);
if ((now - last) > options.minElapsed) build.build(evt, msg, true);
else log.state('Build: merge event file', msg, evt);
last = now;
}
@ -156,7 +156,7 @@ async function main() {
server2.on('listening', () => log.state('HTTP2 server listening:', options.httpsPort));
server2.listen(options.httpsPort);
}
await build.build('all', 'startup');
await build.build('all', 'startup', true);
}
main();

15
tsconfig.json
View File

@ -23,4 +23,19 @@
},
"formatCodeOptions": { "indentSize": 2, "tabSize": 2 },
"include": ["src"],
"typedocOptions": {
"excludePrivate": true,
"excludeExternals": true,
"excludeProtected": true,
"excludeInternal": true,
"disableSources": false,
"gitRevision": "main",
"hideGenerator": "true",
"theme": "default",
"readme": "none",
"out": "typedoc",
"entryPoints": "src/index.ts",
"logLevel": "Error",
"logger": "none"
}
}

2660
typedoc/assets/css/main.css Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
typedoc/assets/images/icons.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.4 KiB

BIN
typedoc/assets/images/icons@2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
typedoc/assets/images/widgets.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 480 B

BIN
typedoc/assets/images/widgets@2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 855 B

248
typedoc/assets/js/main.js Normal file
View File

File diff suppressed because one or more lines are too long

1
typedoc/assets/js/search.js Normal file
View File

File diff suppressed because one or more lines are too long

825
typedoc/classes/agegendernet.html Normal file
View File

@ -0,0 +1,825 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AgeGenderNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="agegendernet.html">AgeGenderNet</a>
</li>
</ul>
<h1>Class AgeGenderNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">AgeGenderNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="agegendernet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="agegendernet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="agegendernet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#predictageandgender" class="tsd-kind-icon">predict<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="agegendernet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="agegendernet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Age<wbr>Gender<wbr>Net<span class="tsd-signature-symbol">(</span>faceFeatureExtractor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TinyXception</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="agegendernet.html" class="tsd-signature-type" data-tsd-kind="Class">AgeGenderNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L15">ageGenderNet/AgeGenderNet.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceFeatureExtractor: <span class="tsd-signature-type">TinyXception</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="agegendernet.html" class="tsd-signature-type" data-tsd-kind="Class">AgeGenderNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="facefeatureextractor" class="tsd-anchor"></a>
<h3>face<wbr>Feature<wbr>Extractor</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> faceFeatureExtractor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TinyXception</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L22">ageGenderNet/AgeGenderNet.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TinyXception</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L90">ageGenderNet/AgeGenderNet.ts:90</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L101">ageGenderNet/AgeGenderNet.ts:101</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><a href="../index.html#netparams" class="tsd-signature-type" data-tsd-kind="Type alias">NetParams</a></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#extractweights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L52">ageGenderNet/AgeGenderNet.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L45">ageGenderNet/AgeGenderNet.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getfrozenparams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamfrompath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamlist">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#gettrainableparams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loadclassifierparams" class="tsd-anchor"></a>
<h3>load<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L95">ageGenderNet/AgeGenderNet.ts:95</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromdisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromuri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromweightmap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="predictageandgender" class="tsd-anchor"></a>
<h3>predict<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">predict<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L56">ageGenderNet/AgeGenderNet.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#ageandgenderprediction" class="tsd-signature-type" data-tsd-kind="Type alias">AgeAndGenderPrediction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#reassignparamfrompath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/AgeGenderNet.ts#L26">ageGenderNet/AgeGenderNet.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#netoutput" class="tsd-signature-type" data-tsd-kind="Type alias">NetOutput</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#serializeparams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="agegendernet.html" class="tsd-kind-icon">Age<wbr>Gender<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="agegendernet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="agegendernet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="agegendernet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#predictageandgender" class="tsd-kind-icon">predict<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="agegendernet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="agegendernet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

824
typedoc/classes/boundingbox.html Normal file
View File

@ -0,0 +1,824 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BoundingBox | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="boundingbox.html">BoundingBox</a>
</li>
</ul>
<h1>Class BoundingBox</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">BoundingBox</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="boundingbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#calibrate" class="tsd-kind-icon">calibrate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#pad" class="tsd-kind-icon">pad</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#rescale" class="tsd-kind-icon">rescale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#round" class="tsd-kind-icon">round</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#shift" class="tsd-kind-icon">shift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="boundingbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="boundingbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="boundingbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Bounding<wbr>Box<span class="tsd-signature-symbol">(</span>left<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, top<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, right<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bottom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="box.html">Box</a>.<a href="box.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/BoundingBox.ts#L10">classes/BoundingBox.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>left: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>top: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>right: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>bottom: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L70">classes/Box.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#bottom">bottom</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L68">classes/Box.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomleft" class="tsd-anchor"></a>
<h3>bottom<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L76">classes/Box.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomright" class="tsd-anchor"></a>
<h3>bottom<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L78">classes/Box.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L60">classes/Box.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#left">left</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L62">classes/Box.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#right">right</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L66">classes/Box.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#top">top</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L64">classes/Box.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topleft" class="tsd-anchor"></a>
<h3>top<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L72">classes/Box.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topright" class="tsd-anchor"></a>
<h3>top<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L74">classes/Box.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L58">classes/Box.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L54">classes/Box.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L56">classes/Box.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="calibrate" class="tsd-anchor"></a>
<h3>calibrate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">calibrate<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#calibrate">calibrate</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L201">classes/Box.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>region: <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="clipatimageborders" class="tsd-anchor"></a>
<h3>clip<wbr>AtImage<wbr>Borders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">clip<wbr>AtImage<wbr>Borders<span class="tsd-signature-symbol">(</span>imgWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imgHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#clipatimageborders">clipAtImageBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L138">classes/Box.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imgWidth: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imgHeight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#floor">floor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L88">classes/Box.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="pad" class="tsd-anchor"></a>
<h3>pad</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<span class="tsd-signature-symbol">(</span>padX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, padY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#pad">pad</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L126">classes/Box.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>padX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>padY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="padatborders" class="tsd-anchor"></a>
<h3>pad<wbr>AtBorders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<wbr>AtBorders<span class="tsd-signature-symbol">(</span>imageHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imageWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#padatborders">padAtBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L165">classes/Box.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imageHeight: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imageWidth: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="rescale" class="tsd-anchor"></a>
<h3>rescale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">rescale<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#rescale">rescale</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L115">classes/Box.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#round">round</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L80">classes/Box.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#shift">shift</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L155">classes/Box.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="tosquare" class="tsd-anchor"></a>
<h3>to<wbr>Square</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Square<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#tosquare">toSquare</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L96">classes/Box.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="assertisvalidbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#assertisvalidbox">assertIsValidBox</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L12">classes/Box.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="isrect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Rect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>Rect<span class="tsd-signature-symbol">(</span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#isrect">isRect</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L8">classes/Box.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="boundingbox.html" class="tsd-kind-icon">Bounding<wbr>Box</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="boundingbox.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#top" class="tsd-kind-icon">top</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#calibrate" class="tsd-kind-icon">calibrate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#pad" class="tsd-kind-icon">pad</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#rescale" class="tsd-kind-icon">rescale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#round" class="tsd-kind-icon">round</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="boundingbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="boundingbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="boundingbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

828
typedoc/classes/box.html Normal file
View File

@ -0,0 +1,828 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Box | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="box.html">Box</a>
</li>
</ul>
<h1>Class Box&lt;BoxType&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>BoxType = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Box</span>
<ul class="tsd-hierarchy">
<li>
<a href="boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a>
</li>
<li>
<a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a>
</li>
<li>
<a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a></li>
<li><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="box.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#topleft" class="tsd-kind-icon">top<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#topright" class="tsd-kind-icon">top<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="box.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#calibrate" class="tsd-kind-icon">calibrate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#pad" class="tsd-kind-icon">pad</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#rescale" class="tsd-kind-icon">rescale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#round" class="tsd-kind-icon">round</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#shift" class="tsd-kind-icon">shift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="box.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="box.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="box.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">new <wbr>Box&lt;BoxType&gt;<span class="tsd-signature-symbol">(</span>_box<span class="tsd-signature-symbol">: </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L28">classes/Box.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>BoxType = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>_box: <a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L70">classes/Box.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#bottom">bottom</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L68">classes/Box.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="bottomleft" class="tsd-anchor"></a>
<h3>bottom<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L76">classes/Box.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="bottomright" class="tsd-anchor"></a>
<h3>bottom<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L78">classes/Box.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#height">height</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L60">classes/Box.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#left">left</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L62">classes/Box.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#right">right</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L66">classes/Box.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iboundingbox.html">IBoundingBox</a>.<a href="../interfaces/iboundingbox.html#top">top</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L64">classes/Box.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="topleft" class="tsd-anchor"></a>
<h3>top<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L72">classes/Box.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="topright" class="tsd-anchor"></a>
<h3>top<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L74">classes/Box.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#width">width</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L58">classes/Box.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#x">x</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L54">classes/Box.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#y">y</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L56">classes/Box.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="calibrate" class="tsd-anchor"></a>
<h3>calibrate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">calibrate<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L201">classes/Box.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>region: <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clipatimageborders" class="tsd-anchor"></a>
<h3>clip<wbr>AtImage<wbr>Borders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clip<wbr>AtImage<wbr>Borders<span class="tsd-signature-symbol">(</span>imgWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imgHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L138">classes/Box.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imgWidth: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imgHeight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L88">classes/Box.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pad" class="tsd-anchor"></a>
<h3>pad</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pad<span class="tsd-signature-symbol">(</span>padX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, padY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L126">classes/Box.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>padX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>padY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="padatborders" class="tsd-anchor"></a>
<h3>pad<wbr>AtBorders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pad<wbr>AtBorders<span class="tsd-signature-symbol">(</span>imageHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imageWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L165">classes/Box.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imageHeight: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imageWidth: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rescale" class="tsd-anchor"></a>
<h3>rescale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">rescale<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L115">classes/Box.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L80">classes/Box.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L155">classes/Box.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tosquare" class="tsd-anchor"></a>
<h3>to<wbr>Square</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>Square<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L96">classes/Box.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BoxType</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="assertisvalidbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L12">classes/Box.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="isrect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Rect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>Rect<span class="tsd-signature-symbol">(</span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L8">classes/Box.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="box.html" class="tsd-kind-icon">Box</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a href="box.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#top" class="tsd-kind-icon">top</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#topleft" class="tsd-kind-icon">top<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#topright" class="tsd-kind-icon">top<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="box.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#calibrate" class="tsd-kind-icon">calibrate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#pad" class="tsd-kind-icon">pad</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#rescale" class="tsd-kind-icon">rescale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#round" class="tsd-kind-icon">round</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="box.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="box.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="box.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

257
typedoc/classes/composabletask.html Normal file
View File

@ -0,0 +1,257 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ComposableTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="composabletask.html">ComposableTask</a>
</li>
</ul>
<h1>Class ComposableTask&lt;T&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ComposableTask</span>
<ul class="tsd-hierarchy">
<li>
<a href="computefacedescriptorstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeFaceDescriptorsTaskBase</a>
</li>
<li>
<a href="detectfacestaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFacesTaskBase</a>
</li>
<li>
<a href="detectfacelandmarkstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFaceLandmarksTaskBase</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="composabletask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="composabletask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="composabletask.html#then" class="tsd-kind-icon">then</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">new <wbr>Composable<wbr>Task&lt;T&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L9">globalApi/ComposableTask.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">T</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="composabletask.html" class="tsd-kind-icon">Composable<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a href="composabletask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="composabletask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="composabletask.html#then" class="tsd-kind-icon">then</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

308
typedoc/classes/computeallfacedescriptorstask.html Normal file
View File

@ -0,0 +1,308 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ComputeAllFaceDescriptorsTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="computeallfacedescriptorstask.html">ComputeAllFaceDescriptorsTask</a>
</li>
</ul>
<h1>Class ComputeAllFaceDescriptorsTask&lt;TSource&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="computefacedescriptorstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeFaceDescriptorsTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ComputeAllFaceDescriptorsTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="computeallfacedescriptorstask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="computeallfacedescriptorstask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="computeallfacedescriptorstask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="computeallfacedescriptorstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="computeallfacedescriptorstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Compute<wbr>All<wbr>Face<wbr>Descriptors<wbr>Task&lt;TSource&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="computeallfacedescriptorstask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeAllFaceDescriptorsTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L18">globalApi/ComputeFaceDescriptorsTasks.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="computeallfacedescriptorstask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeAllFaceDescriptorsTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L32">globalApi/ComputeFaceDescriptorsTasks.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L50">globalApi/ComputeFaceDescriptorsTasks.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L46">globalApi/ComputeFaceDescriptorsTasks.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="computeallfacedescriptorstask.html" class="tsd-kind-icon">Compute<wbr>All<wbr>Face<wbr>Descriptors<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="computeallfacedescriptorstask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="computeallfacedescriptorstask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="computeallfacedescriptorstask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="computeallfacedescriptorstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="computeallfacedescriptorstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

280
typedoc/classes/computefacedescriptorstaskbase.html Normal file
View File

@ -0,0 +1,280 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ComputeFaceDescriptorsTaskBase | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>
</li>
</ul>
<h1>Class ComputeFaceDescriptorsTaskBase&lt;TReturn, TParentReturn&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
<li>
<h4>TParentReturn</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ComputeFaceDescriptorsTaskBase</span>
<ul class="tsd-hierarchy">
<li>
<a href="computeallfacedescriptorstask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeAllFaceDescriptorsTask</a>
</li>
<li>
<a href="computesinglefacedescriptortask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeSingleFaceDescriptorTask</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="computefacedescriptorstaskbase.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="computefacedescriptorstaskbase.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="computefacedescriptorstaskbase.html#then" class="tsd-kind-icon">then</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Compute<wbr>Face<wbr>Descriptors<wbr>Task<wbr>Base&lt;TReturn, TParentReturn&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="computefacedescriptorstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeFaceDescriptorsTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L18">globalApi/ComputeFaceDescriptorsTasks.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
<li>
<h4>TParentReturn</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="computefacedescriptorstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeFaceDescriptorsTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L9">globalApi/ComposableTask.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">TReturn</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="computefacedescriptorstaskbase.html" class="tsd-kind-icon">Compute<wbr>Face<wbr>Descriptors<wbr>Task<wbr>Base</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a href="computefacedescriptorstaskbase.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="computefacedescriptorstaskbase.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="computefacedescriptorstaskbase.html#then" class="tsd-kind-icon">then</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

308
typedoc/classes/computesinglefacedescriptortask.html Normal file
View File

@ -0,0 +1,308 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ComputeSingleFaceDescriptorTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="computesinglefacedescriptortask.html">ComputeSingleFaceDescriptorTask</a>
</li>
</ul>
<h1>Class ComputeSingleFaceDescriptorTask&lt;TSource&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="computefacedescriptorstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeFaceDescriptorsTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ComputeSingleFaceDescriptorTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="computesinglefacedescriptortask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="computesinglefacedescriptortask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="computesinglefacedescriptortask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="computesinglefacedescriptortask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="computesinglefacedescriptortask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Compute<wbr>Single<wbr>Face<wbr>Descriptor<wbr>Task&lt;TSource&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="computesinglefacedescriptortask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeSingleFaceDescriptorTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L18">globalApi/ComputeFaceDescriptorsTasks.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="computesinglefacedescriptortask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeSingleFaceDescriptorTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L58">globalApi/ComputeFaceDescriptorsTasks.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="computefacedescriptorstaskbase.html">ComputeFaceDescriptorsTaskBase</a>.<a href="computefacedescriptorstaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L79">globalApi/ComputeFaceDescriptorsTasks.ts:79</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComputeFaceDescriptorsTasks.ts#L75">globalApi/ComputeFaceDescriptorsTasks.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedescriptor" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDescriptor</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="computesinglefacedescriptortask.html" class="tsd-kind-icon">Compute<wbr>Single<wbr>Face<wbr>Descriptor<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="computesinglefacedescriptortask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="computesinglefacedescriptortask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="computesinglefacedescriptortask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="computesinglefacedescriptortask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="computesinglefacedescriptortask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

332
typedoc/classes/detectallfacelandmarkstask.html Normal file
View File

@ -0,0 +1,332 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectAllFaceLandmarksTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectallfacelandmarkstask.html">DetectAllFaceLandmarksTask</a>
</li>
</ul>
<h1>Class DetectAllFaceLandmarksTask&lt;TSource&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="detectfacelandmarkstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFaceLandmarksTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectAllFaceLandmarksTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="detectallfacelandmarkstask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="detectallfacelandmarkstask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectallfacelandmarkstask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacelandmarkstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacelandmarkstask.html#withfacedescriptors" class="tsd-kind-icon">with<wbr>Face<wbr>Descriptors</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacelandmarkstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>All<wbr>Face<wbr>Landmarks<wbr>Task&lt;TSource&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, useTinyLandmarkNet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectallfacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L22">globalApi/DetectFaceLandmarksTasks.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>useTinyLandmarkNet: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectallfacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L44">globalApi/DetectFaceLandmarksTasks.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L65">globalApi/DetectFaceLandmarksTasks.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfacedescriptors" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Descriptors</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Descriptors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="computeallfacedescriptorstask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeAllFaceDescriptorsTask</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L69">globalApi/DetectFaceLandmarksTasks.ts:69</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="computeallfacedescriptorstask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeAllFaceDescriptorsTask</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L61">globalApi/DetectFaceLandmarksTasks.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="detectallfacelandmarkstask.html" class="tsd-kind-icon">Detect<wbr>All<wbr>Face<wbr>Landmarks<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="detectallfacelandmarkstask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="detectallfacelandmarkstask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectallfacelandmarkstask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacelandmarkstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacelandmarkstask.html#withfacedescriptors" class="tsd-kind-icon">with<wbr>Face<wbr>Descriptors</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacelandmarkstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

321
typedoc/classes/detectallfacestask.html Normal file
View File

@ -0,0 +1,321 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectAllFacesTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectallfacestask.html">DetectAllFacesTask</a>
</li>
</ul>
<h1>Class DetectAllFacesTask</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="detectfacestaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFacesTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectAllFacesTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="detectallfacestask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="detectallfacestask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectallfacestask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacestask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacestask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectallfacestask.html#withfacelandmarks" class="tsd-kind-icon">with<wbr>Face<wbr>Landmarks</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>All<wbr>Faces<wbr>Task<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectallfacestask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFacesTask</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L15">globalApi/DetectFacesTasks.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectallfacestask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFacesTask</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L27">globalApi/DetectFacesTasks.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllAgeAndGenderTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L62">globalApi/DetectFacesTasks.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllAgeAndGenderTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictAllFaceExpressionsTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L55">globalApi/DetectFacesTasks.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictAllFaceExpressionsTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfacelandmarks" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Landmarks<span class="tsd-signature-symbol">(</span>useTinyLandmarkNet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectallfacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L47">globalApi/DetectFacesTasks.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>useTinyLandmarkNet: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectallfacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="detectallfacestask.html" class="tsd-kind-icon">Detect<wbr>All<wbr>Faces<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="detectallfacestask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="detectallfacestask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectallfacestask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacestask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacestask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectallfacestask.html#withfacelandmarks" class="tsd-kind-icon">with<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

283
typedoc/classes/detectfacelandmarkstaskbase.html Normal file
View File

@ -0,0 +1,283 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectFaceLandmarksTaskBase | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>
</li>
</ul>
<h1>Class DetectFaceLandmarksTaskBase&lt;TReturn, TParentReturn&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
<li>
<h4>TParentReturn</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectFaceLandmarksTaskBase</span>
<ul class="tsd-hierarchy">
<li>
<a href="detectallfacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFaceLandmarksTask</a>
</li>
<li>
<a href="detectsinglefacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceLandmarksTask</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="detectfacelandmarkstaskbase.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectfacelandmarkstaskbase.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectfacelandmarkstaskbase.html#then" class="tsd-kind-icon">then</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>Face<wbr>Landmarks<wbr>Task<wbr>Base&lt;TReturn, TParentReturn&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, useTinyLandmarkNet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectfacelandmarkstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFaceLandmarksTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L22">globalApi/DetectFaceLandmarksTasks.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
<li>
<h4>TParentReturn</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>useTinyLandmarkNet: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectfacelandmarkstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFaceLandmarksTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TParentReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L9">globalApi/ComposableTask.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">TReturn</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="detectfacelandmarkstaskbase.html" class="tsd-kind-icon">Detect<wbr>Face<wbr>Landmarks<wbr>Task<wbr>Base</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a href="detectfacelandmarkstaskbase.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectfacelandmarkstaskbase.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectfacelandmarkstaskbase.html#then" class="tsd-kind-icon">then</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

274
typedoc/classes/detectfacestaskbase.html Normal file
View File

@ -0,0 +1,274 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectFacesTaskBase | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectfacestaskbase.html">DetectFacesTaskBase</a>
</li>
</ul>
<h1>Class DetectFacesTaskBase&lt;TReturn&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectFacesTaskBase</span>
<ul class="tsd-hierarchy">
<li>
<a href="detectallfacestask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectAllFacesTask</a>
</li>
<li>
<a href="detectsinglefacetask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceTask</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="detectfacestaskbase.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectfacestaskbase.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectfacestaskbase.html#then" class="tsd-kind-icon">then</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>Faces<wbr>Task<wbr>Base&lt;TReturn&gt;<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectfacestaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFacesTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L15">globalApi/DetectFacesTasks.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TReturn</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectfacestaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFacesTaskBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L9">globalApi/ComposableTask.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="composabletask.html">ComposableTask</a>.<a href="composabletask.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">TReturn</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TReturn</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="detectfacestaskbase.html" class="tsd-kind-icon">Detect<wbr>Faces<wbr>Task<wbr>Base</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a href="detectfacestaskbase.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectfacestaskbase.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectfacestaskbase.html#then" class="tsd-kind-icon">then</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

332
typedoc/classes/detectsinglefacelandmarkstask.html Normal file
View File

@ -0,0 +1,332 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectSingleFaceLandmarksTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectsinglefacelandmarkstask.html">DetectSingleFaceLandmarksTask</a>
</li>
</ul>
<h1>Class DetectSingleFaceLandmarksTask&lt;TSource&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="detectfacelandmarkstaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFaceLandmarksTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectSingleFaceLandmarksTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="detectsinglefacelandmarkstask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="detectsinglefacelandmarkstask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectsinglefacelandmarkstask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacelandmarkstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacelandmarkstask.html#withfacedescriptor" class="tsd-kind-icon">with<wbr>Face<wbr>Descriptor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacelandmarkstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>Single<wbr>Face<wbr>Landmarks<wbr>Task&lt;TSource&gt;<span class="tsd-signature-symbol">(</span>parentTask<span class="tsd-signature-symbol">: </span><a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span>, input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, useTinyLandmarkNet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectsinglefacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L22">globalApi/DetectFaceLandmarksTasks.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parentTask: <a href="composabletask.html" class="tsd-signature-type" data-tsd-kind="Class">ComposableTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>useTinyLandmarkNet: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectsinglefacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L77">globalApi/DetectFaceLandmarksTasks.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacelandmarkstaskbase.html">DetectFaceLandmarksTaskBase</a>.<a href="detectfacelandmarkstaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L99">globalApi/DetectFaceLandmarksTasks.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleAgeAndGenderWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfacedescriptor" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Descriptor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Descriptor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="computesinglefacedescriptortask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeSingleFaceDescriptorTask</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L103">globalApi/DetectFaceLandmarksTasks.ts:103</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="computesinglefacedescriptortask.html" class="tsd-signature-type" data-tsd-kind="Class">ComputeSingleFaceDescriptorTask</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFaceLandmarksTasks.ts#L95">globalApi/DetectFaceLandmarksTasks.ts:95</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleFaceExpressionsWithFaceAlignmentTask</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="detectsinglefacelandmarkstask.html" class="tsd-kind-icon">Detect<wbr>Single<wbr>Face<wbr>Landmarks<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="detectsinglefacelandmarkstask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="detectsinglefacelandmarkstask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectsinglefacelandmarkstask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacelandmarkstask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacelandmarkstask.html#withfacedescriptor" class="tsd-kind-icon">with<wbr>Face<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacelandmarkstask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

321
typedoc/classes/detectsinglefacetask.html Normal file
View File

@ -0,0 +1,321 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DetectSingleFaceTask | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="detectsinglefacetask.html">DetectSingleFaceTask</a>
</li>
</ul>
<h1>Class DetectSingleFaceTask</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="detectfacestaskbase.html" class="tsd-signature-type" data-tsd-kind="Class">DetectFacesTaskBase</a><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">DetectSingleFaceTask</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="detectsinglefacetask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="detectsinglefacetask.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="detectsinglefacetask.html#then" class="tsd-kind-icon">then</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacetask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacetask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="detectsinglefacetask.html#withfacelandmarks" class="tsd-kind-icon">with<wbr>Face<wbr>Landmarks</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Detect<wbr>Single<wbr>Face<wbr>Task<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectsinglefacetask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceTask</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L15">globalApi/DetectFacesTasks.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../index.html#facedetectionoptions" class="tsd-signature-type" data-tsd-kind="Type alias">FaceDetectionOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectsinglefacetask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceTask</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L71">globalApi/DetectFacesTasks.ts:71</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="then" class="tsd-anchor"></a>
<h3>then</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">then<span class="tsd-signature-symbol">(</span>onfulfilled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="detectfacestaskbase.html">DetectFacesTaskBase</a>.<a href="detectfacestaskbase.html#then">then</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/ComposableTask.ts#L2">globalApi/ComposableTask.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>onfulfilled: <span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PromiseLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withageandgender" class="tsd-anchor"></a>
<h3>with<wbr>Age<wbr>And<wbr>Gender</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleAgeAndGenderTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L103">globalApi/DetectFacesTasks.ts:103</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleAgeAndGenderTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfaceexpressions" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PredictSingleFaceExpressionsTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L96">globalApi/DetectFacesTasks.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PredictSingleFaceExpressionsTask</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="withfacelandmarks" class="tsd-anchor"></a>
<h3>with<wbr>Face<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">with<wbr>Face<wbr>Landmarks<span class="tsd-signature-symbol">(</span>useTinyLandmarkNet<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="detectsinglefacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/DetectFacesTasks.ts#L88">globalApi/DetectFacesTasks.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>useTinyLandmarkNet: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="detectsinglefacelandmarkstask.html" class="tsd-signature-type" data-tsd-kind="Class">DetectSingleFaceLandmarksTask</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>detection<span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="detectsinglefacetask.html" class="tsd-kind-icon">Detect<wbr>Single<wbr>Face<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="detectsinglefacetask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="detectsinglefacetask.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="detectsinglefacetask.html#then" class="tsd-kind-icon">then</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacetask.html#withageandgender" class="tsd-kind-icon">with<wbr>Age<wbr>And<wbr>Gender</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacetask.html#withfaceexpressions" class="tsd-kind-icon">with<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="detectsinglefacetask.html#withfacelandmarks" class="tsd-kind-icon">with<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

257
typedoc/classes/dimensions.html Normal file
View File

@ -0,0 +1,257 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Dimensions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="dimensions.html">Dimensions</a>
</li>
</ul>
<h1>Class Dimensions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Dimensions</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="dimensions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="dimensions.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="dimensions.html#width" class="tsd-kind-icon">width</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="dimensions.html#reverse" class="tsd-kind-icon">reverse</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Dimensions<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L11">classes/Dimensions.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/idimensions.html">IDimensions</a>.<a href="../interfaces/idimensions.html#height">height</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L24">classes/Dimensions.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/idimensions.html">IDimensions</a>.<a href="../interfaces/idimensions.html#width">width</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L22">classes/Dimensions.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="reverse" class="tsd-anchor"></a>
<h3>reverse</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">reverse<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L26">classes/Dimensions.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="dimensions.html" class="tsd-kind-icon">Dimensions</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="dimensions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="dimensions.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="dimensions.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="dimensions.html#reverse" class="tsd-kind-icon">reverse</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

298
typedoc/classes/draw.drawbox.html Normal file
View File

@ -0,0 +1,298 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawBox | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawbox.html">DrawBox</a>
</li>
</ul>
<h1>Class DrawBox</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawBox</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawbox.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawbox.html#options" class="tsd-kind-icon">options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawbox.html#draw" class="tsd-kind-icon">draw</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawbox.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBox</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L43">draw/DrawBox.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a></h5>
</li>
<li>
<h5>options: <a href="../interfaces/draw.idrawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawbox.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBox</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="box" class="tsd-anchor"></a>
<h3>box</h3>
<div class="tsd-signature tsd-kind-icon">box<span class="tsd-signature-symbol">:</span> <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L41">draw/DrawBox.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="draw.drawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBoxOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L43">draw/DrawBox.ts:43</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L53">draw/DrawBox.ts:53</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawbox.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawbox.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawbox.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawbox.html#draw" class="tsd-kind-icon">draw</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

288
typedoc/classes/draw.drawboxoptions.html Normal file
View File

@ -0,0 +1,288 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawBoxOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawboxoptions.html">DrawBoxOptions</a>
</li>
</ul>
<h1>Class DrawBoxOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawBoxOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawboxoptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawboxoptions.html#boxcolor" class="tsd-kind-icon">box<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawboxoptions.html#drawlabeloptions" class="tsd-kind-icon">draw<wbr>Label<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawboxoptions.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawboxoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Box<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBoxOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L22">draw/DrawBox.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/draw.idrawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawBoxOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawboxoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawBoxOptions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="boxcolor" class="tsd-anchor"></a>
<h3>box<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">box<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L16">draw/DrawBox.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="drawlabeloptions" class="tsd-anchor"></a>
<h3>draw<wbr>Label<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Label<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="draw.drawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextFieldOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L20">draw/DrawBox.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L22">draw/DrawBox.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="linewidth" class="tsd-anchor"></a>
<h3>line<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L18">draw/DrawBox.ts:18</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawboxoptions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawboxoptions.html#boxcolor" class="tsd-kind-icon">box<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawboxoptions.html#drawlabeloptions" class="tsd-kind-icon">draw<wbr>Label<wbr>Options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawboxoptions.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawboxoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

298
typedoc/classes/draw.drawfacelandmarks.html Normal file
View File

@ -0,0 +1,298 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawFaceLandmarks | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawfacelandmarks.html">DrawFaceLandmarks</a>
</li>
</ul>
<h1>Class DrawFaceLandmarks</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawFaceLandmarks</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawfacelandmarks.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarks.html#facelandmarks" class="tsd-kind-icon">face<wbr>Landmarks</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarks.html#options" class="tsd-kind-icon">options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawfacelandmarks.html#draw" class="tsd-kind-icon">draw</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Face<wbr>Landmarks<span class="tsd-signature-symbol">(</span>faceLandmarks<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawFaceLandmarksOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawfacelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">DrawFaceLandmarks</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L48">draw/DrawFaceLandmarks.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceLandmarks: <a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a></h5>
</li>
<li>
<h5>options: <a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawFaceLandmarksOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawfacelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">DrawFaceLandmarks</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="facelandmarks" class="tsd-anchor"></a>
<h3>face<wbr>Landmarks</h3>
<div class="tsd-signature tsd-kind-icon">face<wbr>Landmarks<span class="tsd-signature-symbol">:</span> <a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L46">draw/DrawFaceLandmarks.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="draw.drawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawFaceLandmarksOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L48">draw/DrawFaceLandmarks.ts:48</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L58">draw/DrawFaceLandmarks.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawfacelandmarks.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarks.html#facelandmarks" class="tsd-kind-icon">face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarks.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawfacelandmarks.html#draw" class="tsd-kind-icon">draw</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

316
typedoc/classes/draw.drawfacelandmarksoptions.html Normal file
View File

@ -0,0 +1,316 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawFaceLandmarksOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawfacelandmarksoptions.html">DrawFaceLandmarksOptions</a>
</li>
</ul>
<h1>Class DrawFaceLandmarksOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawFaceLandmarksOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#drawlines" class="tsd-kind-icon">draw<wbr>Lines</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#drawpoints" class="tsd-kind-icon">draw<wbr>Points</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#linecolor" class="tsd-kind-icon">line<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#pointcolor" class="tsd-kind-icon">point<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawfacelandmarksoptions.html#pointsize" class="tsd-kind-icon">point<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Face<wbr>Landmarks<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawFaceLandmarksOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawFaceLandmarksOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L30">draw/DrawFaceLandmarks.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawFaceLandmarksOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawfacelandmarksoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawFaceLandmarksOptions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="drawlines" class="tsd-anchor"></a>
<h3>draw<wbr>Lines</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Lines<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L20">draw/DrawFaceLandmarks.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="drawpoints" class="tsd-anchor"></a>
<h3>draw<wbr>Points</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L22">draw/DrawFaceLandmarks.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="linecolor" class="tsd-anchor"></a>
<h3>line<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L28">draw/DrawFaceLandmarks.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="linewidth" class="tsd-anchor"></a>
<h3>line<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L24">draw/DrawFaceLandmarks.ts:24</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="pointcolor" class="tsd-anchor"></a>
<h3>point<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">point<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L30">draw/DrawFaceLandmarks.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="pointsize" class="tsd-anchor"></a>
<h3>point<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">point<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L26">draw/DrawFaceLandmarks.ts:26</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#drawlines" class="tsd-kind-icon">draw<wbr>Lines</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#drawpoints" class="tsd-kind-icon">draw<wbr>Points</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#linecolor" class="tsd-kind-icon">line<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#pointcolor" class="tsd-kind-icon">point<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawfacelandmarksoptions.html#pointsize" class="tsd-kind-icon">point<wbr>Size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

393
typedoc/classes/draw.drawtextfield.html Normal file
View File

@ -0,0 +1,393 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawTextField | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawtextfield.html">DrawTextField</a>
</li>
</ul>
<h1>Class DrawTextField</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawTextField</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawtextfield.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfield.html#anchor" class="tsd-kind-icon">anchor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfield.html#options" class="tsd-kind-icon">options</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfield.html#text" class="tsd-kind-icon">text</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawtextfield.html#draw" class="tsd-kind-icon">draw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawtextfield.html#getupperleft" class="tsd-kind-icon">get<wbr>Upper<wbr>Left</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawtextfield.html#measureheight" class="tsd-kind-icon">measure<wbr>Height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="draw.drawtextfield.html#measurewidth" class="tsd-kind-icon">measure<wbr>Width</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Text<wbr>Field<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="draw.drawtextfield.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextField</a>, anchor<span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawtextfield.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextField</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L58">draw/DrawTextField.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>text: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="draw.drawtextfield.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextField</a></h5>
</li>
<li>
<h5>anchor: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
<li>
<h5>options: <a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawtextfield.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextField</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="anchor" class="tsd-anchor"></a>
<h3>anchor</h3>
<div class="tsd-signature tsd-kind-icon">anchor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L56">draw/DrawTextField.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="options" class="tsd-anchor"></a>
<h3>options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="draw.drawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextFieldOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L58">draw/DrawTextField.ts:58</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="text" class="tsd-anchor"></a>
<h3>text</h3>
<div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L54">draw/DrawTextField.ts:54</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L103">draw/DrawTextField.ts:103</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getupperleft" class="tsd-anchor"></a>
<h3>get<wbr>Upper<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Upper<wbr>Left<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CanvasRenderingContext2D</span>, canvasDims<span class="tsd-signature-symbol">?: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L83">draw/DrawTextField.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ctx: <span class="tsd-signature-type">CanvasRenderingContext2D</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> canvasDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="measureheight" class="tsd-anchor"></a>
<h3>measure<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">measure<wbr>Height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L78">draw/DrawTextField.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="measurewidth" class="tsd-anchor"></a>
<h3>measure<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">measure<wbr>Width<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CanvasRenderingContext2D</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L73">draw/DrawTextField.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ctx: <span class="tsd-signature-type">CanvasRenderingContext2D</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawtextfield.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfield.html#anchor" class="tsd-kind-icon">anchor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfield.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfield.html#text" class="tsd-kind-icon">text</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawtextfield.html#draw" class="tsd-kind-icon">draw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawtextfield.html#getupperleft" class="tsd-kind-icon">get<wbr>Upper<wbr>Left</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawtextfield.html#measureheight" class="tsd-kind-icon">measure<wbr>Height</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="draw.drawtextfield.html#measurewidth" class="tsd-kind-icon">measure<wbr>Width</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

328
typedoc/classes/draw.drawtextfieldoptions.html Normal file
View File

@ -0,0 +1,328 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawTextFieldOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.drawtextfieldoptions.html">DrawTextFieldOptions</a>
</li>
</ul>
<h1>Class DrawTextFieldOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DrawTextFieldOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#anchorposition" class="tsd-kind-icon">anchor<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#fontcolor" class="tsd-kind-icon">font<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#fontsize" class="tsd-kind-icon">font<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#fontstyle" class="tsd-kind-icon">font<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="draw.drawtextfieldoptions.html#padding" class="tsd-kind-icon">padding</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Draw<wbr>Text<wbr>Field<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="draw.drawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextFieldOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L38">draw/DrawTextField.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="draw.drawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextFieldOptions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="anchorposition" class="tsd-anchor"></a>
<h3>anchor<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">anchor<wbr>Position<span class="tsd-signature-symbol">:</span> <a href="../enums/draw.anchorposition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnchorPosition</a></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#anchorposition">anchorPosition</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L28">draw/DrawTextField.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="backgroundcolor" class="tsd-anchor"></a>
<h3>background<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#backgroundcolor">backgroundColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L30">draw/DrawTextField.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fontcolor" class="tsd-anchor"></a>
<h3>font<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#fontcolor">fontColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L32">draw/DrawTextField.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fontsize" class="tsd-anchor"></a>
<h3>font<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#fontsize">fontSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L34">draw/DrawTextField.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fontstyle" class="tsd-anchor"></a>
<h3>font<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#fontstyle">fontStyle</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L36">draw/DrawTextField.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="padding" class="tsd-anchor"></a>
<h3>padding</h3>
<div class="tsd-signature tsd-kind-icon">padding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>.<a href="../interfaces/draw.idrawtextfieldoptions.html#padding">padding</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L38">draw/DrawTextField.ts:38</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#anchorposition" class="tsd-kind-icon">anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#fontcolor" class="tsd-kind-icon">font<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#fontsize" class="tsd-kind-icon">font<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#fontstyle" class="tsd-kind-icon">font<wbr>Style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="draw.drawtextfieldoptions.html#padding" class="tsd-kind-icon">padding</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

402
typedoc/classes/facedetection.html Normal file
View File

@ -0,0 +1,402 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceDetection | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facedetection.html">FaceDetection</a>
</li>
</ul>
<h1>Class FaceDetection</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceDetection</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ifacedetecion.html" class="tsd-signature-type" data-tsd-kind="Interface">IFaceDetecion</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="facedetection.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#classname" class="tsd-kind-icon">class<wbr>Name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#classscore" class="tsd-kind-icon">class<wbr>Score</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#imagedims" class="tsd-kind-icon">image<wbr>Dims</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#relativebox" class="tsd-kind-icon">relative<wbr>Box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetection.html#score" class="tsd-kind-icon">score</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="facedetection.html#forsize" class="tsd-kind-icon">for<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Detection<span class="tsd-signature-symbol">(</span>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, relativeBox<span class="tsd-signature-symbol">: </span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a>, imageDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="objectdetection.html">ObjectDetection</a>.<a href="objectdetection.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L11">classes/FaceDetection.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>score: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>relativeBox: <a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h5>
</li>
<li>
<h5>imageDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="box" class="tsd-anchor"></a>
<h3>box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> box<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacedetecion.html">IFaceDetecion</a>.<a href="../interfaces/ifacedetecion.html#box">box</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L36">classes/ObjectDetection.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="classname" class="tsd-anchor"></a>
<h3>class<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> className<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L34">classes/ObjectDetection.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="classscore" class="tsd-anchor"></a>
<h3>class<wbr>Score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> classScore<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L32">classes/ObjectDetection.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imagedims" class="tsd-anchor"></a>
<h3>image<wbr>Dims</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageDims<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L38">classes/ObjectDetection.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageheight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L42">classes/ObjectDetection.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imagewidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L40">classes/ObjectDetection.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="relativebox" class="tsd-anchor"></a>
<h3>relative<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativeBox<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L44">classes/ObjectDetection.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="score" class="tsd-anchor"></a>
<h3>score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> score<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacedetecion.html">IFaceDetecion</a>.<a href="../interfaces/ifacedetecion.html#score">score</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L30">classes/ObjectDetection.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="forsize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="objectdetection.html">ObjectDetection</a>.<a href="objectdetection.html#forsize">forSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L20">classes/FaceDetection.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facedetection.html" class="tsd-kind-icon">Face<wbr>Detection</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="facedetection.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#classname" class="tsd-kind-icon">class<wbr>Name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#classscore" class="tsd-kind-icon">class<wbr>Score</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#imagedims" class="tsd-kind-icon">image<wbr>Dims</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#relativebox" class="tsd-kind-icon">relative<wbr>Box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetection.html#score" class="tsd-kind-icon">score</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="facedetection.html#forsize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

715
typedoc/classes/facedetectionnet.html Normal file
View File

@ -0,0 +1,715 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceDetectionNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facedetectionnet.html">FaceDetectionNet</a>
</li>
</ul>
<h1>Class FaceDetectionNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ssdmobilenetv1.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceDetectionNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facedetectionnet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Detection<wbr>Net<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facedetectionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetectionNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L16">ssdMobilenetv1/SsdMobilenetv1.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="facedetectionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetectionNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#extractweights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#forward">forward</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L39">ssdMobilenetv1/SsdMobilenetv1.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#forwardinput">forwardInput</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L21">ssdMobilenetv1/SsdMobilenetv1.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#getfrozenparams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#getparamfrompath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#getparamlist">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#gettrainableparams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#loadfromdisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#loadfromuri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#loadfromweightmap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="locatefaces" class="tsd-anchor"></a>
<h3>locate<wbr>Faces</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">locate<wbr>Faces<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#locatefaces">locateFaces</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L43">ssdMobilenetv1/SsdMobilenetv1.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#reassignparamfrompath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#serializeparams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ssdmobilenetv1.html">SsdMobilenetv1</a>.<a href="ssdmobilenetv1.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facedetectionnet.html" class="tsd-kind-icon">Face<wbr>Detection<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facedetectionnet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

828
typedoc/classes/faceexpressionnet.html Normal file
View File

@ -0,0 +1,828 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceExpressionNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="faceexpressionnet.html">FaceExpressionNet</a>
</li>
</ul>
<h1>Class FaceExpressionNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">FaceProcessor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FaceFeatureExtractorParams</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceExpressionNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="faceexpressionnet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="faceexpressionnet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="faceexpressionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="faceexpressionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="faceexpressionnet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faceexpressionnet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faceexpressionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faceexpressionnet.html#predictexpressions" class="tsd-kind-icon">predict<wbr>Expressions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="faceexpressionnet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Expression<wbr>Net<span class="tsd-signature-symbol">(</span>faceFeatureExtractor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="faceexpressionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressionNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides FaceProcessor&lt;FaceFeatureExtractorParams&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressionNet.ts#L9">faceExpressionNet/FaceExpressionNet.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceFeatureExtractor: <span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="faceexpressionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressionNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from FaceProcessor._name</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="facefeatureextractor" class="tsd-anchor"></a>
<h3>face<wbr>Feature<wbr>Extractor</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> faceFeatureExtractor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L27">faceProcessor/FaceProcessor.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L52">faceProcessor/FaceProcessor.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.extractClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L63">faceProcessor/FaceProcessor.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.extractWeights</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressionNet.ts#L18">faceExpressionNet/FaceExpressionNet.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressionNet.ts#L14">faceExpressionNet/FaceExpressionNet.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.freeze</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.getFrozenParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.getParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.getParamList</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.getTrainableParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.load</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadclassifierparams" class="tsd-anchor"></a>
<h3>load<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.loadClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L57">faceProcessor/FaceProcessor.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.loadFromDisk</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.loadFromUri</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.loadFromWeightMap</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="predictexpressions" class="tsd-anchor"></a>
<h3>predict<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">predict<wbr>Expressions<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a><span class="tsd-signature-symbol"> | </span><a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressionNet.ts#L22">faceExpressionNet/FaceExpressionNet.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a><span class="tsd-signature-symbol"> | </span><a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.reassignParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.runNet</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L37">faceProcessor/FaceProcessor.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.serializeParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceProcessor.variable</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="faceexpressionnet.html" class="tsd-kind-icon">Face<wbr>Expression<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="faceexpressionnet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="faceexpressionnet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="faceexpressionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="faceexpressionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="faceexpressionnet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="faceexpressionnet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="faceexpressionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="faceexpressionnet.html#predictexpressions" class="tsd-kind-icon">predict<wbr>Expressions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="faceexpressionnet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

302
typedoc/classes/faceexpressions.html Normal file
View File

@ -0,0 +1,302 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceExpressions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="faceexpressions.html">FaceExpressions</a>
</li>
</ul>
<h1>Class FaceExpressions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceExpressions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="faceexpressions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#angry" class="tsd-kind-icon">angry</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#disgusted" class="tsd-kind-icon">disgusted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#fearful" class="tsd-kind-icon">fearful</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#happy" class="tsd-kind-icon">happy</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#neutral" class="tsd-kind-icon">neutral</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#sad" class="tsd-kind-icon">sad</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="faceexpressions.html#surprised" class="tsd-kind-icon">surprised</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="faceexpressions.html#assortedarray" class="tsd-kind-icon">as<wbr>Sorted<wbr>Array</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span>probabilities<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L16">faceExpressionNet/FaceExpressions.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>probabilities: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="angry" class="tsd-anchor"></a>
<h3>angry</h3>
<div class="tsd-signature tsd-kind-icon">angry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L10">faceExpressionNet/FaceExpressions.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="disgusted" class="tsd-anchor"></a>
<h3>disgusted</h3>
<div class="tsd-signature tsd-kind-icon">disgusted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L14">faceExpressionNet/FaceExpressions.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fearful" class="tsd-anchor"></a>
<h3>fearful</h3>
<div class="tsd-signature tsd-kind-icon">fearful<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L12">faceExpressionNet/FaceExpressions.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="happy" class="tsd-anchor"></a>
<h3>happy</h3>
<div class="tsd-signature tsd-kind-icon">happy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L6">faceExpressionNet/FaceExpressions.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="neutral" class="tsd-anchor"></a>
<h3>neutral</h3>
<div class="tsd-signature tsd-kind-icon">neutral<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L4">faceExpressionNet/FaceExpressions.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sad" class="tsd-anchor"></a>
<h3>sad</h3>
<div class="tsd-signature tsd-kind-icon">sad<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L8">faceExpressionNet/FaceExpressions.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="surprised" class="tsd-anchor"></a>
<h3>surprised</h3>
<div class="tsd-signature tsd-kind-icon">surprised<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L16">faceExpressionNet/FaceExpressions.ts:16</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="assortedarray" class="tsd-anchor"></a>
<h3>as<wbr>Sorted<wbr>Array</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">as<wbr>Sorted<wbr>Array<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>expression<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>probability<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceExpressionNet/FaceExpressions.ts#L28">faceExpressionNet/FaceExpressions.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>expression<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>probability<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="faceexpressions.html" class="tsd-kind-icon">Face<wbr>Expressions</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="faceexpressions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#angry" class="tsd-kind-icon">angry</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#disgusted" class="tsd-kind-icon">disgusted</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#fearful" class="tsd-kind-icon">fearful</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#happy" class="tsd-kind-icon">happy</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#neutral" class="tsd-kind-icon">neutral</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#sad" class="tsd-kind-icon">sad</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="faceexpressions.html#surprised" class="tsd-kind-icon">surprised</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="faceexpressions.html#assortedarray" class="tsd-kind-icon">as<wbr>Sorted<wbr>Array</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

870
typedoc/classes/facelandmark68net.html Normal file
View File

@ -0,0 +1,870 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmark68Net | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmark68net.html">FaceLandmark68Net</a>
</li>
</ul>
<h1>Class FaceLandmark68Net</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">FaceLandmark68NetBase</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FaceFeatureExtractorParams</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmark68Net</span>
<ul class="tsd-hierarchy">
<li>
<a href="facelandmarknet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarkNet</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="facelandmark68net.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68net.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68net.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68net.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68net.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#runnet" class="tsd-kind-icon">run<wbr>Net</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68net.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmark68<wbr>Net<span class="tsd-signature-symbol">(</span>faceFeatureExtractor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmark68net.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmark68Net</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides FaceLandmark68NetBase&lt;FaceFeatureExtractorParams&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68Net.ts#L5">faceLandmarkNet/FaceLandmark68Net.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceFeatureExtractor: <span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmark68net.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmark68Net</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase._name</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="facefeatureextractor" class="tsd-anchor"></a>
<h3>face<wbr>Feature<wbr>Extractor</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> faceFeatureExtractor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L27">faceProcessor/FaceProcessor.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="detectlandmarks" class="tsd-anchor"></a>
<h3>detect<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">detect<wbr>Landmarks<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.detectLandmarks</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L67">faceLandmarkNet/FaceLandmark68NetBase.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L52">faceProcessor/FaceProcessor.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.extractClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L63">faceProcessor/FaceProcessor.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.extractWeights</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.forward</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L63">faceLandmarkNet/FaceLandmark68NetBase.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.forwardInput</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L52">faceLandmarkNet/FaceLandmark68NetBase.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.freeze</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getFrozenParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getParamList</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getTrainableParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.load</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadclassifierparams" class="tsd-anchor"></a>
<h3>load<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L57">faceProcessor/FaceProcessor.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromDisk</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromUri</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromWeightMap</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="postprocess" class="tsd-anchor"></a>
<h3>post<wbr>Process</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">post<wbr>Process<span class="tsd-signature-symbol">(</span>output<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, originalDimensions<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.postProcess</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L14">faceLandmarkNet/FaceLandmark68NetBase.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>output: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>originalDimensions: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.reassignParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.runNet</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L37">faceProcessor/FaceProcessor.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.serializeParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.variable</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmark68net.html" class="tsd-kind-icon">Face<wbr>Landmark68<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="facelandmark68net.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68net.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68net.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68net.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68net.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#runnet" class="tsd-kind-icon">run<wbr>Net</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68net.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

865
typedoc/classes/facelandmark68tinynet.html Normal file
View File

@ -0,0 +1,865 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmark68TinyNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmark68tinynet.html">FaceLandmark68TinyNet</a>
</li>
</ul>
<h1>Class FaceLandmark68TinyNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">FaceLandmark68NetBase</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TinyFaceFeatureExtractorParams</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmark68TinyNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="facelandmark68tinynet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68tinynet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68tinynet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68tinynet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmark68tinynet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmark68tinynet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmark68<wbr>Tiny<wbr>Net<span class="tsd-signature-symbol">(</span>faceFeatureExtractor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">TinyFaceFeatureExtractor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmark68tinynet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmark68TinyNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides FaceLandmark68NetBase&lt;TinyFaceFeatureExtractorParams&gt;.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68TinyNet.ts#L5">faceLandmarkNet/FaceLandmark68TinyNet.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceFeatureExtractor: <span class="tsd-signature-type">TinyFaceFeatureExtractor</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmark68tinynet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmark68TinyNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase._name</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="facefeatureextractor" class="tsd-anchor"></a>
<h3>face<wbr>Feature<wbr>Extractor</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> faceFeatureExtractor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L27">faceProcessor/FaceProcessor.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="detectlandmarks" class="tsd-anchor"></a>
<h3>detect<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">detect<wbr>Landmarks<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.detectLandmarks</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L67">faceLandmarkNet/FaceLandmark68NetBase.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L52">faceProcessor/FaceProcessor.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.extractClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L63">faceProcessor/FaceProcessor.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.extractWeights</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.forward</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L63">faceLandmarkNet/FaceLandmark68NetBase.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.forwardInput</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L52">faceLandmarkNet/FaceLandmark68NetBase.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.freeze</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getFrozenParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getParamList</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.getTrainableParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.load</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadclassifierparams" class="tsd-anchor"></a>
<h3>load<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadClassifierParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L57">faceProcessor/FaceProcessor.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromDisk</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromUri</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.loadFromWeightMap</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="postprocess" class="tsd-anchor"></a>
<h3>post<wbr>Process</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">post<wbr>Process<span class="tsd-signature-symbol">(</span>output<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, originalDimensions<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.postProcess</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L14">faceLandmarkNet/FaceLandmark68NetBase.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>output: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>originalDimensions: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.reassignParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.runNet</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L37">faceProcessor/FaceProcessor.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.serializeParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from FaceLandmark68NetBase.variable</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmark68tinynet.html" class="tsd-kind-icon">Face<wbr>Landmark68<wbr>Tiny<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="facelandmark68tinynet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68tinynet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68tinynet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68tinynet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmark68tinynet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmark68tinynet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

865
typedoc/classes/facelandmarknet.html Normal file
View File

@ -0,0 +1,865 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmarkNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmarknet.html">FaceLandmarkNet</a>
</li>
</ul>
<h1>Class FaceLandmarkNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="facelandmark68net.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmark68Net</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmarkNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarknet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmark<wbr>Net<span class="tsd-signature-symbol">(</span>faceFeatureExtractor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmarknet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarkNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68Net.ts#L5">faceLandmarkNet/FaceLandmark68Net.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>faceFeatureExtractor: <span class="tsd-signature-type">FaceFeatureExtractor</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmarknet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarkNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="facefeatureextractor" class="tsd-anchor"></a>
<h3>face<wbr>Feature<wbr>Extractor</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> faceFeatureExtractor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L27">faceProcessor/FaceProcessor.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IFaceFeatureExtractor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TExtractorParams</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="detectlandmarks" class="tsd-anchor"></a>
<h3>detect<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">detect<wbr>Landmarks<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#detectlandmarks">detectLandmarks</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L67">faceLandmarkNet/FaceLandmark68NetBase.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol"> | </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L52">faceProcessor/FaceProcessor.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractclassifierparams" class="tsd-anchor"></a>
<h3>extract<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#extractclassifierparams">extractClassifierParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L63">faceProcessor/FaceProcessor.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>paramMappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>param<wbr>Mappings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NetParams</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#extractweights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#forward">forward</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L63">faceLandmarkNet/FaceLandmark68NetBase.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#forwardinput">forwardInput</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L52">faceLandmarkNet/FaceLandmark68NetBase.ts:52</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#getfrozenparams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#getparamfrompath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#getparamlist">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#gettrainableparams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadclassifierparams" class="tsd-anchor"></a>
<h3>load<wbr>Classifier<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>Classifier<wbr>Params<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#loadclassifierparams">loadClassifierParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L57">faceProcessor/FaceProcessor.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#loadfromdisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#loadfromuri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#loadfromweightmap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="postprocess" class="tsd-anchor"></a>
<h3>post<wbr>Process</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">post<wbr>Process<span class="tsd-signature-symbol">(</span>output<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, originalDimensions<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#postprocess">postProcess</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceLandmarkNet/FaceLandmark68NetBase.ts#L14">faceLandmarkNet/FaceLandmark68NetBase.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>output: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>originalDimensions: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#reassignparamfrompath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runnet" class="tsd-anchor"></a>
<h3>run<wbr>Net</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Net<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#runnet">runNet</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceProcessor/FaceProcessor.ts#L37">faceProcessor/FaceProcessor.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#serializeparams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmark68net.html">FaceLandmark68Net</a>.<a href="facelandmark68net.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmarknet.html" class="tsd-kind-icon">Face<wbr>Landmark<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#facefeatureextractor" class="tsd-kind-icon">face<wbr>Feature<wbr>Extractor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#detectlandmarks" class="tsd-kind-icon">detect<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#extractclassifierparams" class="tsd-kind-icon">extract<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#loadclassifierparams" class="tsd-kind-icon">load<wbr>Classifier<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#postprocess" class="tsd-kind-icon">post<wbr>Process</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#runnet" class="tsd-kind-icon">run<wbr>Net</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarknet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

467
typedoc/classes/facelandmarks.html Normal file
View File

@ -0,0 +1,467 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmarks | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmarks.html">FaceLandmarks</a>
</li>
</ul>
<h1>Class FaceLandmarks</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmarks</span>
<ul class="tsd-hierarchy">
<li>
<a href="facelandmarks5.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks5</a>
</li>
<li>
<a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ifacelandmarks.html" class="tsd-signature-type" data-tsd-kind="Interface">IFaceLandmarks</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="facelandmarks.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmarks.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmarks.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmarks.html#positions" class="tsd-kind-icon">positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmarks.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facelandmarks.html#shift" class="tsd-kind-icon">shift</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks.html#align" class="tsd-kind-icon">align</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="facelandmarks.html#forsize" class="tsd-kind-icon">for<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="facelandmarks.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="facelandmarks.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmarks<span class="tsd-signature-symbol">(</span>relativeFaceLandmarkPositions<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span>, imgDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a>, shift<span class="tsd-signature-symbol">?: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L25">classes/FaceLandmarks.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>relativeFaceLandmarkPositions: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>imgDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
<li>
<h5>shift: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imageheight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L44">classes/FaceLandmarks.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imagewidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L42">classes/FaceLandmarks.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="positions" class="tsd-anchor"></a>
<h3>positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> positions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacelandmarks.html">IFaceLandmarks</a>.<a href="../interfaces/ifacelandmarks.html#positions">positions</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L46">classes/FaceLandmarks.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="relativepositions" class="tsd-anchor"></a>
<h3>relative<wbr>Positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativePositions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L48">classes/FaceLandmarks.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> shift<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacelandmarks.html">IFaceLandmarks</a>.<a href="../interfaces/ifacelandmarks.html#shift">shift</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L40">classes/FaceLandmarks.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="align" class="tsd-anchor"></a>
<h3>align</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">align<span class="tsd-signature-symbol">(</span>detection<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L84">classes/FaceLandmarks.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Aligns the face landmarks after face detection from the relative positions of the faces
bounding box, or it&#39;s current shift. This function should be used to align the face images
after face detection has been performed, before they are passed to the face recognition net.
This will make the computed face descriptor more accurate.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> detection: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h5>
<div class="tsd-comment tsd-typography">
<p>(optional) The bounding box of the face or the face detection result. If
no argument was passed the position of the face landmarks are assumed to be relative to
it&#39;s current shift.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Box<wbr>Padding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Dlib<wbr>Alignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The bounding box of the aligned face.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="forsize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size&lt;T&gt;<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L54">classes/FaceLandmarks.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="shiftby" class="tsd-anchor"></a>
<h3>shift<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">shift<wbr>By&lt;T&gt;<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L61">classes/FaceLandmarks.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="shiftbypoint" class="tsd-anchor"></a>
<h3>shift<wbr>ByPoint</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">shift<wbr>ByPoint&lt;T&gt;<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L69">classes/FaceLandmarks.ts:69</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmarks.html" class="tsd-kind-icon">Face<wbr>Landmarks</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="facelandmarks.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmarks.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmarks.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmarks.html#positions" class="tsd-kind-icon">positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmarks.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facelandmarks.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks.html#align" class="tsd-kind-icon">align</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="facelandmarks.html#forsize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="facelandmarks.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="facelandmarks.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

461
typedoc/classes/facelandmarks5.html Normal file
View File

@ -0,0 +1,461 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmarks5 | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmarks5.html">FaceLandmarks5</a>
</li>
</ul>
<h1>Class FaceLandmarks5</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmarks5</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#positions" class="tsd-kind-icon">positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#shift" class="tsd-kind-icon">shift</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks5.html#align" class="tsd-kind-icon">align</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks5.html#forsize" class="tsd-kind-icon">for<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks5.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks5.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmarks5<span class="tsd-signature-symbol">(</span>relativeFaceLandmarkPositions<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span>, imgDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a>, shift<span class="tsd-signature-symbol">?: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmarks5.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks5</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L25">classes/FaceLandmarks.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>relativeFaceLandmarkPositions: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>imgDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
<li>
<h5>shift: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmarks5.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks5</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageheight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L44">classes/FaceLandmarks.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imagewidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L42">classes/FaceLandmarks.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="positions" class="tsd-anchor"></a>
<h3>positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> positions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L46">classes/FaceLandmarks.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="relativepositions" class="tsd-anchor"></a>
<h3>relative<wbr>Positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativePositions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L48">classes/FaceLandmarks.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> shift<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L40">classes/FaceLandmarks.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="align" class="tsd-anchor"></a>
<h3>align</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">align<span class="tsd-signature-symbol">(</span>detection<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#align">align</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L84">classes/FaceLandmarks.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Aligns the face landmarks after face detection from the relative positions of the faces
bounding box, or it&#39;s current shift. This function should be used to align the face images
after face detection has been performed, before they are passed to the face recognition net.
This will make the computed face descriptor more accurate.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> detection: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h5>
<div class="tsd-comment tsd-typography">
<p>(optional) The bounding box of the face or the face detection result. If
no argument was passed the position of the face landmarks are assumed to be relative to
it&#39;s current shift.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Box<wbr>Padding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Dlib<wbr>Alignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The bounding box of the aligned face.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="forsize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size&lt;T&gt;<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#forsize">forSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L54">classes/FaceLandmarks.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="shiftby" class="tsd-anchor"></a>
<h3>shift<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<wbr>By&lt;T&gt;<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#shiftby">shiftBy</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L61">classes/FaceLandmarks.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="shiftbypoint" class="tsd-anchor"></a>
<h3>shift<wbr>ByPoint</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<wbr>ByPoint&lt;T&gt;<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#shiftbypoint">shiftByPoint</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L69">classes/FaceLandmarks.ts:69</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmarks5.html" class="tsd-kind-icon">Face<wbr>Landmarks5</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#positions" class="tsd-kind-icon">positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks5.html#align" class="tsd-kind-icon">align</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks5.html#forsize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks5.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks5.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

608
typedoc/classes/facelandmarks68.html Normal file
View File

@ -0,0 +1,608 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceLandmarks68 | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facelandmarks68.html">FaceLandmarks68</a>
</li>
</ul>
<h1>Class FaceLandmarks68</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceLandmarks68</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#positions" class="tsd-kind-icon">positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#shift" class="tsd-kind-icon">shift</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facelandmarks68.html#align" class="tsd-kind-icon">align</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks68.html#forsize" class="tsd-kind-icon">for<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getjawoutline" class="tsd-kind-icon">get<wbr>Jaw<wbr>Outline</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getlefteye" class="tsd-kind-icon">get<wbr>Left<wbr>Eye</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getlefteyebrow" class="tsd-kind-icon">get<wbr>Left<wbr>Eye<wbr>Brow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getmouth" class="tsd-kind-icon">get<wbr>Mouth</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getnose" class="tsd-kind-icon">get<wbr>Nose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getrighteye" class="tsd-kind-icon">get<wbr>Right<wbr>Eye</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facelandmarks68.html#getrighteyebrow" class="tsd-kind-icon">get<wbr>Right<wbr>Eye<wbr>Brow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks68.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="facelandmarks68.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Landmarks68<span class="tsd-signature-symbol">(</span>relativeFaceLandmarkPositions<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span>, imgDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a>, shift<span class="tsd-signature-symbol">?: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L25">classes/FaceLandmarks.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>relativeFaceLandmarkPositions: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>imgDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
<li>
<h5>shift: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facelandmarks68.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks68</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageheight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L44">classes/FaceLandmarks.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imagewidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L42">classes/FaceLandmarks.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="positions" class="tsd-anchor"></a>
<h3>positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> positions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L46">classes/FaceLandmarks.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="relativepositions" class="tsd-anchor"></a>
<h3>relative<wbr>Positions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativePositions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L48">classes/FaceLandmarks.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> shift<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L40">classes/FaceLandmarks.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="align" class="tsd-anchor"></a>
<h3>align</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">align<span class="tsd-signature-symbol">(</span>detection<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#align">align</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L84">classes/FaceLandmarks.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Aligns the face landmarks after face detection from the relative positions of the faces
bounding box, or it&#39;s current shift. This function should be used to align the face images
after face detection has been performed, before they are passed to the face recognition net.
This will make the computed face descriptor more accurate.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> detection: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h5>
<div class="tsd-comment tsd-typography">
<p>(optional) The bounding box of the face or the face detection result. If
no argument was passed the position of the face landmarks are assumed to be relative to
it&#39;s current shift.</p>
</div>
</li>
<li>
<h5>options: <span class="tsd-signature-symbol">{ </span>minBoxPadding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>useDlibAlignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Box<wbr>Padding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Dlib<wbr>Alignment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The bounding box of the aligned face.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="forsize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size&lt;T&gt;<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#forsize">forSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L54">classes/FaceLandmarks.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getjawoutline" class="tsd-anchor"></a>
<h3>get<wbr>Jaw<wbr>Outline</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Jaw<wbr>Outline<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L6">classes/FaceLandmarks68.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlefteye" class="tsd-anchor"></a>
<h3>get<wbr>Left<wbr>Eye</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Left<wbr>Eye<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L22">classes/FaceLandmarks68.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getlefteyebrow" class="tsd-anchor"></a>
<h3>get<wbr>Left<wbr>Eye<wbr>Brow</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Left<wbr>Eye<wbr>Brow<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L10">classes/FaceLandmarks68.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmouth" class="tsd-anchor"></a>
<h3>get<wbr>Mouth</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Mouth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L30">classes/FaceLandmarks68.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getnose" class="tsd-anchor"></a>
<h3>get<wbr>Nose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Nose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L18">classes/FaceLandmarks68.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getrighteye" class="tsd-anchor"></a>
<h3>get<wbr>Right<wbr>Eye</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Right<wbr>Eye<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L26">classes/FaceLandmarks68.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getrighteyebrow" class="tsd-anchor"></a>
<h3>get<wbr>Right<wbr>Eye<wbr>Brow</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Right<wbr>Eye<wbr>Brow<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks68.ts#L14">classes/FaceLandmarks68.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="shiftby" class="tsd-anchor"></a>
<h3>shift<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<wbr>By&lt;T&gt;<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#shiftby">shiftBy</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L61">classes/FaceLandmarks.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="shiftbypoint" class="tsd-anchor"></a>
<h3>shift<wbr>ByPoint</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<wbr>ByPoint&lt;T&gt;<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="facelandmarks.html">FaceLandmarks</a>.<a href="facelandmarks.html#shiftbypoint">shiftByPoint</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L69">classes/FaceLandmarks.ts:69</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facelandmarks68.html" class="tsd-kind-icon">Face<wbr>Landmarks68</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#positions" class="tsd-kind-icon">positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#relativepositions" class="tsd-kind-icon">relative<wbr>Positions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facelandmarks68.html#align" class="tsd-kind-icon">align</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks68.html#forsize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getjawoutline" class="tsd-kind-icon">get<wbr>Jaw<wbr>Outline</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getlefteye" class="tsd-kind-icon">get<wbr>Left<wbr>Eye</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getlefteyebrow" class="tsd-kind-icon">get<wbr>Left<wbr>Eye<wbr>Brow</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getmouth" class="tsd-kind-icon">get<wbr>Mouth</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getnose" class="tsd-kind-icon">get<wbr>Nose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getrighteye" class="tsd-kind-icon">get<wbr>Right<wbr>Eye</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facelandmarks68.html#getrighteyebrow" class="tsd-kind-icon">get<wbr>Right<wbr>Eye<wbr>Brow</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks68.html#shiftby" class="tsd-kind-icon">shift<wbr>By</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a href="facelandmarks68.html#shiftbypoint" class="tsd-kind-icon">shift<wbr>ByPoint</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

263
typedoc/classes/facematch.html Normal file
View File

@ -0,0 +1,263 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceMatch | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facematch.html">FaceMatch</a>
</li>
</ul>
<h1>Class FaceMatch</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceMatch</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ifacematch.html" class="tsd-signature-type" data-tsd-kind="Interface">IFaceMatch</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="facematch.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facematch.html#distance" class="tsd-kind-icon">distance</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facematch.html#label" class="tsd-kind-icon">label</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facematch.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Match<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L11">classes/FaceMatch.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>label: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>distance: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="distance" class="tsd-anchor"></a>
<h3>distance</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> distance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacematch.html">IFaceMatch</a>.<a href="../interfaces/ifacematch.html#distance">distance</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L20">classes/FaceMatch.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="label" class="tsd-anchor"></a>
<h3>label</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> label<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifacematch.html">IFaceMatch</a>.<a href="../interfaces/ifacematch.html#label">label</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L18">classes/FaceMatch.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span>withDistance<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L22">classes/FaceMatch.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>withDistance: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facematch.html" class="tsd-kind-icon">Face<wbr>Match</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="facematch.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facematch.html#distance" class="tsd-kind-icon">distance</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facematch.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facematch.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

360
typedoc/classes/facematcher.html Normal file
View File

@ -0,0 +1,360 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceMatcher | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facematcher.html">FaceMatcher</a>
</li>
</ul>
<h1>Class FaceMatcher</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceMatcher</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="facematcher.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facematcher.html#distancethreshold" class="tsd-kind-icon">distance<wbr>Threshold</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="facematcher.html#labeleddescriptors" class="tsd-kind-icon">labeled<wbr>Descriptors</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facematcher.html#computemeandistance" class="tsd-kind-icon">compute<wbr>Mean<wbr>Distance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facematcher.html#findbestmatch" class="tsd-kind-icon">find<wbr>Best<wbr>Match</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facematcher.html#matchdescriptor" class="tsd-kind-icon">match<wbr>Descriptor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facematcher.html#tojson" class="tsd-kind-icon">toJSON</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="facematcher.html#fromjson" class="tsd-kind-icon">fromJSON</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Matcher<span class="tsd-signature-symbol">(</span>inputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, distanceThreshold<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facematcher.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatcher</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L9">globalApi/FaceMatcher.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputs: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>distanceThreshold: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.6</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facematcher.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatcher</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="distancethreshold" class="tsd-anchor"></a>
<h3>distance<wbr>Threshold</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> distanceThreshold<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L45">globalApi/FaceMatcher.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="labeleddescriptors" class="tsd-anchor"></a>
<h3>labeled<wbr>Descriptors</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> labeledDescriptors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L43">globalApi/FaceMatcher.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="computemeandistance" class="tsd-anchor"></a>
<h3>compute<wbr>Mean<wbr>Distance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">compute<wbr>Mean<wbr>Distance<span class="tsd-signature-symbol">(</span>queryDescriptor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span>, descriptors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L47">globalApi/FaceMatcher.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>queryDescriptor: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
<li>
<h5>descriptors: <span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="findbestmatch" class="tsd-anchor"></a>
<h3>find<wbr>Best<wbr>Match</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">find<wbr>Best<wbr>Match<span class="tsd-signature-symbol">(</span>queryDescriptor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L63">globalApi/FaceMatcher.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>queryDescriptor: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="matchdescriptor" class="tsd-anchor"></a>
<h3>match<wbr>Descriptor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">match<wbr>Descriptor<span class="tsd-signature-symbol">(</span>queryDescriptor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L54">globalApi/FaceMatcher.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>queryDescriptor: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tojson" class="tsd-anchor"></a>
<h3>toJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L70">globalApi/FaceMatcher.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromjson" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> fromJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">fromJSON<span class="tsd-signature-symbol">(</span>json<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facematcher.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatcher</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/globalApi/FaceMatcher.ts#L77">globalApi/FaceMatcher.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>json: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="facematcher.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatcher</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facematcher.html" class="tsd-kind-icon">Face<wbr>Matcher</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="facematcher.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facematcher.html#distancethreshold" class="tsd-kind-icon">distance<wbr>Threshold</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="facematcher.html#labeleddescriptors" class="tsd-kind-icon">labeled<wbr>Descriptors</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facematcher.html#computemeandistance" class="tsd-kind-icon">compute<wbr>Mean<wbr>Distance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facematcher.html#findbestmatch" class="tsd-kind-icon">find<wbr>Best<wbr>Match</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facematcher.html#matchdescriptor" class="tsd-kind-icon">match<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facematcher.html#tojson" class="tsd-kind-icon">toJSON</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="facematcher.html#fromjson" class="tsd-kind-icon">fromJSON</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

709
typedoc/classes/facerecognitionnet.html Normal file
View File

@ -0,0 +1,709 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceRecognitionNet | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="facerecognitionnet.html">FaceRecognitionNet</a>
</li>
</ul>
<h1>Class FaceRecognitionNet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceRecognitionNet</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="facerecognitionnet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facerecognitionnet.html#computefacedescriptor" class="tsd-kind-icon">compute<wbr>Face<wbr>Descriptor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facerecognitionnet.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="facerecognitionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="facerecognitionnet.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Recognition<wbr>Net<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facerecognitionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceRecognitionNet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceRecognitionNet/FaceRecognitionNet.ts#L12">faceRecognitionNet/FaceRecognitionNet.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="facerecognitionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceRecognitionNet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="computefacedescriptor" class="tsd-anchor"></a>
<h3>compute<wbr>Face<wbr>Descriptor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">compute<wbr>Face<wbr>Descriptor<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceRecognitionNet/FaceRecognitionNet.ts#L62">faceRecognitionNet/FaceRecognitionNet.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#extractweights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceRecognitionNet/FaceRecognitionNet.ts#L58">faceRecognitionNet/FaceRecognitionNet.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/faceRecognitionNet/FaceRecognitionNet.ts#L17">faceRecognitionNet/FaceRecognitionNet.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getfrozenparams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamfrompath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamlist">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#gettrainableparams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromdisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromuri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromweightmap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#reassignparamfrompath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#serializeparams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="facerecognitionnet.html" class="tsd-kind-icon">Face<wbr>Recognition<wbr>Net</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="facerecognitionnet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facerecognitionnet.html#computefacedescriptor" class="tsd-kind-icon">compute<wbr>Face<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facerecognitionnet.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="facerecognitionnet.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="facerecognitionnet.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

861
typedoc/classes/labeledbox.html Normal file
View File

@ -0,0 +1,861 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LabeledBox | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="labeledbox.html">LabeledBox</a>
</li>
</ul>
<h1>Class LabeledBox</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">LabeledBox</span>
<ul class="tsd-hierarchy">
<li>
<a href="predictedbox.html" class="tsd-signature-type" data-tsd-kind="Class">PredictedBox</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="labeledbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="labeledbox.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#calibrate" class="tsd-kind-icon">calibrate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#pad" class="tsd-kind-icon">pad</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#rescale" class="tsd-kind-icon">rescale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#round" class="tsd-kind-icon">round</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#shift" class="tsd-kind-icon">shift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="labeledbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="labeledbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="labeledbox.html#assertisvalidlabeledbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="labeledbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Labeled<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="box.html">Box</a>.<a href="box.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledBox.ts#L15">classes/LabeledBox.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>label: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L70">classes/Box.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L68">classes/Box.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomleft" class="tsd-anchor"></a>
<h3>bottom<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L76">classes/Box.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomright" class="tsd-anchor"></a>
<h3>bottom<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L78">classes/Box.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L60">classes/Box.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="label" class="tsd-anchor"></a>
<h3>label</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> label<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledBox.ts#L22">classes/LabeledBox.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L62">classes/Box.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L66">classes/Box.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L64">classes/Box.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topleft" class="tsd-anchor"></a>
<h3>top<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L72">classes/Box.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topright" class="tsd-anchor"></a>
<h3>top<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L74">classes/Box.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L58">classes/Box.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L54">classes/Box.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L56">classes/Box.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="calibrate" class="tsd-anchor"></a>
<h3>calibrate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">calibrate<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#calibrate">calibrate</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L201">classes/Box.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>region: <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="clipatimageborders" class="tsd-anchor"></a>
<h3>clip<wbr>AtImage<wbr>Borders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">clip<wbr>AtImage<wbr>Borders<span class="tsd-signature-symbol">(</span>imgWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imgHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#clipatimageborders">clipAtImageBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L138">classes/Box.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imgWidth: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imgHeight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#floor">floor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L88">classes/Box.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="pad" class="tsd-anchor"></a>
<h3>pad</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<span class="tsd-signature-symbol">(</span>padX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, padY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#pad">pad</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L126">classes/Box.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>padX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>padY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="padatborders" class="tsd-anchor"></a>
<h3>pad<wbr>AtBorders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<wbr>AtBorders<span class="tsd-signature-symbol">(</span>imageHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imageWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#padatborders">padAtBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L165">classes/Box.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imageHeight: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imageWidth: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="rescale" class="tsd-anchor"></a>
<h3>rescale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">rescale<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#rescale">rescale</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L115">classes/Box.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#round">round</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L80">classes/Box.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#shift">shift</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L155">classes/Box.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="tosquare" class="tsd-anchor"></a>
<h3>to<wbr>Square</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Square<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#tosquare">toSquare</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L96">classes/Box.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="assertisvalidbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#assertisvalidbox">assertIsValidBox</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L12">classes/Box.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="assertisvalidlabeledbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Labeled<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledBox.ts#L7">classes/LabeledBox.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="isrect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Rect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>Rect<span class="tsd-signature-symbol">(</span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#isrect">isRect</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L8">classes/Box.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="labeledbox.html" class="tsd-kind-icon">Labeled<wbr>Box</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="labeledbox.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="labeledbox.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#top" class="tsd-kind-icon">top</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#calibrate" class="tsd-kind-icon">calibrate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#pad" class="tsd-kind-icon">pad</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#rescale" class="tsd-kind-icon">rescale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#round" class="tsd-kind-icon">round</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="labeledbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="labeledbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="labeledbox.html#assertisvalidlabeledbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="labeledbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

276
typedoc/classes/labeledfacedescriptors.html Normal file
View File

@ -0,0 +1,276 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LabeledFaceDescriptors | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="labeledfacedescriptors.html">LabeledFaceDescriptors</a>
</li>
</ul>
<h1>Class LabeledFaceDescriptors</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">LabeledFaceDescriptors</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="labeledfacedescriptors.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="labeledfacedescriptors.html#descriptors" class="tsd-kind-icon">descriptors</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="labeledfacedescriptors.html#label" class="tsd-kind-icon">label</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="labeledfacedescriptors.html#tojson" class="tsd-kind-icon">toJSON</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="labeledfacedescriptors.html#fromjson" class="tsd-kind-icon">fromJSON</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Labeled<wbr>Face<wbr>Descriptors<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, descriptors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledFaceDescriptors.ts#L4">classes/LabeledFaceDescriptors.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>label: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>descriptors: <span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="descriptors" class="tsd-anchor"></a>
<h3>descriptors</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> descriptors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledFaceDescriptors.ts#L21">classes/LabeledFaceDescriptors.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="label" class="tsd-anchor"></a>
<h3>label</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> label<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledFaceDescriptors.ts#L19">classes/LabeledFaceDescriptors.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tojson" class="tsd-anchor"></a>
<h3>toJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledFaceDescriptors.ts#L23">classes/LabeledFaceDescriptors.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="fromjson" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> fromJSON</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">fromJSON<span class="tsd-signature-symbol">(</span>json<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledFaceDescriptors.ts#L30">classes/LabeledFaceDescriptors.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>json: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="labeledfacedescriptors.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledFaceDescriptors</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="labeledfacedescriptors.html" class="tsd-kind-icon">Labeled<wbr>Face<wbr>Descriptors</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="labeledfacedescriptors.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="labeledfacedescriptors.html#descriptors" class="tsd-kind-icon">descriptors</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="labeledfacedescriptors.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="labeledfacedescriptors.html#tojson" class="tsd-kind-icon">toJSON</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="labeledfacedescriptors.html#fromjson" class="tsd-kind-icon">fromJSON</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

508
typedoc/classes/netinput.html Normal file
View File

@ -0,0 +1,508 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NetInput | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="netinput.html">NetInput</a>
</li>
</ul>
<h1>Class NetInput</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">NetInput</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="netinput.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#batchsize" class="tsd-kind-icon">batch<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#canvases" class="tsd-kind-icon">canvases</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#imagetensors" class="tsd-kind-icon">image<wbr>Tensors</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#inputdimensions" class="tsd-kind-icon">input<wbr>Dimensions</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#isbatchinput" class="tsd-kind-icon">is<wbr>Batch<wbr>Input</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="netinput.html#reshapedinputdimensions" class="tsd-kind-icon">reshaped<wbr>Input<wbr>Dimensions</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#getinput" class="tsd-kind-icon">get<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#getinputdimensions" class="tsd-kind-icon">get<wbr>Input<wbr>Dimensions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#getinputheight" class="tsd-kind-icon">get<wbr>Input<wbr>Height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#getinputwidth" class="tsd-kind-icon">get<wbr>Input<wbr>Width</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#getreshapedinputdimensions" class="tsd-kind-icon">get<wbr>Reshaped<wbr>Input<wbr>Dimensions</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="netinput.html#tobatchtensor" class="tsd-kind-icon">to<wbr>Batch<wbr>Tensor</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Net<wbr>Input<span class="tsd-signature-symbol">(</span>inputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, treatAsBatchInput<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L24">dom/NetInput.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputs: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>treatAsBatchInput: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="batchsize" class="tsd-anchor"></a>
<h3>batch<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> batchSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L73">dom/NetInput.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="canvases" class="tsd-anchor"></a>
<h3>canvases</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> canvases<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L65">dom/NetInput.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imagetensors" class="tsd-anchor"></a>
<h3>image<wbr>Tensors</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageTensors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L61">dom/NetInput.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="inputdimensions" class="tsd-anchor"></a>
<h3>input<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> inputDimensions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L77">dom/NetInput.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="inputsize" class="tsd-anchor"></a>
<h3>input<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> inputSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L81">dom/NetInput.ts:81</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isbatchinput" class="tsd-anchor"></a>
<h3>is<wbr>Batch<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isBatchInput<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L69">dom/NetInput.ts:69</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="reshapedinputdimensions" class="tsd-anchor"></a>
<h3>reshaped<wbr>Input<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> reshapedInputDimensions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L85">dom/NetInput.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getinput" class="tsd-anchor"></a>
<h3>get<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Input<span class="tsd-signature-symbol">(</span>batchIdx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L91">dom/NetInput.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>batchIdx: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getinputdimensions" class="tsd-anchor"></a>
<h3>get<wbr>Input<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Input<wbr>Dimensions<span class="tsd-signature-symbol">(</span>batchIdx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L95">dom/NetInput.ts:95</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>batchIdx: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getinputheight" class="tsd-anchor"></a>
<h3>get<wbr>Input<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Input<wbr>Height<span class="tsd-signature-symbol">(</span>batchIdx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L99">dom/NetInput.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>batchIdx: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getinputwidth" class="tsd-anchor"></a>
<h3>get<wbr>Input<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Input<wbr>Width<span class="tsd-signature-symbol">(</span>batchIdx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L103">dom/NetInput.ts:103</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>batchIdx: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getreshapedinputdimensions" class="tsd-anchor"></a>
<h3>get<wbr>Reshaped<wbr>Input<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Reshaped<wbr>Input<wbr>Dimensions<span class="tsd-signature-symbol">(</span>batchIdx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L107">dom/NetInput.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>batchIdx: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tobatchtensor" class="tsd-anchor"></a>
<h3>to<wbr>Batch<wbr>Tensor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>Batch<wbr>Tensor<span class="tsd-signature-symbol">(</span>inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, isCenterInputs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/dom/NetInput.ts#L126">dom/NetInput.ts:126</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a batch tensor from all input canvases and tensors
with size [batchSize, inputSize, inputSize, 3].</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Height and width of the tensor.</p>
</div>
</li>
<li>
<h5>isCenterInputs: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<p>The batch tensor.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="netinput.html" class="tsd-kind-icon">Net<wbr>Input</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="netinput.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#batchsize" class="tsd-kind-icon">batch<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#canvases" class="tsd-kind-icon">canvases</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#imagetensors" class="tsd-kind-icon">image<wbr>Tensors</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#inputdimensions" class="tsd-kind-icon">input<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#isbatchinput" class="tsd-kind-icon">is<wbr>Batch<wbr>Input</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="netinput.html#reshapedinputdimensions" class="tsd-kind-icon">reshaped<wbr>Input<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#getinput" class="tsd-kind-icon">get<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#getinputdimensions" class="tsd-kind-icon">get<wbr>Input<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#getinputheight" class="tsd-kind-icon">get<wbr>Input<wbr>Height</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#getinputwidth" class="tsd-kind-icon">get<wbr>Input<wbr>Width</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#getreshapedinputdimensions" class="tsd-kind-icon">get<wbr>Reshaped<wbr>Input<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="netinput.html#tobatchtensor" class="tsd-kind-icon">to<wbr>Batch<wbr>Tensor</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

638
typedoc/classes/neuralnetwork.html Normal file
View File

@ -0,0 +1,638 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NeuralNetwork | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="neuralnetwork.html">NeuralNetwork</a>
</li>
</ul>
<h1>Class NeuralNetwork&lt;TNetParams&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>TNetParams</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">NeuralNetwork</span>
<ul class="tsd-hierarchy">
<li>
<a href="agegendernet.html" class="tsd-signature-type" data-tsd-kind="Class">AgeGenderNet</a>
</li>
<li>
<a href="facerecognitionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceRecognitionNet</a>
</li>
<li>
<a href="ssdmobilenetv1.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="neuralnetwork.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="neuralnetwork.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="neuralnetwork.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="neuralnetwork.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="neuralnetwork.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="neuralnetwork.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">new <wbr>Neural<wbr>Network&lt;TNetParams&gt;<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TNetParams</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L8">NeuralNetwork.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TNetParams</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TNetParams</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="neuralnetwork.html" class="tsd-kind-icon">Neural<wbr>Network</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter">
<a href="neuralnetwork.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="neuralnetwork.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="neuralnetwork.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="neuralnetwork.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="neuralnetwork.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="neuralnetwork.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

398
typedoc/classes/objectdetection.html Normal file
View File

@ -0,0 +1,398 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ObjectDetection | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="objectdetection.html">ObjectDetection</a>
</li>
</ul>
<h1>Class ObjectDetection</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ObjectDetection</span>
<ul class="tsd-hierarchy">
<li>
<a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="objectdetection.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#classname" class="tsd-kind-icon">class<wbr>Name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#classscore" class="tsd-kind-icon">class<wbr>Score</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#imagedims" class="tsd-kind-icon">image<wbr>Dims</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#relativebox" class="tsd-kind-icon">relative<wbr>Box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="objectdetection.html#score" class="tsd-kind-icon">score</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="objectdetection.html#forsize" class="tsd-kind-icon">for<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Object<wbr>Detection<span class="tsd-signature-symbol">(</span>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, classScore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, className<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, relativeBox<span class="tsd-signature-symbol">: </span><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a>, imageDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L14">classes/ObjectDetection.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>score: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>classScore: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>className: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>relativeBox: <a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a></h5>
</li>
<li>
<h5>imageDims: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="box" class="tsd-anchor"></a>
<h3>box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> box<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L36">classes/ObjectDetection.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="classname" class="tsd-anchor"></a>
<h3>class<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> className<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L34">classes/ObjectDetection.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="classscore" class="tsd-anchor"></a>
<h3>class<wbr>Score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> classScore<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L32">classes/ObjectDetection.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imagedims" class="tsd-anchor"></a>
<h3>image<wbr>Dims</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageDims<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L38">classes/ObjectDetection.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imageheight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L42">classes/ObjectDetection.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="imagewidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L40">classes/ObjectDetection.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="relativebox" class="tsd-anchor"></a>
<h3>relative<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativeBox<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L44">classes/ObjectDetection.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="score" class="tsd-anchor"></a>
<h3>score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> score<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L30">classes/ObjectDetection.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forsize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L46">classes/ObjectDetection.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="objectdetection.html" class="tsd-kind-icon">Object<wbr>Detection</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="objectdetection.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#classname" class="tsd-kind-icon">class<wbr>Name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#classscore" class="tsd-kind-icon">class<wbr>Score</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#imagedims" class="tsd-kind-icon">image<wbr>Dims</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#imageheight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#imagewidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#relativebox" class="tsd-kind-icon">relative<wbr>Box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="objectdetection.html#score" class="tsd-kind-icon">score</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="objectdetection.html#forsize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

407
typedoc/classes/point.html Normal file
View File

@ -0,0 +1,407 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Point | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="point.html">Point</a>
</li>
</ul>
<h1>Class Point</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Point</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="point.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="point.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="point.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#abs" class="tsd-kind-icon">abs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#div" class="tsd-kind-icon">div</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#magnitude" class="tsd-kind-icon">magnitude</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#mul" class="tsd-kind-icon">mul</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="point.html#sub" class="tsd-kind-icon">sub</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Point<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L9">classes/Point.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ipoint.html">IPoint</a>.<a href="../interfaces/ipoint.html#x">x</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L16">classes/Point.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ipoint.html">IPoint</a>.<a href="../interfaces/ipoint.html#y">y</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L18">classes/Point.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="abs" class="tsd-anchor"></a>
<h3>abs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">abs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L36">classes/Point.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="add" class="tsd-anchor"></a>
<h3>add</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L20">classes/Point.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="div" class="tsd-anchor"></a>
<h3>div</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">div<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L32">classes/Point.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L44">classes/Point.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="magnitude" class="tsd-anchor"></a>
<h3>magnitude</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">magnitude<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L40">classes/Point.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mul" class="tsd-anchor"></a>
<h3>mul</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">mul<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L28">classes/Point.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sub" class="tsd-anchor"></a>
<h3>sub</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sub<span class="tsd-signature-symbol">(</span>pt<span class="tsd-signature-symbol">: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L24">classes/Point.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pt: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="point.html" class="tsd-kind-icon">Point</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="point.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="point.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="point.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#abs" class="tsd-kind-icon">abs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#div" class="tsd-kind-icon">div</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#magnitude" class="tsd-kind-icon">magnitude</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#mul" class="tsd-kind-icon">mul</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="point.html#sub" class="tsd-kind-icon">sub</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

935
typedoc/classes/predictedbox.html Normal file
View File

@ -0,0 +1,935 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PredictedBox | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="predictedbox.html">PredictedBox</a>
</li>
</ul>
<h1>Class PredictedBox</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">PredictedBox</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="predictedbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="predictedbox.html#classscore" class="tsd-kind-icon">class<wbr>Score</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="predictedbox.html#score" class="tsd-kind-icon">score</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#calibrate" class="tsd-kind-icon">calibrate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#pad" class="tsd-kind-icon">pad</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#rescale" class="tsd-kind-icon">rescale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#round" class="tsd-kind-icon">round</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#shift" class="tsd-kind-icon">shift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="predictedbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="predictedbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="predictedbox.html#assertisvalidlabeledbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="predictedbox.html#assertisvalidpredictedbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Predicted<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="predictedbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Predicted<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, classScore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="predictedbox.html" class="tsd-signature-type" data-tsd-kind="Class">PredictedBox</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/PredictedBox.ts#L20">classes/PredictedBox.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>label: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>score: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>classScore: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="predictedbox.html" class="tsd-signature-type" data-tsd-kind="Class">PredictedBox</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L70">classes/Box.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L68">classes/Box.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomleft" class="tsd-anchor"></a>
<h3>bottom<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L76">classes/Box.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomright" class="tsd-anchor"></a>
<h3>bottom<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L78">classes/Box.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="classscore" class="tsd-anchor"></a>
<h3>class<wbr>Score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> classScore<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/PredictedBox.ts#L30">classes/PredictedBox.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L60">classes/Box.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="label" class="tsd-anchor"></a>
<h3>label</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> label<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledBox.ts#L22">classes/LabeledBox.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L62">classes/Box.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L66">classes/Box.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="score" class="tsd-anchor"></a>
<h3>score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> score<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/PredictedBox.ts#L28">classes/PredictedBox.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L64">classes/Box.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topleft" class="tsd-anchor"></a>
<h3>top<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L72">classes/Box.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topright" class="tsd-anchor"></a>
<h3>top<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L74">classes/Box.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L58">classes/Box.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L54">classes/Box.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L56">classes/Box.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="calibrate" class="tsd-anchor"></a>
<h3>calibrate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">calibrate<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#calibrate">calibrate</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L201">classes/Box.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>region: <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="clipatimageborders" class="tsd-anchor"></a>
<h3>clip<wbr>AtImage<wbr>Borders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">clip<wbr>AtImage<wbr>Borders<span class="tsd-signature-symbol">(</span>imgWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imgHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#clipatimageborders">clipAtImageBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L138">classes/Box.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imgWidth: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imgHeight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#floor">floor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L88">classes/Box.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="pad" class="tsd-anchor"></a>
<h3>pad</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<span class="tsd-signature-symbol">(</span>padX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, padY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#pad">pad</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L126">classes/Box.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>padX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>padY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="padatborders" class="tsd-anchor"></a>
<h3>pad<wbr>AtBorders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<wbr>AtBorders<span class="tsd-signature-symbol">(</span>imageHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imageWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#padatborders">padAtBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L165">classes/Box.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imageHeight: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imageWidth: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="rescale" class="tsd-anchor"></a>
<h3>rescale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">rescale<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#rescale">rescale</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L115">classes/Box.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#round">round</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L80">classes/Box.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#shift">shift</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L155">classes/Box.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="tosquare" class="tsd-anchor"></a>
<h3>to<wbr>Square</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Square<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#tosquare">toSquare</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L96">classes/Box.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="labeledbox.html" class="tsd-signature-type" data-tsd-kind="Class">LabeledBox</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="assertisvalidbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#assertisvalidbox">assertIsValidBox</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L12">classes/Box.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="assertisvalidlabeledbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Labeled<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#assertisvalidlabeledbox">assertIsValidLabeledBox</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/LabeledBox.ts#L7">classes/LabeledBox.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="assertisvalidpredictedbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Predicted<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Predicted<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/PredictedBox.ts#L7">classes/PredictedBox.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="isrect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Rect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>Rect<span class="tsd-signature-symbol">(</span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="labeledbox.html">LabeledBox</a>.<a href="labeledbox.html#isrect">isRect</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L8">classes/Box.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="predictedbox.html" class="tsd-kind-icon">Predicted<wbr>Box</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="predictedbox.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="predictedbox.html#classscore" class="tsd-kind-icon">class<wbr>Score</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="predictedbox.html#score" class="tsd-kind-icon">score</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#top" class="tsd-kind-icon">top</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#topleft" class="tsd-kind-icon">top<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#topright" class="tsd-kind-icon">top<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#calibrate" class="tsd-kind-icon">calibrate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#pad" class="tsd-kind-icon">pad</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#rescale" class="tsd-kind-icon">rescale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#round" class="tsd-kind-icon">round</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="predictedbox.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="predictedbox.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="predictedbox.html#assertisvalidlabeledbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Labeled<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="predictedbox.html#assertisvalidpredictedbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Predicted<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="predictedbox.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

824
typedoc/classes/rect.html Normal file
View File

@ -0,0 +1,824 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Rect | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="rect.html">Rect</a>
</li>
</ul>
<h1>Class Rect</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">Rect</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="rect.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#area" class="tsd-kind-icon">area</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#top" class="tsd-kind-icon">top</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#topleft" class="tsd-kind-icon">top<wbr>Left</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#topright" class="tsd-kind-icon">top<wbr>Right</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#calibrate" class="tsd-kind-icon">calibrate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#floor" class="tsd-kind-icon">floor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#pad" class="tsd-kind-icon">pad</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#rescale" class="tsd-kind-icon">rescale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#round" class="tsd-kind-icon">round</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#shift" class="tsd-kind-icon">shift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="rect.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="rect.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="rect.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Rect<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="box.html">Box</a>.<a href="box.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Rect.ts#L10">classes/Rect.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>y: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="area" class="tsd-anchor"></a>
<h3>area</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L70">classes/Box.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L68">classes/Box.ts:68</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomleft" class="tsd-anchor"></a>
<h3>bottom<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L76">classes/Box.ts:76</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="bottomright" class="tsd-anchor"></a>
<h3>bottom<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bottomRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L78">classes/Box.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#height">height</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L60">classes/Box.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> left<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L62">classes/Box.ts:62</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> right<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L66">classes/Box.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> top<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L64">classes/Box.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topleft" class="tsd-anchor"></a>
<h3>top<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topLeft<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L72">classes/Box.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="topright" class="tsd-anchor"></a>
<h3>top<wbr>Right</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> topRight<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L74">classes/Box.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#width">width</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L58">classes/Box.ts:58</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> x<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#x">x</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L54">classes/Box.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> y<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/irect.html">IRect</a>.<a href="../interfaces/irect.html#y">y</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L56">classes/Box.ts:56</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="calibrate" class="tsd-anchor"></a>
<h3>calibrate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">calibrate<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#calibrate">calibrate</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L201">classes/Box.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>region: <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="clipatimageborders" class="tsd-anchor"></a>
<h3>clip<wbr>AtImage<wbr>Borders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">clip<wbr>AtImage<wbr>Borders<span class="tsd-signature-symbol">(</span>imgWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imgHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#clipatimageborders">clipAtImageBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L138">classes/Box.ts:138</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imgWidth: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imgHeight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="floor" class="tsd-anchor"></a>
<h3>floor</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#floor">floor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L88">classes/Box.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="pad" class="tsd-anchor"></a>
<h3>pad</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<span class="tsd-signature-symbol">(</span>padX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, padY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#pad">pad</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L126">classes/Box.ts:126</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>padX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>padY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="padatborders" class="tsd-anchor"></a>
<h3>pad<wbr>AtBorders</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pad<wbr>AtBorders<span class="tsd-signature-symbol">(</span>imageHeight<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, imageWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#padatborders">padAtBorders</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L165">classes/Box.ts:165</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>imageHeight: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>imageWidth: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>dx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>dy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>edy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>ey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>h<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>w<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="rescale" class="tsd-anchor"></a>
<h3>rescale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">rescale<span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#rescale">rescale</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L115">classes/Box.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>s: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#round">round</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L80">classes/Box.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span>sx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#shift">shift</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L155">classes/Box.ts:155</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sx: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>sy: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="tosquare" class="tsd-anchor"></a>
<h3>to<wbr>Square</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>Square<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#tosquare">toSquare</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L96">classes/Box.ts:96</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><a href="rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="assertisvalidbox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> assert<wbr>IsValid<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsValid<wbr>Box<span class="tsd-signature-symbol">(</span>box<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, allowNegativeDimensions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#assertisvalidbox">assertIsValidBox</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L12">classes/Box.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>box: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>callee: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>allowNegativeDimensions: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="isrect" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Rect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>Rect<span class="tsd-signature-symbol">(</span>rect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="box.html">Box</a>.<a href="box.html#isrect">isRect</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Box.ts#L8">classes/Box.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>rect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="rect.html" class="tsd-kind-icon">Rect</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="rect.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#area" class="tsd-kind-icon">area</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#bottomleft" class="tsd-kind-icon">bottom<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#bottomright" class="tsd-kind-icon">bottom<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#top" class="tsd-kind-icon">top</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#topleft" class="tsd-kind-icon">top<wbr>Left</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#topright" class="tsd-kind-icon">top<wbr>Right</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#y" class="tsd-kind-icon">y</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#calibrate" class="tsd-kind-icon">calibrate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#clipatimageborders" class="tsd-kind-icon">clip<wbr>AtImage<wbr>Borders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#floor" class="tsd-kind-icon">floor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#pad" class="tsd-kind-icon">pad</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#padatborders" class="tsd-kind-icon">pad<wbr>AtBorders</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#rescale" class="tsd-kind-icon">rescale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#round" class="tsd-kind-icon">round</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#shift" class="tsd-kind-icon">shift</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="rect.html#tosquare" class="tsd-kind-icon">to<wbr>Square</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="rect.html#assertisvalidbox" class="tsd-kind-icon">assert<wbr>IsValid<wbr>Box</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="rect.html#isrect" class="tsd-kind-icon">is<wbr>Rect</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

717
typedoc/classes/ssdmobilenetv1.html Normal file
View File

@ -0,0 +1,717 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SsdMobilenetv1 | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ssdmobilenetv1.html">SsdMobilenetv1</a>
</li>
</ul>
<h1>Class SsdMobilenetv1</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="neuralnetwork.html" class="tsd-signature-type" data-tsd-kind="Class">NeuralNetwork</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">NetParams</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">SsdMobilenetv1</span>
<ul class="tsd-hierarchy">
<li>
<a href="facedetectionnet.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetectionNet</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ssdmobilenetv1.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#_name" class="tsd-kind-icon">_name</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#params" class="tsd-kind-icon">params</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ssdmobilenetv1.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ssdmobilenetv1.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ssdmobilenetv1.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ssdmobilenetv1.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Ssd<wbr>Mobilenetv1<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ssdmobilenetv1.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L16">ssdMobilenetv1/SsdMobilenetv1.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="ssdmobilenetv1.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#_name">_name</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#extractweights">extractWeights</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L39">ssdMobilenetv1/SsdMobilenetv1.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L21">ssdMobilenetv1/SsdMobilenetv1.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#freeze">freeze</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getfrozenparams">getFrozenParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamfrompath">getParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#getparamlist">getParamList</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#gettrainableparams">getTrainableParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromdisk">loadFromDisk</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromuri">loadFromUri</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#loadfromweightmap">loadFromWeightMap</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="locatefaces" class="tsd-anchor"></a>
<h3>locate<wbr>Faces</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">locate<wbr>Faces<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1.ts#L43">ssdMobilenetv1/SsdMobilenetv1.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>options: <a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#reassignparamfrompath">reassignParamFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#serializeparams">serializeParams</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="neuralnetwork.html">NeuralNetwork</a>.<a href="neuralnetwork.html#variable">variable</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ssdmobilenetv1.html" class="tsd-kind-icon">Ssd<wbr>Mobilenetv1</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="ssdmobilenetv1.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ssdmobilenetv1.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ssdmobilenetv1.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ssdmobilenetv1.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ssdmobilenetv1.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

217
typedoc/classes/ssdmobilenetv1options.html Normal file
View File

@ -0,0 +1,217 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SsdMobilenetv1Options | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ssdmobilenetv1options.html">SsdMobilenetv1Options</a>
</li>
</ul>
<h1>Class SsdMobilenetv1Options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SsdMobilenetv1Options</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ssdmobilenetv1options.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ssdmobilenetv1options.html#maxresults" class="tsd-kind-icon">max<wbr>Results</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="ssdmobilenetv1options.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Ssd<wbr>Mobilenetv1<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ssdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1Options</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1Options.ts#L11">ssdMobilenetv1/SsdMobilenetv1Options.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/issdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Interface">ISsdMobilenetv1Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ssdmobilenetv1options.html" class="tsd-signature-type" data-tsd-kind="Class">SsdMobilenetv1Options</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="maxresults" class="tsd-anchor"></a>
<h3>max<wbr>Results</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> maxResults<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1Options.ts#L28">ssdMobilenetv1/SsdMobilenetv1Options.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="minconfidence" class="tsd-anchor"></a>
<h3>min<wbr>Confidence</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> minConfidence<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1Options.ts#L26">ssdMobilenetv1/SsdMobilenetv1Options.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="ssdmobilenetv1options.html" class="tsd-kind-icon">Ssd<wbr>Mobilenetv1<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="ssdmobilenetv1options.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="ssdmobilenetv1options.html#maxresults" class="tsd-kind-icon">max<wbr>Results</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="ssdmobilenetv1options.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

912
typedoc/classes/tinyfacedetector.html Normal file
View File

@ -0,0 +1,912 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TinyFaceDetector | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="tinyfacedetector.html">TinyFaceDetector</a>
</li>
</ul>
<h1>Class TinyFaceDetector</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">TinyYolov2Base</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">TinyFaceDetector</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="tinyfacedetector.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#_name" class="tsd-kind-icon">_name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="tinyfacedetector.html#default_filter_sizes" class="tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#anchors" class="tsd-kind-icon">anchors</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#boxencodingsize" class="tsd-kind-icon">box<wbr>Encoding<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyfacedetector.html#withclassscores" class="tsd-kind-icon">with<wbr>Class<wbr>Scores</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#detect" class="tsd-kind-icon">detect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tinyfacedetector.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#runmobilenet" class="tsd-kind-icon">run<wbr>Mobilenet</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#runtinyyolov2" class="tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetector.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tiny<wbr>Face<wbr>Detector<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tinyfacedetector.html" class="tsd-signature-type" data-tsd-kind="Class">TinyFaceDetector</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides TinyYolov2Base.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyFaceDetector/TinyFaceDetector.ts#L11">tinyFaceDetector/TinyFaceDetector.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="tinyfacedetector.html" class="tsd-signature-type" data-tsd-kind="Class">TinyFaceDetector</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base._name</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="default_filter_sizes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>FILTER_<wbr>SIZES</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.DEFAULT_FILTER_SIZES</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L25">tinyYolov2/TinyYolov2Base.ts:25</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="anchors" class="tsd-anchor"></a>
<h3>anchors</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> anchors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyFaceDetector/TinyFaceDetector.ts#L26">tinyFaceDetector/TinyFaceDetector.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="boxencodingsize" class="tsd-anchor"></a>
<h3>box<wbr>Encoding<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> boxEncodingSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L43">tinyYolov2/TinyYolov2Base.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#tinyyolov2config" class="tsd-signature-type" data-tsd-kind="Type alias">TinyYolov2Config</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L35">tinyYolov2/TinyYolov2Base.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../index.html#tinyyolov2config" class="tsd-signature-type" data-tsd-kind="Type alias">TinyYolov2Config</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="withclassscores" class="tsd-anchor"></a>
<h3>with<wbr>Class<wbr>Scores</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> withClassScores<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L39">tinyYolov2/TinyYolov2Base.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="detect" class="tsd-anchor"></a>
<h3>detect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">detect<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, forwardParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.detect</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L108">tinyYolov2/TinyYolov2Base.ts:108</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>forwardParams: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.extractWeights</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.forward</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L104">tinyYolov2/TinyYolov2Base.ts:104</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.forwardInput</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L85">tinyYolov2/TinyYolov2Base.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.freeze</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getFrozenParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getParamList</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getTrainableParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.load</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromDisk</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromUri</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromWeightMap</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="locatefaces" class="tsd-anchor"></a>
<h3>locate<wbr>Faces</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">locate<wbr>Faces<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, forwardParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyFaceDetector/TinyFaceDetector.ts#L30">tinyFaceDetector/TinyFaceDetector.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>forwardParams: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.reassignParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runmobilenet" class="tsd-anchor"></a>
<h3>run<wbr>Mobilenet</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Mobilenet<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, params<span class="tsd-signature-symbol">: </span><a href="../index.html#mobilenetparams" class="tsd-signature-type" data-tsd-kind="Type alias">MobilenetParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.runMobilenet</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L65">tinyYolov2/TinyYolov2Base.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>params: <a href="../index.html#mobilenetparams" class="tsd-signature-type" data-tsd-kind="Type alias">MobilenetParams</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runtinyyolov2" class="tsd-anchor"></a>
<h3>run<wbr>Tiny<wbr>Yolov2</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, params<span class="tsd-signature-symbol">: </span><a href="../index.html#defaulttinyyolov2netparams" class="tsd-signature-type" data-tsd-kind="Type alias">DefaultTinyYolov2NetParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.runTinyYolov2</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L47">tinyYolov2/TinyYolov2Base.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>params: <a href="../index.html#defaulttinyyolov2netparams" class="tsd-signature-type" data-tsd-kind="Type alias">DefaultTinyYolov2NetParams</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.serializeParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.variable</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="tinyfacedetector.html" class="tsd-kind-icon">Tiny<wbr>Face<wbr>Detector</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="tinyfacedetector.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="tinyfacedetector.html#default_filter_sizes" class="tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#anchors" class="tsd-kind-icon">anchors</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#boxencodingsize" class="tsd-kind-icon">box<wbr>Encoding<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyfacedetector.html#withclassscores" class="tsd-kind-icon">with<wbr>Class<wbr>Scores</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#detect" class="tsd-kind-icon">detect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tinyfacedetector.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#runmobilenet" class="tsd-kind-icon">run<wbr>Mobilenet</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#runtinyyolov2" class="tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetector.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

223
typedoc/classes/tinyfacedetectoroptions.html Normal file
View File

@ -0,0 +1,223 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TinyFaceDetectorOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="tinyfacedetectoroptions.html">TinyFaceDetectorOptions</a>
</li>
</ul>
<h1>Class TinyFaceDetectorOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="tinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Class">TinyYolov2Options</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">TinyFaceDetectorOptions</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetectoroptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetectoroptions.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="tinyfacedetectoroptions.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tiny<wbr>Face<wbr>Detector<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tinyfacedetectoroptions.html" class="tsd-signature-type" data-tsd-kind="Class">TinyFaceDetectorOptions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="tinyyolov2options.html">TinyYolov2Options</a>.<a href="tinyyolov2options.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L11">tinyYolov2/TinyYolov2Options.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tinyfacedetectoroptions.html" class="tsd-signature-type" data-tsd-kind="Class">TinyFaceDetectorOptions</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="inputsize" class="tsd-anchor"></a>
<h3>input<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> inputSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L26">tinyYolov2/TinyYolov2Options.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="scorethreshold" class="tsd-anchor"></a>
<h3>score<wbr>Threshold</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> scoreThreshold<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L28">tinyYolov2/TinyYolov2Options.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="tinyfacedetectoroptions.html" class="tsd-kind-icon">Tiny<wbr>Face<wbr>Detector<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetectoroptions.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetectoroptions.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="tinyfacedetectoroptions.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

939
typedoc/classes/tinyyolov2.html Normal file
View File

@ -0,0 +1,939 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TinyYolov2 | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="tinyyolov2.html">TinyYolov2</a>
</li>
</ul>
<h1>Class TinyYolov2</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">TinyYolov2Base</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">TinyYolov2</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="tinyyolov2.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#_name" class="tsd-kind-icon">_name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="tinyyolov2.html#default_filter_sizes" class="tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#anchors" class="tsd-kind-icon">anchors</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#boxencodingsize" class="tsd-kind-icon">box<wbr>Encoding<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#withclassscores" class="tsd-kind-icon">with<wbr>Class<wbr>Scores</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2.html#withseparableconvs" class="tsd-kind-icon">with<wbr>Separable<wbr>Convs</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#detect" class="tsd-kind-icon">detect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#forward" class="tsd-kind-icon">forward</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#freeze" class="tsd-kind-icon">freeze</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="tinyyolov2.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#runmobilenet" class="tsd-kind-icon">run<wbr>Mobilenet</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#runtinyyolov2" class="tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="tinyyolov2.html#variable" class="tsd-kind-icon">variable</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tiny<wbr>Yolov2<span class="tsd-signature-symbol">(</span>withSeparableConvs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tinyyolov2.html" class="tsd-signature-type" data-tsd-kind="Class">TinyYolov2</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides TinyYolov2Base.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2.ts#L18">tinyYolov2/TinyYolov2.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>withSeparableConvs: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tinyyolov2.html" class="tsd-signature-type" data-tsd-kind="Class">TinyYolov2</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="_name" class="tsd-anchor"></a>
<h3>_name</h3>
<div class="tsd-signature tsd-kind-icon">_name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base._name</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L17">NeuralNetwork.ts:17</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="default_filter_sizes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> DEFAULT_<wbr>FILTER_<wbr>SIZES</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.DEFAULT_FILTER_SIZES</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L25">tinyYolov2/TinyYolov2Base.ts:25</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="anchors" class="tsd-anchor"></a>
<h3>anchors</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> anchors<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2.ts#L42">tinyYolov2/TinyYolov2.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="boxencodingsize" class="tsd-anchor"></a>
<h3>box<wbr>Encoding<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> boxEncodingSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L43">tinyYolov2/TinyYolov2Base.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="config" class="tsd-anchor"></a>
<h3>config</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#tinyyolov2config" class="tsd-signature-type" data-tsd-kind="Type alias">TinyYolov2Config</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L35">tinyYolov2/TinyYolov2Base.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../index.html#tinyyolov2config" class="tsd-signature-type" data-tsd-kind="Type alias">TinyYolov2Config</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isloaded" class="tsd-anchor"></a>
<h3>is<wbr>Loaded</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isLoaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L23">NeuralNetwork.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="parammappings" class="tsd-anchor"></a>
<h3>param<wbr>Mappings</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> paramMappings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L21">NeuralNetwork.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParamMapping</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L19">NeuralNetwork.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TNetParams</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="withclassscores" class="tsd-anchor"></a>
<h3>with<wbr>Class<wbr>Scores</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> withClassScores<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L39">tinyYolov2/TinyYolov2Base.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="withseparableconvs" class="tsd-anchor"></a>
<h3>with<wbr>Separable<wbr>Convs</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> withSeparableConvs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2.ts#L38">tinyYolov2/TinyYolov2.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="detect" class="tsd-anchor"></a>
<h3>detect</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">detect<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, forwardParams<span class="tsd-signature-symbol">?: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.detect</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L108">tinyYolov2/TinyYolov2Base.ts:108</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>forwardParams: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="objectdetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>throwOnRedispose<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L65">NeuralNetwork.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throwOnRedispose: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="extractweights" class="tsd-anchor"></a>
<h3>extract<wbr>Weights</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">extract<wbr>Weights<span class="tsd-signature-symbol">(</span>weights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.extractWeights</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L118">NeuralNetwork.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weights: <span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forward" class="tsd-anchor"></a>
<h3>forward</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.forward</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L104">tinyYolov2/TinyYolov2Base.ts:104</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="forwardinput" class="tsd-anchor"></a>
<h3>forward<wbr>Input</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">forward<wbr>Input<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.forwardInput</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L85">tinyYolov2/TinyYolov2Base.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="netinput.html" class="tsd-signature-type" data-tsd-kind="Class">NetInput</a></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="freeze" class="tsd-anchor"></a>
<h3>freeze</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">freeze<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.freeze</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L57">NeuralNetwork.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getfrozenparams" class="tsd-anchor"></a>
<h3>get<wbr>Frozen<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Frozen<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getFrozenParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L47">NeuralNetwork.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamfrompath" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L25">NeuralNetwork.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getparamlist" class="tsd-anchor"></a>
<h3>get<wbr>Param<wbr>List</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Param<wbr>List<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getParamList</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L36">NeuralNetwork.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="gettrainableparams" class="tsd-anchor"></a>
<h3>get<wbr>Trainable<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Trainable<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.getTrainableParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L43">NeuralNetwork.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>weightsOrUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.load</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L83">NeuralNetwork.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightsOrUrl: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Float32Array</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromdisk" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Disk</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Disk<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromDisk</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L99">NeuralNetwork.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filePath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromuri" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Uri</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Uri<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromUri</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L91">NeuralNetwork.ts:91</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="loadfromweightmap" class="tsd-anchor"></a>
<h3>load<wbr>From<wbr>Weight<wbr>Map</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map<span class="tsd-signature-symbol">(</span>weightMap<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.loadFromWeightMap</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L112">NeuralNetwork.ts:112</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>weightMap: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="locatefaces" class="tsd-anchor"></a>
<h3>locate<wbr>Faces</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">locate<wbr>Faces<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, forwardParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2.ts#L46">tinyYolov2/TinyYolov2.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>forwardParams: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="reassignparamfrompath" class="tsd-anchor"></a>
<h3>reassign<wbr>Param<wbr>From<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path<span class="tsd-signature-symbol">(</span>paramPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.reassignParamFromPath</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L30">NeuralNetwork.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>paramPath: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runmobilenet" class="tsd-anchor"></a>
<h3>run<wbr>Mobilenet</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Mobilenet<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, params<span class="tsd-signature-symbol">: </span><a href="../index.html#mobilenetparams" class="tsd-signature-type" data-tsd-kind="Type alias">MobilenetParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.runMobilenet</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L65">tinyYolov2/TinyYolov2Base.ts:65</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>params: <a href="../index.html#mobilenetparams" class="tsd-signature-type" data-tsd-kind="Type alias">MobilenetParams</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="runtinyyolov2" class="tsd-anchor"></a>
<h3>run<wbr>Tiny<wbr>Yolov2</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, params<span class="tsd-signature-symbol">: </span><a href="../index.html#defaulttinyyolov2netparams" class="tsd-signature-type" data-tsd-kind="Type alias">DefaultTinyYolov2NetParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.runTinyYolov2</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Base.ts#L47">tinyYolov2/TinyYolov2Base.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>x: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>params: <a href="../index.html#defaulttinyyolov2netparams" class="tsd-signature-type" data-tsd-kind="Type alias">DefaultTinyYolov2NetParams</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializeparams" class="tsd-anchor"></a>
<h3>serialize<wbr>Params</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>Params<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Float32Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.serializeParams</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L75">NeuralNetwork.ts:75</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Float32Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="variable" class="tsd-anchor"></a>
<h3>variable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from TinyYolov2Base.variable</p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/NeuralNetwork.ts#L51">NeuralNetwork.ts:51</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="tinyyolov2.html" class="tsd-kind-icon">Tiny<wbr>Yolov2</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="tinyyolov2.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#_name" class="tsd-kind-icon">_name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="tinyyolov2.html#default_filter_sizes" class="tsd-kind-icon">DEFAULT_<wbr>FILTER_<wbr>SIZES</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#anchors" class="tsd-kind-icon">anchors</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#boxencodingsize" class="tsd-kind-icon">box<wbr>Encoding<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#isloaded" class="tsd-kind-icon">is<wbr>Loaded</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#parammappings" class="tsd-kind-icon">param<wbr>Mappings</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#withclassscores" class="tsd-kind-icon">with<wbr>Class<wbr>Scores</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2.html#withseparableconvs" class="tsd-kind-icon">with<wbr>Separable<wbr>Convs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#detect" class="tsd-kind-icon">detect</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#extractweights" class="tsd-kind-icon">extract<wbr>Weights</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#forward" class="tsd-kind-icon">forward</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#forwardinput" class="tsd-kind-icon">forward<wbr>Input</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#freeze" class="tsd-kind-icon">freeze</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#getfrozenparams" class="tsd-kind-icon">get<wbr>Frozen<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#getparamfrompath" class="tsd-kind-icon">get<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#getparamlist" class="tsd-kind-icon">get<wbr>Param<wbr>List</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#gettrainableparams" class="tsd-kind-icon">get<wbr>Trainable<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#loadfromdisk" class="tsd-kind-icon">load<wbr>From<wbr>Disk</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#loadfromuri" class="tsd-kind-icon">load<wbr>From<wbr>Uri</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#loadfromweightmap" class="tsd-kind-icon">load<wbr>From<wbr>Weight<wbr>Map</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="tinyyolov2.html#locatefaces" class="tsd-kind-icon">locate<wbr>Faces</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#reassignparamfrompath" class="tsd-kind-icon">reassign<wbr>Param<wbr>From<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#runmobilenet" class="tsd-kind-icon">run<wbr>Mobilenet</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#runtinyyolov2" class="tsd-kind-icon">run<wbr>Tiny<wbr>Yolov2</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#serializeparams" class="tsd-kind-icon">serialize<wbr>Params</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="tinyyolov2.html#variable" class="tsd-kind-icon">variable</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

222
typedoc/classes/tinyyolov2options.html Normal file
View File

@ -0,0 +1,222 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TinyYolov2Options | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="tinyyolov2options.html">TinyYolov2Options</a>
</li>
</ul>
<h1>Class TinyYolov2Options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">TinyYolov2Options</span>
<ul class="tsd-hierarchy">
<li>
<a href="tinyfacedetectoroptions.html" class="tsd-signature-type" data-tsd-kind="Class">TinyFaceDetectorOptions</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="tinyyolov2options.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2options.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="tinyyolov2options.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tiny<wbr>Yolov2<wbr>Options<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Class">TinyYolov2Options</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L11">tinyYolov2/TinyYolov2Options.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Class">TinyYolov2Options</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="inputsize" class="tsd-anchor"></a>
<h3>input<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> inputSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L26">tinyYolov2/TinyYolov2Options.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="scorethreshold" class="tsd-anchor"></a>
<h3>score<wbr>Threshold</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> scoreThreshold<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L28">tinyYolov2/TinyYolov2Options.ts:28</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="tinyyolov2options.html" class="tsd-kind-icon">Tiny<wbr>Yolov2<wbr>Options</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="tinyyolov2options.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2options.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="tinyyolov2options.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

245
typedoc/enums/draw.anchorposition.html Normal file
View File

@ -0,0 +1,245 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AnchorPosition | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.anchorposition.html">AnchorPosition</a>
</li>
</ul>
<h1>Enumeration AnchorPosition</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="draw.anchorposition.html#bottom_left" class="tsd-kind-icon">BOTTOM_<wbr>LEFT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="draw.anchorposition.html#bottom_right" class="tsd-kind-icon">BOTTOM_<wbr>RIGHT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="draw.anchorposition.html#top_left" class="tsd-kind-icon">TOP_<wbr>LEFT</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="draw.anchorposition.html#top_right" class="tsd-kind-icon">TOP_<wbr>RIGHT</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="bottom_left" class="tsd-anchor"></a>
<h3>BOTTOM_<wbr>LEFT</h3>
<div class="tsd-signature tsd-kind-icon">BOTTOM_<wbr>LEFT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;BOTTOM_LEFT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L13">draw/DrawTextField.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="bottom_right" class="tsd-anchor"></a>
<h3>BOTTOM_<wbr>RIGHT</h3>
<div class="tsd-signature tsd-kind-icon">BOTTOM_<wbr>RIGHT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;BOTTOM_RIGHT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L15">draw/DrawTextField.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="top_left" class="tsd-anchor"></a>
<h3>TOP_<wbr>LEFT</h3>
<div class="tsd-signature tsd-kind-icon">TOP_<wbr>LEFT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;TOP_LEFT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L9">draw/DrawTextField.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="top_right" class="tsd-anchor"></a>
<h3>TOP_<wbr>RIGHT</h3>
<div class="tsd-signature tsd-kind-icon">TOP_<wbr>RIGHT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;TOP_RIGHT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L11">draw/DrawTextField.ts:11</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum tsd-parent-kind-namespace">
<a href="draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="draw.anchorposition.html#bottom_left" class="tsd-kind-icon">BOTTOM_<wbr>LEFT</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="draw.anchorposition.html#bottom_right" class="tsd-kind-icon">BOTTOM_<wbr>RIGHT</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="draw.anchorposition.html#top_left" class="tsd-kind-icon">TOP_<wbr>LEFT</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="draw.anchorposition.html#top_right" class="tsd-kind-icon">TOP_<wbr>RIGHT</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

160
typedoc/enums/gender.html Normal file
View File

@ -0,0 +1,160 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Gender | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="gender.html">Gender</a>
</li>
</ul>
<h1>Enumeration Gender</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="gender.html#female" class="tsd-kind-icon">FEMALE</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="gender.html#male" class="tsd-kind-icon">MALE</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="female" class="tsd-anchor"></a>
<h3>FEMALE</h3>
<div class="tsd-signature tsd-kind-icon">FEMALE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;female&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/types.ts#L8">ageGenderNet/types.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="male" class="tsd-anchor"></a>
<h3>MALE</h3>
<div class="tsd-signature tsd-kind-icon">MALE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;male&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ageGenderNet/types.ts#L10">ageGenderNet/types.ts:10</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="gender.html" class="tsd-kind-icon">Gender</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="gender.html#female" class="tsd-kind-icon">FEMALE</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="gender.html#male" class="tsd-kind-icon">MALE</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

3401
typedoc/index.html Normal file
View File

File diff suppressed because it is too large Load Diff

253
typedoc/interfaces/draw.idrawboxoptions.html Normal file
View File

@ -0,0 +1,253 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IDrawBoxOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.idrawboxoptions.html">IDrawBoxOptions</a>
</li>
</ul>
<h1>Interface IDrawBoxOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IDrawBoxOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawboxoptions.html#boxcolor" class="tsd-kind-icon">box<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawboxoptions.html#drawlabeloptions" class="tsd-kind-icon">draw<wbr>Label<wbr>Options</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawboxoptions.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawboxoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="boxcolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> box<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">box<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L9">draw/DrawBox.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawlabeloptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> draw<wbr>Label<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Label<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="draw.idrawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDrawTextFieldOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L11">draw/DrawBox.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L12">draw/DrawBox.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="linewidth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> line<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawBox.ts#L10">draw/DrawBox.ts:10</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawboxoptions.html#boxcolor" class="tsd-kind-icon">box<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawboxoptions.html#drawlabeloptions" class="tsd-kind-icon">draw<wbr>Label<wbr>Options</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawboxoptions.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawboxoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

281
typedoc/interfaces/draw.idrawfacelandmarksoptions.html Normal file
View File

@ -0,0 +1,281 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IDrawFaceLandmarksOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.idrawfacelandmarksoptions.html">IDrawFaceLandmarksOptions</a>
</li>
</ul>
<h1>Interface IDrawFaceLandmarksOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IDrawFaceLandmarksOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#drawlines" class="tsd-kind-icon">draw<wbr>Lines</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#drawpoints" class="tsd-kind-icon">draw<wbr>Points</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#linecolor" class="tsd-kind-icon">line<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#pointcolor" class="tsd-kind-icon">point<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawfacelandmarksoptions.html#pointsize" class="tsd-kind-icon">point<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawlines" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> draw<wbr>Lines</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Lines<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L11">draw/DrawFaceLandmarks.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="drawpoints" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> draw<wbr>Points</h3>
<div class="tsd-signature tsd-kind-icon">draw<wbr>Points<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L12">draw/DrawFaceLandmarks.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="linecolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> line<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L15">draw/DrawFaceLandmarks.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="linewidth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> line<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L13">draw/DrawFaceLandmarks.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pointcolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> point<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">point<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L16">draw/DrawFaceLandmarks.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pointsize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> point<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">point<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L14">draw/DrawFaceLandmarks.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#drawlines" class="tsd-kind-icon">draw<wbr>Lines</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#drawpoints" class="tsd-kind-icon">draw<wbr>Points</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#linecolor" class="tsd-kind-icon">line<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#linewidth" class="tsd-kind-icon">line<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#pointcolor" class="tsd-kind-icon">point<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawfacelandmarksoptions.html#pointsize" class="tsd-kind-icon">point<wbr>Size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

287
typedoc/interfaces/draw.idrawtextfieldoptions.html Normal file
View File

@ -0,0 +1,287 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IDrawTextFieldOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="../modules/draw.html">draw</a>
</li>
<li>
<a href="draw.idrawtextfieldoptions.html">IDrawTextFieldOptions</a>
</li>
</ul>
<h1>Interface IDrawTextFieldOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IDrawTextFieldOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/draw.drawtextfieldoptions.html" class="tsd-signature-type" data-tsd-kind="Class">DrawTextFieldOptions</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#anchorposition" class="tsd-kind-icon">anchor<wbr>Position</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#fontcolor" class="tsd-kind-icon">font<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#fontsize" class="tsd-kind-icon">font<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#fontstyle" class="tsd-kind-icon">font<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="draw.idrawtextfieldoptions.html#padding" class="tsd-kind-icon">padding</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="anchorposition" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> anchor<wbr>Position</h3>
<div class="tsd-signature tsd-kind-icon">anchor<wbr>Position<span class="tsd-signature-symbol">:</span> <a href="../enums/draw.anchorposition.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnchorPosition</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L19">draw/DrawTextField.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="backgroundcolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> background<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L20">draw/DrawTextField.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fontcolor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L21">draw/DrawTextField.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fontsize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L22">draw/DrawTextField.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fontstyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L23">draw/DrawTextField.ts:23</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="padding" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> padding</h3>
<div class="tsd-signature tsd-kind-icon">padding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawTextField.ts#L24">draw/DrawTextField.ts:24</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="../modules/utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#anchorposition" class="tsd-kind-icon">anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#fontcolor" class="tsd-kind-icon">font<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#fontsize" class="tsd-kind-icon">font<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#fontstyle" class="tsd-kind-icon">font<wbr>Style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="draw.idrawtextfieldoptions.html#padding" class="tsd-kind-icon">padding</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="../modules/draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="../modules/draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

203
typedoc/interfaces/iboundingbox.html Normal file
View File

@ -0,0 +1,203 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IBoundingBox | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="iboundingbox.html">IBoundingBox</a>
</li>
</ul>
<h1>Interface IBoundingBox</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IBoundingBox</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/boundingbox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a></li>
<li><a href="../classes/box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="iboundingbox.html#bottom" class="tsd-kind-icon">bottom</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="iboundingbox.html#left" class="tsd-kind-icon">left</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="iboundingbox.html#right" class="tsd-kind-icon">right</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="iboundingbox.html#top" class="tsd-kind-icon">top</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bottom" class="tsd-anchor"></a>
<h3>bottom</h3>
<div class="tsd-signature tsd-kind-icon">bottom<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/BoundingBox.ts#L7">classes/BoundingBox.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="left" class="tsd-anchor"></a>
<h3>left</h3>
<div class="tsd-signature tsd-kind-icon">left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/BoundingBox.ts#L4">classes/BoundingBox.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="right" class="tsd-anchor"></a>
<h3>right</h3>
<div class="tsd-signature tsd-kind-icon">right<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/BoundingBox.ts#L6">classes/BoundingBox.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="top" class="tsd-anchor"></a>
<h3>top</h3>
<div class="tsd-signature tsd-kind-icon">top<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/BoundingBox.ts#L5">classes/BoundingBox.ts:5</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="iboundingbox.html" class="tsd-kind-icon">IBounding<wbr>Box</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="iboundingbox.html#bottom" class="tsd-kind-icon">bottom</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="iboundingbox.html#left" class="tsd-kind-icon">left</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="iboundingbox.html#right" class="tsd-kind-icon">right</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="iboundingbox.html#top" class="tsd-kind-icon">top</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

174
typedoc/interfaces/idimensions.html Normal file
View File

@ -0,0 +1,174 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IDimensions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="idimensions.html">IDimensions</a>
</li>
</ul>
<h1>Interface IDimensions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IDimensions</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="idimensions.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="idimensions.html#width" class="tsd-kind-icon">width</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L5">classes/Dimensions.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Dimensions.ts#L4">classes/Dimensions.ts:4</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="idimensions.html" class="tsd-kind-icon">IDimensions</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="idimensions.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="idimensions.html#width" class="tsd-kind-icon">width</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

174
typedoc/interfaces/ifacedetecion.html Normal file
View File

@ -0,0 +1,174 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IFaceDetecion | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ifacedetecion.html">IFaceDetecion</a>
</li>
</ul>
<h1>Interface IFaceDetecion</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IFaceDetecion</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacedetecion.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacedetecion.html#score" class="tsd-kind-icon">score</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="box" class="tsd-anchor"></a>
<h3>box</h3>
<div class="tsd-signature tsd-kind-icon">box<span class="tsd-signature-symbol">:</span> <a href="../classes/box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L8">classes/FaceDetection.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="score" class="tsd-anchor"></a>
<h3>score</h3>
<div class="tsd-signature tsd-kind-icon">score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L7">classes/FaceDetection.ts:7</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ifacedetecion.html" class="tsd-kind-icon">IFace<wbr>Detecion</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacedetecion.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacedetecion.html#score" class="tsd-kind-icon">score</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

174
typedoc/interfaces/ifacelandmarks.html Normal file
View File

@ -0,0 +1,174 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IFaceLandmarks | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ifacelandmarks.html">IFaceLandmarks</a>
</li>
</ul>
<h1>Interface IFaceLandmarks</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IFaceLandmarks</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacelandmarks.html#positions" class="tsd-kind-icon">positions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacelandmarks.html#shift" class="tsd-kind-icon">shift</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="positions" class="tsd-anchor"></a>
<h3>positions</h3>
<div class="tsd-signature tsd-kind-icon">positions<span class="tsd-signature-symbol">:</span> <a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L16">classes/FaceLandmarks.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="shift" class="tsd-anchor"></a>
<h3>shift</h3>
<div class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">:</span> <a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceLandmarks.ts#L17">classes/FaceLandmarks.ts:17</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ifacelandmarks.html" class="tsd-kind-icon">IFace<wbr>Landmarks</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacelandmarks.html#positions" class="tsd-kind-icon">positions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacelandmarks.html#shift" class="tsd-kind-icon">shift</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

174
typedoc/interfaces/ifacematch.html Normal file
View File

@ -0,0 +1,174 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IFaceMatch | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ifacematch.html">IFaceMatch</a>
</li>
</ul>
<h1>Interface IFaceMatch</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IFaceMatch</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/facematch.html" class="tsd-signature-type" data-tsd-kind="Class">FaceMatch</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacematch.html#distance" class="tsd-kind-icon">distance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ifacematch.html#label" class="tsd-kind-icon">label</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="distance" class="tsd-anchor"></a>
<h3>distance</h3>
<div class="tsd-signature tsd-kind-icon">distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L5">classes/FaceMatch.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="label" class="tsd-anchor"></a>
<h3>label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceMatch.ts#L4">classes/FaceMatch.ts:4</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ifacematch.html" class="tsd-kind-icon">IFace<wbr>Match</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacematch.html#distance" class="tsd-kind-icon">distance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ifacematch.html#label" class="tsd-kind-icon">label</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

174
typedoc/interfaces/ipoint.html Normal file
View File

@ -0,0 +1,174 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IPoint | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="ipoint.html">IPoint</a>
</li>
</ul>
<h1>Interface IPoint</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IPoint</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipoint.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ipoint.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L2">classes/Point.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Point.ts#L3">classes/Point.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="ipoint.html" class="tsd-kind-icon">IPoint</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipoint.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ipoint.html#y" class="tsd-kind-icon">y</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

203
typedoc/interfaces/irect.html Normal file
View File

@ -0,0 +1,203 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IRect | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="irect.html">IRect</a>
</li>
</ul>
<h1>Interface IRect</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IRect</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a></li>
<li><a href="../classes/rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="irect.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="irect.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="irect.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="irect.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Rect.ts#L7">classes/Rect.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="width" class="tsd-anchor"></a>
<h3>width</h3>
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Rect.ts#L6">classes/Rect.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Rect.ts#L4">classes/Rect.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/Rect.ts#L5">classes/Rect.ts:5</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="irect.html" class="tsd-kind-icon">IRect</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="irect.html#height" class="tsd-kind-icon">height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="irect.html#width" class="tsd-kind-icon">width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="irect.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="irect.html#y" class="tsd-kind-icon">y</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

168
typedoc/interfaces/issdmobilenetv1options.html Normal file
View File

@ -0,0 +1,168 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ISsdMobilenetv1Options | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="issdmobilenetv1options.html">ISsdMobilenetv1Options</a>
</li>
</ul>
<h1>Interface ISsdMobilenetv1Options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ISsdMobilenetv1Options</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="issdmobilenetv1options.html#maxresults" class="tsd-kind-icon">max<wbr>Results</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="issdmobilenetv1options.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maxresults" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Results</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Results<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1Options.ts#L3">ssdMobilenetv1/SsdMobilenetv1Options.ts:3</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="minconfidence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Confidence</h3>
<div class="tsd-signature tsd-kind-icon">min<wbr>Confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/ssdMobilenetv1/SsdMobilenetv1Options.ts#L2">ssdMobilenetv1/SsdMobilenetv1Options.ts:2</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="issdmobilenetv1options.html" class="tsd-kind-icon">ISsd<wbr>Mobilenetv1<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="issdmobilenetv1options.html#maxresults" class="tsd-kind-icon">max<wbr>Results</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="issdmobilenetv1options.html#minconfidence" class="tsd-kind-icon">min<wbr>Confidence</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

175
typedoc/interfaces/itinyfacedetectoroptions.html Normal file
View File

@ -0,0 +1,175 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ITinyFaceDetectorOptions | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="itinyfacedetectoroptions.html">ITinyFaceDetectorOptions</a>
</li>
</ul>
<h1>Interface ITinyFaceDetectorOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="itinyyolov2options.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyYolov2Options</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">ITinyFaceDetectorOptions</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="itinyfacedetectoroptions.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="itinyfacedetectoroptions.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="inputsize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> input<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">input<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="itinyyolov2options.html">ITinyYolov2Options</a>.<a href="itinyyolov2options.html#inputsize">inputSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L2">tinyYolov2/TinyYolov2Options.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="scorethreshold" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> score<wbr>Threshold</h3>
<div class="tsd-signature tsd-kind-icon">score<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="itinyyolov2options.html">ITinyYolov2Options</a>.<a href="itinyyolov2options.html#scorethreshold">scoreThreshold</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L3">tinyYolov2/TinyYolov2Options.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="itinyfacedetectoroptions.html" class="tsd-kind-icon">ITiny<wbr>Face<wbr>Detector<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="itinyfacedetectoroptions.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="itinyfacedetectoroptions.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

173
typedoc/interfaces/itinyyolov2options.html Normal file
View File

@ -0,0 +1,173 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ITinyYolov2Options | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="itinyyolov2options.html">ITinyYolov2Options</a>
</li>
</ul>
<h1>Interface ITinyYolov2Options</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ITinyYolov2Options</span>
<ul class="tsd-hierarchy">
<li>
<a href="itinyfacedetectoroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ITinyFaceDetectorOptions</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="itinyyolov2options.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="itinyyolov2options.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inputsize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> input<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">input<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L2">tinyYolov2/TinyYolov2Options.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="scorethreshold" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> score<wbr>Threshold</h3>
<div class="tsd-signature tsd-kind-icon">score<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/tinyYolov2/TinyYolov2Options.ts#L3">tinyYolov2/TinyYolov2Options.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="itinyyolov2options.html" class="tsd-kind-icon">ITiny<wbr>Yolov2<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="itinyyolov2options.html#inputsize" class="tsd-kind-icon">input<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="itinyyolov2options.html#scorethreshold" class="tsd-kind-icon">score<wbr>Threshold</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

363
typedoc/modules/draw.html Normal file
View File

@ -0,0 +1,363 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>draw | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="draw.html">draw</a>
</li>
</ul>
<h1>Namespace draw</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a></li>
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a></li>
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a></li>
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a></li>
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a></li>
<li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
<a name="drawfaceexpressionsinput" class="tsd-anchor"></a>
<h3>Draw<wbr>Face<wbr>Expressions<wbr>Input</h3>
<div class="tsd-signature tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input<span class="tsd-signature-symbol">:</span> <a href="../classes/faceexpressions.html" class="tsd-signature-type" data-tsd-kind="Class">FaceExpressions</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfaceexpressions" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceExpressions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/drawFaceExpressions.ts#L8">draw/drawFaceExpressions.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
<a name="drawfacelandmarksinput" class="tsd-anchor"></a>
<h3>Draw<wbr>Face<wbr>Landmarks<wbr>Input</h3>
<div class="tsd-signature tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input<span class="tsd-signature-symbol">:</span> <a href="../classes/facelandmarks.html" class="tsd-signature-type" data-tsd-kind="Class">FaceLandmarks</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacelandmarks" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceLandmarks</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L91">draw/DrawFaceLandmarks.ts:91</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
<a name="tdrawdetectionsinput" class="tsd-anchor"></a>
<h3>TDraw<wbr>Detections<wbr>Input</h3>
<div class="tsd-signature tsd-kind-icon">TDraw<wbr>Detections<wbr>Input<span class="tsd-signature-symbol">:</span> <a href="../interfaces/irect.html" class="tsd-signature-type" data-tsd-kind="Interface">IRect</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/iboundingbox.html" class="tsd-signature-type" data-tsd-kind="Interface">IBoundingBox</a><span class="tsd-signature-symbol"> | </span><a href="../classes/facedetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a><span class="tsd-signature-symbol"> | </span><a href="../index.html#withfacedetection" class="tsd-signature-type" data-tsd-kind="Type alias">WithFaceDetection</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/drawDetections.ts#L7">draw/drawDetections.ts:7</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="drawcontour" class="tsd-anchor"></a>
<h3>draw<wbr>Contour</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">draw<wbr>Contour<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CanvasRenderingContext2D</span>, points<span class="tsd-signature-symbol">: </span><a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span>, isClosed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/drawContour.ts#L3">draw/drawContour.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ctx: <span class="tsd-signature-type">CanvasRenderingContext2D</span></h5>
</li>
<li>
<h5>points: <a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>isClosed: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="drawdetections" class="tsd-anchor"></a>
<h3>draw<wbr>Detections</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">draw<wbr>Detections<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span>, detections<span class="tsd-signature-symbol">: </span><a href="draw.html#tdrawdetectionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">TDrawDetectionsInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#tdrawdetectionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">TDrawDetectionsInput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/drawDetections.ts#L9">draw/drawDetections.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
<li>
<h5>detections: <a href="draw.html#tdrawdetectionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">TDrawDetectionsInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#tdrawdetectionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">TDrawDetectionsInput</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="drawfaceexpressions" class="tsd-anchor"></a>
<h3>draw<wbr>Face<wbr>Expressions</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">draw<wbr>Face<wbr>Expressions<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span>, faceExpressions<span class="tsd-signature-symbol">: </span><a href="draw.html#drawfaceexpressionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceExpressionsInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#drawfaceexpressionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceExpressionsInput</a><span class="tsd-signature-symbol">[]</span>, minConfidence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, textFieldAnchor<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/drawFaceExpressions.ts#L10">draw/drawFaceExpressions.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
<li>
<h5>faceExpressions: <a href="draw.html#drawfaceexpressionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceExpressionsInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#drawfaceexpressionsinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceExpressionsInput</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>minConfidence: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.1</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> textFieldAnchor: <a href="../interfaces/ipoint.html" class="tsd-signature-type" data-tsd-kind="Interface">IPoint</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="drawfacelandmarks-1" class="tsd-anchor"></a>
<h3>draw<wbr>Face<wbr>Landmarks</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">draw<wbr>Face<wbr>Landmarks<span class="tsd-signature-symbol">(</span>canvasArg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span>, faceLandmarks<span class="tsd-signature-symbol">: </span><a href="draw.html#drawfacelandmarksinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceLandmarksInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#drawfacelandmarksinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceLandmarksInput</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/draw/DrawFaceLandmarks.ts#L93">draw/DrawFaceLandmarks.ts:93</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvasArg: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
<li>
<h5>faceLandmarks: <a href="draw.html#drawfacelandmarksinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceLandmarksInput</a><span class="tsd-signature-symbol"> | </span><a href="draw.html#drawfacelandmarksinput" class="tsd-signature-type" data-tsd-kind="Type alias">DrawFaceLandmarksInput</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="draw.html">draw</a>
</li>
<li class=" tsd-kind-namespace">
<a href="utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-namespace">
<a href="../enums/draw.anchorposition.html" class="tsd-kind-icon">Anchor<wbr>Position</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawbox.html" class="tsd-kind-icon">Draw<wbr>Box</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawboxoptions.html" class="tsd-kind-icon">Draw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarks.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawfacelandmarksoptions.html" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfield.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-namespace">
<a href="../classes/draw.drawtextfieldoptions.html" class="tsd-kind-icon">Draw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawboxoptions.html" class="tsd-kind-icon">IDraw<wbr>Box<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawfacelandmarksoptions.html" class="tsd-kind-icon">IDraw<wbr>Face<wbr>Landmarks<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/draw.idrawtextfieldoptions.html" class="tsd-kind-icon">IDraw<wbr>Text<wbr>Field<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="draw.html#drawfaceexpressionsinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Expressions<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="draw.html#drawfacelandmarksinput" class="tsd-kind-icon">Draw<wbr>Face<wbr>Landmarks<wbr>Input</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
<a href="draw.html#tdrawdetectionsinput" class="tsd-kind-icon">TDraw<wbr>Detections<wbr>Input</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="draw.html#drawcontour" class="tsd-kind-icon">draw<wbr>Contour</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="draw.html#drawdetections" class="tsd-kind-icon">draw<wbr>Detections</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="draw.html#drawfaceexpressions" class="tsd-kind-icon">draw<wbr>Face<wbr>Expressions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="draw.html#drawfacelandmarks-1" class="tsd-kind-icon">draw<wbr>Face<wbr>Landmarks</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

522
typedoc/modules/utils.html Normal file
View File

@ -0,0 +1,522 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>utils | @vladmandic/face-api</title>
<meta name="description" content="Documentation for @vladmandic/face-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@vladmandic/face-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="utils.html">utils</a>
</li>
</ul>
<h1>Namespace utils</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#computereshapeddimensions" class="tsd-kind-icon">compute<wbr>Reshaped<wbr>Dimensions</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#getcenterpoint" class="tsd-kind-icon">get<wbr>Center<wbr>Point</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#isdimensions" class="tsd-kind-icon">is<wbr>Dimensions</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#iseven" class="tsd-kind-icon">is<wbr>Even</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#isfloat" class="tsd-kind-icon">is<wbr>Float</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#istensor" class="tsd-kind-icon">is<wbr>Tensor</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#istensor1d" class="tsd-kind-icon">is<wbr>Tensor1D</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#istensor2d" class="tsd-kind-icon">is<wbr>Tensor2D</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#istensor3d" class="tsd-kind-icon">is<wbr>Tensor3D</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#istensor4d" class="tsd-kind-icon">is<wbr>Tensor4D</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#isvalidnumber" class="tsd-kind-icon">is<wbr>Valid<wbr>Number</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#isvalidprobablitiy" class="tsd-kind-icon">is<wbr>Valid<wbr>Probablitiy</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#range" class="tsd-kind-icon">range</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="utils.html#round" class="tsd-kind-icon">round</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="computereshapeddimensions" class="tsd-anchor"></a>
<h3>compute<wbr>Reshaped<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">compute<wbr>Reshaped<wbr>Dimensions<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a>, inputSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L43">utils/index.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/idimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
<li>
<h5>inputSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="getcenterpoint" class="tsd-anchor"></a>
<h3>get<wbr>Center<wbr>Point</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">get<wbr>Center<wbr>Point<span class="tsd-signature-symbol">(</span>pts<span class="tsd-signature-symbol">: </span><a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L48">utils/index.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pts: <a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/point.html" class="tsd-signature-type" data-tsd-kind="Class">Point</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="isdimensions" class="tsd-anchor"></a>
<h3>is<wbr>Dimensions</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Dimensions<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L39">utils/index.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>obj: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="iseven" class="tsd-anchor"></a>
<h3>is<wbr>Even</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Even<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L30">utils/index.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="isfloat" class="tsd-anchor"></a>
<h3>is<wbr>Float</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Float<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L26">utils/index.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="istensor" class="tsd-anchor"></a>
<h3>is<wbr>Tensor</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tensor<span class="tsd-signature-symbol">(</span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, dim<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L6">utils/index.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>dim: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="istensor1d" class="tsd-anchor"></a>
<h3>is<wbr>Tensor1D</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tensor1D<span class="tsd-signature-symbol">(</span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L10">utils/index.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="istensor2d" class="tsd-anchor"></a>
<h3>is<wbr>Tensor2D</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tensor2D<span class="tsd-signature-symbol">(</span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L14">utils/index.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="istensor3d" class="tsd-anchor"></a>
<h3>is<wbr>Tensor3D</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tensor3D<span class="tsd-signature-symbol">(</span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L18">utils/index.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="istensor4d" class="tsd-anchor"></a>
<h3>is<wbr>Tensor4D</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Tensor4D<span class="tsd-signature-symbol">(</span>tensor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L22">utils/index.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tensor: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">tensor</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="isvalidnumber" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Number</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Number<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L57">utils/index.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="isvalidprobablitiy" class="tsd-anchor"></a>
<h3>is<wbr>Valid<wbr>Probablitiy</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Probablitiy<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L61">utils/index.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="range" class="tsd-anchor"></a>
<h3>range</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, step<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L53">utils/index.ts:53</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>start: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>step: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="round" class="tsd-anchor"></a>
<h3>round</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, prec<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/utils/index.ts#L34">utils/index.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>num: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>prec: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
<li class=" tsd-kind-namespace">
<a href="draw.html">draw</a>
</li>
<li class="current tsd-kind-namespace">
<a href="utils.html">utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#computereshapeddimensions" class="tsd-kind-icon">compute<wbr>Reshaped<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#getcenterpoint" class="tsd-kind-icon">get<wbr>Center<wbr>Point</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#isdimensions" class="tsd-kind-icon">is<wbr>Dimensions</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#iseven" class="tsd-kind-icon">is<wbr>Even</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#isfloat" class="tsd-kind-icon">is<wbr>Float</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#istensor" class="tsd-kind-icon">is<wbr>Tensor</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#istensor1d" class="tsd-kind-icon">is<wbr>Tensor1D</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#istensor2d" class="tsd-kind-icon">is<wbr>Tensor2D</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#istensor3d" class="tsd-kind-icon">is<wbr>Tensor3D</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#istensor4d" class="tsd-kind-icon">is<wbr>Tensor4D</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#isvalidnumber" class="tsd-kind-icon">is<wbr>Valid<wbr>Number</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#isvalidprobablitiy" class="tsd-kind-icon">is<wbr>Valid<wbr>Probablitiy</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#range" class="tsd-kind-icon">range</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="utils.html#round" class="tsd-kind-icon">round</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>