Description
The VectorizeRaster process produces polygons from raster pixels.
Inputs
A raster in a supported format. A BDB Server URI can be specified as input.
Outputs
Area features in HOB format.
Command Line Syntax
carisbatch --run VectorizeRaster --input-band <value> --polygon-feature <value> [options] <input> <output>
User Interface Command
Vectorize Raster
Options
The following table describes the parameter available for this process.
Parameter |
| |||
|---|---|---|---|---|
Long | Short | Description | Can Repeat | Notes |
--input-band | i | A string specifying the name of the input band. | FALSE | This must be specified explicitly. |
--feature-catalogue | F | A string specifying the name of the catalogue that defines the features and attributes in a vector dataset. One of {list dynamically populated from the catalogue control file}. The names of the available catalogues can be accessed through application via the Object Catalogue environment variable in Tools > Options. The available catalogues are controlled by the Catalogue Control file. An example of a catalogue name is "S-57 ENC 3.1". The units and z-axis direction of the output are controlled by the pool of the feature catalogue of the output. If the input cannot be converted to those units and z-axis convention, then the values are simply copied from the input data. | FALSE | This must be specified explicitly. |
--polygon-feature | P | A string specifying the feature acronym of the area object to be used for the polygons. | FALSE | This must be specified explicitly. |
--mode | m | A string specifying the mode. One of: • COVERAGE: Coverage - A polygon is generated around each set of joined pixels. • VALUE: Value - A polygon is generated around pixels with the same value. Only valid for integer scaler type or string table type bands. The default value is COVERAGE. | FALSE | |
--value-attribute | a | A string specifying the attribute acronym for the value of the polygons. This is only used when the Mode is set to VALUE. | FALSE | |
--component-attribute | A | The mapping for one component of the band value to an attribute acronym. <Component> - A string specifying the name of the component in the vertical-bar separated list of components. <Attribute> - A string specifying the attribute acronym for the value of this component. It is possible to specify the same component multiple times, with different attributes, to map the same component to multiple attributes. As the raster has been vectorized based on the values in this band, all nodes in the raster within any given polygon have the same value for this band. | TRUE | |
To use this command refer to the following examples.
Example: Value Attribute
Example | ||
|---|---|---|
Objective | You want to vectorize seabed areas to represent the data sources in a contributor band. | |
Description | Command Line Syntax | |
The band to be vectorized is Contributor. | --input-band Contributor | |
The feature catalogue name is S-57 ENC 3.1. | --feature-catalogue "S-57 ENC 3.1" | |
The resulting polygons will be assigned the Coverage (cvrage) object acronym. | --polygon-feature M_SREL | |
The polygons will be created based on the values in the band. | --mode VALUE | |
The attribute acronym to use for the value of the polygons will be TXTDSC (Textual Description). | --component-attribute | |
The source surface, CombinedSurface.csar, is located at D:\BatchSample. | D:\BatchSample\CombinedSurface.csar | |
The resulting features will be saved to the MappedRaster.hob file, which will be created in the same location as the source surface. | D:\BatchSample\MappedRaster.hob | |
Command Line |
| |
Outcome | A HOB file is created containing newly-created SBDARE objects representing the data sources that contributed to the surface. The TXTDSC attribute of each object will be populated with the name and location of the data source that contributed to the area of the surface that is represented by each respective feature object. | |
Extra Notes | N/A | |
Example: Component Attribute
Example | ||
|---|---|---|
Objective | You want to identify the datasets that contributed to a combined surface in a database to determine which data is in need of updating. | |
Description | Command Line Syntax | |
The band to be vectorized is Contributor. | --input-band Contributor | |
The feature catalogue name is S-57 ENC 3.1. | --feature-catalogue "S-57 ENC 3.1" | |
The polygons will be created based on the values in the band. | --mode VALUE | |
The resulting polygons will be assigned the M_SREL (Survey Reliability) object acronym. | --polygon-feature M_SREL | |
The attribute acronym to use for the value of the polygons will be SUREND (Survey Date - End), which will be mapped from the SUREND values in the Contributor band. | --component-attribute SUREND SUREND | |
The source surface, CombinedDBSurface.csar, was extracted to D:\BatchSample. | D:\BatchSample\CombinedDBSurface.csar | |
The resulting features will be saved to the SURENDObjects.hob file, which will be created in the same location as the source surface. | D:\BatchSample\SURENDObjects.hob | |
Command Line |
| |
Outcome | A HOB file is created containing newly-created M_SREL objects representing the data sources that contributed to the surface. The SUREND attribute of each object will be populated with the survey end data of each data source that contributed to the area of the surface that is represented by each respective feature object. | |
Extra Notes | N/A | |