Description
The ClassifyRasterHolidays process assigns each cell in a raster band as valid data, no data or an interior holiday (hole).
Inputs
A raster dataset. The raster must be editable.
Outputs
No output is generated. The input raster is modified. A new band called <InputBand> and Holidays is added.
Command Line Syntax
carisbatch --run ClassifyRasterHolidays --input-band <value> [options] <input>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--input-band | i | A string specifying the name of the input raster band that will be classified. | FALSE | This must be specified explicitly. |
--classify-no-data | y | If set, cells outside will be classified as NO-DATA. With this option set, every cell inside the raster surface extents is classified. By default, only the cells inside the outer boundary of the data in the band are classified. | FALSE | |
Example
To use this command refer to the following example.
Example | ||
Objective | You want to classify every cell within the raster surface as being data, or part of a holiday or part of an exterior no data area. | |
Description | Command Line Syntax | |
Holidays will be classified for the Depth band. | --input-band Depth | |
Exterior no-data values will be populated. | --classify-no-data | |
The source surface, Surface1.csar, is located at D:\BatchSample\Surface1.csar. | D:\BatchSample\Surface1.csar | |
Command Line |
| |
Outcome | A new "Depth and Holidays" band will be created in the raster surface. | |
Extra Notes | N/A | |