Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Human

Hierarchy

  • Human

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Human(userConfig?: {}): Human

  • Parameters

    • userConfig: {} = ...

    Returns Human

Properties

classes

classes: { age: __module; body: __module | __module; emotion: __module; facemesh: __module; gender: __module; hand: __module; nanodet: __module }

Type declaration

  • age: __module
  • body: __module | __module
  • emotion: __module
  • facemesh: __module
  • gender: __module
  • hand: __module
  • nanodet: __module

config

config: { async: boolean; backend: string; body: { enabled: boolean; maxDetections: number; modelPath: string; nmsRadius: number; scoreThreshold: number }; deallocate: boolean; debug: boolean; face: { age: { enabled: boolean; modelPath: string; skipFrames: number }; detector: { iouThreshold: number; maxFaces: number; minConfidence: number; modelPath: string; return: boolean; rotation: boolean; scoreThreshold: number; skipFrames: number; skipInitial: boolean }; embedding: { enabled: boolean; modelPath: string }; emotion: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }; enabled: boolean; gender: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }; iris: { enabled: boolean; modelPath: string }; mesh: { enabled: boolean; modelPath: string } }; filter: { blur: number; brightness: number; contrast: number; enabled: boolean; height: number; hue: number; kodachrome: boolean; negative: boolean; pixelate: number; polaroid: boolean; return: boolean; saturation: number; sepia: boolean; sharpness: number; technicolor: boolean; vintage: boolean; width: number }; gesture: { enabled: boolean }; hand: { detector: { modelPath: string }; enabled: boolean; iouThreshold: number; landmarks: boolean; maxHands: number; minConfidence: number; rotation: boolean; scoreThreshold: number; skeleton: { modelPath: string }; skipFrames: number; skipInitial: boolean }; object: { enabled: boolean; iouThreshold: number; maxResults: number; minConfidence: number; modelPath: string; skipFrames: number }; profile: boolean; scoped: boolean; videoOptimized: boolean; warmup: string; wasmPath: string }

Type declaration

  • async: boolean
  • backend: string
  • body: { enabled: boolean; maxDetections: number; modelPath: string; nmsRadius: number; scoreThreshold: number }
    • enabled: boolean
    • maxDetections: number
    • modelPath: string
    • nmsRadius: number
    • scoreThreshold: number
  • deallocate: boolean
  • debug: boolean
  • face: { age: { enabled: boolean; modelPath: string; skipFrames: number }; detector: { iouThreshold: number; maxFaces: number; minConfidence: number; modelPath: string; return: boolean; rotation: boolean; scoreThreshold: number; skipFrames: number; skipInitial: boolean }; embedding: { enabled: boolean; modelPath: string }; emotion: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }; enabled: boolean; gender: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }; iris: { enabled: boolean; modelPath: string }; mesh: { enabled: boolean; modelPath: string } }
    • age: { enabled: boolean; modelPath: string; skipFrames: number }
      • enabled: boolean
      • modelPath: string
      • skipFrames: number
    • detector: { iouThreshold: number; maxFaces: number; minConfidence: number; modelPath: string; return: boolean; rotation: boolean; scoreThreshold: number; skipFrames: number; skipInitial: boolean }
      • iouThreshold: number
      • maxFaces: number
      • minConfidence: number
      • modelPath: string
      • return: boolean
      • rotation: boolean
      • scoreThreshold: number
      • skipFrames: number
      • skipInitial: boolean
    • embedding: { enabled: boolean; modelPath: string }
      • enabled: boolean
      • modelPath: string
    • emotion: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }
      • enabled: boolean
      • minConfidence: number
      • modelPath: string
      • skipFrames: number
    • enabled: boolean
    • gender: { enabled: boolean; minConfidence: number; modelPath: string; skipFrames: number }
      • enabled: boolean
      • minConfidence: number
      • modelPath: string
      • skipFrames: number
    • iris: { enabled: boolean; modelPath: string }
      • enabled: boolean
      • modelPath: string
    • mesh: { enabled: boolean; modelPath: string }
      • enabled: boolean
      • modelPath: string
  • filter: { blur: number; brightness: number; contrast: number; enabled: boolean; height: number; hue: number; kodachrome: boolean; negative: boolean; pixelate: number; polaroid: boolean; return: boolean; saturation: number; sepia: boolean; sharpness: number; technicolor: boolean; vintage: boolean; width: number }
    • blur: number
    • brightness: number
    • contrast: number
    • enabled: boolean
    • height: number
    • hue: number
    • kodachrome: boolean
    • negative: boolean
    • pixelate: number
    • polaroid: boolean
    • return: boolean
    • saturation: number
    • sepia: boolean
    • sharpness: number
    • technicolor: boolean
    • vintage: boolean
    • width: number
  • gesture: { enabled: boolean }
    • enabled: boolean
  • hand: { detector: { modelPath: string }; enabled: boolean; iouThreshold: number; landmarks: boolean; maxHands: number; minConfidence: number; rotation: boolean; scoreThreshold: number; skeleton: { modelPath: string }; skipFrames: number; skipInitial: boolean }
    • detector: { modelPath: string }
      • modelPath: string
    • enabled: boolean
    • iouThreshold: number
    • landmarks: boolean
    • maxHands: number
    • minConfidence: number
    • rotation: boolean
    • scoreThreshold: number
    • skeleton: { modelPath: string }
      • modelPath: string
    • skipFrames: number
    • skipInitial: boolean
  • object: { enabled: boolean; iouThreshold: number; maxResults: number; minConfidence: number; modelPath: string; skipFrames: number }
    • enabled: boolean
    • iouThreshold: number
    • maxResults: number
    • minConfidence: number
    • modelPath: string
    • skipFrames: number
  • profile: boolean
  • scoped: boolean
  • videoOptimized: boolean
  • warmup: string
  • wasmPath: string

