TrainRandomForest Task

This task creates a set of decision trees from a randomly selected subset of the training set.

For background on the algorithm used, see Random Forest Classification.

Example

; Start the application

e = ENVI()

; Open an input raster file

RasterFile = Filepath('qb_boulder_msi', Subdir=['data'], $

  Root_Dir=e.Root_Dir)

Raster = e.OpenRaster(RasterFile)

; Open an input ROI file

ROIFile = Filepath('qb_boulder_roi.xml', Subdir=['data'], $

Root_Dir=e.Root_Dir)

ROI = e.OpenROI(ROIFile)

; Get the statistics task from the catalog of ENVITasks

StatsTask = ENVITask('NormalizationStatistics')

; Define inputs

StatsTask.INPUT_RASTERS = Raster

; Run the task

StatsTask.Execute

; Get the data prep task from the catalog of ENVITasks

DataPrepTask = ENVITask('MLTrainingDataFromROIs')

; Define inputs

DataPrepTask.INPUT_RASTER = Raster

DataPrepTask.INPUT_ROI = ROI

DataPrepTask.BACKGROUND_LABELS = ['Disturbed Earth', 'Water']

DataPrepTask.NORMALIZE_MIN_MAX = StatsTask.Normalization

DataPrepTask.Execute

; Get the training task from the catalog of ENVITasks

TrainTask = ENVITask('TrainRandomForest')

; Define inputs

TrainTask.INPUT_RASTER = DataPrepTask.OUTPUT_RASTER

TrainTask.NUM_ESTIMATORS = 100

; Run the task

TrainTask.Execute

; Output model metadata

outputModelUri = TrainTask.OUTPUT_MODEL_URI

print, 'Model URI: ' + outputModelUri

outputModel = TrainTask.OUTPUT_MODEL

print, outputModel.Attributes, /IMPLIED

Syntax

Result = ENVITask('TrainRandomForest')

Input properties (Set, Get): CUSTOM_MAX_FEATURES, BALANCE_CLASSES, INPUT_RASTERS, MAX_DEPTH, MAX_FEATURES, MODEL_NAME, MODEL_DESCRIPTION, NUM_ESTIMATORS, OOB_SCORE, OUTPUT_MODEL_URI

Output properties (Get only): OUTPUT_MODEL

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Methods

This task inherits the following methods from ENVITask. See the ENVITask topic in ENVI Help.

AddParameter
Execute
Parameter
ParameterNames
RemoveParameters

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

See the ENVITask topic in ENVI Help for details.

This task also contains the following properties:

BALANCE_CLASSES (optional)

Specify whether all classes should be considered equal during training. This helps to account for classes with few samples compared to classes with many examples.

CUSTOM_MAX_FEATURES (optional)

Specify the number of features to consider when looking for the best split. This parameter accepts a float or integer value. If specified, this value will override MAX_FEATURES.

INPUT_RASTERS (required)

Specify one or more preprocessed training rasters to be used for training.

MAX_DEPTH (optional)

Specify the number of decision trees to use. The estimators are the predictors of the algorithm. The default is 100.

MAX_FEATURES (optional)

Specify the number of features to consider when looking for the best split. This parameter offers options sqrt or log2 string literals. The default is sqrt.

MODEL_NAME (optional)

Specify the name of the model. The default is Random Forest Supervised Classifier.

MODEL_DESCRIPTION (optional)

Specify the purpose of the model.

NUM_ESTIMATORS (optional)

Specify the number of decision trees in the forest. Estimators are the predictors of the algorithm. The default is 100. The default is false.

OUTPUT_MODEL (required)

This is a reference to the output model file.

OOB_SCORE (optional)

Specify whether to use out-of-bag samples to estimate the generalization score. The default is false. If set to true, the score will be stored in the OUTPUT_MODEL statistics report.

OUTPUT_MODEL_URI (optional)

Specify a string with the fully qualified filename and path of the associated OUTPUT_MODEL. If you do not specify this property, or set it to an exclamation symbol (!), a temporary file will be created.

Version History

Deep Learning 2.0	Introduced
Deep Learning 2.1	Added MAX_FEATURES, CUSTOM_MAX_FEATURES, and OOB_SCORE properties.