Mosaic Clip AOI module

Name	Caption
Original Mosaic Folder	Mosaic folder
Output Folder	Output folder
Output File Type	Output file type
Output File Options	Output file options
Output Map Units	Output projection
Output Pixel Size	Output pixel size
Area of Interest File	Area-of-interest vector file
Crop Tiles to AOI	Crop tiles to area of interest
Base Name	Base name
Tile Specification	Mosaic tile specification
Height	Height of the mosaic tile, in pixels
Width	Width of the mosaic tile, in pixels
Vertical Overlap	Vertical overlap between tiles
Horizontal Overlap	Horizontal overlap between tiles
Tile File	File containing tile-definition layer
Segment Number	Vector segment in tile file
Field Name	File containing tile-definition layer
Coordinate Type	Type of coordinates in script
Existing Tile Rule	Rule for processing existing tile
Delete Empty Tiles	Whether to delete empty tiles

Parameter descriptions

Original Mosaic Folder

The path and name of the folder that contains the original mosaic from which to clip an AOI. You can specify a path to a single file.

Output Folder

The path and name of the folder to which to write the output files.

If tiled output is specified, tiles are processed by the processing nodes configured by the CATALYST Enterprise, and are stored in the specified output folder. Local copies of the tiles on processing nodes are automatically deleted. The output tile file names are generated automatically according to the Tile Base Name.

Output File Type

The format of the output file.

For more information on the supported file formats, see GDB-supported file formats.

Output File Options

The options to apply when creating the output file or files. The available options are specific to the file format; in each case, the default of no options is allowed.

For more information on the options available for the output file type you specify, see GDB-supported file formats.

Output Map Units

The projection of the output imagery.

The value of this parameter must be in the PCI Projection String format.

The standard definitions are:

PIXEL: Pixel and line (not for use with DEM extraction)
UTM: Universal Transverse Mercator

The value specified can be the UTM grid zone number and row, and Earth model, as follows:
```
UTM [mm] [r] [Ennn]
```
where:
- [mm] is the two-digit zone number between 1 and 60
- [r] is the zone row: a single letter between N and X for north of the equator and between C and M for south of the equator. Zone rows A, B, Y, and Z are not supported; rows I and O do not exist.
- [Ennn] specifies the Earth model, where the model number is between 0 and 19. If the Earth model is not specified, it is assumed to be E000 (Clarke 1866).
SPCS: State Plane Coordinate System

The SPCS zone number and Earth model can be specified as follows:
```
SPCS [mmmm] [Ennn]
```
where:
- [mmmm] is the four-digit zone number
- [Ennn] specifies the Earth model, where the model number is between 0 and 19. If the Earth model is not specified, it is assumed to be E000 (Clarke 1866).
LONG/LAT: Longitude and latitude

The Earth model can be specified for LONG/LAT (and other units except PIXEL), as follows:
```
LONG/LAT [Ennn]
```
If the Earth model is not specified, it is assumed to be E000 (Clarke 1866).
EPSG: European Petroleum Survey Group code

You can specify the projection by entering an EPSG code defined by the Open Geospatial Consortium (OGC). For information on the code definitions, visit epsg.org and spatialreference.org.

The EPSG code is specified using the EPSG keyword followed by an integer and separated by a colon; for example:
```
EPSG:4326
```
Most common EPSG codes are supported.
METER: Image along-row and along-column meters
FEET: Image along-row and along-column feet
You can also specify the label of a projection you define, if the projection exists in the userproj.txt file; otherwise, you must enter the projection-parameter information as a string separated by the vertical bar (|). The projection-parameter string defines 18 parameters delimited by spaces, including the following:
- Dearth
- RefLong
- RefLat
- StdParallel1
- StdParallel2
- FalseEasting
- FalseNorthing
- Scale
- Height
- Long1
- Lat1
- Long2
- Lat2
- Azimuth
- LandsatNum
- LandsatPath
- UnitsCode
For example, the projection named 'France93' can be specified, as follows:
```
LCC D350 | 0 0 3.0 46.5 44.0 49.0 700000 6600000 0 0 0 0 0 0 0 0 0 -1
```

If you do not specify a value for Output Map Units, the map unit of the input image is used for the output image. If the input data is a variety of map units, the map unit of each output image is that of its corresponding input image. In such a case, it is recommended that you specify the output map units.

You can also specify the label of a projection defined in the userproj.txt file.

Output Pixel Size

The sample size of the output imagery.

The output pixel size must be specified in the value (units) of the Output Map Units parameter; for example, when the value of Output Map Units is specified as a UTM zone, the pixel output size must be in meters. When the value is specified as Long/Lat, the pixel size must be in decimal degrees.

If you specify only one value, it defines the pixel size in both dimensions. If you do not specify any values, the resolution of the output mosaic is determined automatically by examining the resolution of the input images. The resolution occurring most frequently; that is, the mode, is used as the output resolution. If the mode is not unique, the coarsest of the tied resolutions is used.

