FisFilter_DL_SegmentInstances


Header: FIL.h
Namespace: fil
Module: DL_IS

Executes a Segment Instances model on a single input image.

Syntax

void fil::FisFilter_DL_SegmentInstances
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	const fil::SegmentInstancesModelId& inModelId,
	const ftl::Optional<float>& inMinDetectionScore,
	const ftl::Optional<int>& inMaxObjectsCount,
	ftl::Array<fil::Box>& outBoundingBoxes,
	ftl::Array<int>& outClassIds,
	ftl::Array<ftl::String>& outClassNames,
	ftl::Array<float>& outScores,
	ftl::Array<fil::Region>& outMasks
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Region&> NIL Limits the area where objects may be located
Input value inModelId const SegmentInstancesModelId& Segment Instances model stored in a specific disk directory
Input value inMinDetectionScore const Optional<float>& 0.0 - 1.0 NIL Sets a minimum required score for an object to be returned. If not set, a value determined during the training is used
Input value inMaxObjectsCount const Optional<int>& 1 - NIL Limits maximum number of returned objects. If not set, a value determined during the training is used
Output value outBoundingBoxes Array<Box>& Returns bounding boxes of the found objects
Output value outClassIds Array<int>& Returns ids of the found object classes
Output value outClassNames Array<String>& Returns names of the found objects classes
Output value outScores Array<float>& Returns scores of the found objects
Output value outMasks Array<Region>& Returns masks of the found objects

Requirements

For input inImage only pixel formats are supported: 1⨯uint8, 3⨯uint8.

Read more about pixel formats in Image documentation.

Hints

Remarks

This filter should not be executed along with running Deep Learning Service as it may result in degraded performance or even out-of-memory errors.

Errors

List of possible exceptions:

Error type Description
DomainError Not supported inImage pixel format in FisFilter_DL_SegmentInstances. Supported formats: 1xUInt8, 3xUInt8.

See Also