draw

draw: { all: Function; body: Function; canvas: Function; drawOptions?: { bufferedOutput: Boolean; color: string; drawBoxes: Boolean; drawLabels: Boolean; drawPoints: Boolean; drawPolygons: Boolean; fillPolygons: Boolean; font: string; labelColor: string; lineHeight: number; lineWidth: number; pointSize: number; roundRect: number; shadowColor: string; useCurves: Boolean; useDepth: Boolean }; face: Function; gesture: Function; hand: Function }

Type declaration

  • all: Function
  • body: Function
  • canvas: Function
  • Optional drawOptions?: { bufferedOutput: Boolean; color: string; drawBoxes: Boolean; drawLabels: Boolean; drawPoints: Boolean; drawPolygons: Boolean; fillPolygons: Boolean; font: string; labelColor: string; lineHeight: number; lineWidth: number; pointSize: number; roundRect: number; shadowColor: string; useCurves: Boolean; useDepth: Boolean }
    • bufferedOutput: Boolean
    • color: string
    • drawBoxes: Boolean
    • drawLabels: Boolean
    • drawPoints: Boolean
    • drawPolygons: Boolean
    • fillPolygons: Boolean
    • font: string
    • labelColor: string
    • lineHeight: number
    • lineWidth: number
    • pointSize: number
    • roundRect: number
    • shadowColor: string
    • useCurves: Boolean
    • useDepth: Boolean
  • face: Function
  • gesture: Function
  • hand: Function

image

image: { canvas: OffscreenCanvas | HTMLCanvasElement; tensor: Tensor }

Type declaration

  • canvas: OffscreenCanvas | HTMLCanvasElement
  • tensor: Tensor

models

models: { age: null | Model; blazepose: null | Model; embedding: null | Model; emotion: null | Model; face: null | MediaPipeFaceMesh; gender: null | Model; handpose: null | HandPose; iris: null | Model; nanodet: null | Model; posenet: null | PoseNet }

Type declaration

  • age: null | Model
  • blazepose: null | Model
  • embedding: null | Model
  • emotion: null | Model
  • face: null | MediaPipeFaceMesh
  • gender: null | Model
  • handpose: null | HandPose
  • iris: null | Model
  • nanodet: null | Model
  • posenet: null | PoseNet

state

state: String

sysinfo

sysinfo: { agent: String; platform: String }

Type declaration

  • agent: String
  • platform: String

tf

tf: __module

version

version: String

Methods

detect

  • detect(input: OffscreenCanvas | HTMLCanvasElement | Tensor | ImageData | HTMLVideoElement, userConfig?: Object): Promise<Result | { error: String }>

  • Parameters

    • input: OffscreenCanvas | HTMLCanvasElement | Tensor | ImageData | HTMLVideoElement
    • userConfig: Object = ...

    Returns Promise<Result | { error: String }>

enhance

  • enhance(input: Tensor): null | Tensor

  • Parameters

    • input: Tensor

    Returns null | Tensor

load

  • load(userConfig?: Object): Promise<void>

  • Parameters

    • userConfig: Object = ...

    Returns Promise<void>

match

  • match(faceEmbedding: Number[], db: { embedding: Number[]; name: String; source: undefined | String }[], threshold?: number): { embedding: Number[]; name: String; simmilarity: Number; source: undefined | String }

  • Parameters

    • faceEmbedding: Number[]
    • db: { embedding: Number[]; name: String; source: undefined | String }[]
    • threshold: number = 0

    Returns { embedding: Number[]; name: String; simmilarity: Number; source: undefined | String }

    • embedding: Number[]
    • name: String
    • simmilarity: Number
    • source: undefined | String

profileData

  • profileData(): {} | { largestKernelOps: any; newBytes: any; newTensors: any; numKernelOps: any; peakBytes: any; slowestKernelOps: any; timeKernelOps: any }

  • Returns {} | { largestKernelOps: any; newBytes: any; newTensors: any; numKernelOps: any; peakBytes: any; slowestKernelOps: any; timeKernelOps: any }

simmilarity

  • simmilarity(embedding1: Number[], embedding2: Number[]): Number

  • Parameters

    • embedding1: Number[]
    • embedding2: Number[]

    Returns Number

warmup

  • warmup(userConfig?: Object): Promise<Result | { error: any }>

  • Parameters

    • userConfig: Object = ...

    Returns Promise<Result | { error: any }>