Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Deep Learning » DeepLearning_ClassifyObject

DeepLearning_ClassifyObject


Performs whole image classification using a trained deep-learning model.

Name Type Description
inImage Image Input image
inRoi Region* Area of interest
inDeepModel DeepModel_Classification Trained model
inCreateRelevanceHeatmap Bool Enable-Disable create relevance heatmap
outConfidences ClassConfidenceArray Returns confidences for all classes
outClassName String Returns name of the class with highest confidence
outClassIndex Integer Returns the index of the class with highest confidence
outScore Real Returns the value of the highest confidence
outRelevanceHeatmap Image Returns heatmap indicating how strong specific parts of image influenced classification result

Requirements

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

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

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 Empty image in DeepLearning_ClassifyObject.
DomainError Empty ROI region in DeepLearning_ClassifyObject
DomainError Invalid DeepModel in DeepLearning_ClassifyObject.
DomainError Size of ROI differs from size of image in DeepLearning_ClassifyObject
IoError Missing confidences.
IoError Received invalid number of heatmaps.

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, Adaptive Vision Studio Professional version.

See Also