Interface SegmentationConfig

Configures all body segmentation module removes background from input containing person if segmentation is enabled it will run as preprocessing task before any other model alternatively leave it disabled and use it on-demand using human.segmentation method which can remove background or replace it with user-provided background

interface SegmentationConfig {
    enabled: boolean;
    mode: SegmentationEnum;
    modelPath: string;
    ratio: number;
    skipFrames: number;
    skipTime: number;
}

Hierarchy (view full)

Properties

enabled: boolean

is module enabled?

possible rvm segmentation mode

modelPath: string

path to model json file (relative to modelBasePath

ratio: number

downsample ratio, adjust to reflect approximately how much of input is taken by body

skipFrames: number

how many max frames to go without re-running model if cached results are acceptable for two-phase models such as face and hand caching applies to bounding boxes detection only

skipTime: number

how many max milliseconds to go without re-running model if cached results are acceptable for two-phase models such as face and hand caching applies to bounding boxes detection only