CARIS HIPS and SIPS Help : CARIS Batch Utility : BASE Editor Processes : Resample Surface To Raster
 

Resample Surface To Raster

Description

The ResampleSurfaceToRaster process creates a fixed resolution raster surface by interpolating a fixed or variable resolution surface at a single resolution.

Inputs

A surface in CSAR format.

Outputs

A raster surface in CSAR format.

Command Line Syntax

carisbatch --run ResampleSurfaceToRaster --resolution <value> [options] <input> <output>

User Interface Command

Interpolate Surface

Options

The following table describes the parameters available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

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

--extent

E

The extents that defines the window.

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

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

<UpperX> - A number specifying the upper right X origin in the coordinate reference system of the output.

<UpperY> - A number specifying the upper right Y origin in the coordinate reference system of the output.

The unit is assumed to be that of the output's coordinate reference system, unless otherwise specified. When specifying units for unprojected data, an angle type unit is required. The order for unprojected coordinates is longitude followed by latitude. Supported units: cable, ch, cm, fm, ft, in, inm, km, m, mi, mm, nm, usfm, usft, usmi, usnm, usyd, yd, deg and rad.

If not set, the cover of the data will be used.

FALSE

--type

The type of interpolation to be performed. One of:

LINEAR: Use linear interpolation

LINEAR_UNCERTAINTY: Use linear interpolation with uncertainty

NATURAL_NEIGHBOUR: Use natural neighbour interpolation

NATURAL_NEIGHBOUR_UNCERTAINTY: Use natural neighbour interpolation with uncertainty

The default value is LINEAR.

FALSE

--minimum-neighbours

A number specifying the minimum number of neighbours for calculating uncertainty.

The default value is 50. The valid range is 0 or greater.

This is only used when interpolating with uncertainty.

FALSE

--tautness

A list of numbers specifying two tautness values.

<Tautness1> - Controls the slope of the inflection point on an exponential curve.

<Tautness2> - Controls the position of the inflection point on an exponential curve.

The default values are 5.0 and 5.0. Both values must be provided.

This is only applicable when performing natural neighbour interpolation.

FALSE

--grid-linearity

The grid linearity style to use when performing natural neighbour interpolation. One of:

LINEAR_ONLY: Always use linear gridding

NON_LINEAR: Always use non-linear gridding

NON_LINEAR_EXCEPT_PERIMETER: Use non-linear gridding except near perimeter, where linear is then used

The default is LINEAR_ONLY.

FALSE

Example

To use this command refer to the following example.

Example

Objective

You want to create a single resolution surface from a variable resolution surface.

Description

Command Line Syntax

The output surface will have a resolution of 2m.

--resolution 2m

The node values will be calculated using the LINEAR_UNCERTAINTY interpolation method.

--type LINEAR_UNCERTAINTY

A minimum of 10 neighbouring nodes must be populated to interpolate the node values.

--minimum-neighbours 10

The input surface is named VariableResolution.csar and is in the BatchSample directory on the D: drive.

D:\BatchSample\VariableResolution.csar

The output surface will be named RasterSurface.csar and will be in the source directory.

D:\BatchSample\RasterSurface.csar

Command Line

carisbatch --run ResampleSurfaceToRaster --resolution 2m --type LINEAR_UNCERTAINTY --minimum-neighbours 10 D:\BatchSample\VariableResolution.csar D:\BatchSample\RasterSurface.csar

Outcome

A new single-resolution surface is interpolated from the variable resolution surface and saved to the location specified.

Extra Notes

N/A