Description
The FillRasterHolidays process uses the mean of nearby nodes to fill cells in holidays.
Inputs
A raster dataset.
Outputs
A raster in CSAR format. Previously empty cells in the input band are populated based on the process options. A new band called "<InputBand> Interpolated" is added.
Command Line Syntax
carisbatch --run FillRasterHolidays --input-band <value> [options] <input> <output>
User Interface Command
Fill Raster Holidays for Entire Dataset
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 band that will be updated. Any numeric band can be specified. | FALSE | This must be specified explicitly. |
--matrix | m | The criteria that controls how interpolation is performed. <Size> - A string specifying the size of the matrix of input values for each output node. One of: • 3x3: A 3 x 3 interpolation matrix that considers one layer of cells around each output cell. • 5x5: A 5 x 5 interpolation matrix that considers two layers of cells around each output cell. <Neighbours> - A number specifying the minimum number of populated nodes in the input matrix to calculate an output node. Each output cell is populated with the average of the input cells in the matrix if there are at least <Neighbours> populated cells in the input matrix. Otherwise, the output cell is left empty. <Neighbours> is a number between 1 and (<Size>-1), inclusive. The default values are 3x3 and 6. | FALSE | |
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all other bands in the output. | TRUE | |
Example:
To use this command refer to the following example.
Example | ||
Objective | You want to fill holidays in a raster surface. | |
Description | Command Line Syntax | |
The input band to be used is Depth. | --input-band Depth | |
A matrix size of 5x5 is to be used. There must be at least 15 cells within the matrix area with values in the input in order to calculate a new output cell. | --matrix 5x5 15 | |
Mean and Std_Dev are additional bands to be included in the interpolated raster surface. | --include-band Mean --include-band Std_Dev | |
The source raster surface is Surface_2.csar in the D:\BatchSample directory. | D:\BatchSample\Surface_2.csar | |
The resulting raster surface will be named FillRasterHolidays.csar and stored in the D:\BatchSample directory. | D:\BatchSample\FillRasterHolidays.csar | |
Command Line |
| |
Outcome | A new raster surface will be created in the specified location with the specified name. The depth band will be updated to include additional populated cells, based on the rules specified. In addition to the specified bands, a new "Depth Interpolated" band will be created in the output raster surface. | |
Notes | N/A | |