FisFilter_DL_ClassifyObject

Header:	FIL.h
Namespace:	fil
Module:	DL_CO

Executes a Classify Object model on a single input image.

Syntax

void fil::FisFilter_DL_ClassifyObject
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Rectangle2D&> inRoi,
	ftl::Optional<const fil::CoordinateSystem2D&> inRoiAlignment,
	const fil::ClassifyObjectModelId& inModelId,
	const bool inCreateHeatmap,
	ftl::Array<fil::ClassConfidence>& outConfidences,
	ftl::String& outClassName,
	int& outClassIndex,
	float& outScore,
	fil::Heatmap& outRelevanceHeatmap,
	ftl::Optional<fil::Rectangle2D&> outAlignedRoi = ftl::NIL
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Rectangle2D&>	NIL	Limits the area where a classified object is located
inRoiAlignment	Optional<const CoordinateSystem2D&>	NIL
inModelId	const ClassifyObjectModelId&		Identifier of a Classify Object model
inCreateHeatmap	const bool	False	Enables creating a relevance heatmap at the expense of extended execution time
outConfidences	Array<ClassConfidence>&		Returns confidences for all classes
outClassName	String&		Returns the name of the class with the highest confidence
outClassIndex	int&		Returns the index of the class with the highest confidence
outScore	float&		Returns the value of the highest confidence
outRelevanceHeatmap	Heatmap&		Returns the heatmap indicating how strong specific parts of image influenced the classification result
outAlignedRoi	Optional<Rectangle2D&>	NIL	Input roi after the transformation

Requirements

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

Read more about pixel formats in Image documentation.

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outAlignedRoi.

Hints

It is recommended that the deep learning model is deployed with FisFilter_DL_ClassifyObject_Deploy first and connected through the inModelId input.
If one decides not to use FisFilter_DL_ClassifyObject_Deploy, then the model will be loaded in the first iteration. It will take up to several seconds.

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_ClassifyObject. Supported formats: 1xUInt8, 3xUInt8.