Header: AVL.h
Namespace: avl
Module: DL_IS

Executes a Segment Instances model on a single input image.


void avl::AvsFilter_DL_SegmentInstances
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	const avl::SegmentInstancesModelId& inModelId,
	const atl::Optional<float>& inMinDetectionScore,
	const atl::Optional<int>& inMaxObjectsCount,
	atl::Array<avl::Box>& outBoundingBoxes,
	atl::Array<int>& outClassIds,
	atl::Array<atl::String>& outClassNames,
	atl::Array<float>& outScores,
	atl::Array<avl::Region>& outMasks


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


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

Read more about pixel formats in Image documentation.



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.


List of possible exceptions:

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

See Also