The directives that are processed by the JPEG 2000 reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword>_ in a mapping file. By default, the <ReaderKeyword> for the JPEG 2000 reader is JPEG2000.
DATASET
The value for this directive is the name of a single JPEG 2000 file. Common extensions for JPEG200 files:
- .jp2
- .j2k
- .jpf
- .jpx
- .jpm
- .jp2000
- .jp2k
- .jpp
Required/Optional
Required
Mapping File Syntax
JPEG2000_DATASET “C:\DATA\JPEG2000\p0_04.j2k”
Workbench Parameter
Source JPEG 2000 File(s)
GROUP_BY_DATASET
When the value is set to No, the only feature type this reader will use is the reader type name.
When the value is set to Yes, the feature type of each dataset is the filename (without the path or the extension) of the dataset.
Required/Optional
Required
Values
YES | NO (default)
Mapping File Syntax
GROUP_BY_DATASET “Yes”
Workbench Parameter
Feature Type Name(s)
READ_OFFSETS_IN_CS_UNITS
This directive applies only when the georeferencing of the JPEG2000 dataset is stored via an embedded GeoTIFF.
The value for this directive is either Yes or No. 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
This directive applies only when the georeferencing of the JPEG2000 dataset is stored via an embedded GeoTIFF.
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
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