You are here: Start » AVL.NET » AVL.DeepLearning_ClassifyObject
AVL.DeepLearning_ClassifyObject
Performs whole image classification using a trained deep-learning model.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void DeepLearning_ClassifyObject ( AvlNet.DeepLearningConnectionState ioState, AvlNet.Image inImage, NullableRef<AvlNet.Region> inRoi, string inDeepModel, bool inCreateRelevanceHeatmap, IList<AvlNet.ClassConfidence> outConfidences, out string outClassName, out int outClassIndex, out float outScore, AvlNet.Image outRelevanceHeatmap )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
| ioState | AvlNet.DeepLearningConnectionState | ||||
 | inImage | AvlNet.Image | Input image. | ||
| inRoi | AvlNet.NullableRef<AvlNet.Region> | Area of interest. Default value: atl::NIL. | ||
| inDeepModel | string | Trained model. | ||
| inCreateRelevanceHeatmap | bool | False | Enable-Disable create relevance heatmap. Default value: False. | |
 | outConfidences | System.Collections.Generic.IList<AvlNet.ClassConfidence> | Returns confidences for all classes. | ||
| outClassName | string | Returns name of the class with highest confidence. | ||
| outClassIndex | int | Returns the index of the class with highest confidence. | ||
| outScore | float | Returns the value of the highest confidence. | ||
| outRelevanceHeatmap | AvlNet.Image | Returns heatmap indicating how strong specific parts of image influenced classification result. |
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
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. |
