Filters
Filter values by
Classification result buffer
  • Training - CNN
  • Training - tree ensemble
  • Prediction - CNN
  • Prediction - tree ensemble
| Customize Help
| Save Settings

MclassGetResult



Function Map
Synopsis
Get results from a classification result buffer.
Syntax
void MclassGetResult(
MIL_ID ResultClassId, //in
MIL_INT64 LabelOrIndex, //in
MIL_INT64 ResultType, //in
void *ResultArrayPtr //out
)
Description

This function retrieves results of the specified type from a classification result buffer. Result buffers are allocated using MclassAllocResult(). You can either retrieve training results, which are available after calling MclassTrain(), or you can retrieve prediction results, which are available after calling MclassPredict().

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ResultClassId

Specifies the identifier of the classification result buffer from which to retrieve results. You can get results from a CNN (M_TRAIN_CNN_RESULT) or a tree ensemble (M_TRAIN_TREE_ENSEMBLE_RESULT) training result buffer, or a CNN (M_PREDICT_CNN_RESULT) or a tree ensemble (M_PREDICT_TREE_ENSEMBLE_RESULT) prediction result buffer.

LabelOrIndex

Specifies what to retrieve. Set this parameter to one of the following values.

function map For specifying what to retrieve
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_GENERAL.

Click to summarize

Specifies the index of the class for which to get results. You can get the number of included classes in the result buffer using M_NUMBER_OF_CLASSES.

(summarize)
Parameters

Specifies the index of a class.

Click to summarize M_GENERAL

Specifies to retrieve global results from the result buffer.

ResultType

Specifies the type of result to retrieve.

See the Parameter associations section for possible values that can be specified.

ResultArrayPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_UUID [optionally, in C++: a reference to a std::vector<MIL_UUID> ]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address of the array in which to write results.

See the Parameter associations section for possible values that can be returned.

To retrieve general results from a CNN training result buffer (ResultClassId), the ResultType can be set to one of the following values. In this case, set the LabelOrIndex parameter to M_GENERAL.

function map For training (CNN) - retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_DEV_DATASET_EPOCH_ACCURACY +

Retrieves an array containing the development dataset accuracy for each epoch.

Note that the required array size, which you can retrieve with M_NB_ELEMENTS, is equivalent to the M_MAX_EPOCH (MclassControl()) of the training context used.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the development dataset accuracy for each epoch, as a percentage. These values are stored in an array of MIL_DOUBLE.

(summarize)
Click to summarize M_DEV_DATASET_EPOCH_ERROR_RATE +

Retrieves an array containing the development dataset error rate for each epoch.

Note that the required array size, which you can retrieve with M_NB_ELEMENTS, is equivalent to the M_MAX_EPOCH (MclassControl()) of the training context used.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the development dataset error rate for each epoch, as a percentage. These values are stored in an array of MIL_DOUBLE.

(summarize)
Click to summarize M_DEV_DATASET_ERROR_ENTRIES +

Retrieves an array containing the MIL_UUID of each image in the development dataset that could not be loaded, at least once, during training.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_UUID [optionally, in C++: a reference to a std::vector<MIL_UUID> ] MORE
Click to summarize M_LAST_EPOCH_UPDATED_PARAMETERS +

Retrieves the index of the epoch where classifier parameters were updated the last time.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_INVALID

Specifies that the parameters were not updated.

Click to summarize Value >= 0

Specifies the index of the epoch.

Click to summarize M_MINI_BATCH_PER_EPOCH +

Retrieves the number of mini-batches per epoch.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the number of mini-batches per epoch.

Click to summarize M_TRAIN_DATASET_EPOCH_ACCURACY +

Retrieves an array containing the training dataset accuracy for each epoch.

Note that the required array size, which you can retrieve with M_NB_ELEMENTS, is equivalent to the M_MAX_EPOCH (MclassControl()) of the training context used.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the training dataset accuracy for each epoch, as a percentage. These values are stored in an array of MIL_DOUBLE.

