| Environments | PYTHON :: EASI :: MODELER |
| Batch Mode | Yes |
| Quick links | Description :: Parameters :: Parameter descriptions :: Details |
| Back to top |
CLIP collects raster, vector, or bitmap layers to create a new file from dataset regions you specify. You can define clip regions with a clip file, clip layer, or coordinates you define. The formats of the input and output files are supported by the generic database (GDB).
The CLIP algorithm performs clipping similar to doing so in CATALYST Professional Focus.
| Back to top |
| Name | Type | Length | Value range |
|---|---|---|---|
| InputLayer: Input layers to clip | Mixed port | 0 - 16 | |
| ClipDefinitionMethod2: Input clip layer number | Any port | 0 - 16 | |
| ClipDefinitionMethod3: Input clip file name | GEO port | 0 - 16 | |
| OutputLayer: Output clip file name | Mixed port | 0 - 1024 | |
| OutputBoundaryLayer: Output clip boundary vector | Mixed port | 0 - 1024 | |
| Clip Definition Method | String | 0 - 1 | Select a clip file, Select a clip layer, User-entered coordinates Default: Select a file |
| Bounds | String | 0 - | EXTENTS, SHAPES Default: Extents |
| Coordinate Type | String | 0 - 1 | Raster extents, Geocoded extents, Long/Lat extents, Raster offset/size, Geocoded offset/size Default: Geocoded extents |
| Upper-Left | String | 0 - | |
| Lower-Right | String | 0 - | |
| Width, Height | String | 0 - | |
| Initialization Value | Float | 0 - 1 | Default: 0.0 |
| SETNODAT | Boolean | 0 - 3 | Selected, Cleared Default: Cleared |
| Back to top |
InputLayer: Input layers to clip
The input layer or layers to clip.
You can use any GDB-supported file format. This parameter also supports mixed input; that is, layers of various data types can be selected at once, such as rasters, vectors, and LUTs.
ClipDefinitionMethod2: Input clip layer number
The input clip layer that defines the clip region.
You can use any GDB-supported file format. This parameter is dependent on the option selected for the Bounds parameter.
ClipDefinitionMethod3: Input clip file name
The input file that contains the clip region.
The georeferencing extents of the input file are used to define a rectangle of the clip region. To use this parameter, you must select Select a file in the Clip Definition Method list.
You can use any GDB-supported file format. This parameter is dependent on the option selected for the Bounds parameter.
OutputLayer: Output clip file name
The output file that contains the clipped regions.
This parameter also supports mixed output; that is, clipped layers of various data types can be written.
OutputBoundaryLayer: Output clip boundary vector
The output layer that contains the clip boundary.
The output is a vector equivalent to the defined clip region.
Clip Definition Method
The clip method to use.
Values include:
The default value is Select a file.
Bounds
Coordinate Type
Upper-Left
The upper-left x and y coordinates of the clip region.
When you specify User-entered coordinates (USERCRD) as the value of the Clip Definition Method (CLIPMETH) parameter, you must specify a value for this parameter.
The coordinate units are based on the value specified for the Coordinate Type (COORDTYP) parameter.
Lower-Right
The lower-right x and y coordinates of the clip region.
When you specify User-entered coordinates (USERCRD) as the value of the Clip Definition Method (CLIPMETH) parameter, you must specify a value for this parameter.
The coordinate units are based on the value specified for the Coordinate Type (COORDTYP) parameter.
Width, Height
The width and height of the clip region you have defined.
When you specify User-entered coordinates (USERCRD) as the value of the Clip Definition Method (CLIPMETH) parameter, and Raster Offset/Size or Geocoded Offset/Size for the Coordinate Type (COORDTYP) parameter, you must specify a value for this parameter.
Initialization Value
The initialization value for the raster output. The full extent of the output rasters will be initialized to this value before the clipped data is written to them.
Acceptable values include any coordinate value in the projection system of the data. The default value is 0.0.
SETNODAT
To use the value of the Initialization Value parameter as the NoData pixel value in the image metadata, select this check box. You need only specify a value for this parameter when you select Full Tiles in the Overhanging Tiles list.
| Back to top |
CLIP extracts the subset of a dataset that intersects a specified spatial region–the clip region–and writes the extracted, or clipped, dataset to a new file. Only raster, vector, and bitmap layers in the original dataset are clipped. Auxiliary data types, such as PCT, LUT, or orbit segments, may be copied in their entirety to the output file. You can specify which parts of the input dataset to clip, where applicable, and, subsequently, write to the output file.
The clip-definition method determines the type of data that specifies the clip region. You must enter valid clip-region details for the selected clip definition.
You define a clip region by specifying the following:
Clip file:The overall spatial extent associated with the specified file is used as the clip region. The definition file must be smaller than the source file.
Clip layer:A specified data layer that intersects spatially the dataset to clip defines the clip region. The clip region is defined either by the overall extent of the clip layer or by the boundary of the "shapes" defined within the clip layer.
Only raster, bitmap, or vector layers can contain shapes. A raster layer must contain a thematic classification and a vector layer must contain topological polygon data for those layers to contain shapes. A shape boundary is always an extent for a point, line, unstructured vector layer, or raster (non-thematic).
The clip layer is read from a specified data file.
User-defined coordinates: Coordinates you specify that define a bounding box to use as the clip region.
The coordinates you specify are assumed to reference the input file to clip. For example, when you specify raster extents, the origin is taken from the upper-left corner of the input file.
User-defined coordinates supports many formats and can be:
You must omit the symbol for seconds (") when specifying longitudes or latitudes; otherwise, CLIP interprets it as the end of a string; if there is a hemisphere, it is ignored.
For example:
CLIPUL="110d15'30"W"
is processed as
110.2583333 (instead of -110.2583333)
CLIPUL="110d15'30W" is processed correctly.
If you select the Set as NoData value check box, the initialization value is flagged as a 'NoData Value' in the metadata.
If you specify Y (yes) as the value of the SETNODAT parameter, the initialization value is flagged as a 'NoData Value' in the metadata.
© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.