Reader Directives

The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the GeoTIFF reader is GEOTIFF.

DATASET

The value for this keyword is the name of a single GeoTIFF file. The normal extension for GeoTIFF files is .tif.

Required/Optional

Required

Mapping File Syntax

GEOTIFF_DATASET “C:\DATA\GEOTIFF\portland.tif”

Workbench Parameter

Source GeoTIFF File(s)

APPLY_GCPS

GCPs will be automatically converted to referencing (regardless of the value of this directive) if both of the following conditions apply:

  • the GCP pixel locations form an unrotated rectangle;
  • the GCP ground coordinates form a (possibly rotated) rectangle.

If either of these conditions does not apply, then this directive must be set to yes in order to convert the GCPs to referencing.

Note: This is true for tab files only. GCPs in the header must always be manually applied (i.e. "Apply GCPs" must be set to yes).

Coordinates with coordinate system information can be stored in a tab-file. Header plus coordinates (without coordinate system information) can be stored in the world file.

Values

Yes | No (default)

If set to Yes, then GCP information, including a GCP projection, will be read from the file and applied to the raster data as an affine transformation. If set to No, the GCP information is preserved as properties on the raster geometry.

Required/Optional

Required

Mapping File Syntax

APPLY_GCPS “YES”

Workbench Parameter

Apply GCPs

GCP_INTERPOLATION_METHOD

Required/Optional: Required

The value for this keyword is one of NearestNeighbor, Bilinear or Bicubic. If APPLY_GCPS is set to Yes, this directive must be specified. The default value for this directive is NearestNeighbor.

Required/Optional

Required

Mapping File Syntax

GCP_INTERPOLATION_METHOD “Bilinear”

Workbench Parameter

GCP Interpolation Method

GROUP_BY_DATASET, GROUP_BY_SUBDATASET

The Yes/No values of the two directives together provide four different options for the feature type name:

GROUP_BY_

DATASET

GROUP_BY_

SUBDATASET

Feature Type Name

Example

No

No

<reader_type_name>

GEOTIFF

No

Yes

<subdataset_name>

1

Yes

No

<filename>

myfile

Yes

Yes

<filename_subdataset_name>

myfile_1

Values

Yes | No (default)

Required/Optional

Required

Mapping File Syntax

GROUP_BY_DATASET “Yes”

GROUP_BY_SUBDATASET “Yes”

READ_OFFSETS_IN_CS_UNITS

When the value is set to Yes, the coordinate system offsets stored in the GeoTIFF file will be interpreted as being in the linear units of the projection; this is correct according to the GeoTIFF specification. When set to No, the coordinate system offsets will be interpreted as being in meters; this is what is actually done in practice by many software packages.

Note that if the offsets are explicitly marked as being in the coordinate system units (via the ProjLinearUnitsInterpCorrectGeoKey flag), and PREFER_FILE_CS_UNITS is set to Yes, this option is ignored.

Required/Optional

Optional

Values

Yes | No (default)

Mapping File Syntax

READ_OFFSETS_IN_CS_UNITS “Yes”

Workbench Parameter

Offsets in Coordinate System Units

PREFER_FILE_CS_UNITS

When the value is set to Yes and the ProjLinearUnitsInterpCorrectGeoKey flag is present in the file, the coordinate system offsets will be assumed to be in the linear units of the projection. When the value is set to No or the ProjLinearUnitsInterpCorrectGeoKey flag is not present, the READ_OFFSETS_IN_CS_UNITS flag is used to determine the interpretation of the coordinate system offsets.

Required/Optional

Optional

Values

Yes | No

Mapping File Syntax

PREFER_FILE_CS_UNITS “Yes”

Workbench Parameter

Prefer File Coordinate System Units

IGNORE_RASTER_TYPE_KEY

GeoTIFF contains a “raster type” key which specifies whether each pixel in the file represents an area (“PixelIsArea”) or a point (“PixelIsPoint”).

When reading PixelIsPoint data, the raster extents should be shifted up and left by half a pixel when transformed to the FME georeferencing model. Setting this value to Yes prevents this adjustment from happening.

Required/Optional

Optional

Values

Yes| No (default)

Mapping File Syntax

IGNORE_RASTER_TYPE_KEY Yes

Workbench Parameter

Ignore Raster Type Key

SEARCH_ENVELOPE

Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that interact with the bounding box are returned.

If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.

Mapping File Syntax

<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>

Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.

Required/Optional

Optional

Workbench Parameter

Minimum X, Minimum Y, Maximum X, Maximum Y

SEARCH_ENVELOPE_COORDINATE_SYSTEM

This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.

The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.

If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.

Required/Optional

Optional

Mapping File Syntax

<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>

Workbench Parameter

Search Envelope Coordinate System

CLIP_TO_ENVELOPE

This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.

Values

YES | NO (default)

Mapping File Syntax

<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]

Workbench Parameter

Clip To Envelope

EXPOSED_ATTRS

This directive allows the selection of format attributes to be explicitly added to the reader feature type.

This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.

The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.

Required/Optional

Optional

Mapping File Syntax

Not applicable.

While it is possible for FME Objects applications to invoke this directive, the required format is not documented.

This directive is intended for use in our GUI applications (for example, Workbench) only.

Workbench Parameter

Additional Attributes to Expose