Area of Interest File

A file that contains a single vector layer that defines the area to which the output mosaic is clipped.

The vector layer can contain one or more polygons.

Crop Tiles to AOI

Selected by default, this check box controls whether to crop the tiles to the area of interest (AOI) during processing.

Base Name

The base name for the output files.

The base name will be used for file names for all tiles generated during the clipping process. The default base name is clip_mosaic.

Tile Specification

The tiling scheme to use for the output mosaic.

Available schemes are:

Single Tile: Generates the output mosaic as a single tile.
Vector: Use when you have an existing vector-polygon layer that contains the tile definitions you want to use for the mosaic. When you select this option, you can add options for it with Tile File, Segment Number, Field Name, and Buffer Distance, respectively.
Dimensions: Creates tiles of a specific size. When you select this option, you can add options for it with Tile Height and Tile Width, respectively. When using this specification, the TileID values of the output tiles is generated using the convention <column_number>_<row_number>. For example, the upper-left tile always has a TileID of "1_1", the one immediately below is "1_2", and so on.
Script File: Use when you have a text file that defines the coordinates of each tile you want to create. When you select this option, you can add options for it with Tile File.

Height

The height of the mosaic tile, in pixels.

The union of the extents of all of the source images is divided into a series of evenly sized and abutting rectangular tiles with the specified dimension.

Only tiles that actually intersect at least one of the source images is present in the output. The tiles at the far right and on the far bottom may overhang the extents of the source images. This is done to ensure that all tiles have the same dimensions.

TileID values are generated using the convention <column_number>_<row_number>. For example, the upper-left tile always has a TileID of "1_1", while the one immediately below it is "1_2", and so on.

For example:

Width

The width of the mosaic tile, in pixels.

The union of the extents of all of the source images is divided into a series of evenly sized and abutting rectangular tiles with the specified dimension.

TileID values are generated using the convention <column_number>_<row_number>. For example, the upper-left tile always has a TileID of "1_1", while the one immediately below it is "1_2", and so on.

For example:

Vertical Overlap

The vertical overlap of each tile, in pixels.

Note: The Width parameter value is considered sacrosanct and is always honored. Thus, setting the Vertical Overlap to something other than zero causes the mosaic tile positions to be adjusted, rather than changing the tile widths.

Horizontal Overlap

The horizontal overlap of each tile, in pixels.

Note: The Height parameter value is considered sacrosanct and is always honored. Thus, setting the Horizontal Overlap to something other than zero causes the mosaic tile positions to be adjusted, rather than changing the tile heights.

Tile File

The name of the text file containing the tile-definition layer.

Each line in the text file contains five elements separated by spaces: the first two define the upper-left coordinate in the x and y dimension, respectively. The next two define the lower-right coordinate in the x and y dimensions, respectively. The last one specifies the output file name of the tile. If the file name includes an extension, the extension is removed when the value is stored as the 'TileID' attribute in the tile-definition polygon. If the file name includes a path, the entire path is transferred and appended to the output folder.

The values specified in the text file can be in one of these coordinate types:

RASEXT: Raster extents
GEOEXT: Geocoded extents
LNGLATEX: Longitude and latitude extents
RASOFFSZ: Raster offset and size
GEOOFFSZ: Geocoded offset and size

The RASEXT and RASOFFSZ coordinate types make use of pixel/line raster, as defined by the union of the extents of all input source images. If a coordinate type is not specified, it is assumed to be GEOEXT. For example:

Segment Number

In the tile file you specified, the number of the vector segment to use. If no segment number is specified, the last segment in the specified tile file is used.

Field Name

Name of the field (attribute) that has unique identifiers for each tile. The module uses the values in the field to form the names of the mosaic tile files. If no field name is specified, the attribute ShapeID is used.

Coordinate Type

When Tile Specification is Script File, the type of coordinates in the script.

You can select from the following:

Geocoded Extents
Geocoded Offset & Size
Long/Lat Extents
Raster Extents
Raster Offset & Size

Existing Tile Rule

Select an action to perform when an output tile already exists.

Available options are:

Skip: No change is made to the existing tile and no new processing is performed. This option is useful when you do not want to modify your existing mosaic output.

Note: When an existing tile is skipped, it is not checked to see if it is empty. The tile is never deleted, regardless of the value of Delete Empty Tile.
Regenerate: Any existing tile is deleted, and then a new tile created. Unlike Skip or Update, the output is in the same projection and extents as the new polygon-tile definition.
Update: An existing tile is updated with any new information. The existing information is not overwritten; rather, the file is appended with any new information resulting from the mosaicking. Any existing georeferencing is safeguarded.

Delete Empty Tiles

Select whether to delete empty tiles. A tile is considered to be empty if all pixels in it have the value defined as NoData.

Mosaic Clip AOI module

Description

Parameters

Parameter descriptions

Details