Description
The DescribeRasterProduct process allows displaying the existing raster product templates and their command line equivalents.
Inputs
A file containing raster product templates. The file specified in Tools > Options for Raster Product Templates is used as the input.
Outputs
Either the list of templates available in the file or the set of commands to generate the specified raster product.
Command Line Syntax
carisbatch --run DescribeRasterProduct [options]
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes |
--list-templates | s | Lists the available product templates. | FALSE | |
--template-name | t | The name of template for which to provide commands. | FALSE | |
Example
To use this command refer to the following examples.
Example | ||
Objective | You want to view a list of previously created product template files. | |
Description | Command Line Syntax | |
View a list of previously created product templates. | --list-templates | |
Command Line |
| |
Outcome | A list of available product templates is displayed in the command line window. | |
Extra Notes | N/A | |
Example | ||
Objective | You want to know what is in an existing template to be able to use it to create raster surfaces. | |
Description | Command Line Syntax | |
You want to use the product template file,Template1, previously created using the Export Raster Product tool in BASE Editor. | --template-name Template1 | |
Command Line |
| |
Outcome | The RasterProduct process reads the rasterproducttemplate.xml file and provides command lines for each of the individual export processes that would be required to generate all output defined in the template. | |
Extra Notes | The resulting command lines will not have values specified for the options unless they were defined in the template. Once complete, the commands can either be placed in a batch script and run in a single transaction, or each command can be run individually in CARIS Batch. | |