@camera.ui/sdk / plugin / SegmentationInterface

Interface: SegmentationInterface

Defined in: plugin/interfaces.ts:455

Implemented by plugins that outline objects: a mask that separates an object from its background. The frame-based side is the segmenter sensor.

Methods

segmentationSettings()?

optional segmentationSettings(): Promise<JsonSchema[] | undefined>

Defined in: plugin/interfaces.ts:463

Return the JSON schema for the segmentation settings form in the UI, or undefined for no schema.

Returns

Promise<JsonSchema[] | undefined>

---

segmentImages()

segmentImages(images, config?): Promise<(SegmentationPluginResponse | undefined)[]>

Defined in: plugin/interfaces.ts:461

Outline the object at box in each picture: one result per input in the same order, undefined when the plugin could not run at all. config holds the values of the segmentation settings form.

Parameters

images

SegmentationImage[]

config?

Record<string, unknown>

Returns

Promise<(SegmentationPluginResponse | undefined)[]>