Description
The SplitCoverage process creates new coverages for each set of data that meets a specified criteria.
Inputs
A coverage in a supported format.
Outputs
One or more coverages in CSAR format. The split files are named based on the provided output name prefix, with the split criteria value encoded into the name, such as "Classification_Water.csar" if splitting the Classification band using the Value method and an output prefix of "Classification_".
Command Line Syntax
carisbatch --run SplitCoverage --method <value> --input-band <value> [options] <input> <output>
User Interface Command
None.
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--method | A string specifying the criteria used to split the coverage data. • Value: A new coverage is created for each distinct value in a specified band. | FALSE | This must be specified explicitly. | |
Method = Value Options | ||||
--input-band | i | A string specifying the name of the input band. | FALSE | This must be specified explicitly. |
Example
To use this command, refer to the following example.
Example | ||
Objective | You need to split a coverage using the values in the Source_Name band to create separate coverages representing each of the original sources that were imported to create the input coverage. | |
Description | Command Line Syntax | |
The split will be performed using the Value method. | --method Value | |
The Source_Name band contains the values that will be used to split the input coverage. | --input-band Source_Name | |
The source coverage is called CombinedCoverage.csar and is located in the D:\BatchSample directory. | D:\BatchSample\CombinedCoverage.csar | |
The resulting coverages will be saved to same location as the source coverage, and the file names will have a prefix of "Split_". | D:\BatchSample\Split_.csar | |
Command Line | carisbatch --run SplitCoverage --method Value --input-band Source_Name D:\BatchSample\CombinedCoverage.csar D:\BatchSample\Split_.csar | |
Outcome | A coverage is created for each value found in the Source_Name band. Each coverage is named according to the Source_Name value it contains, with a prefix of "Split_", resulting in files names such as "Split_Input1.csar" and "Split_Input2.csar". | |
Extra Notes | N/A | |