(summarize)
Click to summarize M_TRAIN_DATASET_EPOCH_ERROR_RATE +

Retrieves an array containing the training dataset error rate for each epoch.

Note that the required array size, which you can retrieve with M_NB_ELEMENTS, is equivalent to the M_MAX_EPOCH (MclassControl()) of the training context used.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the training dataset error rate for each epoch, as a percentage. These values are stored in an array of MIL_DOUBLE.

(summarize)
Click to summarize M_TRAIN_DATASET_ERROR_ENTRIES +

Retrieves an array containing the MIL_UUID of each image in the training dataset that could not be loaded, at least once, during training.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_UUID [optionally, in C++: a reference to a std::vector<MIL_UUID> ] MORE
Click to summarize M_TRAIN_DATASET_MINI_BATCH_LOSS +

Retrieves an array containing the loss error values for each mini-batch during training. You can use the loss to evaluate the lack of confidence (doubt) associated with the classification during training.

Note that the required array size, which you can retrieve with M_NB_ELEMENTS, is equivalent to M_MAX_EPOCH (MclassControl()) * M_MINI_BATCH_PER_EPOCH (MclassGetResult()) of the training context used.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 1.0

Specifies the training dataset loss for each mini-batch. These values are stored in an array of MIL_DOUBLE.

(summarize)

To retrieve general results from a tree ensemble training result buffer (ResultClassId), the ResultType can be set to one of the following values. In this case, set the LabelOrIndex parameter to M_GENERAL.

Note, bagging information is typically unreliable if your training dataset has augmented entries.

function map For training (tree ensemble) - retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_DEV_DATASET_ACCURACY_AFTER_EACH_TREE +

Retrieves an array containing the accuracies on the development dataset after adding each tree to the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_DEV_DATASET_ERROR_RATE_AFTER_EACH_TREE +

Retrieves an array containing the error rates after on the development dataset after adding each tree to the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_FEATURE_IMPORTANCE +

Retrieves an array containing the importance of each feature when training the classifier.

This result can be disabled if M_FEATURE_IMPORTANCE_MODE is set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_NUMBER_OF_ENTRIES_OUT_OF_BAG +

Retrieves the number of out-of-bag dataset entries.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the number of out-of-bag dataset entries.

Click to summarize M_NUMBER_OF_FEATURES +

Retrieves the number of features.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the number of features.

Click to summarize M_NUMBER_OF_TREES_TRAINED +

Retrieves the number of trained trees. This result is equivalent to the number of trees in the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the number of trained trees.

Click to summarize M_OUT_OF_BAG_ACCURACY +

Retrieves the out-of-bag error accuracy.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the out-of-bag accuracy, as a percentage.

Click to summarize M_OUT_OF_BAG_ACCURACY_AFTER_EACH_TREE +

Retrieves the array containing the accuracies on the out-of-bag set after adding each tree to the classifier.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_OUT_OF_BAG_CONFUSION_MATRIX +

Retrieves the confusion matrix obtained using the out-of-bag set.

This is a square matrix. MIL returns the matrix values, row-by-row, as an array. The array size is equivalent to the square of the total amount of classes, which is the same M_OUT_OF_BAG_CONFUSION_MATRIX_SIZE_X x M_OUT_OF_BAG_CONFUSION_MATRIX_SIZE_Y, or M_NB_ELEMENTS.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_OUT_OF_BAG_CONFUSION_MATRIX_SIZE_X +

Retrieves the X-dimension of the confusion matrix. This value is calculated using the out-of-bag set.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the X-dimension of the confusion matrix.

Click to summarize M_OUT_OF_BAG_CONFUSION_MATRIX_SIZE_Y +

Retrieves the Y-dimension of the confusion matrix. This value is calculated using the out-of-bag set.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the Y-dimension of the confusion matrix.

Click to summarize M_OUT_OF_BAG_ERROR_RATE +

Retrieves the out-of-bag error rate.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the out-of-bag error rate.

