Description
The ShiftElevationBands process alters elevation band values by the specified method.
Inputs
A point cloud or raster surface.
Outputs
A coverage in CSAR format.
Command Line Syntax
carisbatch --run ShiftElevationBands --shift-type <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 | ||||
--input-band | i | A string specifying the name of the input band. The values in these elevation bands are to be shifted. The ALL keyword is used to shift all elevation bands and include them in the output. | TRUE | This must be specified explicitly. |
--include-band | b | A string specifying the name of a band to include in the output. The ALL keyword is used to include all other bands in the output, excluding any input bands. The values in these bands are not shifted. | TRUE | |
--shift-type | s | A string specifying the type of data by which to shift the band. One of: • ASCII: Shift by an ASCII file. • TIDE: Shift by a tide file, as well as a date and time band. • VALUE: Shift by a single floating point value. • RASTER: Shift by a raster surface file. • SPINE: Shift by a SPINE service. ShiftType specific options are given below. | FALSE | This must be specified explicitly. |
--output-vertical-crs | o | A string specifying the vertical coordinate reference system key of the output. | FALSE | |
--polygon-type | Y | A string specifying the type of bounding polygon to generate. One of: • CONVEX: The convex hull of the data is used for the polygon. • BUFFERED: A simplified buffered boundary is used for the polygon. The default value is BUFFERED. | FALSE | |
--comments | General comments to be added to the coverage metadata. The default value is an empty string. | FALSE | ||
ShiftType = ASCII Options | ||||
--shift-file | F | The path to the ASCII file containing the shift values. | FALSE | This must be specified explicitly. |
ShiftType = VALUE Options | ||||
--shift-value | S | A number and unit specifying the single shift value. All values representing elevations are entered using the convention that up is positive. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd. | FALSE | This must be specified explicitly. |
ShiftType = Tide Options | ||||
--shift-file | F | The path to the tide file. | FALSE | This must be specified explicitly. |
--date-band | d | A string specifying the band in the input containing date information. | FALSE | This may be a separate band or it may be encoded as part of the time band. |
--time-band | T | A string specifying the band in the input containing time information. | FALSE | This must be specified explicitly. |
ShiftType = Raster Options | ||||
--shift-file | F | The path to the raster surface file. The file can be in BIN format or any other supported raster surface format. | FALSE | This must be specified explicitly. |
--elevation-band | E | A string specifying the band in the shift raster surface containing the elevation values. | FALSE | This must be specified explicitly. |
ShiftType = SPINE Options | ||||
--username | n | A string specifying the user name used to log into the SPINE web server. | FALSE | This must be specified explicitly. |
--password | P | A string specifying the password used to log into the SPINE web server. | FALSE | This must be specified explicitly. |
--url | U | A string specifying the URL of the SPINE web server. | FALSE | This must be specified explicitly. |
--proxy | x | A string specifying the proxy used to connect to the SPINE web server. | FALSE | |
--time | t | A string specifying the time to request from the SPINE web server in UTC. | FALSE | This must be specified explicitly. |
To use this command refer to the following examples.
Example: ASCII Shift
Example | ||
Objective | You need to apply a shift to a surface using an ASCII file to control the shift. | |
Description | Command Line Syntax | |
The ASCII file to be used is called ShiftValues.xyz and is located in the BatchSample directory on the D drive. | --shift-file D:\BatchSample\ShiftValues.xyz | |
The Depth band will be shifted. | --input-band Depth | |
The output vertical coordinate reference system for the shift will be NAVD88 height. | --output-vertical-crs "NAVD88 height" | |
The source surface is called Cloud1 and is located in the BatchSample directory, on the D drive. | D:\BatchSample\Cloud1.csar | |
The resulting file will be named ASCIIShift.csar and will be placed in the BatchSample directory on the D drive. | D:\BatchSample\ASCIIShift.csar | |
Command Line Format |
| |
Outcome | A new CSAR file, with a shift applied to the specified band, is created. | |
Extra Notes | N/A | |
Example: Value Shift
Example | ||
Objective | You need to shift a surface by a single value. | |
Description | Command Line Syntax | |
A single shift of 4m will be applied, making the surface 4m less deep. | --shift-value 4.0m | |
The Depth band will be shifted. | --input-band Depth | |
The polygon type is buffered. | --polygon-type BUFFERED | |
The source surface is named Surface1 located in the BatchSample directory, on the D drive. | D:\BatchSample\Surface1.csar | |
The resulting file will be named ValueShift.csar and will be placed in the BatchSample directory on the D drive. | D:\BatchSample\ValueShift.csar | |
Command Line | ||
| ||
Outcome | A new CSAR file is created with a single value shift applied. | |
Extra Notes | The direction of the shift depends on the current application settings for the Z-axis Convention attribute. | |
Example: Tide Shift
Example | ||
Objective | You need to apply tide correction to a raster surface using data from a single tide station. | |
Description | Command Line Syntax | |
The shift type is Tide. | --shift-type TIDE | |
The input band is Depth. In addition to the Depth, you also need to shift Tide. | --input-band Depth --input-band Tide | |
The tide file is named 05tide.tid and is located in the BatchSample directory on the D drive. | --shift-file D:\BatchSample\05tide.tid | |
The date information is contained in the Time attribute layer. | --date-band Time | |
The time information is contained in the Time attribute layer. | --time-band Time | |
The source surface is named tide_surface.csar and is located in the BatchSample directory, on the D drive. | D:\BatchSample\tide_surface.csar | |
The resulting file will be named TideShifted.csar and will be placed in the BatchSample directory on the D drive. | D:\BatchSample\TideShifted.csar | |
Command Line Format |
| |
Outcome | A new CSAR file is created with a tide shift applied to the data. | |
Extra Notes | The source surface to be shifted must contain Date and Time attribute layers. | |