Welcome to the Harris Geospatial documentation center. Here you will find reference guides and help documents.


  >  Docs Center  >  ENVI API  >  Classification Framework  >  ENVIConfusionMatrix

ENVIConfusionMatrix

ENVIConfusionMatrix

This function returns a reference to an ENVIConfusionMatrix object, which contains a confusion matrix and classification accuracy metrics that indicate how well a classifier performed. A confusion matrix is helpful for comparing the predicted (classification) results with truth data.

In an ENVI confusion matrix, columns represent true classes, while rows represent the classifier's predictions. The matrix is square, with all correct classifications along the upper-left to lower-right diagonal.

Here are some examples of how to read this matrix:

  • 2,385 values were correctly classified as Asphalt.
  • Reading down the Concrete column, 4 values that should have been Concrete were classified as Asphalt, and 1 value was classified as Grass. These are omission errors, which are defined as the fraction of values that belong to a class but were predicted to be in a different class. Errors of omission represent false negatives.
  • Reading across the Concrete row, 1 value that should have been Building was classified as Concrete. This is a commission error, which is defined as the fraction of values that were predicted to be in a class but do not belong to that class. Errors of commission represent false positives.

Example


See the following topics for code examples:

Syntax


Result = ENVIConfusionMatrix(Keywords=value)

Return Value


This function returns a reference to an ENVIConfusionMatrix object.

Arguments


None

Methods


Accuracy

ColumnTotals

CommissionError

Dehydrate

F1

GetParameters

GetProperties

Hydrate

KappaCoefficient

OmissionError

Precision

ProducerAccuracy

Recall

RowTotals

Save

UserAccuracy

Properties


COLUMN_NAMES (Get)

The truth class names.

CONFUSION_MATRIX (Get)

The confusion matrix computed from the input truth values and predicted values.

DESCRIPTION (Get, Set)

An optional description for the confusion matrix object.

ROW_NAMES (Get)

The predicted class names.

Keywords


The COLUMN_NAMES, DESCRIPTION, PREDICTED_VALUES, ROW_NAMES, and TRUTH_VALUES keywords are for users who want to manually specify confusion matrix parameters. In most cases you will use the ENVIEvaluateClassifier function, which creates an ENVIConfusionMatrix object with all of the required parameters.

COLUMN_NAMES (optional)

Set this keyword to a string array of column names corresponding to the truth class names.

DESCRIPTION (optional)

Set this keyword to a string with a description for the confusion matrix.

ERROR (optional)

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

PREDICTED_VALUES (required)

Set this keyword to an array of predicted class values. The array size must be equal to that of TRUTH_VALUES.

ROW_NAMES (optional)

Set this keyword to a string array of row names corresponding to the predicted class names.

TRUTH_VALUES (required)

Set this keyword to an array of truth class values. The array size must be equal to that of PREDICTED_VALUES.

URI (optional)

Set this keyword to a string with the fully qualified filename and path of the output object. If you specify a URI, the Save method will use that URI. You can restore the object later using ENVIRestoreObject.

Version History


ENVI 5.4

Introduced

API Version


3.3

See Also


ENVIEvaluateClassifier, ENVISoftmaxRegressionClassifier, ENVIGradientDescentTrainer, ENVIExamples



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us