Performs classification on images.
Signature:
export
declare
class
ImageClassifier
extends
VisionTaskRunner
Extends: VisionTaskRunner
Methods
| Method | Modifiers | Description |
|---|---|---|
Performs image classification on the provided single image and waits synchronously for the response. Only use this method when the ImageClassifier is created with running mode image
. |
||
Performs image classification on the provided video frame and waits synchronously for the response. Only use this method when the ImageClassifier is created with running mode video
. |
||
static
|
Initializes the Wasm runtime and creates a new image classifier based on the provided model asset buffer. | |
static
|
Initializes the Wasm runtime and creates a new image classifier based on the path to the model asset. | |
static
|
Initializes the Wasm runtime and creates a new image classifier from the provided options. | |
Sets new options for the image classifier.Calling setOptions()
with a subset of options only affects those options. You can reset an option back to its default value by explicitly setting it to undefined
. |
ImageClassifier.classify()
Performs image classification on the provided single image and waits synchronously for the response. Only use this method when the ImageClassifier is created with running mode image
.
Signature:
classify
(
image
:
ImageSource
,
imageProcessingOptions?
:
ImageProcessingOptions
)
:
ImageClassifierResult
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
image
|
ImageSource | An image to process. |
|
imageProcessingOptions
|
ImageProcessingOptions | the ImageProcessingOptions
specifying how to process the input image before running inference. The classification result of the image |
Returns:
ImageClassifier.classifyForVideo()
Performs image classification on the provided video frame and waits synchronously for the response. Only use this method when the ImageClassifier is created with running mode video
.
Signature:
classifyForVideo
(
videoFrame
:
ImageSource
,
timestamp
:
number
,
imageProcessingOptions?
:
ImageProcessingOptions
)
:
ImageClassifierResult
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
videoFrame
|
ImageSource | A video frame to process. |
|
timestamp
|
number | The timestamp of the current frame, in ms. |
|
imageProcessingOptions
|
ImageProcessingOptions | the ImageProcessingOptions
specifying how to process the input image before running inference. The classification result of the image |
Returns:
ImageClassifier.createFromModelBuffer()
Initializes the Wasm runtime and creates a new image classifier based on the provided model asset buffer.
Signature:
static
createFromModelBuffer
(
wasmFileset
:
WasmFileset
,
modelAssetBuffer
:
Uint8Array
)
:
Promise<ImageClassifier>
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
wasmFileset
|
WasmFileset | A configuration object that provides the location of the Wasm binary and its loader. |
|
modelAssetBuffer
|
Uint8Array | A binary representation of the model. |
Returns:
Promise< ImageClassifier >
ImageClassifier.createFromModelPath()
Initializes the Wasm runtime and creates a new image classifier based on the path to the model asset.
Signature:
static
createFromModelPath
(
wasmFileset
:
WasmFileset
,
modelAssetPath
:
string
)
:
Promise<ImageClassifier>
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
wasmFileset
|
WasmFileset | A configuration object that provides the location of the Wasm binary and its loader. |
|
modelAssetPath
|
string | The path to the model asset. |
Returns:
Promise< ImageClassifier >
ImageClassifier.createFromOptions()
Initializes the Wasm runtime and creates a new image classifier from the provided options.
Signature:
static
createFromOptions
(
wasmFileset
:
WasmFileset
,
imageClassifierOptions
:
ImageClassifierOptions
)
:
Promise<ImageClassifier>
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
wasmFileset
|
WasmFileset | A configuration object that provides the location Wasm binary and its loader. |
|
imageClassifierOptions
|
ImageClassifierOptions | The options for the image classifier. Note that either a path to the model asset or a model buffer needs to be provided (via baseOptions
). |
Returns:
Promise< ImageClassifier >
ImageClassifier.setOptions()
Sets new options for the image classifier.
Calling setOptions()
with a subset of options only affects those options. You can reset an option back to its default value by explicitly setting it to undefined
.
Signature:
setOptions
(
options
:
ImageClassifierOptions
)
:
Promise<void>
;
Parameters
| Parameter | Type | Description |
|---|---|---|
|
options
|
ImageClassifierOptions | The options for the image classifier. |
Returns:
Promise<void>
