Reference Guide : BASE Editor Processes : Clip Raster
 

Clip Raster

Description

The ClipRaster process exports a defined portion of the input file.

Inputs

A raster dataset. A BDB Server URI can be specified as input.

Outputs

A raster in CSAR format.

Command Line Syntax

carisbatch --run ClipRaster --extent <value> <input> <output>

User Interface Command

Clip Raster

Options

The following table describes the parameter available for this process.

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--extent

E

The extents that define 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.

FALSE

This must be specified explicitly.

Example

To use this command refer to the following example.

Example

Objective

You want to clip a raster in order to export only a portion of the source data.

Description

Command Line Syntax

The extents to be included in the new surface are:

lower-left X: 417941.63

lower-left Y: 5579318.66

upper-right X: 418041.63

upper-right Y: 5579418.66

--extent 417941.63m 5579318.66m 418041.63m 5579418.66m

The source surface, Surface1.csar is located at D:\BatchSample.

D:\BatchSample\Surface1.csar

The output surface will be named Clipped and will be saved to the same location as the source file.

D:\BatchSample\Clipped.csar

Command Line

carisbatch --run ClipRaster --extent 417941.63m 5579318.66m 418041.63m 5579418.66m D:\BatchSample\Surface1.csar D:\BatchSample\Clipped.csar

Outcome

A new clipped raster with the specified name will be created in the specified location.

Notes

N/A