Click to summarize M_OUT_OF_BAG_ERROR_RATE_AFTER_EACH_TREE +

Retrieves the array containing the accuracies on the out-of-bag set after adding each tree to the classifier.

This is only available if M_COMPUTE_OUT_OF_BAG_RESULTS is set to M_ENABLE and M_BOOTSTRAP is not set to M_DISABLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_PROXIMITY_MATRIX +

Retrieves the proximity matrix.

This is a square matrix. MIL returns the matrix values, row-by-row, as an array. The array size is equivalent M_PROXIMITY_MATRIX_SIZE_X x M_PROXIMITY_MATRIX_SIZE_Y or M_NB_ELEMENTS.

In the proximity matrix, the entry in cell (j, k) is some measure of similarity (or distance) between the entries to which row j and column k correspond.

The proximity matrix result can be enabled or disabled using M_COMPUTE_PROXIMITY_MATRIX in the train context.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_PROXIMITY_MATRIX_SIZE_X +

Retrieves the X-dimension of the proximity matrix.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the X-dimension of the proximity matrix.

Click to summarize M_PROXIMITY_MATRIX_SIZE_Y +

Retrieves the Y-dimension of the proximity matrix.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the Y-dimension of the proximity matrix.

Click to summarize M_SEED_VALUE +

Retrieves the seed used for the training dataset.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the seed used for the training dataset.

Click to summarize M_TRAIN_DATASET_ACCURACY_AFTER_EACH_TREE +

Retrieves the array containing the accuracies on the training dataset after adding each tree to the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TRAIN_DATASET_ERROR_RATE_AFTER_EACH_TREE +

Retrieves the array containing the error rates on the training dataset after adding each tree to the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TREE_DEPTHS_ACHIEVED +

Retrieves the array containing the depth achieved by each tree in the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TREE_NUMBER_OF_LEAF_NODES_ACHIEVED +

Retrieves the array containing the number of leaf nodes for each tree in the classifier.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE

To retrieve general results from a CNN or tree ensemble training result buffer (ResultClassId), the ResultType parameter can be set to one of the following values. In this case, set the LabelOrIndex parameter to M_GENERAL.

function map For training (CNN or tree ensemble) - retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_DEV_DATASET_ACCURACY +

Retrieves the accuracy on the development dataset using the trained context.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the accuracy on the development dataset, as a percentage.

Click to summarize M_DEV_DATASET_CONFUSION_MATRIX +

Retrieves the confusion matrix obtained using the development dataset.

This is a square matrix. MIL returns the matrix values, row-by-row, as an array. The array size is equivalent to the square of the total amount of classes, which is the same M_DEV_DATASET_CONFUSION_MATRIX_SIZE_X x M_DEV_DATASET_CONFUSION_MATRIX_SIZE_Y, or M_NB_ELEMENTS.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_DEV_DATASET_CONFUSION_MATRIX_SIZE_X +

Retrieves the X-dimension of the confusion matrix. This value is calculated using the development dataset.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the X-dimension of the confusion matrix.

Click to summarize M_DEV_DATASET_CONFUSION_MATRIX_SIZE_Y +

Retrieves the Y-dimension of the confusion matrix. This value is calculated using the development dataset.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the Y-dimension of the confusion matrix.

Click to summarize M_DEV_DATASET_ERROR_RATE +

Retrieves the error rate on the development dataset. This can be expressed as 100.0 - M_DEV_DATASET_ACCURACY.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the accuracy error rate on the development dataset, as a percentage.

Click to summarize M_DEV_DATASET_USED_ENTRIES +

Retrieves an array containing the MIL_UUID of each image in the development dataset used during the training phase.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_UUID [optionally, in C++: a reference to a std::vector<MIL_UUID> ] MORE
Click to summarize M_TRAIN_DATASET_ACCURACY +

Retrieves the accuracy on the training dataset using the trained context.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the accuracy on the training dataset, as a percentage.

