DL_ClassifyObject

Basic

Module: DL_CO

Executes a Classify Object model on a single input image.

Name Type Description
Input value
 inImage Image Input image
Input value
 inRoi Rectangle2D* Limits the area where a classified object is located
Input value
 inRoiAlignment CoordinateSystem2D*
Input value
 inModelId ClassifyObjectModelId Identifier of a Classify Object model
Input value
 inCreateHeatmap Bool Enables creating a relevance heatmap at the expense of extended execution time
Output value
 outConfidences ClassConfidenceArray Returns confidences for all classes
Output value
 outClassName String Returns the name of the class with the highest confidence
Output value
 outClassIndex Integer Returns the index of the class with the highest confidence
Output value
 outScore Real Returns the value of the highest confidence
Output value
 outRelevanceHeatmap Heatmap Returns the heatmap indicating how strong specific parts of image influenced the classification result
Output value
 outAlignedRoi Rectangle2D 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.

Hints

  • It is recommended that the deep learning model is deployed with DL_ClassifyObject_Deploy first and connected through the inModelId input.
  • If one decides not to use 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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

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

Complexity Level

This filter is available on Basic Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, Aurora Vision Studio Professional version.

See Also