Parameter

Long

Short

Description

Can Repeat

Notes

--output-crs

c

A string specifying the horizontal coordinate reference system key of the output.

FALSE

This must be specified explicitly.

--output-vertical-crs

o

A string specifying the vertical coordinate reference system key of the output.

No vertical transformation is applied even if a value is specified. This value is only used as metadata on the output dataset.

FALSE

--primary-band

m

The name, interpolation method and sampling method of the primary elevation band of the output.

<Name> - A string specifying the name of the primary elevation band of the output.

<Interpolation> - A string specifying the interpolation method. One of:

• BICUBIC: Performs bicubic interpolation, which is smoother but may take longer than bilinear.

• BICUBIC_KEEP_HOLE: Performs bicubic interpolation that maintains holes.

• BILINEAR: Performs linear interpolation in one direction and then the other, resulting in quadratic interpolation.

• BILINEAR_KEEP_HOLE: Bilinear interpolation that maintains holes.

• NEAREST_NEIGHBOUR: Uses the nearest point, averaging if some are equidistant.

• NONE: No interpolation is performed.

<Sampling> - A string specifying the sampling method. One of:

• MIN: Use the minimum value.

• MAX: Use the maximum value.

• NONE: The interpolation method determines the value used.

The primary elevation band must be a numeric type band.

All values representing elevations are considered using the convention that up is positive, so a minimum bias is a minimum elevation bias; minimum elevation is equivalent to maximum depth. The value of NONE cannot be specified for both Interpolation and Sampling parameters.

The default value is the name of primary elevation band in the input, with no interpolation or sampling.

FALSE

This must be specified explicitly.

--resolution

R

A number and unit specifying the resolution of the output raster.

Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

FALSE

This must be specified explicitly.

--reprojection -method

j

The reprojection method to use. One of:

• FAST: Use fast, approximate reprojection.

• EXACT: Use exact reprojection.

The default value is FAST.

FALSE

--input-band

i

The name, interpolation method, and sampling method of an input band.

<Name> - A string specifying the name of the band.

<Interpolation> - A string specifying the interpolation method. One of:

• BICUBIC: Performs bicubic interpolation, which is smoother but may take longer than bilinear.

• BICUBIC_KEEP_HOLE: Performs bicubic interpolation that maintains holes.

• BILINEAR: Performs linear interpolation in one direction and then the other, resulting in quadratic interpolation.

• BILINEAR_KEEP_HOLE: Performs bilinear interpolation that maintains holes.

• NEAREST_NEIGHBOUR: Uses the nearest point, averaging if some are equidistant.

• NONE: No interpolation is performed.

<Sampling> - A string specifying the sampling method. One of:

• FOLLOW_PRIMARY: Use the value of this band in the input at the location of the used primary band value.

• NONE: The interpolation method determines the value used.

The ALL keyword is used to include all bands in the output. If the ALL keyword is used in conjunction with explicit band names, the latter will override the options specified with the ALL keyword.

TRUE

When the sampling for the primary band is set to NONE, all input bands must use NONE for sampling.

When the band is not numeric and does not contain colour information, then NONE is the only valid interpolation option.

If NONE is specified for both interpolation and sampling method, then the band will not be included in the output.

--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.

--recompute-stat

s

If set, values in statistical bands present in the output are recomputed.

The bands that are recomputed are Density, Mean, Standard Deviation, Shoal and Deep.

FALSE

--anchor

A

The point that defines the output raster anchor position.

<LowerX> - A number and unit specifying the lower left X origin in the coordinate reference system of the output.

<LowerY> - A number and unit specifying the lower left Y origin in the coordinate reference system of the output.

The anchor position is a position in the centre of a cell.

HALF_RES is used to calculate a coordinate position for a cell centre that is half the resolution offset from a multiple of the resolution, which creates cells that have their lower left corner at a multiple of the resolution. Typically, the usage in this context is --anchor HALF_RES HALF_RES.

The default value is 0.0 0.0.

FALSE

Example

Objective

You want to transform a raster surface to a specific coordinate reference system.

Description

Command Line Syntax

The output coordinate reference system will be EPSG:3395.

--output-crs EPSG:3395

The Depth layer will be interpolated using BILINEAR interpretation and sampling set to MIN.

--primary-band Depth BILINEAR MIN

The Std_Dev layer will be interpolated using BILINEAR interpretation and sampling set to NONE.

--input-band Std_Dev BILINEAR NONE

The output resolution will be 3m.

--resolution 3m

The FAST reprojection will be used.

--reprojection-method FAST

The source raster surface is Surface11.csar located in the D:\BatchSample directory.

D:\BatchSample\Surface11.csar

The resulting file will be named Warped.csar located in the D:\BatchSample directory.

D:\BatchSample\Warped.csar

Command Line

carisbatch --run WarpRaster --output-crs EPSG:3395 --primary-band Depth BILINEAR MIN --input-band Std_Dev BILINEAR NONE --resolution 3m --reprojection-method FAST D:\BatchSample\Surface11.csar D:\BatchSample\Warped.csar

Outcome

A new raster surface file, with the specified parameters, is created.

Extra Notes

N/A