Skip to main content

Class: HumansOptions

Defined in: src/world/humans/HumansOptions.ts:7

Configuration options for the Human Pose Detection system.

Constructors​

Constructor​

new HumansOptions(options?): HumansOptions

Defined in: src/world/humans/HumansOptions.ts:39

Parameters​

options?​
backendConfig?​

{ activeBackend?: string; mediapipe?: { minPoseDetectionConfidence?: number; minPosePresenceConfidence?: number; minTrackingConfidence?: number; modelAssetPath?: string; numPoses?: number; wasmFilesUrl?: string; }; } = ...

Configuration options for the active pose detection backend.

backendConfig.activeBackend?​

string = 'mediapipe'

backendConfig.mediapipe?​

{ minPoseDetectionConfidence?: number; minPosePresenceConfidence?: number; minTrackingConfidence?: number; modelAssetPath?: string; numPoses?: number; wasmFilesUrl?: string; } = ...

backendConfig.mediapipe.minPoseDetectionConfidence?​

number = 0.5

The minimum confidence score [0.0, 1.0] required for a pose to be detected.

backendConfig.mediapipe.minPosePresenceConfidence?​

number = 0.5

The minimum confidence score [0.0, 1.0] required to confirm a pose is still present.

backendConfig.mediapipe.minTrackingConfidence?​

number = 0.5

The minimum confidence score [0.0, 1.0] required for tracking landmarks between frames.

backendConfig.mediapipe.modelAssetPath?​

string = 'https://storage.googleapis.com/mediapipe-models/pose_landmarker/pose_landmarker_full/float16/latest/pose_landmarker_full.task'

backendConfig.mediapipe.numPoses?​

number = 1

The maximum number of simultaneous human poses/bodies to track.

backendConfig.mediapipe.wasmFilesUrl?​

string = 'https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@latest/wasm'

enable?​

() => HumansOptions

enabled?​

boolean = false

Returns​

HumansOptions

Properties​

backendConfig​

backendConfig: object

Defined in: src/world/humans/HumansOptions.ts:13

Configuration options for the active pose detection backend.

activeBackend​

activeBackend: string = 'mediapipe'

mediapipe​

mediapipe: object

mediapipe.minPoseDetectionConfidence​

minPoseDetectionConfidence: number = 0.5

The minimum confidence score [0.0, 1.0] required for a pose to be detected.

mediapipe.minPosePresenceConfidence​

minPosePresenceConfidence: number = 0.5

The minimum confidence score [0.0, 1.0] required to confirm a pose is still present.

mediapipe.minTrackingConfidence​

minTrackingConfidence: number = 0.5

The minimum confidence score [0.0, 1.0] required for tracking landmarks between frames.

mediapipe.modelAssetPath​

modelAssetPath: string = 'https://storage.googleapis.com/mediapipe-models/pose_landmarker/pose_landmarker_full/float16/latest/pose_landmarker_full.task'

mediapipe.numPoses​

numPoses: number = 1

The maximum number of simultaneous human poses/bodies to track.

mediapipe.wasmFilesUrl​

wasmFilesUrl: string = 'https://cdn.jsdelivr.net/npm/@mediapipe/tasks-vision@latest/wasm'

enabled​

enabled: boolean = false

Defined in: src/world/humans/HumansOptions.ts:8

Methods​

enable()​

enable(): HumansOptions

Defined in: src/world/humans/HumansOptions.ts:45

Returns​

HumansOptions