Description
The ContourRaster process generates isolines to mark areas of constant value.
Inputs
A raster or variable resolution surface 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>
User Interface Command
Contouring
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 lower bound of the range. <MaxValue> - A number specifying the upper bound of the range. <Interval> - The spacing between contour values. If CARIS:NONE is used as the <MinValue>, the minimum value of the data is used. Similarly, if CARIS:NONE is used as the <MaxValue>, the maximum value of the data is used. 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 | |
--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 | |
--level-file | A file containing contour levels. <FilePath> - The path to a file containing newline-separated contour levels. <ZAxisConvention> - The z-axis convention of the contour levels in the file. • UP: Z-axis is positive up. • DOWN: Z-axis is positive down. • NONE: The contour levels are unaffected by z-axis convention. <Unit> - The unit of the contour levels in the file. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad. The unit can be caris:none if the contour levels are unitless. If levels and/or ranges are also specified, level files are ignored. | TRUE | ||
--generation-method | G | The generation method, controlling the location of nodes and the extents of the boundary. • GRID: Generate contours based on nodes in the centre of each cell, with the contour boundary around all populated cells. • TRUE_POSITION: Generate contours based on nodes in the true positions, with the contour boundary connecting the true position locations. The default is TRUE_POSITION. However, setting the TRUE_POSITION generation method on a raster with no true position locations will result in GRID-based contours. | FALSE | |
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. |
--polygon-feature | P | The mapping for polygons created between successive contour line features. <AreaObject> - A string specifying the feature acronym of the area object to be used for the polygons. <MinAttribute> - A string specifying the attribute acronym for the minimum value of bounding contours. <MaxAttribute> - A string specifying the attribute acronym for the maximum value of bounding contours. CARIS:NONE can be used for the MinAttribute and/or MaxAttribute. | FALSE | |
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. |
To use this command refer to the following examples.
Example 1:
Example | ||
|---|---|---|
Objective | You want to create contour lines and depth areas 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 contour feature is DEPCNT. |
| |
The level attribute is VALDCO. | --level-attribute VALDCO | |
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 10m. | --level -10m | |
The polygon feature for the depth areas is DEPARE. The attributes for the minimum and maximum values of the polygons are DRVAL1 and DRVAL2, respectively. | --polygon-feature DEPARE DRVAL1 DRVAL2 | |
The input file is named Surface1.csar and is found in D:\BatchSample. | D:\BatchSample\Surface1.csar | |
The resulting contour lines will be saved to Contours.hob in the same location as the source data. | D:\BatchSample\Contours.hob | |
Command Line |
| |
Outcome | A HOB file, containing the contour lines and depth areas 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. | |
Example 2:
Example | ||
|---|---|---|
Objective | You want to create contour lines for a SIPS mosaic. | |
Description | Command Line Syntax | |
The band to be contoured is Intensity. | --input-band Intensity | |
The output format is HOB. | --output-format HOB | |
The feature catalogue name is Bathy DataBASE. | --feature-catalogue "Bathy DataBASE" | |
The contour feature is isolne. |
| |
The level attribute is isoval. | --level-attribute isoval | |
Contours will be created for data at 7dB. | --level 7dB | |
The input file is named SIPS_Mosaic.csar and is found in D:\BatchSample. | D:\BatchSample\SIPS_Mosaic.csar | |
The resulting contour lines will be saved to SIPS_Contours.hob in the same location as the source data. | D:\BatchSample\SIPS_Contours.hob | |
Command Line |
| |
Outcome | A HOB file, containing the contour lines generated by the process, is created. | |
Extra Notes | One of either level or range must be specified for the process to run. | |