Click to summarize M_TRAIN_DATASET_CONFUSION_MATRIX +

Retrieves the confusion matrix obtained using the training dataset.

This is a square matrix. MIL returns the matrix values, row-by-row, as an array. The array size is equivalent to the square of the total amount of classes, which is the same M_TRAIN_DATASET_CONFUSION_MATRIX_SIZE_X x M_TRAIN_DATASET_CONFUSION_MATRIX_SIZE_Y, or M_NB_ELEMENTS.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TRAIN_DATASET_CONFUSION_MATRIX_SIZE_X +

Retrieves the X-dimension of the confusion matrix. This value is calculated using the training dataset.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the X-dimension of the confusion matrix.

Click to summarize M_TRAIN_DATASET_CONFUSION_MATRIX_SIZE_Y +

Retrieves the Y-dimension of the confusion matrix. This value is calculated using the training dataset.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 1

Specifies the Y-dimension of the confusion matrix.

Click to summarize M_TRAIN_DATASET_ERROR_RATE +

Retrieves the error rate on the training dataset. This can be expressed as 100.0 - M_TRAIN_DATASET_ACCURACY.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the accuracy error rate on the training dataset, as a percentage.

Click to summarize M_TRAIN_DATASET_USED_ENTRIES +

Retrieves an array containing the MIL_UUID of each image in the training dataset used during the training phase.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_UUID [optionally, in C++: a reference to a std::vector<MIL_UUID> ] MORE

To retrieve general results from a CNN prediction result buffer (ResultClassId), the ResultType can be set to one of the following values. In this case, set the LabelOrIndex parameter to M_GENERAL.

function map For prediction (CNN) - retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CLASS_MAP_INDEX_IMAGE_TYPE +

Retrieves the image type to provide when calling MclassDraw() with M_DRAW_BEST_INDEX_IMAGE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_UNSIGNED + 8

Specifies that the image type is 8-bit unsigned.

Click to summarize M_UNSIGNED + 16

Specifies that the image type is 16-bit unsigned.

Click to summarize M_CLASSIFICATION_MAP_OFFSET_X +

Retrieves the classification map offset along the X-axis.

Apply the scale and offset to M_CLASSIFICATION_MAP_SIZE_X to compute the center of the receptive field of each M_CLASS_SCORES into the target image such as: x * M_CLASSIFICATION_MAP_SCALE_X + M_CLASSIFICATION_MAP_OFFSET_X.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the classification map offset along the X-axis.

Click to summarize M_CLASSIFICATION_MAP_OFFSET_Y +

Retrieves the classification map offset along the Y-axis.

Apply the scale and offset to M_CLASSIFICATION_MAP_SIZE_Y to compute the center of the receptive field of each M_CLASS_SCORES into the target image such as: y * M_CLASSIFICATION_MAP_SCALE_Y + M_CLASSIFICATION_MAP_OFFSET_Y.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the classification map offset along the Y-axis.

Click to summarize M_CLASSIFICATION_MAP_SCALE_X +

Retrieves the classification map scale along the X-axis.

Apply the scale and offset to M_CLASSIFICATION_MAP_SIZE_X to compute the center of the receptive field of each CLASS_SCORES into the target image such as: x * M_CLASSIFICATION_MAP_SCALE_X + M_CLASSIFICATION_MAP_OFFSET_X.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0.0

Specifies the classification map scale along the X-axis.

Click to summarize M_CLASSIFICATION_MAP_SCALE_Y +

Retrieves the classification map scale along the Y-axis.

Apply the scale and offset to M_CLASSIFICATION_MAP_SIZE_Y to compute the center of the receptive field of each CLASS_SCORES into the target image such as: y * M_CLASSIFICATION_MAP_SCALE_Y + M_CLASSIFICATION_MAP_OFFSET_Y.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0.0

Specifies the classification map scale along the Y-axis.

Click to summarize M_CLASSIFICATION_MAP_SIZE_X +

