r.confusionmatrix

Calculates a confusion matrix and accuracies for a given classification using r.kappa.

r.confusionmatrix [-dm] [classification=name] [raster_reference=name] [vector_reference=name] [column=name] [label_column=name] [csvfile=name] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

r.confusionmatrix

grass.script.run_command("r.confusionmatrix", classification=None, raster_reference=None, vector_reference=None, column=None, label_column=None, csvfile=None, flags=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("r.confusionmatrix")

Parameters

Command linePython (grass.script)

classification=name
    Name of raster map containing classification result
raster_reference=name
    Name of raster map containing reference classes
vector_reference=name
    Name of input vector map
    Name of vector map containing reference classes
column=name
    Name of column in the vector map containing reference classes
label_column=name
    Name of column used as raster category labels
csvfile=name
    Name for output csv file containing confusion matrix and accuracies
    If not given write to standard output
-d
    Description of the accuracies
-m
    Print output as a matrix
--overwrite
    Allow output files to overwrite existing files
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

classification : str, optional
    Name of raster map containing classification result
    Used as: input, raster, name
raster_reference : str, optional
    Name of raster map containing reference classes
    Used as: input, raster, name
vector_reference : str, optional
    Name of input vector map
    Name of vector map containing reference classes
    Used as: input, vector, name
column : str, optional
    Name of column in the vector map containing reference classes
    Used as: input, dbcolumn, name
label_column : str, optional
    Name of column used as raster category labels
    Used as: name
csvfile : str, optional
    Name for output csv file containing confusion matrix and accuracies
    If not given write to standard output
    Used as: output, file, name
flags : str, optional
    Allowed values: d, m
    d
        Description of the accuracies
    m
        Print output as a matrix
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

r.confusionmatrix calculates the confusion matrix, overall, user and producer accuracies, the omission and commission errors and the Kappa coefficient of classification result using r.kappa.

NOTES

The reference can be a raster map raster_reference or a vector map vector_reference with a column containing the class labels as integer numbers.

In case of vector reference, this map is rasterized according to the extent and resolution of the classification raster map.

EXAMPLE

Compute the confusion matrix as a CSV file including description of the accuracies:

r.confusionmatrix classification=classified raster_reference=trainingmap csvfile=test.csv -d

AUTHOR

Anika Weinmann, mundialis GmbH & Co. KG

SOURCE CODE

Available at: r.confusionmatrix source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819