DeepLearning_ClassifyObject


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

Name Type Description
inImage Image Input image
inRoi Rectangle2D* Area of interest
inRoiAlignment CoordinateSystem2D*
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_ObjectClassification for pre-loading model before execution starts.

Remarks

  • Model provided on inDeepModel input will be loaded automatically on first usage of this filter.
  • 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. However, if stopping Deep Learning Service is not an option (e.g. program uses other Deep Learning filters related to Anomaly Detection or Instances Segmentation) it is advised that this filter should be executed before other Deep Learning filters. Such "warm up" execution does not have to use real image or roi as long as provided image and roi have similar size.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

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 DeepLearning_ClassifyObject.

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