Retrieves the number of predictions the deep network has made according to the target image size (see M_TARGET_IMAGE_SIZE_X).

Typically, for a target image the same size as the network's source layer the map size will be 1x1, meaning a single prediction for the whole target image. For a larger target image, the map size can be larger, meaning the CNN has convolved the larger target image and made many predictions doing so.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Retrieves the number of entries in the dataset.

Click to summarize M_CLASSIFICATION_MAP_SIZE_Y +

Retrieves the number of predictions the deep network has made according to the target image size (see M_TARGET_IMAGE_SIZE_Y).

Typically, for a target image the same size as the network's source layer the map size will be 1x1, meaning a single prediction for the whole target image. For a larger target image, the map size can be larger, meaning the CNN has convolved the larger target image and made many predictions doing so.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Retrieves the number of entries in the dataset.

Click to summarize M_RECEPTIVE_FIELD_SIZE_X +

Retrieves the size of the receptive field along the X-axis.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the size of the receptive field along the X-axis.

Click to summarize M_RECEPTIVE_FIELD_SIZE_Y +

Retrieves the size of the receptive field along the Y-axis.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the size of the receptive field along the Y-axis.

To retrieve general results from a CNN or tree ensemble prediction result buffer (ResultClassId), the ResultType can be set to one of the following values. In this case, set the LabelOrIndex parameter to M_GENERAL.

function map For prediction (CNN or tree ensemble) - retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_BEST_CLASS_INDEX +

Retrieves the highest class index.

Note, for coarse segmentation (pixel level classification) of an image with a CNN, this retrieves an array (map) of values that can be arranged in a 2D image, where the size is equal to M_CLASSIFICATION_MAP_SIZE_X multiplied by M_CLASSIFICATION_MAP_SIZE_Y. Each value is the index of the class having the best score. The index of the class begins at 0.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value >= 0

Specifies the highest class index.

Click to summarize M_BEST_CLASS_SCORE +

Retrieves the highest class score.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies the best class score.

Click to summarize M_NUMBER_OF_CLASSES +

Retrieves the number of classes.

For a CNN, this refers to the number of outputs in the CNN's last layer. For tree ensemble, this refers to the number of tree ensemble in the classifier.

This can also be used in a tree ensemble prediction with LabelOrIndex set to M_GENERAL.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Retrieves the number of entries in the dataset.

To retrieve general results from a CNN or tree ensemble prediction result buffer, set the LabelOrIndex parameter to M_GENERAL; to retrieve class-specific results from a CNN prediction result buffer, set the LabelOrIndex parameter the index of a specific class (using M_CLASS_INDEX()). In these cases, the ResultType can be set to one of the following values. Note, you cannot receive class-specific results from a tree ensemble result buffer.

function map For prediction (CNN or tree ensemble) - retrieving general or class-specific results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CLASS_SCORES +

Retrieves an array of all the class scores.

The number of returned values is M_NUMBER_OF_CLASS_SCORES.

For general results obtained from a CNN prediction result buffer, the returned values are organized planar-wise in a 3d volume of size M_CLASSIFICATION_MAP_SIZE_X * M_CLASSIFICATION_MAP_SIZE_Y * M_NUMBER_OF_CLASSES. Note, each band contains the score of one given class. The index in this returned array of the score of class C at pixel X, Y is: index = (C * MapSizeX * MapSizeY) + (Y * MapSizeX) + X.

For general results obtained from a tree ensemble prediction result buffer, the number of class scores is equivalent to M_NUMBER_OF_CLASS_SCORES.

For class-specific results (LabelOrIndex set to M_CLASS_INDEX()) obtained from a CNN prediction result buffer, the returned values are organized in a vector that corresponds to a 2D volume of size M_CLASSIFICATION_MAP_SIZE_X * M_CLASSIFICATION_MAP_SIZE_Y. The index of the score at location X, Y is: index = (Y * M_CLASSIFICATION_MAP_SIZE_X ) + X.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize 0.0 <= Value <= 100.0

