You are here: Start » Function Reference » Deep Learning » DeepLearning_SegmentInstances

DeepLearning_SegmentInstances

Performs instance segmentation using a trained deep-learning model.

Header:	AVL.h

Syntax

void avl::DeepLearning_SegmentInstances
(
	DeepLearningConnectionState& ioState,
	const avl::Image& inImage,
	const atl::Optional<avl::Region>& inRoi,
	const avl::DeepModel_InstanceSegmentation& inDeepModel,
	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
)

void DeepLearning_SegmentInstances
(
	ref DeepLearningConnectionState ioState,
	Image inImage,
	Region? inRoi,
	DeepModel_InstanceSegmentation inDeepModel,
	float? inMinDetectionScore,
	int? inMaxObjectsCount,
	out Box[] outBoundingBoxes,
	out int[] outClassIds,
	out System.String[] outClassNames,
	out float[] outScores,
	out Region[] outMasks
)

Parameters

Name	Type	Range	Default	Description
ioState	DeepLearningConnectionState&			Object used to maintain state of the function.
inImage	const Image&			Input image
inRoi	const Optional<Region>&		NIL	Area of interest
inDeepModel	const DeepModel_InstanceSegmentation&			Trained model
inMinDetectionScore	const Optional<float>&	0.0 - 1.0	NIL	Minimal score of found objects
inMaxObjectsCount	const Optional<int>&	1 -	NIL	Maximal number of found objects
outBoundingBoxes	Array<Box>&			Bounding boxes of found objects
outClassIds	Array<int>&			Ids of found objects classes
outClassNames	Array<String>&			Names of found objects classes
outScores	Array<float>&			Scores of found objects
outMasks	Array<Region>&			Masks of found objects

Requirements

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

Read more about pixel formats in Image documentation.

Hints

Loading Deep Learning Model may take longer timer. Consider using DeepLearning_LoadModel for pre-loading model before execution starts.

Remarks

Model provided on inDeepModel input will be loaded to service automatically on first usage of Deep Learning filters.
Service automatically releases and loads model into its memory. It may result in releasing model previously loaded using DeepLearning_LoadModel filter.
These filters only communicates with service and cannot be use for parallel computation.

Errors

Error type	Description
DomainError	Empty ROI region in DeepLearning_SegmentInstances
DomainError	Size of ROI differs from size of image in DeepLearning_SegmentInstances
DomainError	Invalid DeepModel in DeepLearning_SegmentInstances.
DomainError	Empty image in DeepLearning_SegmentInstances.
IoError	Inconsistent service response
IoError	Invalid service response - missing score
IoError	Invalid service response - missing class id
IoError	Invalid service response - missing class name
IoError	Invalid service response - missing bounding box