Description
The ContourRaster process generates isolines to mark areas of constant value.
Inputs
A raster dataset.
Outputs
A vector file in the specified output format.
Command Line Syntax
carisbatch --run ContourRaster --output-format <value> --input-band <value> [options] <input> <output>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
Common Options | ||||
--output-format | O | A string specifying the format in which the output is generated. One of: • HOB: The CARIS HOB format. • DXF: The AutoCAD DXF format. Options specific to each format are specified below. | FALSE | This must be specified explicitly. |
--input-band | i | A string specifying the name of the input band. The input band can be any numeric band. String table bands like Contributor and Source_Name are supported, but should only be used with integer intervals. | FALSE | This must be specified explicitly. |
--range | g | The interval and minimum and maximum range of values to be considered. <MinValue> - A number specifying the range's lower bound. <MaxValue> - A number specifying the range's upper bound. <Interval> - The spacing between contour values. MIN and MAX are keywords to consider all the values in the specified band. All values representing elevations are entered using the convention that up is positive. The unit must be specified, unless the input band is a unitless band like Density. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | TRUE | MIN is a keyword for the minimum value in the specified band. MAX is a keyword for the maximum value in the specified band. |
--level | L | A number specifying a contour level. All values representing elevations are entered using the convention that up is positive. The unit must be specified, unless the input band is a unitless band like Density. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. | TRUE | |
OutputFormat = HOB | ||||
--feature-catalogue | F | A string specifying the name of the catalogue that defines the features and attributes in the input dataset. One of {list dynamically populated from the catalogue control file}. The catalogue must be in the catalogue control file specified in Tools > Options > Files and Folders > Files > Catalogue Control, for example S-57 ENC 3.1. | FALSE | This must be specified explicitly. The default location of CatalogueControl.xml file is C:\Program Files\CARIS\BASE Editor\4.2\system\. |
--contour-feature | C | A string specifying the feature acronym of the line object to be used for contour line features. The specified acronym must be present in the specified catalogue. | FALSE | This must be specified explicitly. |
--level-attribute | a | A string specifying the attribute acronym for the level of contour line features. | FALSE | This must be specified explicitly. |
--boundary-feature | B | A string specifying the feature acronym of the area object to be used for the data boundary. The specified acronym must be present in the specified catalogue. | FALSE | This is optional. If it is not specified, no boundary features will be created in the output HOB file. |
OutputFormat = DXF | ||||
--boundary-name | B | A string specifying the name of the area object to be used for the data boundary. | FALSE | This is optional. If it is not specified, no boundary features will be created in the output DXF file. |
--contour-name | C | A string specifying the name of the line object to be used for contour line features. The default value is Contour. | FALSE | This is optional. |
Example
To use this command refer to the following example.
Example | ||
Objective | You want to create contour lines based on a raster surface. | |
Description | Command Line Syntax | |
The band to be contoured is Depth. | --input-band Depth | |
The output format is HOB. | --output-format HOB | |
The feature catalogue name is S-57 ENC 3.1. | --feature-catalogue "S-57 ENC 3.1" | |
The level attribute is VALDCO. | --level-attribute VALDCO | |
The contour feature is DEPCNT. |
| |
The data will be contoured between a lower boundary of -100 metres, an upper boundary of 0 metres, with a contour interval of 20 metres. | --range -100m 0m 20m | |
An extra contour level is at a depth of 10 metres. | --level -10m | |
Command Line |
| |
Outcome | A HOB file, containing the contour lines generated by the process, is created. Depending on the data, contours are created at depths of 10, 20, 40, 60, 80 and 100 metres. | |
Extra Notes | One of either level or range must be specified for the process to run. | |