Specifies all of the class scores.

Click to summarize M_NUMBER_OF_CLASS_SCORES +

Retrieves the total number of class scores.

For general results obtained from a CNN predict result buffer, the total corresponds to M_CLASSIFICATION_MAP_SIZE_X * M_CLASSIFICATION_MAP_SIZE_Y * M_NUMBER_OF_CLASSES scores. The first batch of M_CLASSIFICATION_MAP_SIZE_X * M_CLASSIFICATION_MAP_SIZE_Y scores are for the first class and the subsequent batches are for the remaining classes. In other words, the data is organized planar-wise.

For general results obtained from a tree ensemble predict result buffer, the total corresponds to M_NUMBER_OF_CLASSES.

For class-specific results (LabelOrIndex set to M_CLASS_INDEX()) obtained from a CNN predict result buffer, the total corresponds to M_CLASSIFICATION_MAP_SIZE_X * M_CLASSIFICATION_MAP_SIZE_Y.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Retrieves the number of entries in the dataset.

To retrieve the status of the training or prediction operation from a result buffer (ResultClassId), the ResultType can be set to the following value. In this case, set the LabelOrIndex parameter to M_GENERAL. Unless otherwise specified, the following values apply to a CNN or tree ensemble training result buffer, or a CNN prediction result buffer.

function map For training or prediction (CNN or tree ensemble) - retrieving the operation's resulting status
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_STATUS +

Retrieves information regarding the state of the operation.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_COMPLETE

Specifies that the operation completed successfully.

Click to summarize M_CURRENTLY_PREDICTING

Specifies that the prediction operation is currently ongoing. You can only get this status if you're retrieving it from another thread.

This only applies if you are retrieving results from a CNN or tree ensemble prediction result buffer (ResultClassId).

(summarize)
Click to summarize M_CURRENTLY_TRAINING

Specifies that the training operation is currently ongoing. You can only get this status if you're retrieving it from another thread.

This only applies if you are retrieving results from a CNN or tree ensemble training result buffer (ResultClassId).

(summarize)
Click to summarize M_INTERNAL_ERROR

Specifies that an unexpected error occurred during the operation (contact customer support).

Click to summarize M_NON_FINITE_VALUE_DETECTED

Specifies that the training terminated because a non-finite value was detected when the network's parameters were last updated. These values include NaN (Not a Number) and INF (infinity) cases. Such invalid values are often caused by numerically unstable computations that occur during training due to a learning rate that is too high.

This only applies if you are retrieving results from a CNN training result buffer (ResultClassId).

(summarize)
Click to summarize M_NOT_ENOUGH_GPU_MEMORY

Specifies that a memory allocation error occurred while training on the GPU.

This only applies if you are retrieving results from a CNN training result buffer (ResultClassId).

(summarize)
Click to summarize M_NOT_ENOUGH_MEMORY

Specifies that a memory allocation error occurred during the operation.

Click to summarize M_PREDICT_NOT_PERFORMED

Specifies that the prediction operation was not performed. This is the initial status.

This only applies if you are retrieving results from a CNN or tree ensemble prediction result buffer (ResultClassId).

(summarize)
Click to summarize M_STOPPED_BY_REQUEST

Specifies that the current execution of the operation was explicitly stopped (MclassControl() with M_STOP_PREDICT).

Click to summarize M_TIMEOUT_REACHED

Specifies that the operation ended because the timeout limit was reached (MclassControl() with M_TIMEOUT).

Click to summarize M_TRAINING_NOT_PERFORMED

Specifies that the training operation was not performed. This is the initial status.

This only applies if you are retrieving results from a CNN or tree ensemble training result buffer (ResultClassId).

(summarize)

You can add the following value to the above-mentioned values to determine the required number of elements in the array (array size).

function map For determining the required number of elements in the array (array size)
Click to summarizeResultType combination value Description
ResultArrayPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE

You can add the following value to the above-mentioned values to determine whether a result is available.

function map For determining whether results are available
Click to summarizeResultType Description
ResultArrayPtr
- Possible values returned
Click to summarize M_AVAILABLE

Retrieves whether a result is available to be returned.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_NULL

Specifies that the result is not available to be retrieved.

Click to summarize Value != 0

Specifies that the result is available to be retrieved.

You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For specifying the data type
Click to summarizeResultType Description
ResultArrayPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]  |  address of a MIL_DOUBLE MORE
Click to summarize M_TYPE_MIL_ID

Casts the requested results to a MIL_ID.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]  |  address of a MIL_ID MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]  |  address of a MIL_INT MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested results to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]  |  address of a MIL_INT32 MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]  |  address of a MIL_INT64 MORE
Compilation information
Header Include mil.h.
Library Use mil.lib; milclass.lib.
DLL Requires mil.dll; milclass.dll.
DEFAULT NUMBER OF CLASSES GENERAL DEV DATASET EPOCH ACCURACY DEV DATASET EPOCH ERROR RATE DEV DATASET ERROR ENTRIES LAST EPOCH UPDATED PARAMETERS INVALID MINI BATCH PER EPOCH TRAIN DATASET EPOCH ACCURACY TRAIN DATASET EPOCH ERROR RATE TRAIN DATASET ERROR ENTRIES TRAIN DATASET MINI BATCH LOSS DEV DATASET ACCURACY AFTER EACH TREE DEV DATASET ERROR RATE AFTER EACH TREE FEATURE IMPORTANCE NUMBER OF ENTRIES OUT OF BAG NUMBER OF FEATURES NUMBER OF TREES TRAINED OUT OF BAG ACCURACY OUT OF BAG ACCURACY AFTER EACH TREE OUT OF BAG CONFUSION MATRIX OUT OF BAG CONFUSION MATRIX SIZE X OUT OF BAG CONFUSION MATRIX SIZE Y OUT OF BAG ERROR RATE OUT OF BAG ERROR RATE AFTER EACH TREE PROXIMITY MATRIX PROXIMITY MATRIX SIZE X PROXIMITY MATRIX SIZE Y SEED VALUE TRAIN DATASET ACCURACY AFTER EACH TREE TRAIN DATASET ERROR RATE AFTER EACH TREE TREE DEPTHS ACHIEVED TREE NUMBER OF LEAF NODES ACHIEVED DEV DATASET ACCURACY DEV DATASET CONFUSION MATRIX DEV DATASET CONFUSION MATRIX SIZE X DEV DATASET CONFUSION MATRIX SIZE Y DEV DATASET ERROR RATE DEV DATASET USED ENTRIES TRAIN DATASET ACCURACY TRAIN DATASET CONFUSION MATRIX TRAIN DATASET CONFUSION MATRIX SIZE X TRAIN DATASET CONFUSION MATRIX SIZE Y TRAIN DATASET ERROR RATE TRAIN DATASET USED ENTRIES CLASS MAP INDEX IMAGE TYPE UNSIGNED 8 UNSIGNED 16 CLASSIFICATION MAP OFFSET X CLASSIFICATION MAP OFFSET Y CLASSIFICATION MAP SCALE X CLASSIFICATION MAP SCALE Y CLASSIFICATION MAP SIZE X CLASSIFICATION MAP SIZE Y RECEPTIVE FIELD SIZE X RECEPTIVE FIELD SIZE Y BEST CLASS INDEX BEST CLASS SCORE NUMBER OF CLASSES CLASS SCORES NUMBER OF CLASS SCORES STATUS COMPLETE CURRENTLY PREDICTING CURRENTLY TRAINING INTERNAL ERROR NON FINITE VALUE DETECTED NOT ENOUGH GPU MEMORY NOT ENOUGH MEMORY PREDICT NOT PERFORMED STOPPED BY REQUEST TIMEOUT REACHED TRAINING NOT PERFORMED NB ELEMENTS AVAILABLE NULL TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64