Fme Readers And Writers 2013

Transcript

FME Readers and Writers Technical Reference for Formats Supported by FME 2013 SP1 FME Desktop lets you read and write data in more than 275 spatial and non-spatial formats, including CAD, GIS, raster, database, 3D, and BIM formats. With more than 400 different transformers and support for thousands of coordinate systems, FME Desktop gives you unlimited flexibility to manipulate the geometry and attributes of your spatial data. About This Help File This documentation contains detailed technical information on FME-supported formats, and is intended for a technical audience involved in configuring FME for customized translation. Each format contains reference information that includes the following: l l l l l Format Overview: This section gives an overview of the Reader and/or Writer, and lists any dependencies or licensing limitations. Quick Facts: This table contains high-level information on the format’s characteristics. For raster formats, it also includes raster-specific quick facts. Reader/Writer Overview: This section contains any reader- and/or writer-specific information. Reader/Writer Directives: Most reader and writer directives correspond to Workbench parameters in the Workbench Navigator pane. To access parameter help from the FME Desktop help window, click FME Reader and Writer Parameters. Feature Representation: In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. Please note that the information in this document can sometimes be easier to navigate by accessing it from http://fmepedia.safe.com/ knowledgeDocumentation -1- FME Readers and Writers 2013 SP1 Safe Software Inc. makes no warranty either expressed or implied, including, but not limited to, any implied warranties of merchantability or fitness for a particular purpose regarding these materials, and makes such materials available solely on an “as-is” basis. In no event shall Safe Software Inc. be liable to anyone for special, collateral, incidental, or consequential damages in connection with or arising out of purchase or use of these materials. The sole and exclusive liability of Safe Software Inc., regardless of the form or action, shall not exceed the purchase price of the materials described herein. This manual describes the functionality and use of FME at the time of publication. The software described herein and the descriptions themselves, are subject to change without notice. Copyright © 1994–2013 Safe Software Inc. All rights are reserved. Revisions Every effort has been made to ensure the accuracy of this document. Safe Software Inc. regrets any errors and omissions that may occur and would appreciate being informed of any errors found. Safe Software Inc. will correct any such errors and omissions in a subsequent version, as feasible. Please contact us at: Safe Software Inc. Phone: 604-501-9985 Web: www.safe.com Safe Software Inc. assumes no responsibility for any errors in this document or their consequences, and reserves the right to make improvements and changes to this document without notice. Safe may provide links to third-party web sites for your reference or convenience. Such third-party web sites are not under Safe's control, and Safe is not responsible for and does not endorse the content of these sites. Trademarks FME is a registered trademark of Safe Software Inc. All brand or product names mentioned in this document may be trademarks or registered trademarks of their respective companies or organizations. Information Document Name: FME Readers and Writers Version: FME 2013 SP1 -3- -4- FME Readers and Writers 2013 SP1 About Quick Facts Tables Each format’s chapter overview includes high-level information about the format’s characteristics: Format Type Identifier Every format supported by FME is uniquely identified by an uppercase alphanumeric string. This row lists the unique identifier for this format. For example, the identifier for IGDS Design is IGDS. The format type identifier is used in mapping files on READER_TYPE and WRITER_TYPE lines to define the reader and writer to be used for translation. In FME Objects, when a reader or writer is created, the format type identifier is used to specify its type. Reader/Writer FME typically allows reading from and writing to a supported data format. However, some formats support either reading or writing, but not both. This row specifies whether reading only, writing only, or reading and writing is available for this format. Licensing Level Some FME-supported formats require specific licensing. For example, certain formats are not supported in FME Base Edition. This row lists the minimum licensing level required to read from or write to the format. Dependencies Some formats require the installation of the application associated with the format, or may require an extra-cost plug-in. Dataset Type FME reads features from datasets and writes features to datasets. The definition of a dataset varies between different readers and writers, depending nature of the format. This row specifies the type of dataset used by this format. File Dataset: The most basic type of dataset is the file dataset: a single file whose extension is included in the list of supported file extensions. A file dataset reader opens the specified file and reads its features. A file dataset writer creates the specified file if it doesn't exist and writes features into it. In general, file dataset writers overwrite existing files, but some can append to existing files. Directory Dataset: A directory dataset consists of a directory specification. A directory dataset reader examines the name of all the files in the specified directory and reads those files whose extensions are included in the list of supported file extensions. The order in which files are read is not documented. Many directory dataset readers provide an option to explicitly name a subset of the directory's files that are to be read. A directory dataset writer creates the specified directory if it does not exist. In general, if the directory does exist, any files in the directory that match the name of output files will be overwritten; however, some directory dataset writers can append to existing files. -5- Database Dataset: A database dataset consists of a set of information needed to connect to a database schema. A database dataset reader reads all the tables in the specified database schema. The order in which tables are read is not documented. Many database dataset readers provide an option to explicitly name a subset of the schema's tables that are to be read. Any tables in the specified database that match the name of output tables will be overwritten. URL Dataset: A URL dataset consists of a uniform resource locator. A URL dataset reader connects over a network to a remote server and retrieves the data provided by that resource. Typical File Extensions Most file dataset readers will read data from any legally-named file, independent of extension. Most formats are associated with one or more file extensions. This row lists the file extensions typically associated with this format. When a format uses several files with the same basename but different extensions, the primary extension is listed first and the ancillary ones are listed in parentheses. Automated Translation Support The FME typically allows automated translation to and from a supported data format. However, some formats support either automated reading or automated writing, but not both. This row specifies whether this format supports automated reading, writing, or both. When automated translation is not available, a custom mapping file must be used. Feature Type Every format supported by FME identifies the features in its datasets according to a well-defined data classification scheme. This primary classification is known as the feature's type, which serves as the main handle to a feature. This row describes the format’s classification scheme. For example, a simple classification scheme is to identify features according to the file or table they reside in (the feature's type is the file base name or table name, respectively). For level-based formats, features are typically grouped by level (the feature's type is the level in which it resides). Another common classification is to group features according to the thematic layer to which they belong – for example, roads, railways, and rivers. Although these are the most common classification schemes, the list of possible schemes is quite broad because the classification chosen is individual to the format. User-Defined Attributes An FME feature consists of geometry and attributes. While many of a feature's attributes are predefined by FME and the feature's format (such attributes are constant from one dataset to another), some formats allow users to define custom attributes. These user-defined attributes give the format flexibility to store arbitrary amounts of domain-specific information in addition to geometry. This row specifies whether this format supports user-defined attributes. -6- FME Readers and Writers 2013 SP1 Coordinate System Support This row indicates whether datasets of this format can store coordinate system information, and if so, whether the reader extracts this information. Generic Color Support The fme_color and fme_fill_color feature attributes represent the red, green, and blue intensities of a feature. Intensities can each vary between 0.0 and 1.0, and are calculated by taking the color intensity and dividing it by the total intensity range. This row indicates whether or not the format supports the generic fme_color and fme_ fill_color attributes. If a format has generic color support, the reader will add both the generic FME color attributes and the format-specific color attributes to features. Writers that support generic color will give precedence to the format-specific color attributes if they are present in addition to the generic attributes. Note: Since both generic FME attributes and format-specific attributes exist on workspace features, it is important to note that the co-existence of the two types of attributes can sometimes cause a conflict, and the format-specific attribute will be deleted. For more information, see Format-Specific Attributes and Generic FME Attributes in Workbench. Spatial Index This row applies only to readers: it indicates whether or not the native reader supports spatial indexing. The possible values are: l l l Never: This reader never provides a spatial index. Optional: This reader may or may not provide a spatial index, depending on whether or not one is available for the specific dataset being read. Always: This reader always provides a spatial index. Schema Required This row applies only to writers. For mapping files, it indicates whether or not DEF lines are required. For FME Objects applications, it indicates whether or not schema features need to be provided to the writer before data features can be written to a dataset. Encoding Support This row indicates whether a format supports character encoding schemes for attribute values. Users who need to translate their international data will benefit from this enhanced support as they will no longer need to set their default system language (on Windows, this is set through the "Regional and Language Options" dialog) to match the encoding of the data. Depending on the format, the character encoding may need to be specified by the user. -7- Transaction Support This row applies only to readers: it indicates whether or not the native reader supports transaction processing. For mapping files, it indicates whether or not the starting transaction number and the transaction interval can be specified. For FME Objects applications, it indicates whether or not the universal writer object honors the startTransaction, commitTransaction, and rollbackTransaction methods. Enhanced Geometry Indicates whether the reader/writer supports the enhanced geometry model. The addition of enhanced geometry model support allows lines and polygons containing arcs to be maintained, rather than stroked or the geometry split up into multiple segments. It also provides the ability to truly hold measures. Geometry Type Attribute The name of the feature attribute that contains the feature's format-specific geometry type. Supported Geometry See Geometry Types for more information on supported geometry. Within each format, this table indicates which geometry types the format supports. Geometry Support Geometry Supported? Geometry Supported? aggregate yes/no point yes/no circles yes/no polygon yes/no circular arc yes/no raster yes/no donut polygon yes/no solid yes/no elliptical arc yes/no surface yes/no ellipses yes/no text yes/no line yes/no z values yes/no none yes/no Raster-Specific Information In any raster format, this table provides additional raster-specific information. See See "About FME Rasters" on page 23 for more information on each entry. Band Interpretations Red8, Green8, Blue8 Palette Key Interpretations not applicable Palette Value Interpretations not applicable Nodata Value 0,0,0 -8- FME Readers and Writers 2013 SP1 Cell Origin (x, y) 0.5, 0.5 Rotation Support No GCP Support No World File Support No TAB File Support Yes -9- FME Readers and Writers 2013 SP1 About Feature Attributes Feature attributes are categorized into one of the following three groups: 1. Format-specific attributes: A feature may have one or more associated format attributes. A format attribute represents an attribute that is specific to a format. Some examples are: autocad_block_name and sde30_justification. 2. User attributes: A feature is also associated with one or more associated user attributes, which represent custom attributes that hold domain information about a feature, such as: parcel_identifier, owner_name, date_surveyed, etc. 3. FME (generic) attributes: A particular set of Format Attributes has the prefix fme_. These attributes represent the data as it is perceived by FME and are sometimes known as FME Attributes or Generic FME Attributes. How FME Processes Feature Attributes When a translation is carried out, the following occurs: l l l FME reads the source data and stores information about its features as format attributes. These format attributes reflect the data that is stored in the original source data. FME converts the source data’s format attributes into FME Attributes. These FME attributes reflect the source data as it is perceived within FME. FME writes the destination data by creating a second set of format attributes. These format attributes reflect the information as it will be stored in the destination data. This is why, when a user inspects data, there are two sets of attributes. Using this method, FME can convert from one format to another, without having to separately map the source format attributes to the destination format attributes for every format. FME simply converts everything to an FME standard, and then from there to the Writer Format. - 11 - About Feature Attributes The benefit of using generic attributes over format-specific attributes is that they have the same meaning in all the readers and writers that support them. For example, the fme_color and fme_fill_color feature attributes represent the red, green, and blue intensities of a feature. If a format has generic color support, the reader will add both the generic FME color attributes and the format-specific color attributes to features. Writers that support generic color will give precedence to the format-specific color attributes if they are present in addition to the generic attributes. The most important generic attributes are fme_type and fme_geometry. Both of these relate to the geometry of a feature. The Geometry class represents a feature’s positional information. Feature geometry may consist of points, lines, or areas. Features that contain multiple geometric parts are said to have an aggregate geometry. Features with no geometry are also supported. The distinction between fme_type and fme_geometry is an important one: fme_ geometry indicates the geometry type of the actual coordinates, whereas fme_type specifies how that geometry is to be interpreted. For example, a point geometry type can be interpreted as one of the following FME types: point, arc, ellipse, or text. The valid combinations of fme_type and fme_geometry are shown in the table below: fme_ fme_ fme_ fme_ fme_ fme_ fme_ no_ geometry point line polygon donut aggregate geom fme_type fme_point X fme_arc X fme_ellipse X fme_text X fme_line X X X fme_area X X X fme_ undefined - 12 - FME Readers and Writers 2013 SP1 Attribute Types - 13 - FME Readers and Writers 2013 SP1 About Feature Attributes Feature attributes are categorized into one of the following three groups: 1. Format-specific attributes: A feature may have one or more associated format attributes. A format attribute represents an attribute that is specific to a format. Some examples are: autocad_block_name and sde30_justification. 2. User attributes: A feature is also associated with one or more associated user attributes, which represent custom attributes that hold domain information about a feature, such as: parcel_identifier, owner_name, date_surveyed, etc. 3. FME (generic) attributes: A particular set of Format Attributes has the prefix fme_. These attributes represent the data as it is perceived by FME and are sometimes known as FME Attributes or Generic FME Attributes. How FME Processes Feature Attributes When a translation is carried out, the following occurs: l l l FME reads the source data and stores information about its features as format attributes. These format attributes reflect the data that is stored in the original source data. FME converts the source data’s format attributes into FME Attributes. These FME attributes reflect the source data as it is perceived within FME. FME writes the destination data by creating a second set of format attributes. These format attributes reflect the information as it will be stored in the destination data. This is why, when a user inspects data, there are two sets of attributes. Using this method, FME can convert from one format to another, without having to separately map the source format attributes to the destination format attributes for every format. FME simply converts everything to an FME standard, and then from there to the Writer Format. - 15 - The benefit of using generic attributes over format-specific attributes is that they have the same meaning in all the readers and writers that support them. For example, the fme_color and fme_fill_color feature attributes represent the red, green, and blue intensities of a feature. If a format has generic color support, the reader will add both the generic FME color attributes and the format-specific color attributes to features. Writers that support generic color will give precedence to the format-specific color attributes if they are present in addition to the generic attributes. The most important generic attributes are fme_type and fme_geometry. Both of these relate to the geometry of a feature. The Geometry class represents a feature’s positional information. Feature geometry may consist of points, lines, or areas. Features that contain multiple geometric parts are said to have an aggregate geometry. Features with no geometry are also supported. The distinction between fme_type and fme_geometry is an important one: fme_ geometry indicates the geometry type of the actual coordinates, whereas fme_type specifies how that geometry is to be interpreted. For example, a point geometry type can be interpreted as one of the following FME types: point, arc, ellipse, or text. The valid combinations of fme_type and fme_geometry are shown in the table below: fme_ fme_ fme_ fme_ fme_ fme_ fme_ no_ geometry point line polygon donut aggregate geom fme_type fme_point X fme_arc X fme_ellipse X fme_text X fme_line X X X fme_area X X X fme_ undefined - 16 - FME Readers and Writers 2013 SP1 Attribute Types Attribute Types Attribute Names Many formats have restrictions on the structure and format of attribute names. Esri Shape format, for example, permits UPPERCASE names only and has a maximum length of ten characters for attribute names. When creating a workspace, FME converts attribute names to UPPERCASE in the destination schema if needed. In such a case, attribute connections cannot be implied so FME generates schema mapping that joins source attributes to the destination. Note, however, that this is just a starting point. Edits to the workspace may break the FME generated schema mapping and, therefore, require you to create your own attribute connections. Attribute Field Size Some formats carry restrictions on attribute sizes, for example a maximum length of character field or maximum number in a numeric field. Where possible, FME generates a destination schema that reflects any such limitations. Attribute Types Different formats support different attribute types. Even when two formats support the same attribute type, it is often represented by a different name. In this situation, FME must decide how to map data between one attribute type and another. FME solves the problem by supporting all of these types internally within its enhanced data model. A metafile for the reader format instructs FME how to map its attribute types to the FME model and a second metafile instructs FME how to map its model types to the destination schema. Examples of Attribute Type Mapping This is the attribute type mapping for MapInfo data: char(width) fme_char(width) date fme_date decimal(width,decimal) fme_decimal(width,decimal) float fme_real64 integer fme_int32 logical fme_boolean smallint fme_int16 This is the attribute type mapping for Oracle data: - 17 - char(width) fme_char(width) float fme_real32 number(width,decimal) fme_decimal(width,decimal) double fme_real64 integer fme_int32 logical fme_boolean smallint fme_int16 These mappings show that a MapInfo decimal type attribute becomes an fme_decimal type in the FME data model, which then becomes a number type attribute when written to Oracle. Format-Specific Attributes and FME Attributes in Workbench Since both generic FME attributes (sometimes called FME Generic Attributes) and format-specific attributes exist on workspace features, it is important to note that the co-existence of the two types of attributes can sometimes cause a conflict. If this happens between a reader and a writer, the generic fme attribute will take precedence. For example, if a feature contains a format-specific color specification, and the optional fme_color attribute is changed between the reader and the writer, fme_color will take precedence and the format-specific color specification will be deleted from the workspace. (However, if a feature within a writer contains a format-specific color specification, then that will supersede fme_color. This possible conflict also applies if you alter a feature’s geometry in a workspace that has the same source and destination format. If you alter the geometry from the reader to the writer, then the generic fme_type will be used, and the format-specific geometry type will be deleted. List of Format-Specific Attributes and Corresponding FME Attributes The applicable format attributes and corresponding FME attributes are listed below. Any change (including deletion) to the fme_* attribute between a reader and writer will cause the format-specific attribute to be deleted. Format Format-Specific Attribute AutoCAD CGDEF Corresponding FME Attribute fme_color cgdef_color.red fme_color cgdef_color.green cgdef_color.blue Design (v7 and v8) igds_color fme_color igds_color.red - 18 - FME Readers and Writers 2013 SP1 Format Format-Specific Attribute Corresponding FME Attribute igds_color.green igds_color.blue igds_fill_color fme_fill_color igds_fill_color.red igds_fill_color igds_fill_color.green igds_fill_color.blue PenMetrics GRD grd_pen_color fme_color grd_layers_pen_color grd_blocks_pen_color grd_brush_color fme_fill_color grd_layers_brush_color grd_blocks_brush_color IDEX MapInfo Native format (MAPINFO and MITAB) idex_database_color fme_color idex_database_hatch_color fme_fill_color mapinfo_brush_foreground fme_fill_color mapinfo_pen_color fme_color mapinfo_symbol_color mapinfo_text_fontfgcolor MIF/MID (MapInfo Data Interchange Format) mapinfo_brush_foreground fme_fill_color mapinfo_pen_color fme_color mapinfo_symbol_color mapinfo_text_fontfgcolor StruMap strumap_red fme_color strumap_green strumap_blue strumap_color Supported Geometries Not all of the geometries that FME supports are actually supported by every format. For example, Esri Shape format does not support arc features and Oracle Spatial does not support text features. - 19 - When translating unsupported geometries, FME always attempts to convert the data to a geometry that is supported. For example, FME will stroke arcs (that is, turn them into line features) and replace text features with a point feature that has an attribute holding the text string content. Geometry Structure Sometimes FME is required to transform spatial data because of faults with the geometry or because of structural rules that are required by a particular format. Some geometry faults are fixed when the data is read (to give a good generic representation for FME use) and some are fixed when the data is written (to give a representation that conforms to the destination format). For example, there is a rule for Oracle databases that no two vertices on a line or polygon are the same, and FME validates data to make sure it adheres to this rule. Limitations It should be emphasized that the FME processes will not change the overall shape, area, length, or size of a feature. The types of faults fixed are not ones that would have this effect. Some example faults that FME might fix automatically include: l duplicate points on a line feature l duplicate line segments on a polygon feature l polygon orientation — clockwise/counterclockwise l twisted or figure-of-eight polygons l donut polygons where the inner boundary touches the outer boundary at more than a single point In these cases, the only noticeable difference in the data is a change in the number of vertices. Some faults are just too much for FME to fix automatically, in which case you need to add transformers (for example, a SelfIntersector transformer) to search for and fix a specific issue. Aggregate Geometries A feature with aggregate geometry has an fme_geometry value equal to fme_ aggregate and an fme_type value equal to either fme_point, fme_line, or fme_area. FME uses aggregates to represent features with multi-part geometries: geometries that are composed of several disjoint pieces. In most situations, the components of an aggregate are homogeneous. That is, if fme_type is fme_point, then the aggregate contains point geometries; if fme_type is fme_line then the aggregate contains line geometries; and so on. However, your application should be designed to handle nonhomogeneous aggregates gracefully since it is possible that some data sources may contain such features. Non-homogeneous aggregates have no value for fme_type. - 20 - FME Readers and Writers 2013 SP1 OpenGIS Geometries The OpenGIS Consortium defines a Well-Known Text (WKT) representation for feature geometries. The FMEOFeature object allows your application to import a geometry from WKT and export a geometry to WKT using the importGeometryFromOGCWKT and exportGeometryFromOGCWKT methods respectively. Donut Geometries Donut Geometries are used to represent area features with holes, such a lakes with islands. A proper Donut Geometry contains only polygons that do not overlap each other or share common edges; all of the inner polygons are disjoint and fully contained within the outer polygon. However, FME does not guarantee that all features with donut geometry follow these rules. For example, when data is read from a data source that supports donut geometries but do not enforce non-intersecting and nonoverlapping donuts, FME will respect the original geometry. The figure below shows an example donut geometry. Features with donut geometry are those with an fme_geometry equal to fme_donut and an fme_type value equal to fme_area . Arc and Ellipsoid Geometries Features with ellipsoid geometry are those with fme_geometry equal to fme_point and fme_type equal to fme_ellipse. Simple Geometries Simple geometries are geometries that are not composed of other geometries, and do not have associated generic FME attributes that affect their positional representation. More concretely, features with simple geometries are those with the following combinations of fme_geometry and fme_type: {fme_line, fme_line}, {fme_point, fme_point}, {fme_polygon, fme_area}. - 21 - FME Readers and Writers 2013 SP1 About FME Rasters Overview Raster data in FME is represented by features with raster geometry. Raster data differs in several key ways from vector data, and is handled uniquely in FME. A raster can be considered as a grid of values organized into rows and columns, with the relative size of its cells determining its resolution, or level of detail. Each row and column intersection in raster grid is called a cell or pixel. Vector point geometries can often be thought of as analogous to cells, while linear geometries like roads are represented as contiguous cells. Vector features tend to be more meaningful when taken together as a group, while a single raster feature can convey the same spatial information in a non- modular fashion. Often a raster serves as a backdrop for overlaying specific vector information. For example, you can place vector lines and polygons that represent streets and buildings on a raster image that is an aerial photograph of a city. Conversely raster may be used as a backdrop for creating vector maps. For example, one might use satellite or aerial imagery to map particular features of an urban environment for city planning or geologic structures for locating natural resources. Rasters can be represented as either image or numeric data. Images are commonly derived from satellite data or photography, while numeric data often represents elevations, temperatures, and other quantitative information. Raster data is stored in one or more bands whose properties may or may not be homogeneous. Imagery data often contains several bands of data. This data may come from either Optical or SAR (Synthetic Aperture RADAR) type sensors and may contain any number of image bands of data relating to a wide range of spectral bands or polarizations . Though a band may have its own specific band properties, all bands on a raster must share a common set of raster properties such as the number of rows and columns, the cell size and the ground extents. A band may optionally have one or more palettes, also called colormaps or Look-Up Tables (LUTs), associated with it. A palette is essentially a lookup table of discrete keys to color or string values. These rasters are often referred to as classified because of the discrete data ranges. Classified rasters often serve the purpose of providing a visual representation or providing additional descriptive information for specific areas of a raster. About FME Rasters Overview Raster data in FME is represented by features with raster geometry. Raster data differs in several key ways from vector data, and is handled uniquely in FME. A raster can be considered as a grid of values organized into rows and columns, with the relative size of its cells determining its resolution, or level of detail. Each row and - 23 - About FME Rasters column intersection in raster grid is called a cell or pixel. Vector point geometries can often be thought of as analogous to cells, while linear geometries like roads are represented as contiguous cells. Vector features tend to be more meaningful when taken together as a group, while a single raster feature can convey the same spatial information in a non- modular fashion. Often a raster serves as a backdrop for overlaying specific vector information. For example, you can place vector lines and polygons that represent streets and buildings on a raster image that is an aerial photograph of a city. Conversely raster may be used as a backdrop for creating vector maps. For example, one might use satellite or aerial imagery to map particular features of an urban environment for city planning or geologic structures for locating natural resources. Rasters can be represented as either image or numeric data. Images are commonly derived from satellite data or photography, while numeric data often represents elevations, temperatures, and other quantitative information. Raster data is stored in one or more bands whose properties may or may not be homogeneous. Imagery data often contains several bands of data. This data may come from either Optical or SAR (Synthetic Aperture RADAR) type sensors and may contain any number of image bands of data relating to a wide range of spectral bands or polarizations . Though a band may have its own specific band properties, all bands on a raster must share a common set of raster properties such as the number of rows and columns, the cell size and the ground extents. A band may optionally have one or more palettes, also called colormaps or Look-Up Tables (LUTs), associated with it. A palette is essentially a lookup table of discrete keys to color or string values. These rasters are often referred to as classified because of the discrete data ranges. Classified rasters often serve the purpose of providing a visual representation or providing additional descriptive information for specific areas of a raster. Raster Properties Rasters contain a set of metadata that defines the properties for the raster as a whole. These properties include l number of bands (channels or layers) l number of rows and columns (lines and pixels) l cell size (spacing) l cell origin l extents l rotation l Ground Control Point (GCPs) A cell is the rectangular area created in the x and y dimensions by the spacing of pixels from the raster origin. - 24 - FME Readers and Writers 2013 SP1 Spacing or cell size is the fixed distance in the x and y dimensions between each pixel in the raster. Some formats store only one spacing value, meaning that it must be the same for both the x and y dimensions – this is often referred to as square cells. The raster origin is the lower left x and y of the raster at which the coverage of the data sample begins. It contains the minimal x and minimal y values for the raster. In FME, the raster origin is the lower left corner of the lowest and leftmost cell in the raster. Cell origin is the point within each cell of a raster from which the pixel for that cell is derived. The lower left corner of the cell in the x or y dimension is 0.0, while the upper right corner is 1.0. A cell origin of 0.5 in x and 0.5 in y would put the data point for each cell in the center of the cell, which is the default representation in FME. Extents or bounds for a raster are represented by the lower left ground coordinate and the upper right coordinate covered by the raster data. This is sometimes referred to as cell bounded. The minimum x and maximum y values that comprise the upper left corner of the raster extents are equivalent to the raster origin. Rotation is used to represent rasters that are not aligned with the x and y axes. The x rotation is the angle in radians as measured in a counter clockwise direction from the positive x axis. The y rotation is the angle in radians as measured in a counter clockwise direction from the negative y axis. Note that a different rotation from the x and y axes produces a shear. The rotation point is the top left corner of the top left cell of the raster. Ground Control Points, or GCPs, may also be present in the geometry of a raster. If present, these refer to a set of points used to georeference image or elevation data, with each point 'tying' a row and column location in the raster to an x,y location on the earth. A coordinate system will also be present in the properties of a raster containing GCPs, as opposed to being stored on the feature itself. GCPs can either be applied to the raster resulting in the image being georeferenced and tagged with the GCP coordinate system, or the GCPs can be extracted and stored on the resulting data file for those formats supporting unreferenced data and GCP storage. Band Properties Rasters contain a set of metadata that defines the properties for each band. These properties include the band name, number of palettes, interpretation, bit depth, 'nodata' value, and properties relating to the preferred method of data access. The interpretation of a band describes the type of data stored at each cell in the raster and number of bits used for that type. An interpretation also implies an underlying fundamental data type used to store the data. For example, an interpretation 'Gray8' implies that the actual data type is FME_UInt8 and that the size of each cell is 8 bits. Possible interpretation values are Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Real32, Real64, Gray8, Gray16, Red8, Red16, Green8, Green16, Blue8, Blue16, Alpha8, Alpha16. - 25 - About FME Rasters Many raster formats store a single data value called 'nodata', transparent or background value that represents unknown or invalid data. Often the value is at one of the extremes of the data type range. Some formats may specify a particular nodata value that is unique to that format, while others are capable of handling any single value designated as nodata. A second option for nodata specification is a whole band or bitmask of data that acts as a flag for each cell indicating whether the cell is valid data or not. Several formats do not support nodata values at all. Bands may also have multiple palettes associated with each instance. The number of palettes on a band can be determined as part of the band properties. Palette Properties Rasters contain a set of metadata that defines the properties for each palette. These properties include the palette name, key and value interpretation, key and value bitdepth, 'nodata' key and value. Interpretation on palettes works in much the same way as it does on bands. The interpretation of a palette key must match the interpretation of the related band. Valid palette key interpretations are UInt8, UInt16, and UInt32. The palette value interpretation may be a color model such as RGB or RGBA or string data. Valid palette value interpretations are RGB24, RGBA32, RGB48, RGBA64, Gray8, Gray16, and String. A palette does not directly store 'nodata' values however since the palette keys are intended to match the band values, which can store ‘nodata’, a single palette key can be interpreted as ‘nodata’ if it matched the band ‘nodata’ value. This nodata key also looks up to a palette value which is then considered the 'nodata' value. A nodata value may not exist without a nodata key. Raster Concepts FME Features with raster geometry have some particular features and details not always present in vector features. Some of these features include storage and formatting concerns such as compression, pyramiding, interleaving, interpretation, tiling, mosaicking, band merging and splitting, palette creation or resolution and selection. Compression Compression is used to reduce the size of a raster on disk, often traded for lessened performance since the format must often be uncompressed to read and compressed to write. The types of compression available depend on specific format support. Pyramiding Pyramids or overviews create lower resolution views of an original dataset. Often several pyramids are created at various lower resolutions to be used in the place of the original raster when only a snapshot or overview of the data is required. An - 26 - FME Readers and Writers 2013 SP1 example of when a pyramid is typically employed, is when a raster viewer zooms out leaving a smaller raster with less detail. Often the smaller raster is rendered using a cached pyramid instead of resampling the image to a lower resolution at the time of the zoom out request. Interleaving Interleaving refers to the storage of multicomponent interpretations and the order in which the individual cell values are stored together. Bands in FME use Band Sequential (BSQ) interleaving indicating that they are all stored uniquely. Palettes in FME are Band Interleaved by Pixel (BIP) as each palette value is stored together with each key in the palette. Interpretation and Data Type Interpretation and data type are two related concepts associated with both bands and palettes on a raster. Data type refers to the fundamental type of the data stored at each cell and is expressed as an enumeration of various floating point or signed or unsigned integer numbers. Interpretation refers to what the data type is representing. For example, a group of three UInt8 data types in each cell may correspond to an interpretation of RGB24 on a palette, such that each of the three UInt8 values corresponds to red, green and blue values respectively. The data type of a band or palette can be determined from interpretation but the converse is not true. Palette Resolution Rasters containing bands with palettes can be resolved to band without palettes through a process called palette resolution. During this process each band value is looked up in the palette and the resultant value is placed in the band. Once complete, the palette is removed and the band interpretation and data type are adjusted. The resultant raster has the same appearance and values as the original, except the palette is not present. Alternatively palettes can be directly removed without the palette resolution step. Tiling and Mosaicking Tiling and mosaicking raster refers to dividing or combining spatially related rasters. A single raster can be tiled into smaller adjacent rasters. A resultant set of tiled rasters can then be mosaicked into a single raster again. The focus is on the spatial relationship of the tiles which should fit together like pieces in a puzzle. Band Combining and Separating Not to be confused with mosaicking, band combining is a raster structural operation that allows for the combination of bands to form multiple rasters into one raster. The values of each band remain unchanged and the spatial relationship required is equivalent resolution and extents between all input rasters. This is useful in situations such as when one wants to combine three individual one band rasters combined into a single three band raster. Conversely, separating a raster with multiple bands and palettes is also supported and can be employed to write multi-band or multi-palette rasters to destination formats that support only single-band or single-palette output. - 27 - About FME Rasters Band and Palette Selection Rasters that contain multiple bands and/or palettes need not be split to be operated on individually. FME allows for individual band and palette selection for operational purposes. For example, an RGB raster that has three bands can have only the red band selected such that subsequent processing occurs only on the red band, and does not affect the remaining green and blue bands. Bands and palettes are selected based on their numeric location in the raster. The numerical relationship is zero based such that the first band is at index 0, the second band at index 1 and so on. Raster Processing A secondary set of features specific to processing rasters also exists and is expressed through the variety of raster functions and factories inside FME. Please see the various transformers in the Raster category or search for raster in the transformer search box. Raster versus Vector Features FME Features with raster geometry cannot be processed in all the ways that vector features can. If an operation that is not yet supported for a raster is attempted, a vector FME polygon feature is used instead. This substitute feature represents the original raster bounding box, and contains the original attributes. Raster-to-vector data translation and vector-to-raster data translation is not an automatic process. There are factories through which vector data can be transformed into raster data, and raster data into vector points. There currently do not exist any means of stroking or transforming raster data into non-trivial vector output through FME. FME features with raster geometry each typically represent one raster data file. Raster writers typically accept a directory as a destination dataset. When writing multiple raster files for one dataset directory the feature type name is used to determine the filename. If multiple features are written to the same dataset the name will be suffixed to be unique. Some writers use feature type fanout by default on the fme_ basename attribute on each feature, thus providing a name with respect to the source data and having some degree of uniqueness. Raster File Naming Many file-based raster writers use the feature type as the output filename. For example, if you passed a feature to the feature type “image” on the TIFF writer, the output would be “image.tif”. When used in Workbench, most file-based raster format writers fanout on fme_ basename. When this is the case, the feature type will effectively be the value of the fme_basename attribute, which is set by all raster format readers to be the filename without the path or extension. For example, if you read two files, image1.tif and image2.tif, two features would be produced, one with an fme_basename value of “image1”, and one with a value of “image2”. Then, if these two features were written - 28 - FME Readers and Writers 2013 SP1 to a writer when fanning out on fme_basename, two new files would be produced, e.g. image1.png and image2.png. Raster format writers that store their data in files require a mechanism to avoid overwriting existing files and differentiate output file from one another when multiple rasters are written to a writer (particularly if the writer outputs one file per raster feature). Raster file based writers implement a simple renaming mechanism to deal with name collisions. Renaming the output files only occurs within a single instance of the writer within a given translation. The first output file is written using the name requested in the workspace. If additional files are produced from the same feature type, the subsequent files are automatically distinguished by appending sequential numbers to the filenames. For example, if four rasters are written to the same feature type, named "image", the result is a set of output files with the names image.tif, image_1.tif, image_2.tif, and image_3.tif. Multiple translations of the same workspace that incorporates a file based raster writer will overwrite previous file output if name collisions occur. Similarly, using multiple writer instances targeted at the same directory is considered unsafe if the same feature types are used in both translations since data overwriting may occur. World Files World files are used to store georeferencing information for rasters. More specifically, they describe the origin, spacing, and rotation of a raster. Several raster format readers will read world files present alongside a dataset, and many raster writers have the option to generate a world file to accompany the output dataset. Consult individual format documentation for more information on their world file support. Raster format readers will give world file georeferencing more precedence than georeferencing in the raster dataset. That is, if the world file stores georeferencing information that is different than that from the source dataset, it is the world file georeferencing that will be applied to the raster. If this is not desired, a simple workaround is simply to move or rename the world file so it will not be read by the format reader. Additionally, note that readers that read both world and TAB files will give more precedence to the world file. Also note that most raster format writers will not write a world file if the output raster contains only default georeferencing information: an origin of (0, 0), spacing of 1.0, and rotation of 0.0. MapInfo TAB Files Raster TAB files are used to store control points, a coordinate system, and user attributes. Most raster format readers will read TAB files present alongside a dataset, and most raster format writers have an option to generate a TAB file to accompany the output - 29 - About FME Rasters dataset. Consult individual format documentation for more information on their TAB file support. The control points represent georeferencing information for the raster. When reading this information, FME will attempt to determine if these control points represent the extents of the raster (i.e. they occur at the corners of the raster) or if they are Ground Control Points, and apply this information accordingly. Note that georeferencing information will be discarded for datasets that contain multiple subdatasets, as there is no way to ascertain which subdataset the information corresponds to. Attributes are not natively a part of raster TAB files. However, FME will read and write attributes to raster TAB files in the same manner as is done for vector TAB files. This enables the storage of user attributes for many formats that don’t otherwise support attribution. Information in TAB files will be given more precedence than information in the raster dataset. For example, if the TAB file stores georeferencing information that is different than that from the source dataset, it is the TAB file georeferencing that will be applied to the raster. If this is not desired, a simple workaround is simply to move or rename the TAB file so it will not be read by the format reader. Additionally, note that readers that read both world and TAB files will give more precedence to the world file. - 30 - FME Readers and Writers 2013 SP1 Database Writer Mode Overview Most database writers share a WRITER_MODE specification, which indicates the default operations that will be performed by the writer. Note: Some writers implement only portions of these specifications (for example, the ArcSDE writer and Geodatabase writers do not implement the Table Level mode). - 31 - FME Readers and Writers 2013 SP1 1Spatial Internal Feature Format (IFF) Reader/Writer Format Note: This format is not supported by FME Base Edition. The 1Spatial (previously known as Laser-Scan) Internal Feature Format (IFF) Reader/Writer module enables FME to read and write IFF files. The IFF is an internal ASCII format originally created by Laser-Scan Ltd. This chapter assumes that you are familiar with the Internal Feature Format. Overview IFF files store both geometry and attribution for features. An IFF file has the following file name extension: File Name Extension Contents .iff Vector geometric data The extension is added to the basename of the IFF file. The Internal Feature reader supports the types of symbol, line, polygon, and text geometric data in .iff files. The IFF format also stores features with no geometry. Features that have no geometry are referred to as having a geometry of none. IFF files support both two- and three-dimensional geometry. IFF Quick Facts About Quick Facts Tables Format Type Identifier IFF Reader/Writer Both Licensing Level Professional Dependencies None Dataset Type Directory or File Feature Type File base name Typical File Extensions .iff Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support No Generic Color Support No Spatial Index Never Schema Required No Transaction Support No - 33 - 1Spatial Internal Feature Format (IFF) Reader/Writer Geometry Type Attribute iff_type Encoding Support No Geometry Support Geometry Supported? Geometry Supported? aggregate no point yes circles no polygon no circular arc no raster no donut polygon no solid no elliptical arc no surface no ellipses no text yes line yes z values no none yes Reader Overview The IFF reader produces FME features for all feature data held in IFF files that are in the specified directory. The reader first scans the directory specified in the Reader Dataset field. For each IFF file found, it checks to see if that file is requested in the translation by comparison with the list specified by the ID’s keyword. Then the reader extracts features from an IFF file one at a time, and passes them on to the rest of the FME for further processing. When the file is exhausted, the IFF reader moves onto the next file in the directory. Optionally a single IFF file can be specified. In this case, only that IFF file is read. Workbench Parameter Source 1Spatial Internal Feature Format (IFF) File(s) 1Spatial Internal Feature Format (IFF) Reader Parameters Reader Parameters Apply Origin Offset Choose Yes to apply the origin offset found in Type 2 Map Descriptor record to all features. The default is No. Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a - 34 - FME Readers and Writers 2013 SP1 workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Writer Overview The IFF Writer creates and writes feature data to IFF files in the directory specified in the Reader Dataset field. Any existing IFF files are overwritten with a new IFF file. As features are routed from the FME to the IFF writer, the writer determines which file the features are to be written to and outputs them accordingly. More than one IFF file can be written in one translation. Feature Representation IFF features consist of geometry and attributes of feature. The attribute names are defined in the DEF line and there is a value for each attribute in each IFF feature. In addition, each IFF feature contains several special attributes to hold the type of the geometric entity and its display parameters. All IFF features contain the iff_type attribute, which identifies the geometric type. - 35 - 1Spatial Internal Feature Format (IFF) Reader/Writer Depending on the geometric type, the feature contains additional attributes (in addition to the generic FME feature attributes that FME Workbench adds to all features [see About Feature Attributes]) specific to the geometric type. These are described in subsequent sections. The general attributes of all IFF geometric features are described in the table below. Attribute Name Contents iff_type The IFF geometric type of this entity. Range: iff_symbol| iff_line| iff_polygon| iff_text| iff_none Default: No default iff_history The history of the IFF file. Range: Maximum of 256 characters Default: Blank iff_map_area The map area. Range: Maximum of 256 characters Default: No default iff_map_grid The map grid representation Range: Maximum of 256 characters Default: No default iff_map_scale The map scale. Range: Maximum of 256 characters Default: No default iff_map_origin_offset The map’s origin offset or local origin. (Read-only) Range: Maximum of 256 characters Default: No default iff_map_projection The map’s projection as a number. (Read-only) Range: Integer Default: No default iff_map_spheroid The map’s spheroid as number. (Read-only) Range: Integer Default: No default - 36 - FME Readers and Writers 2013 SP1 Attribute Name Contents iff_map_units The map’s unit. (Read-only) Range: Integer Default: No default iff_map_proj_stat The map projection status. Range: Maximum of 256 characters Default: No default iff_map_aux_grid The map auxiliary grid. Range: Maximum of 256 characters Default: No default iff_cubic_coef{#} The matrix for coordinate transformation. Each list attribute of this type contains 2 numbers that are part of the transformation matrix for the feature. Range: Maximum of 256 characters. Default: No default iff_ctrl_pt_nw The Northwest control points. Range: Maximum of 256 characters Default: No default iff_ctrl_pt_sw The Southwest control points. Range: Maximum of 256 characters Default: No default iff_ctrl_pt_se The Southwest control points. Range: Maximum of 256 characters Default: No default iff_ctrl_pt_ne The Northeast control points. Range: Maximum of 256 characters Default: No default iff_sec_descr The section description. Range: Maximum of 256 characters Default: Blank iff_layer_num The layer number of the feature. (0 is a reserved layer number that is often ignored) Range: 0...32767 Default: 1 iff_layer_stat The layer status flag (currently not used). - 37 - 1Spatial Internal Feature Format (IFF) Reader/Writer Attribute Name Contents Range: Integer Default: 0 iff_layer_ptr The layer’s pointer to location of matching end of layer marker. Range: Maximum of 256 characters Default: Blank iff_serial_num The feature serial number. This number is often the same as the iff_seq_num. Range: 0...65535 Default: No default iff_seq_num The feature internal sequence number. This number is unique and corresponds with creation order. Range: 0...65535 Default: 1 and increment for each new feature iff_feat_code The feature code number. Range: 0...32767 Default: 0 iff_feat_stat The feature status. Range: 0...32767 Default: 0 iff_proc_code The feature type or process code. The last two bits specify the feature type (0 = line, circle, area or symbol string feature, 1 = symbol feature, 2 = text feature, and 3 = value reserved). Range: 0...32767 Default: 0 iff_user_word The user defined word, this is a reserved field for use by users. Range: Smallint Default: No default iff_anc_code{#}.type The ancillary code type. Range: 0...32767 Default: No default iff_anc_code{#}.value The ancillary code value. Range: Maximum of 256 characters - 38 - FME Readers and Writers 2013 SP1 Attribute Name Contents Default: No default iff_anc_code{#}.text The ancillary code text. Range: Maximum of 255 characters Default: No default iff_anc_code The comma-separated ancillary code list. Range: Maximum of 256 characters Default: No default iff_pen_stat The pen status. Range: 0 - pen up, 1 - pen down Default: 0 iff_junc_blk{#}.sec_num The junction block section number. Range: integer Default: No default iff_junc_blk{#}.next_jb The junction block pointer to the next junction block. Range: Maximum of 256 characters Default: No default iff_junc_blk{#}.offset The junction block offset number. Range: Maximum of 256 characters Default: No default iff_junc_blk{#}.arms_num The junction block number of arms. Range: Maximum of 256 characters Default: No default iff_junc_blk{#}.x_coord The junction block x-coordinate. Range: Double Default: No default iff_junc_blk{#}.y_coord The junction block y-coordinate. Range: Double Default: No default iff_junc_blk{#}.pnt_no The junction block string vertex number. Range: Integer Default: No default iff_junc_blk{#}.addr The junction block address location of the arm coordinates. - 39 - 1Spatial Internal Feature Format (IFF) Reader/Writer Attribute Name Contents Range: Maximum of 256 characters Default: No default iff_junc_blk The comma separated junction block list. (Nested junction block lines are separated by ‘\’s). Range: Maximum of 256 characters Default: No default iff_junc_ptr{#}.offset The junction pointer junction block offset. Range: Maximum of 256 characters Default: No default iff_junc_ptr{#}.addr The junction pointer junction block address. Range: Maximum of 256 characters Default: No default iff_junc_ptr The comma separated junction pointer list. Range: Maximum of 256 characters Default: No default iff_void_size The size of the void. Range: Integer Default: No default Symbol iff_type: iff_symbol IFF symbol features are point features that specify a single x and y coordinate in addition to any associated user-defined attributes. There are no special FME attribute names used to control the IFF symbol settings. Lines iff_type: iff_line IFF line features specify linear features defined by a sequence of x and y coordinates. The following table lists the special FME attribute names used to control the IFF line settings. Attribute Name Contents iff_size The line thickness. Range: Integer Default: No default - 40 - FME Readers and Writers 2013 SP1 Text iff_type: iff_text IFF text features are used to specify annotation information. Although IFF files can have features that have more than one set of annotation information, only simple text features can be written. The IFF reader is able to read features with more than one set of annotation information by splitting them into separate features. But the IFF writer will not merge these separated features when writing, only features with only a set of annotation information are written. The following table lists the special FME attribute names used to control the IFF text settings. Attribute Name Contents iff_rot The text label’s rotation. Range: 0.00...360.00 Default: 0 iff_text_string The text label. Range: Maximum of 256 characters Default: Blank iff_size The text size. Range: Integer Default: No default iff_text_code The text code value. Range: Integer Default: No default iff_text_cmpnt The text component. Range: Integer Default: No default iff_text_res1 Reserved space for future use. Range: Maximum of 256 characters Default: No default iff_text_res2 Reserved space for future use. Range: Maximum of 256 characters Default: No default Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced - 41 - 1Spatial Internal Feature Format (IFF) Reader/Writer by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. IFF Reader Directives DATASET Required/Optional: Required The value for this directive contains the directory where the IFF files will be read, or the file path to the single IFF file. A typical mapping file fragment specifying an input IFF dataset looks like: IFF_DATASET /usr/data/iff/iffFile.iff Workbench Parameter: Source 1Spatial Internal Feature Format (IFF) File(s) DEF Required/Optional Required Each IFF file may optionally be defined before it is read. The definition specifies the base name of the file, and the names and the types of all attributes. The syntax of an IFF DEF line is: - 42 - FME Readers and Writers 2013 SP1 _DEF [ ]+ \ The file names of the physical IFF files are constructed by using the directory specified by the DATASET keyword, the basename specified on the IFF DEF lines, and the .iff extension. The following table shows the attribute types supported. Field Type Description char() Character fields store fixed-length strings. The width parameter controls the maximum number of characters that can be stored by the field. No padding is required for strings shorter than this width. date Date fields store dates as character strings with the format YYYYMMDD. number(, ) Number fields store single and double precision floating point values. The width parameter is the total number of characters allocated to the field, including the decimal point. The decimals parameter controls the precision of the data and is the number of digits to the right of the decimal. smallint Small integer fields store 16-bit signed integers and therefore have a range of -32767 to +32767. integer Integer fields store 32-bit signed integers. logical Logical fields store TRUE/FALSE data. Data read or written from and to such fields must always have a value of either true or false. float Float fields store 4-byte floating point values. There is no ability to specify the precision and width of the field. double Double fields store 8-byte floating point values. The following mapping file fragment defines a IFF file. Notice that the definition specifies the geometric type of the entities it will contain since IFF files may contain any of the valid geometry types. IFF_DEF landcover \ area number(12,3) \ landcoverType char(11) \ perimeter float IDs Required/Optional Optional - 43 - 1Spatial Internal Feature Format (IFF) Reader/Writer Contains a list of IFF files to process. If more IFF files were in the directory, they are ignored. If this is not specified, then all defined IFF files in the directory are read. This specification is used to limit the available and defined IFF files read. If no IDs are specified, then all defined and available IFF files are read. The syntax of the IDs keyword is: _IDs … \ \ The file IDs must match those used in DEF lines. The example below selects only the iff_data IFF file for input during a translation: IFF_IDs iff_data APPLY_ORIGIN_OFFSET Required/Optional: Optional This directive specifies whether or not to apply the origin offset found in Type 2 Map Descriptor record, to all the features. Values: yes | no Default: no SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE 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 - 44 - FME Readers and Writers 2013 SP1 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 _SEARCH_ENVELOPE_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 _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. - 45 - 1Spatial Internal Feature Format (IFF) Reader/Writer 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 IFF Writer Directives The IFF writer processes the DATASET and DEF directives as described in the Reader Directives topic. It does not use the IDs directive. DATASET Required/Optional: Required Workbench Parameter: Destination 1Spatial Internal Feature Format (IFF) Directory DEF Required/Optional: Required [NOTE: THIS WAS A BLANK HELP TOPIC.] - 46 - FME Readers and Writers 2013 SP1 Additional Military Layers (AML) Reader Note: The AML reader shares the same information as the S-57 format. Please refer to the S-57 (ENC) Hydrographic Data Reader. Overview S-57 Additional Military Layers (AML) is a unified range of digital geospatial data products designed to satisfy the totality of NATO non-navigational maritime defence requirements. This includes hydrographic data beyond that for passage and harbour navigation as well as oceanographic and meteorological data. - 47 - FME Readers and Writers 2013 SP1 Adobe 3D PDF Writer Format Note: This format is not supported by FME Base Edition. The 3D PDF Writer enables FME to write Adobe® Portable Document Format (PDF) files embedded with interactive 3D annotations. Overview The Adobe Reader software version 7.0 and above has included support for interactive 3D annotations in PDF files. These annotations allow users to visualize 3D models. For example, users can view the models from different angles and select sub-elements of the model by picking them with the mouse. The writer represents the 3D models in the ECMA-363 Universal 3D File Format, which become embedded in a PDF document. The 3D model can be viewed by PDF viewer applications that support PDF’s interactive 3D annotations. PDF Quick Facts About Quick Facts Tables Format Type Identifier PDF Reader/Writer Writer Licensing Level Professional Dependencies None Dataset Type File Feature Type U3D Node Typical File Extensions PDF Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support No Generic Color Support No Appearance Support (Surfaces Only) Yes Spatial Index Never Schema Required Yes Transaction Support Never Enhanced Geometry Yes Geometry Type Attribute pdf_type - 49 - Adobe 3D PDF Writer Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles no polygon yes circular arc no raster yes donut polygon yes solid yes elliptical arc no surface yes ellipses no text no line yes z values yes none yes Writer Overview The writer outputs PDF version 1.7 files. The document will have one page which contains the 3D annotation. The 3D model has a hierarchal structure of Nodes, which are elements of the model. Feature types become Nodes with no geometry. Features become Nodes that may have geometries and attributes. Feature Nodes are children of their corresponding Feature Type Node. Adobe 3D PDF Writer Parameters Document Options Display Navigation UI Determines whether Adobe Acrobat software will display the left-hand side Node navigation UI by default when opening the output PDF file. Background Color Specifies the background color of the 3D annotation when the output file is viewed with Adobe Acrobat. The format of the value is a comma delimited list of red, green, and blue components of the desired background color. Each rgb (red green blue) value should be a real number between 0.0 and 1.0, inclusive. The default value for this directive is 0.2,0.2,0.2, which is a dark grey color. Valid values are <0.0 ... 1.0>,<0.0 ... 1.0>,<0.0 ... 1.0> Feature Handling Reorient 2D Features for Visibility Controls whether features with no Z coordinates will have their normals adjusted such that the feature is visible immediately after opening the PDF file. - 50 - FME Readers and Writers 2013 SP1 If the box is checked, all 2D features will be visible from the default camera position after opening the PDF file in Adobe Acrobat software. If the box is unchecked, the geometries will not be adjusted and will be written as-is. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. PDF features consist of geometry and attributes. The attribute names are defined in the DEF line and there is a value for each attribute in each PDF feature. In addition, each PDF feature contains several special attributes to hold the type of the geometric entity and its display parameters. All PDF features contain an pdf_type attribute, which identifies the geometric type. Depending on the geometric type, the feature contains additional attributes specific to the geometric type. These are described in subsequent sections. Geometries with no Z coordinates (2D geometries) will be assigned zero as their z values. The following format specific attributes are applicable to all geometry types, and these attributes do not appear as user attributes in the output data: Attribute Name Contents pdf_uid This is an optional format attribute that can be used to specify the unique Node name of the feature. If this attribute is not set, then an unique name is autoatically generated and assigned. If this attribute is set and each feature is not given an unique value, then undefined behaviour will result. pdf_parent_uid This is an optional format attribute that can be used to specify the parent feature Node for this feature Node. The value for this attribute should correspond to a value given to the pdf_uid attribute in a different feature. pdf_child_uid This is an optional format attribute that can be used to specify the child feature Node for this feature Node. The value for this attribute should correspond to a value given to the pdf_uid attribute in a different feature. - 51 - Adobe 3D PDF Writer Attribute Name Contents pdf_merge_tolerance This is an optional format attribute that can be used to set the numerical tolerance used to merge spatially close vertices. If the value is 0.0 or if the attribute is unset, then no merging will be done. Otherwise, if a positive real number less than 1.0 is specified, then vertices that lie within the maximum extent of the scene divided by the number specified will be merged together. For example, if this attribute is set to 0.01, and the maximum extent of the scene is [0,2500] then vertices that are within a distance of 25 units of each other will be merged together. pdf_ambient_color This is an optional format attribute that can be used to specify the ambient component of the feature’s material according to the Phong lighting model. The format of this attribute is R,G,B where each color component is a real value in the range [0,1]. For example, a value 0,1,0 specifies a green ambient color for the feature. pdf_diffuse_color This is an optional format attribute that can be used to specify the diffuse component of the feature’s material according to the Phong lighting model. The format of this attribute is R,G,B where each color component is a real value in the range [0,1]. For example, a value 0,1,0 specifies a green diffuse color for the feature. pdf_specular_color This is an optional format attribute that can be used to specify the specular component of the feature’s material according to the Phong lighting model. The format of this attribute is R,G,B where each color component is a real value in the range [0,1]. For example, a value 0,1,0 specifies a green specular color for the feature. Points pdf_type: pdf_point PDF point features specify Nodes that is a collection of points. The points are rasterized according to the rendering mode of the viewer application. Lines pdf_type: pdf_line PDF line features specify Nodes that is a collection of linear line segments. The line segments may be disjoint. - 52 - FME Readers and Writers 2013 SP1 Circular and elliptical arc segments will be stroked into linear line segments. Lines have no area or volume, and will appear as rasterized according to the rendering mode of the viewer application. Mesh pdf_type: pdf_mesh PDF mesh features specify Nodes with 3D meshes. Meshes are composed of triangular faces. If the input mesh contains faces with more than three distinct vertices, then the face will be converted into multiple triangular faces. The triangular faces of a mesh need not be connected. Faces are one-sided: they are only visible from one view direction. A face is visible when its normal points toward the observer. If the vertices of the outer boundary of the face are observed to be in anti-clockwise order, then the normal of the face points toward the observer, implying that the face is visible. Polygons and donuts are treated as meshes. They will be converted into triangular faces that represents the inner area of the polygon or donut. Textures are supported. The texture coordinates can be specified through the fme_ texture_coordinate_u, fme_texture_coordinate_v, fme_texture_coordinate_w, and fme_texture_coordinate_q point measures. Collection pdf_type: pdf_collection PDF collection features specify a parent Node with no geometry but with the feature’s attribute values, and child Nodes for each element of the collection. The child Nodes do not have the feature’s attribute values. Child nodes can be of any geometry type. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. - 53 - Adobe 3D PDF Writer You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. IFF Writer Directives The directives that are processed by the PDF writer are listed below. The suffixes shown are prefixed by the current _ in a mapping file. By default, the for the PDF writer is PDF. DEF Required/Optional: Required The PDF writer uses PDF_DEF lines to define feature types. A typical mapping file fragment specifying a feature type looks like: PDF_DEF \ [ ]* The configuration parameters present on the definition line are described in the following table: Parameter Contents featureName This declares the name of the feature type. attributeName This declares the name of an attribute. The maximum length of attribute names is 200 characters. attributeType This declares the type of the attribute. The only valid attribute type is string. CENTER_COORDINATES Required/Optional: Optional This directive specifies whether the coordinates of all features should be normalized to the numerical range [-0.5, 0.5]. The PDF format stores coordinates in single precision format. Translating datasets that stores coordinates in double precision to PDF without normalizing the coordinates may result in severe visual artifacts. Values: YES | NO - 54 - FME Readers and Writers 2013 SP1 Default Value When Keyword Not Specified: YES Default for New Workspaces/Mapping Files: YES Workbench Parameter: Center coordinates at the origin BACKGROUND_COLOR Required/Optional: Optional This directive specifies the background color of the 3D annotation when the output file is viewed with Adobe Acrobat. The format of the value is a comma delimited list of red, green, and blue components of the desired background color. Each rgb (red green blue) value should be a real number between 0.0 and 1.0, inclusive. The default value for this directive is 0.2,0.2,0.2, which is a dark grey color. Values: <0.0 ... 1.0>,<0.0 ... 1.0>,<0.0 ... 1.0> Default Value When Keyword Not Specified: 0.2,0.2,0.2 Default for New Workspaces/Mapping Files: 0.2,0.2,0.2 Workbench Parameter: Background color PAGE_SIZE Required/Optional: Optional This directive specifies the size of the output page of the PDF document. The 3D annotation will fill the entire page leaving a slight margin on all sides. The default value for this directive is 600 600, which specifies a page size of 600 by 600 pixels. Values: <0.0 ...> <0.0 ...> Default Value When Keyword Not Specified: 600 600 Default for New Workspaces/Mapping Files: 600 600 Workbench Parameter: Page size NODE_CREATION_LIST Required/Optional: Optional This directive can be used to quickly and conveniently create empty group nodes in the scene graph. The nodes created by this directive can be used as the targets of the pdf_ parent_uid format-specific feature attributes. The format of the value is a comma delimited lists of node specifiers. Node specifiers are a period delimited list of a node’s ancestry, starting with the root UID and ending with the leaf UID. For example, the directive value ‘Node1.Node2.Node3,Node1.Node4’ creates 4 nodes altogether with the following node hierarchy: Node1 <--- Node2 <--- Node3 ^--- Node4 Values: [.]*[,[.]*]* Default Value When Keyword Not Specified: - 55 - Adobe 3D PDF Writer Default for New Workspaces/Mapping Files: Workbench Parameter: Node creation list DISPLAY_NAV_UI Required/Optional: Optional This directive controls whether the the Adobe Acrobat software will display the lefthand side Node navigation UI by default when opening the ouput PDF file. Values: YES | NO Default Value When Keyword Not Specified: NO Default for New Workspaces/Mapping Files: NO Workbench Parameter: Display Navigation UI 2D_FEATURE_HANDLING Required/Optional: Optional This directive controls whether features with no Z coordinates will have their normals adjusted such that the feature is visible immediately after opening the PDF file. If the value is YES, all 2D features will be visible from the default camera position after opening the PDF file in Adobe Acrobat software. If the value is NO, the geometries will not be adjusted and will be written as-is. Values: REORIENT | AS_IS Default Value When Keyword Not Specified: AS_IS Default for New Workspaces/Mapping Files: REORIENT Workbench Parameter: Reorient 2D features for visibility - 56 - FME Readers and Writers 2013 SP1 Adobe Flash (SWF) Writer The Adobe Flash® (SWF) Writer provides FME with the ability to write Flash export files. Flash is a movie creation and display application designed to deliver vector graphics and animation over the Internet. Overview Flash files are stored in compressed, binary, tag-formatted .swf files. The MIME type is application/x-shockwave-flash. Flash files are compressed so they can be used as web content, but this means that file creation takes longer due to the extensive compression techniques that are employed. Writing the movie to the .swf file can take up to three times as long as processing the features. Processing the features themselves is also more time-consuming than with some other formats due to the conversions and formatting of features that takes place (see notes on particular features). In addition, since Flash was not originally designed to handle maps or large numbers of features, performance declines according to the number of features. Therefore, in order to improve performance, we recommend that the features be generalized before being sent to the Flash writer. A Flash movie may consist of several frames, however, the Flash Writer uses only one frame at a time to hold the converted image if the animate draw option is turned off; otherwise, each feature is stored in a frame and then they are displayed incrementally, which results in the map drawing itself bit by bit. Flash Quick Facts About Quick Facts Tables Format Type Identifier FLASH Reader/Writer Writer Licensing Level Base Dependencies None Dataset Type File Feature Type “FLASH” Typical File Extensions .swf Automated Translation Support Yes User-Defined Attributes No Coordinate System Support No Generic Color Support No Spatial Index Not applicable Schema Required Yes - 57 - Adobe Flash (SWF) Writer Transaction Support No Geometry Type Attribute flash_type Encoding Support No Geometry Support Geometry Supported? Geometry Supported? aggregate no polygon yes circles no donut polygon yes circular arc yes line yes elliptical arc yes point yes ellipses yes text yes none no z values no surface no solid no SWF File Structure An SWF file is made up of a header, followed by a number of tags. There are two types of tags: l l Definition tags define the objects known as characters, which are stored in the dictionary. Control tags manipulate characters, and control the flow of the movie. All tags share a common format, so any program parsing an SWF file can skip over blocks it does not understand. Tags can be removed, inserted, or modified by tools that process an SWF file. The Flash writer will be primarily concerned with the definition tags for the shapes and will use the control tags for only simple movie flow control such as the begin and end tags, and placing the objects in the frames. All Flash frames in a movie are contained in a single file with an .swf extension. Filename Extension Contents .swf All vector geometric data in movie frames Shapes Shape representation is similar to most vector formats in that shapes are defined by a list of edges called a path. A path may be closed (where the start and end of the path meet to close the figure), or open (where the path forms an open-ended stroke). A path may contain a mixture of straight edges, curved edges, and “pen up and move” commands. The latter allows multiple disconnected figures to be described by a single shape structure. - 58 - FME Readers and Writers 2013 SP1 A fill style defines the appearance of an area enclosed by a path. Fill styles supported by SWF include a solid color or two gradient fills. A line style defines the appearance of the outline of a path. The line style may be a stroke of any thickness and color. Most vector formats only allow one fill and line style per path. SWF extends this concept by allowing each edge to have its own line and fill style. This can have unpredictable results when fill styles change in the middle of a path. Flash also supports two fill styles per edge, one for each side of the edge. Note: This capability is not utilized by the Flash writer and all edges of a polygon or line will have the same line and fill styles. Fonts and Text Flash text is supported by FME but is represented as line segments, not as real text glyphs. This is for simplicity and because of incompatibility between the Hershey fonts used and the Flash glyph format. Writer Overview The Flash writer creates and writes feature data to a SWF file specified by the DATASET keyword. The writer searches the mapping file for the _DATASET keyword in the mapping file. This keyword is required to be in the mapping file. An old SWF file in the directory with the same file name is overwritten with the new feature data. A typical mapping file fragment specifying the output SWF file looks like: FLASH_DATASET /usr/data/flash/myfile.swf The _MAINTAIN_ASPECT keyword is another optional keyword. It should be followed by a value of YES or NO. By default, the value is set to YES. A YES indicates that the original map aspect will be maintained to fit within the destination defined bounding box. This means that the entire destination bounding box defined may not used. Alternatively, the value NO causes the original map to be clipped by the box if it is too large. Note: Smaller frames are not expanded to fill the bounding box. The _BACKGROUND_COLOR keyword is another optional keyword. It should be followed by a string with three comma separated values from 0 to 255 indicating the intensity values of red, green and blue respectively. This color is then set as the background color of the movie. The default color is white. The _ANIMATE_DRAW keyword is another optional keyword. It should be followed by a value of YES or NO. By default, the value is set to YES. A YES indicates that the features processed are placed into separate frame so that at drawing time the image draws features to the screen progressively and can be observed by the user. Alternatively, the value NO causes the features to be drawn on the same frame which is loaded all at once, with no display to the user until it is complete, at which point it is displayed. - 59 - Adobe Flash (SWF) Writer Keyword Description DATASET The file that will be written to Range: Valid File Name Default: None Optional: No MAINTAIN_ASPECT Specifies whether or not the source map dimensions will be kept or stretched to fit to the output bounding box. Range: YES or NO Default: YES Optional: Yes RESOLUTION_X Specifies the maximum Flash units (1 unit = 1/20 pixel) for the x dimension of the output map Range: 2000 -24000 Default: 16000 Optional: Yes RESOLUTION_Y Specifies the maximum Flash units (1 unit = 1/20 pixel) for the y dimension of the output map Range: 2000 - 18000 Default: 12000 Optional: Yes BACKGROUND_COLOR Specifies the color of the background of the movie. Range: String(0..255, 0..255, 0..255) Default: White Optional: Yes ANIMATE_DRAW Specifies whether to animate the drawing process of just make the user wait for it to be entirely done before displaying it on the screen. Range: YES or NO Default: YES Optional: Yes Feature Representation Flash features consist of geometric shapes which have associated with them attributes as part of their definition. In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), all Flash features contain a flash_type attribute, which identifies the geometric type. All element types also have a color associated with it. All coordinate points and line widths are in twips instead of pixels, - 60 - FME Readers and Writers 2013 SP1 where 20 twips = 1 pixel. Depending on the geometric type, the feature contains additional attributes specific to the geometric type. Note that points are a subset of area, circles are a subset of ellipse and most polygons and closed shapes fall into the area category. Additional attributes are described in subsequent sections. Here are the common attributes of all flash features. Note: For closed areas that can hold a URL, the URL can only be active if the area has not been rotated, so it both are specified, the rotation takes precedence. Attribute Name Contents flash_type The Flash geometric type of this entity. Range: flash_point| flash_line| flash_text| flash_area| flash_arc| flash_ellipse Default: No default flash_linecolor This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..255 Note: If this attribute is not found, then fme_color will be used. Range: String. (0..255, 0..255, 0..255) Default: String (0,0,0) fme_linecolor This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..1 This is used as a backup to flash_color. Range: String. (0..1, 0..1, 0..1) Default: String(0,0,0) flash_linewidth This is an integer value representing the width of the line in twips. Range: Integer>=0 Default: 20 flash_rotation This attribute specifies and optional rotation for the shape where the clockwise direction is positive. Range: -360 to 360 degrees Default: 0 - 61 - Adobe Flash (SWF) Writer Text flash_type: flash_text Flash text is supported through the drawing of Hershey fonts in FME. Basically the string is broken into letters which are then broken into lines and drawn as such. Attributes line text_size may be specified but the font is fixed due to availability of Hershey fonts. Essentially, though made up of lines, the text has no linewidth or color that is available for setting. Attribute Name Contents flash_text_string This is the string that will be written to the flash movie. Range: Any String value? Default: “No String Value” Optional: No flash_text_size This is the size for the text height and if specified, the text will have this height in ground units multiplied by a Hershey height factor to result in a reasonable size of text that if hopefully readable. Range: Integer Default: 20 Optional: Yes Points flash_type: flash_point Flash point features specify a single set of coordinates which is converted. Each point has a colour associated with it. If not defined, default parameters are used, black for the color. URL is the only additional attribute available to control the Flash point settings other than the common ones for all feature types listed. Note: The concept of a line width is absent in the point feature. Attribute Name Contents flash_URL This is the URL for the point and if specified, the point will have a small circle around it which is linked to the given URL. Range: Any String value? Default: None Lines flash_type: flash_line Flash line features specify linear features defined by a starting point and then a series of delta x and y values specifying the distance to travel from the last point, thus a line - 62 - FME Readers and Writers 2013 SP1 consists of 1 or more line segments. Each line has a colour and line width used when the line is drawn. If not defined, default parameters are used. The no special attributes are required to control the Flash line settings other than the common ones for all feature types listed. Since Flash does not support a line class in its swf API, lines are broken into strictly monotone segments and then buffered into simple polygons. Arcs flash_type: flash_arc The flash_arcs are really just converted to a series of line segments to be drawn as a line since in Flash they are defined in terms of a delta x and delta y value pair for the distances from the starting point to the control point and a control x and control y value pair for the distance from the control point to the end point. This does not match the FME definition of an arc, thus to avoid gruesome math, the arc is stroked into a series of line segments and drawn as a line. Areas flash_type: flash_area Flash area features specify various polygon features. The areas that make up a single feature may or may not be disjoint. Note: The flash linewidth and linecolor now refer to the border lines of the closed polygons. Any closed area can be used as a button for events so long is it has not undergone any transformations, i..e., rotation, scaling or translation. The following table lists the special FME attribute names used to control the flash area settings. Attribute Name Contents flash_fill_color This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..255. If this attribute is not found, then the polygon will not be filled. Range: String. (0..255, 0..255, 0..255) Default: None fme_fillcolor This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..1 This is used as a backup to flash_fill_color. Range: String. (0..1, 0..1, 0..1) Default: String(0,0,0) flash_fillstyle This is the value that determines which of the five available fill styles will be used when filling a closed area: nofill,solidfill, left to right linearfill, right to left linear fill, and radialfill. Note this requires a fill color to - 63 - Adobe Flash (SWF) Writer Attribute Name Contents be specified. Range: 0,1,2,3,4 Default: 0 (nofill) flash_URL This is the URL for the area and if specified, the area will have a URL linked to it its shape unless rotated, scaled, or translated, any of which will negate the URL property. Range: Any String value? Default: None Ellipses flash_type: flash_ellipse The flash_ellipse features are simply closed arc features and thus are handled in the same manner. The ellipse is stroked into a line segment and drawn as a line. Note that the flash linewidth and linecolor now refer to the border lines of the ellipse. Any ellipse can be used as a button for events so long is it has not undergone any transformations, i..e. rotation, scaling or translation. From the flash ellipse we also can arrive at circles since they are just ellipses with equal axis. The following table lists the additional FME attribute names used to control the flash ellipse settings. on top of the common ones. Attribute Name Contents flash_fill_color This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..255. If this attribute is not found, then the ellipse will not be filled. Range: String. (0.255, 0..255, 0..255) Default: None fme_fillcolor This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..1 This is used as a backup to flash_fill_color. Range: String. (0..1, 0..1, 0..1) Default: String(0,0,0) flash_fillstyle This is the value that determines which of the five available fill styles will be used when filling an ellipse: nofill,solidfill, left to right linearfill, right to left linear fill, and radialfill. Note: This requires a fill color to be specified. - 64 - FME Readers and Writers 2013 SP1 Attribute Name Contents Range: 0,1,2,3,4 Default: 0 (nofill) flash_URL This is the URL for the ellipse and if specified, the ellipse will have a URL linked to it its shape unless rotated, scaled, or translated, any of which will negate the URL property. Range: Any String value? Default: None - 65 - FME Readers and Writers 2013 SP1 Adobe Geospatial PDF Writer Format Note: This format is not supported by FME Base Edition. The PDF2D Writer enables FME to write Adobe® Portable Document Format (PDF) with vector drawings and geospatial information. Overview PDF is a document exchange format created by Adobe Systems. The PDF2D writer will write features with 2D geometry as vector drawings or raster features as images on a page of a PDF document. The output PDF file can be viewed with Adobe Acrobat Reader or any other PDF viewer application. Features will be belong to a layer according to its feature type. Feature attribute can be queried using the analysis tools of the Adobe Acrobat Reader software. If features have a coordinate system defined, then geospatial coordinates of the cursor location can also be displayed. Adobe Geospatial PDF Quick Facts About Quick Facts Tables Format Type Identifier PDF2D Reader/Writer Writer Licensing Level Professional Dependencies None Dataset Type File Feature Type Layer Typical File Extensions PDF Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support Yes Generic Color Support Yes Spatial Index Never Schema Required Yes Transaction Support Never Enhanced Geometry Yes Geometry Type Attribute pdf_type Encoding Support Yes - 67 - Adobe Geospatial PDF Writer Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles yes polygon yes circular arc yes raster yes donut polygon yes solid no elliptical arc yes surface no ellipses yes text yes line yes z values no none yes Band Interpretations Red8, Green8, Blue8, Alpha8, Gray8, UInt8, Red16, Green16, Blue16, Alpha16, Gray16, UInt16, Int16 Palette Key Interpretations not applicable Palette Value Interpretations not applicable Nodata Value not applicable Cell Origin (x, y) 0.5, 0.5 Rotation Support No GCP Support No World File Support No TAB File Support No Writer Overview The writer outputs PDF version 1.7 files. The document will have one page and features will be drawn in a rectangular region of the page called the viewport. Measurements on the page use the unit of a typographical point. Also known as a PostScript point, it is defined as 1/72 of an inch on the output page. If attribution is written, then each feature and feature type will be represented by a logical structure element. In Adobe Acrobat Reader, features can be visually picked using the Object Data tool. Features with unsupported geometry types will not be drawn, but their attribution data will still be written. Features will be grouped into layers according to their feature types. In Adobe Acrobat Reader, the visibility of layers can be toggled. - 68 - FME Readers and Writers 2013 SP1 PDF files can be opened through a command or an URL that specifies what and how the contents are displayed. For more details about this feature, see this external documentation: http://www.adobe.com/devnet/acrobat/pdfs/pdf_open_parameters.pdf Adobe Geospatial PDF Writer Parameters Page Size Page Size Specifies the size of the output page of the PDF document. The default value for this parameter is Letter. Preset page sizes for common pager sizes can be selected or the page size can be specified in typographical points in the format . Location of Map on Page This parameter determines where to place the map on the page, and how large the map should be on the page. The format for the parameter is four integers separated by spaces describing the lower left corner and the upper right corner of the viewport/rectangle, specified in typographical points. The lower left corner of the page has coordinate (0,0) and the top right corner has coordinate (,) where these two values are the page size specified by the parameter Page Size. If the aspect ratios of the page viewport and the world viewport differ, then the lesser scaling factor will be chosen: data inside the world viewport will not be clipped and data outside the world viewport might become visible. If a value for the directive is not specified, then the page viewport rectangle will be a centered rectangle with a width and length that is 90% of the page width and length. The page viewport coordinates must be between (0,0) and (page width,page height). - 69 - Adobe Geospatial PDF Writer Values: Map Extents Specifies a rectangular region of space, in world coordinates, that will be mapped to the page viewport. Geometry outside the world viewport will be clipped when drawn on the page. The format for this option is four floating point numbers separated by spaces describing the lower left corner and the upper right corner of the rectangle. If a value is not specified, then the world viewport rectangle will be the bounding box of the entire dataset. Values: Map Parameters Default Fill Opacity Specifies the opacity value of the fill color of area geometries. The boundaries of area geometries are not affected by this setting. A value of 0 corresponds to complete transparency and a value of 1 is complete opaqueness. Default Point Radius The default radius in pixels for point geometry. - 70 - FME Readers and Writers 2013 SP1 Default Line Width The default width in pixels for line geometry and boundaries of area geometry. Navigation Panel to Display Determines the panel that is visible immediately after opening the output PDF file in Adobe Acrobat software. If None is specified, then no panel will be initially displayed. If Layers is specified, then the Layer panel will be visible after opening the file. If Pages is specified, then the Page Thumbnails panel will be visible. Randomize Feature Type Color Specifies whether features without the fme_color attribute set will be assigned a random color based on its feature type. If this box is not checked, then features without their fme_color attributes set will be assigned the color black. Text Parameters Text in Rich Text Format Specifies whether the text string of text features is in the rich text format. If the box is not checked, then the text string is written as-is to the page. If the box is checked, then the text string will be processed for style directives. TrueType Font Directories Specifies the directories that the writer will search in to find the TrueType fonts used in the workspace. The workspace directory of the translation is always searched. Attribution Write Attributes Specifies whether attribution data will be written. Not writing attribution data will decrease the file size of the output file and may improve viewing performance. Compression Compress Streams Determines whether streams in the output file will be compressed. Compatibility PDF 1.4 Compatible This parameter specifies whether or not to write files compatible with PDF 1.4 viewers. By default, this parameter is not selected. This means that features introduced in PDF 1.5 and later will be used, including object stream compression and the JPEG2000 raster image format. If this parameter is selected, the output file will not contain compressed object streams, cross-reference information is stored in a cross-reference table and xref trailer, and rasters are encoded in the JPEG format. - 71 - Adobe Geospatial PDF Writer Note: Note that the Compress Object Streams parameter is deprecated, and equivalent to the opposite of this directive. Multi-page Support The default behavior of the PDF writer is to write to a single frame on a single page. A frame is a rectangle on a page where features are drawn. A feature belongs to one or more frames, and a frame belongs to a single page. There are two sets of format attributes for specifying frame and page properties. Frame specification format attributes: Attribute Name Contents pdf_frame_ name If this attribute is set, it specifies the name of the frame to which the feature belongs. The other frame specification attributes will apply to this frame. See subsection “Named Frames” below for more information. If this attribute is unset, then an unnamed frame will be created. See Unnamed Frames below for more information. pdf_frame_order This attribute specifies the order in which the frames are drawn. Valid values are integers. Frames with higher frame order numbers are drawn above frames with lower order numbers. If this attribute is unset on all features belonging to a given frame, then it will assume the default value of ‘0’. pdf_frame_ rectangle This attributes specifies the position of the frame on the page. pdf_world_ rectangle This attributes specifies the extents of the map that will be written to the frame. The units are in page units, and the format is identical to the PAGE_VIEWPORT writer directive, including support for negative and percentage values. If this attribute is unset on all features belonging to a given frame, then it will assume the value of the PAGE_VIEWPORT directive. The units are in world units, and the format is identical to the WORLD_VIEWPORT writer directive. If this attribute is unset on all features belonging to a given frame, then it will assume the value of the WORLD_VIEWPORT directive. pdf_page_ number This attributes specifies the page number to which the frame belongs. This attribute is also used to specify the page specifications for that page number. For unnamed frames, if this attribute is unset, then the attribute is set to the value ‘1’. If this attribute is unset on - 72 - FME Readers and Writers 2013 SP1 Attribute Name Contents all features belonging to a given named frame, then it will assume the value of ‘1’. Page specification format attributes: Attribute Name Contents pdf_page_ number This attribute specifies the page number of the page to which the page specifications will apply. For unnamed frames, if this attribute is unset, then the attribute is set to the value ‘1’, and any page specification attributes that are set on this feature will apply to the first page. If this attribute is unset on all features belonging to a given named frame, then it will assume the value of ‘1’. For a given feature that does not set this attribute, any page specification attributes that are set on that feature are ignored. pdf_page_size This attribute specifies the size of the page. If this attribute is unset on all features belonging to a given page specification, then the page will assume the page size specified by the last prior page that has a page size specification. If no such page exists (e.g. on the first page) then the page size is set to the PAGE_SIZE writer directive. Unnamed Frames If the pdf_frame_name attribute is not set, then the feature belongs to an unnamed frame. Multiple unknown frames may be created during a translation. Features are assigned to an unnamed frame by first assigning default values to unset frame specification attributes. Then features with identical frame specification attributes are assigned to the same unnamed frame. Named Frames A feature can belong to a named frame by setting the pdf_frame_name attribute. There are two rules for determining the frame specification of a named frame. Given any two features belonging to the same frame, if the same frame specification attribute is set on both features, then their values must be identical. If a specific frame specification attribute is unset on all features belonging to a frame at the end of the translation, then the frame will assume the default value for that attribute. By setting the pdf_no_output format attribute to a non-empty value, frame and page specifications can be specified using dummy features without writing these features onto any page. - 73 - Adobe Geospatial PDF Writer Page Specifications Page specifications are handled similarly to named frames, except that pages are referenced by the pdf_page_number attribute. Given any two features belonging to the same page specification, if the same page specification attribute is set on both features, then their values must be identical. If a specific page specification attribute is unset on all features belonging to a page specification at the end of the translation, then the page will assume the default value for that attribute. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. FME raster features represent raster data and use several concepts that are unlike those used in the handling of vector data. See About FME Rasters. PDF files can be written with non-square pixel dimensions. PDF supports rasters with an arbitrary number of bands, provided all bands are the same data type and no band has a palette. PDF also supports rasters with a single band that has a palette. Attribute Name Contents pdf_type The value specifies PDF geometric type of this entity. Range: pdf_area pdf_collection pdf_line pdf_point pdf_text Default: No default pdf_name If attribution data is written, then the value of this attribute determines the name of the structure element associated with the feature. If this attribute is not set, then the structure element will be numbered sequentially. The names need not be unique. Range: Default: - 74 - FME Readers and Writers 2013 SP1 Attribute Name pdf_line_width Contents The value specifies the line width in typographical points of line geometries and boundaries of area geometries. Points within half the line width perpendicular distance from the line path will be painted. Range: Default: 1.0 pdf_line_cap_ style The value specifies the cap style for the ends of lines. Range: <0,1,2> 0 - Butt cap: Lines are squared off at the end and do not project past the end of the line. 1 - Round cap: Semicircles with diameter equal to the line width cap the ends of lines. 2 - Projecting square cap: Lines project past the end by a distance equal to half the line width and are squared off. Default: 0 pdf_line_join_ style The value specifies the shape of corners between segments of paths. Range: <0,1,2> 0 - Miter join: Outer edges of segments are extended until they meet. 1 - Round join: Arcs with diameter equal to the line width are drawn around corners. 2 - Bevel join: Two adjacent segments are finished with butt caps, and the notch beyond the ends is filled with a triangle. Default: 0 pdf_line_miter_ limit For miter joins, the miter limit imposes a maximum on the ratio of the miter length to the line width. For example, a miter limit of 1.414 will bevel the ends of two segments meeting at an angle less than 90 degrees (the far corner will be at a distance sqrt (1^2+1^2)=sqrt(2) from the line). - 75 - Adobe Geospatial PDF Writer Attribute Name Contents Range: <0.0...> Default: 0.0 pdf_line_dash_ pattern{} The values in this list attribute specify the dash pattern for line geometries and the boundaries of area geometries. This attribute works together with pdf_line_dash_pattern_phase to establish a simple dashed line style. Elements of the list specify the alternating lengths of dashes and gaps. The pattern starts with a dash. Range: For each element in the list: <1,2,...> Default: Empty list pdf_line_dash_ pattern_ phase The value specifies the starting phase of the dash pattern. This attribute works together with pdf_line_dash_pattern to establish a simple dashed line style. The following is an example dash pattern specification: pdf_line_dash_pattern{0} = 2 pdf_line_dash_pattern{1} = 3 pdf_line_dash_pattern_phase = 1 A dash of length 1 will be drawn, then gaps of length 3 and dashes of length 2 will cyclically follow thereafter. Before beginning to stroke a path, the dash array is cycled, adding the lengths of dashes and gaps. When the accumulated length equals the value specified by the dash phase, stroking of the path begins, and the dash array is used cyclically from that point onward. The table below shows examples of line dash patterns. As shown, an empty dash array and zero phase can be used to restore the dash pattern to a solid line: - 76 - FME Readers and Writers 2013 SP1 Attribute Name Contents Range: <0,1,2,...> Default: 0 pdf_url If this attribute is set, then the feature will become an interactive annotation. When a user clicks on the feature in a PDF viewer application that supports URI actions, the value will be treated as a URI and it will be resolved. In the common case that the value is a URL, Adobe Acrobat Reader will open a web browser to resolve the address specified. Note: See the “Annotations” section under Feature Representation for behavioral notes. pdf_tooltip If this attribute is set, then the feature will become an interactive annotation. The value specifies the tooltip string that will be displayed when an user hovers over the feature with the mouse cursor in the PDF viewer application. Note: See the “Annotations” section under Feature Representation for behavioral notes. pdf_fill_opacity The value specifies the opacity of the fill color of the feature. A value of 1.0 is fully opaque, and 0.0 is completely transparent. If this value is not set, then the opacity of the feature is determined by the pdf_default_opacity feature type parameter. If the feature type parameter is not set either, then the writer directive DEFAULT_OPACITY determines the opacity. pdf_pen_opacity The value specifies the opacity of the stroking color of the feature. A value of 1.0 is fully opaque, and 0.0 is completely transparent. If this value is not set, then the stroking opacity is set to fully opaque. - 77 - Adobe Geospatial PDF Writer Annotations pdf_type: any Features with the pdf_url or the pdf_tooltip attribute set become annotation objects. There are several behavioral differences between annotation objects and nonannotation objects: l l l l Annotation objects will always appear above non-annotation objects, regardless of layer ordering. The interactive area of an annotation object is the rectangular bound of the feature instead of its precise outline. Annotation objects are no longer selectable through the Object Data tool or the Model Tree interface. Even when the annotation object’s layer is hidden, the annotation will still provide tooltips and be interactive. The annotation object’s parent layer does not affect the visibility of the annotation; only the object’s layer itself will affect its visibility. Points pdf_type: pdf_point A PDF point feature is drawn as a point with a radius of 1 typographical point. The following attribute is applicable to point features: pdf_point_width The value specifies the point width in typographical points of point geometries. Range: Default: 1.0 Lines pdf_type: pdf_line A PDF line feature is drawn as a stroked line. Area pdf_type: pdf_area A PDF area feature is written as a filled area with a stroked boundary. The fill opacity is controlled by the DEFAULT_OPACITY directive. Collection pdf_type: pdf_collection Each component of a PDF collection feature is drawn according to their geometry type. Text pdf_type: pdf_text - 78 - FME Readers and Writers 2013 SP1 A PDF text feature is drawn as a text annotation according to its fme_text_string, fme_ text_size, and fme_rotation attributes. The encoding of the text string is determined as follows: if the font is one of the PDF Core 14 fonts, then the string is decoded using Windows ANSI code page 1252. If the font is a TrueType font, then the string is decoded using the Macintosh Roman code page. If the TrueType font has a Microsoft Symbol character map table, then the font is treated as a symbolic font, and the text string can specify characters in the FF00-FFFF range of the character map by encoding only the low-byte of the code point. Desired characters in symbolic fonts can either be specified using XML numeric character references (NCR) in rich text format (see below) or if the code point coincides with ASCII characters, the ASCII characters themselves. The following attributes are applicable to text features: Attribute Name Contents pdf_text_font The value specifies the default font family of the text representation. If left blank, Helvetica will be used. Default: Helvetica pdf_text_underline If the value is ‘Y’, the text will be underlined. Default: N pdf_text_strikethrough If the value is ‘Y’, the text will have a strikethrough. Default: N pdf_text_bold If the value is ‘Y’, the text will have a bold style. Default: N pdf_text_italic If the value is ‘Y’, the text will have an italic or oblique style. Default: N The text string can be specified in a rich text format. The format is a subset of XHTML. For more information on XHTML, visit http://www.w3.org/TR/xhtml1/. The following are the supported XML elements: l ..., ...,

...

- Can be used to specify a style for its enclosed text through its “style” attribute. l ... - Bolds the enclosed text. l ... - Italicizes the enclosed text. l ... - Underlines the enclosed text. - 79 - Adobe Geospatial PDF Writer l ... - Adds a strikethrough to the enclosed text. l
- Adds a line break. The “style” XML attribute has the following format: “property:value;...;property:value” The following properties are supported: l font-family - Specifies the font family of the text. l font-size - Specifies the point size of the font. l l color - Specifies the color of the text. The color can be specified through the format “#RRGGBB” where each color component is specified as a hexadecimal value, or through the 16 HTML color names (http://www.w3.org/TR/REChtml40/types.html#h-6.5). text-decoration - Valid values are “underline” and “line-through”. The following is an example rich text fme_text_string value: Hello
World! In the PDF document, the text “Hello” will use the styling specified through the format attributes. The text “World!” appears on the next line and will have a font size of 30 but will inherit all other style attributes. Rasters pdf_type: pdf_raster A PDF raster feature is drawn as a grid of pixels comprising an image. Rasters written to PDF are converted to a JPEG2000 byte string and stored as a blob. Thus the nature of raster support is defined by the JPEG2000 format. The following attribute is applicable to raster features: Attribute Name Contents pdf_raster_compression_level It sets the quality of the compression. The range of the value is from 0 (best quality) to 100 (worst quality). The default value is 75. Setting the value to 0 enables lossless compression. This is a writer attribute. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. - 80 - FME Readers and Writers 2013 SP1 Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. PDF2D Mapping File Directives DATASET Required/Optional: Required The value for this directive is the path to the output file. If the output file does not exist, then the writer will create a new file. If the output file exists, then the writer will overwrite it. If other applications have the output file opened, then the writer will be unable to continue and the translation will fail. Workbench Parameter: Destination PDF File DEF Required/Optional: Required The PDF2D writer uses PDF2D_DEF lines to define feature types. A typical mapping file fragment specifying a feature type looks like: PDF2D_DEF \ [pdf_layer_order ]? \ [pdf_in_page_coordinates ]? \ [pdf_default_opacity ]? \ [pdf_layer_visibility ]? \ [ ]* - 81 - Adobe Geospatial PDF Writer The configuration parameters present on the definition line are described in the following table: Parameter Contents featureName This declares the name of the feature type. attributeName This declares the name of an attribute. The maximum length of attribute names is 200 characters. attributeType This declares the type of the attribute. The only valid attribute type is string. layerOrder This declares the layer order of the feature type. Valid values are all integers. Feature types with lower layer orders will be drawn first. Therefore, features in feature types with higher layer orders will appear on top of features in feature types with lower layer orders. If a value is not specified, then the feature type will have an effective layer order value of ‘0’. If two features have identical layer order values, then the two will be ordered arbitrarily. pageCoordinates The value specifies whether the coordinates of geometries will be interpreted in page coordinates. If this attribute is set to YES, then the coordinates of the geometry are treated as page coordinate values, and the feature can be drawn anywhere on the page. The default value is NO. opacity This determines the opacity level of features of this feature type when their pdf_opacity feature attribute is unset. If this parameter is set, the value overrides the writer parameter DEFAULT_OPACITY. A value of 1.0 is fully opaque, and 0.0 is completely transparent. visibility If the value is VISIBLE, then the layer will be visible by default after opening the output file in Adobe Acrobat Reader. If set to HIDDEN, then the layer will not be initially visible. The visibility of layers can be toggled in Adobe Acrobat Reader after opening the file. PAGE_SIZE This directive specifies the size of the output page of the PDF document. The default page size is Letter. Preset page sizes for common paper sizes can be selected, or the page size can be specified in typographical points in the format . Required/Optional - 82 - FME Readers and Writers 2013 SP1 Optional Values A3 | A4 | A5 | B5 | Ledger | Legal | Legal-half | Letter (Default) | Letter-half | <0 ...> <0 ...> Workbench Parameter Page size PAGE_VIEWPORT (Location of Map on Page) This directive determines where to place the map on the page, and how large the map should be on the page. The format for this directive is four integers separated by spaces describing the lower left corner and the upper right corner of the viewport/rectangle, specified in typographical points. The lower left corner of the page contains coordinate (0,0) and the top right corner contains coordinate (,), where these two values are the page size specified by PAGE_SIZE. If the aspect ratios of the page viewport and the world viewport (WORLD_VIEWPORT)  differ, then the lesser scaling factor will be chosen: data inside the world viewport will not be clipped and data outside the world viewport might become visible. If a value for the directive is not specified, then the page viewport rectangle will be a centered rectangle with a width and length that is 90% of the page width and length. The page viewport coordinates must be between (0,0) and (page width,page height). - 83 - Adobe Geospatial PDF Writer Required/Optional Optional Values The values can also be specified as a percentage of the page width and page height. The values must be an integer ending with a percentage sign. The values can also be negative values, and they are interpreted as being relative to the top and right edges instead of the left and bottom edges. For example, for a page size of 1000 by 1000 points, the rectangle “50 50 –50 –50” is identical to the rectangle “50 50 950 950” for this page size. Workbench Parameter Page viewport dimensions WORLD_VIEWPORT (Map Extents) This directive specifies the extents of the map to write within the page viewport, by defining the lower left and upper right corners of the page viewport in map units. - 84 - FME Readers and Writers 2013 SP1 Geometry outside these extents will be clipped when drawn on the page. The format for the directive is four floating point numbers separated by spaces describing the lower left corner and the upper right corner of the rectangle. If a value for the directive is not specified, then the world viewport rectangle will be the bounding box of the entire dataset. Required/Optional Optional Values Workbench Parameter World viewport dimensions DEFAULT_OPACITY This directive specifies the opacity value of the fill color of area geometries. The boundaries of area geometries are not affected by this setting. Required/Optional Optional Values <0.0...1.0> A value of 0 corresponds to complete transparency and a value of 1 is complete opaqueness. Default Value: 0.4 Workbench Parameter Default fill opacity value DEFAULT_POINT_SIZE This directive specifies the default radius in typographical points for point geometry. Required/Optional Optional Values <0.0...> Default Value: 1.0 Workbench Parameter Default point size value - 85 - Adobe Geospatial PDF Writer DEFAULT_LINE_WIDTH This directive specifies the default width in typographical points for line geometry and boundaries of area geometry. Required/Optional Optional Values <0.0...> Default Value: 1.0 Workbench Parameter Default line width value PANEL_VISIBILITY This directive determines the panel that is visible immediately after opening the output PDF file in Adobe Acrobat software. Required/Optional Optional Values None (default): No panel will be initially displayed Layers: Layer panel will be visible after opening the file Pages: Page Thumbnails panel will be visible Workbench Parameter Navigation Panel to Display RANDOMIZE_FEATURE_TYPE_COLOR This directive specifies whether features without the fme_color attribute set will be assigned a random color based on its feature type. Required/Optional Optional Values YES (default) NO (features without the fme_color attribute set will be assigned the color black) Workbench Parameter Randomize Feature Type Color - 86 - FME Readers and Writers 2013 SP1 RICH_TEXT Required/Optional: Optional This directive specifies whether the text string of text features is in the rich text format. If this directive is set to NO, then the text string is written as-is to the page. If this directive is set to YES, then the text string will be processed for style directives. For more details, see the “Text” section under Feature Representation. Values: YES|NO Default Value: NO Workbench Parameter: Text in rich text format FONT_DIRECTORIES Required/Optional: Optional This directive specifies the directories that the writer will search in to find the TrueType fonts used in the workspace. The workspace directory of the translation is always searched. Values: Default Value: Workbench Parameter: TrueType font directories WRITE_ATTRIBUTES Required/Optional: Optional This directive specifies whether attribution data will be written. Not writing attribution data will decrease the file size of the output file and may improve viewing performance. Values: YES|NO Default Value: YES Workbench Parameter: Write attributes COMPRESS_STREAMS Required/Optional: Optional This directive specifies whether streams in PDF files will be compressed. Values: YES|NO Default Value: YES Workbench Parameter: Compress streams COMPRESS_OBJECT_STREAMS This directive specifies the object stream compression, and the output format of the PDF cross-reference information and trailer. - 87 - Adobe Geospatial PDF Writer If the directive is set to YES, the output file will contain compressed object streams, and cross-reference information will be stored in cross-reference streams. If the directive is set to NO, the output file will not contain compressed object streams, and cross-reference information will be stored in a cross-reference table and trailer. Compressed object streams and cross-reference streams are supported in PDF1.5 and higher. Required/Optional Optional Values YES (default) | NO Workbench Parameter Compress Object Streams PDF_14_COMPATIBILITY Required/Optional: Optional This directive specifies whether or not to write files compatible with PDF 1.4 viewers. The default value of NO means that features introduced in PDF 1.5 and later will be used, including object stream compression and the JPEG2000 raster image format. A value of YES means that the output file will not contain compressed object streams, cross-reference information is stored in a cross-reference table and xref trailer, and rasters are encoded in the JPEG format. Note that the COMPRESS_OBJECT_STREAMS directive is deprecated, and equivalent to the opposite of this directive. Values: YES|NO Default Value: NO Workbench Parameter: PDF 1.4 Compatibility FRAME_SPECS Required/Optional: Optional This directive can be used to specify frame and page properties (see the Multi-page Support section). If the output will have a static number of frames and pages (i.e., the number and properties of frames and pages is not dependant on the data) then this directive provides a convenient and simple method of specifying frame and page properties. The format for this directive is a whitespace-delimited sequence of keywords and values: Specification: [PageSpec|FrameSpec]* PageSpec: page PageSpecAttributes* PageSpecAttributes: page_size FrameSpec: frame FrameSpecAttributes* FrameSpecAttributes: page_number - 88 - FME Readers and Writers 2013 SP1 | frame_rectangle | frame_order | world_rectangle The formats of the , , , , and values are identical to the formats for the pdf_page_ number, pdf_page_size, pdf_frame_rectangle, and pdf_world_rectangle attributes respectively. The order that these attributes are specified is insignificant. Properties that are not specified will use their default values as described in the Multi-page Support section. The following is an example value for this directive: frame f1 frame_rectangle 10% 10% -10% -10% page_number 2 frame f2 frame_order 0 frame f3 frame_order 1 page 1 page_size 500 500 The result is as follows: The output document has two pages. Both pages have size 500x500 points (the unspecified second page inherits its page size from the first page). Frame “f1” will have a 10% margin on the second page. Frame “f3” will be drawn above frame “f2” on the first page, and the two frames will have the frame rectangle specified by the PAGE_VIEWPORT writer directive. All three frames use the world rectangle specified by the WORLD_VIEWPORT writer directive. Features can be written to one of these three frames by setting the pdf_frame_name attribute to “f1”, “f2”, or “f3”. Workbench Parameter Frame and Page Specification Lines - 89 - FME Readers and Writers 2013 SP1 Adobe Illustrator (IEPS) Writer The Adobe Illustrator Encapsulated PostScript® (IEPS) Writer module enables FME to write Encapsulated PostScript export files specifically formatted to work with Adobe Illustrator. Illustrator IEPS is a different flavour of EPS and makes use of some of the functionality of Adobe Illustrator. The most significant additions are the use of layers and object attributes. In this format, many of the PostScript keywords have been shortened into special Adobe Illustrator single letter functions. The implication is that EPS files produced by this writer cannot be used outside of Adobe Illustrator. The standard EPS writer should be used if the EPS is to be used in other applications. IEPS is most often used for high-quality plots in desktop publishing software. Note: This writer may write files that are quite large since it does create an output coordinate for every source coordinate. If you find your .eps files getting too large, it is recommended that you first generalize your source data to make it less dense using the FME’s @Generalize function (or the FME Workbench Generalizer transformer). IEPS Quick Facts About Quick Facts Tables Format Type Identifier IEPS Reader/Writer Writer Licensing Level Base Dependencies None Dataset Type File Feature Type Layer name Typical File Extensions .eps Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support No Generic Color Support Yes Spatial Index Not applicable Schema Required Yes Transaction Support No Geometry Type Attribute ieps_type Encoding Support No - 91 - Adobe Illustrator (IEPS) Writer Geometry Support Geometry Supported? Geometry Supported? aggregate no point yes circles no polygon yes circular arc no raster no donut polygon yes solid no elliptical arc no surface no ellipses no text no line yes z values no none no Overview IEPS is a two-dimensional (2D) format with the ability to store user-defined attributes for the geometric data. All IEPS information is contained in a single page beginning with a version header as well as a bounding box definition. IEPS is based upon the PostScript format which provides methods for graphical drawing, simple programming control structures and the ability to create user-defined variables and functions. All IEPS data is contained in a single file with an .ieps extension. File Name Extension Contents .ieps All vector geometric data. The IEPS writer supports export of points, lines, polygons, and text geometric data. Some geometric entities may have display properties such as pen width, line type, and color. Color may be specified in red/green/blue (RGB) as well as cyan/magenta/yellow/black (CMYK). Writer Overview The IEPS writer creates and writes feature data to an IEPS file specified by the DATASET keyword. The writer searches the mapping file for the _ DATASET keyword in the mapping file. This keyword is required to be in the mapping file. An old IEPS file in the directory with the same file name is overwritten with the new feature data. A typical mapping file fragment specifying the output IEPS file looks like: IEPS_DATASET /usr/data/ieps/myfile.ieps - 92 - FME Readers and Writers 2013 SP1 Adobe Illustrator EPS Writer Parameters Size Width Specifies the maximum EPS units (1 unit = 1/72 inch) for the width of the output map. Height Specifies the maximum EPS units (1 unit = 1/72 inch) for the height of the output map. Buffer Ratio The percentage of buffer room between the border of the output EPS map within the specified bounding box. Line Width The value in pixels of the line width you wish to use by default. The default value is set to 1. The value entered for this parameter must be at least 0 (which is the thinnest printable line width). Text Width This width is similar to line width, except it is applied to text features. The default value is set to 1. The value entered for this parameter must be at least 0, which is the thinnest printable line width. Line Join Type Specifies the default corner types that should be drawn onto paths. Square Specifies a sharp corner. Round Specifies a rounded corner. Butt Specifies a butt-end corner. Line Cap Type Specifies the default cap that will be used on line segments. Square Specifies square-end caps. Round Specifies rounded-end caps. Butt Specifies butt-end caps. - 93 - Adobe Illustrator (IEPS) Writer Map Parameters Maintain Map Aspect Ratio Select Yes to indicate that the original map aspect will be maintained to fit within the destination-defined bounding box. This means that the entire destination bounding box defined may not used. Select No to cause the original map to be stretched onto the defined destination bounding box. Force CMYK By choosing Yes, then all color usage output to the IEPS file is in CMYK. By default, this value is No, meaning that a mix of RGB and CMYK color schemes may be in the output IEPS file. However, despite forcing CMYK color output, some IEPS viewers may not support the setcmykcolor call in their library. In these cases, the actual output of colors is done using a function we define in PostScript which interfaces exactly like the setcmykcolor call, but uses setrgbcolor underneath. This will depend on the IEPS viewer you are using About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. IEPS features consist of geometry but no user-defined attributes, although there are special attributes to hold the type of the geometric entity and its display parameters. The feature type of a feature written to IEPS is used to specify its layer in the output Adobe Illustrator file. All IEPS features contain a ieps_type attribute, which identifies the geometric type. Each element type also has a color associated with it. Depending on the geometric type, the feature contains additional attributes specific to the geometric type. These are described in subsequent sections. Attribute Name Contents ieps_type The IEPS geometric type of this entity. Range: ieps_polyline| ieps_area| ieps_text| ieps_point Default: No default - 94 - FME Readers and Writers 2013 SP1 Attribute Name Contents ieps_cmyk_color This is a string that represents the color intensities of the element. It is formatted as cyan (C), magenta (M), yellow (Y) and black (K), This color attribute has highest priority. If present, it will be used in preference over ieps_color and fme_ color attributes. Range: String. (0..1, 0..1, 0..1, 0...1) Default: String (0,0,0, 1) ieps_cmyk_fill_color This is a string that represents the fill color intensities of the element. It is formatted as cyan (C), magenta (M), yellow (Y) and black (K), This color attribute has highest priority. If present, it will be used in preference over ieps_fill_color and fme_fill_color attributes. Range: String. (0..1, 0..1, 0..1, 0...1) Default: String (0,0,0,1) ieps_color This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..1 Note that if this attribute is not found, then fme_color will be used. Range: String. (0..1, 0..1, 0..1) Default: String (0,0,0) ieps_fill_color This is a string that represents the color intensities of the element. It is formatted as red, green, blue intensities which range between 0..1. If this attribute is not found, then the writer will refer to fme_fill_color. Range: String. (0..1, 0..1, 0..1) Default: None ieps_url Allows you to attach a URL to a feature. The URL should be formatted as http://www.safe.com. Range: String Default: No Default ieps_dash_on The number of pixels to be used as the on part of the dashed line used to draw the feature. If ieps_ pen_linewidth is specified, then this value is multiplied by the size of the pen to determine the number of pixels. If both ieps_dash_on and ieps_ dash_off are 0, then a solid line is used. - 95 - Adobe Illustrator (IEPS) Writer Attribute Name Contents Range: Integer > 0 Default: 0 ieps_dash_off The number of pixels to be used as the off part of the dashed line used to draw the feature. If ieps_ pen_linewidth is specified, then this value is multiplied by the size of the pen to determine the number of pixels. If both ieps_dash_on and ieps_ dash_off are 0, then a solid line is used. Range: Integer > 0 Default: 0 ieps_line_join_type Specify the type of corner that should be drawn onto this path. 0 = sharp corners, 1 = rounded corners, 2 = buttend corners Range: 0, 1, 2 Default: 0 Optional: Yes ieps_line_cap_type Specify the type of caps on line ends. 0 = butt end caps, 1 = rounded end caps, 2 = square end caps Range: 0, 1, 2 Default: 0 Optional: Yes ieps_locked_flag This determines whether or not the feature can be selected for editing when the document is opened in Adobe Illustrator. If set to 0, the feature can be selected for editing. If set to 1, the feature is locked and cannot be selected. Range: 0, 1 Default: 0 Optional: Yes Areas ieps_type: ieps_area IEPS polygon features specify area (polygonal) features. The areas that make up a single feature may or may not be disjoint, and may contain polygons that have holes. Each area has a pen style associated with it to control the color, line weight, line type, and brush pattern used when it’s drawn. If the area contains holes then when the fill pattern is applied, the holes enclosed by the area will not be filled. If no pen style is defined for a polygon entity, the previous style is used. - 96 - FME Readers and Writers 2013 SP1 The following table lists the special FME attribute names used to control the IEPS polygon settings. Attribute Name Contents ieps_line_width Defines the line width used to draw the polyline. By default, the line is drawn one pixel wide. Range: Float >= 0 Default: 0.0 (the thinnest line that can be rendered at device resolution, i.e. 1 pixel wide) Polylines ieps_type: ieps_polyline IEPS polyline features specify linear features defined by a sequence of x and y coordinates. Polylines encapsulate the concept of a line since a line is just a sequence of two points. Each polyline has a pen style associated with it that specifies the color, line weight, and line type used when the line is drawn. If no pen type is defined for a polyline entity, if line attributes aren’t found, then default parameters are used. The table below lists the special FME attribute names used to control the IEPS polyline settings. Attribute Name Contents ieps_line_width Defines the line width used to draw the polyline. By default, the line is drawn one pixel wide. Range: Float >= 0 Default: 0.0 (the thinnest line that can be rendered at device resolution, i.e. 1 pixel wide) Text ieps_type: ieps_text IEPS text is used for text annotation in IEPS. The coordinates specify the lower left coordinates of the text when it is placed. In addition, the size and angle in which the text is output can be specified. The table below lists the special FME attribute names used to control the IEPS text: Attribute Name Contents ieps_size The size of the text specified in ground units Range: float > 0 Default: 0 ieps_illustrator_size The size of the point text specified in points. If this is set, it will override the ieps_size value. Range: float > 0 - 97 - Adobe Illustrator (IEPS) Writer Attribute Name Contents Default: 12pt ieps_rotation The text rotation is given in degrees and measured counterclockwise up from the horizontal. Range: -360..360 Default: 0 ieps_font The PostScript name of the font. The fonts supported depend on the destination of the IEPS file. Some typical fonts are Times, Helvetica and Courier. Range: String Default: NewBaskerville ieps_style The style of the font. This attribute must be matched with the current font since it’s the combination of font and style that IEPS recognizes. Some typical fonts and styles are Times-(None, Roman, Italic, Bold, BoldItalic), Helvetica-(None, Oblique, Bold, BoldOblique) and Courier-(None, Oblique, Bold, BoldOblique). Note the keyword ‘NONE’ can be specified to indicate no style on the font. Range: String Default: Bold ieps_text_string The text to be displayed. Range: String Default: No default ieps_text_width Defines the line width used to stroke the text. By default, the stroked line is drawn one pixel wide. Range: Float >= 0 Default: 0.0 (the thinnest line that can be rendered at device resolution, i.e. 1 pixel wide) ieps_render_type This determines how the text is output. 0 = filled, 1 = stroked, 2 = stroked and filled Range: 0,1,2 Default: 2 Point ieps_type: ieps_point - 98 - FME Readers and Writers 2013 SP1 IEPS point is used for point annotation in IEPS. Points will be represented as text. By default, a symbol will be represented by a period. Attribute Name Contents ieps_size The size of the point text specified in ground units Range: float > 0 Default: 0 ieps_illustrator_size The size of the point text specified in points. If this is set, it will override the ieps_size value. Range: float > 0 Default: 12pt ieps_rotation The text rotation is given in degrees and measured counterclockwise up from the horizontal. Range: -360..360 Default: 0 ieps_font The PostScript name of the font. The fonts supported depend on the destination of the IEPS file. Some typical fonts are Times, Helvetica and Courier. Range: String Default: NewBaskerville ieps_style The style of the font. This attribute must be matched with the current font since it’s the combination of font and style that IEPS recognizes. Some typical fonts and styles are Times-(None, Roman, Italic, Bold, BoldItalic), Helvetica-(None, Oblique, Bold, BoldOblique) and Courier-(None, Oblique, Bold, BoldOblique). Note the keyword ‘NONE’ can be specified to indicate no style on the font. Range: String Default: Bold ieps_symbol_string The text to be displayed. Range: String Default: “.” ieps_symbol_width Defines the line width used to stroke the text. By default, the stroked line is drawn one pixel wide. Range: Float >= 0 Default: 0.0 (the thinnest line that can be rendered - 99 - Adobe Illustrator (IEPS) Writer Attribute Name Contents at device resolution, i.e. 1 pixel wide) ieps_render_type This determines how the text is output. 0 = filled, 1 = stroked, 2 = stroked and filled Range: 0,1,2 Default: 2 Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. IEPS Writer Directives DATASET Required/Optional: Required - 100 - FME Readers and Writers 2013 SP1 The IEPS writer processes the DATASET keyword as described in Writer Overview. Additional keywords can be used to set default parameters that are applied to all applicable features in the file. However, the values set by the keywords can be overwritten if the feature itself has a value defined for that parameter. For example, although the LINE_WIDTH keyword may be used to specify a default width of 5 for all lines in the file, if an ieps_polyline feature has its ieps_line_width set to a value of 2, then the line width of 2 will be used over the default value of 5. Workbench Parameter: Destination Adobe Illustrator EPS File DEF Required/Optional: Required This is a required keyword that defines the layers within the file. DEF lines also list the attributes that will be saved as object tags on features of that layer, and may also include the attribute IEPS_LAYER_COLOR. This should be followed by an RGB combination ranging in intensities from 0 to 255, separated by commas. This defines the layer color seen in Adobe Illustrator. Attribute Contents Required/Optional IEPS_LAYER_COLOR This is an attribute that can be used on a DEF line. It defines the layer color seen in Illustrator. Optional Range: 0..255, 0..255, 0..255 Default: No Default RESOLUTION _X and RESOLUTION _Y Required/Optional: Optional These directives define the bounding box of the IEPS output file. The bounding box extends from the lower left corner of the page (defined as 0,0) and extends out to the values entered. By default, the X value is set to 612 and the Y value is set to 792. These values map onto an 8.5 x 11-inch piece of paper. Range: Integer > 0 Default: RESOLUTION_X: 612 RESOLUTION_Y: 792 Workbench Parameter: Width (points), Height (points) MAINTAIN_ASPECT Required/Optional: Optional This directive is followed by a value of YES or NO. By default, the value is set to YES. A YES indicates that the original map aspect will be maintained to fit within the destination-defined bounding box. This means that the entire destination bounding box - 101 - Adobe Illustrator (IEPS) Writer defined may not used. Alternatively, the value NO causes the original map to be stretched onto the defined destination bounding box. Range: YES | NO Default: YES Workbench Parameter: Maintain Map Aspect Ratio LINE_WIDTH Required/Optional: Optional This directive is followed by the value in pixels of the line width you wish to use by default. The default value is set to 0, which is the thinnest printable line width. Range: float >= 0 Default: 0.0 (1 pixel wide: the thinnest line that can be rendered at device resolution) Workbench Parameter: Line Width (pixels) TEXT_WIDTH Required/Optional: Optional This directive has an attribute just like LINE_WIDTH except that this width is applied to text features. The default value is set to 0, which is the thinnest printable line width. Range: float >= 0 Default: 0.0 (1 pixel wide: the thinnest line that can be rendered at device resolution) Workbench Parameter: Text Width (pixels) TEXT_FONT Required/Optional: Optional This directive specifies the default font applied to all text features. The font must be a PostScript name. The fonts supported depend on the destination of the IEPS file. Some typical fonts are NewBaskerville, Times, Helvetica and Courier. The default is NewBaskerville since it is the most commonly installed with Adobe Illustrator. Range: String Default: NewBaskerVille Workbench Parameter: Text Font TEXT_STYLE Required/Optional: Optional This directive specifies the default style to be applied to the text font all text features. This attribute must be matched to the current font since it is the combination of text font and text style that is recognized by Adobe Illustrator. Some typical font and style combinations are NewBaskerville-(None, Bold), Times-(None, Roman, Italic, Bold, - 102 - FME Readers and Writers 2013 SP1 BoldItalic), Helvetica-(None, Oblique, Bold, BoldOblique), and Courier-(None, Oblique, Bold, BoldItalic). Note that the keyword NONE can be used to specify that no style should be applied to the font. Range: String Default: Bold Workbench Parameter: Text Style LINE_JOIN_TYPE Required/Optional: Optional This directive is followed by the values 0, 1, or 2. These values specify the default shape to be put at corners of paths painted: 0 specifies a sharp corner, 1 specifies a rounded corner, and 2 specifies a butt-end corner. Range: 0, 1, 2 Default: 0 Workbench Paramter: Line Join Type LINE_CAP_TYPE Required/Optional: Optional This directive is followed by the values 0, 1, or 2. These values specify the default cap that will be used on line segments. 0 specifies butt-end caps, 1 specifies roundedend caps and 2 specifies square-end caps. Range: 0, 1, 2 Default: 0 Workbench Parameter: Line Cap Type FORCE_CMYK Required/Optional: Optional By setting the value following this keyword to YES, then all color usage output to the IEPS file is in CMYK. By default, this value is NO, meaning that a mix of RGB and CMYK color schemes may be in the output IEPS file. However, despite forcing CMYK color output, some IEPS viewers may not support the setcmykcolor call in their library. In these cases, the actual output of colors is done using a function we define in PostScript which interfaces exactly like the setcmykcolor call, but uses setrgbcolor underneath. This will depend on the IEPS viewer you are using. Range: YES | NO Default: NO Workbench Parameter: Force CMYK LOCK_FEATURES Required/Optional: Optional - 103 - Adobe Illustrator (IEPS) Writer If set to YES, by default all features will be locked and cannot be selected or edited in Adobe Illustrator. Note: Even if LOCK_FEATURES is set to YES, individual features can be unlocked if its eps_lock_feature is set to 0 (meaning NOT locked). Hence, an individual eps_lock_feature value overrides this LOCK_FEATURES default value. Range: YES | NO Default: NO Workbench Parameter: Lock Features RENDER_TYPE Required/Optional: Optional This directive determines how the text is output. This value will be used as the default render type for all text in the file but it will be overridden if the text feature has its own user-defined render type value. This directive is followed by the values 0, 1, or 2. These values specify the default rendering that will be applied to text features: 0 = fill, 1 = stroke, 2 = stroke and fill. The default value is 2. Range: 0, 1, 2 Default: 2 Workbench Parameter: Render Type - 104 - FME Readers and Writers 2013 SP1 Adobe Illustrator – Avenza MAPublisher Writer The Adobe® Illustrator® – Avenza MAPublisher writer allows FME to translate and import data into the Adobe Illustrator file format, complete with Avenza MAPublisher MAP Views and MAP Layers. Overview The Adobe Illustrator – Avenza MAPublisher writer provides export options to convert GIS data into a new Adobe Illustrator document, complete with MAPublisher MAP Views and MAP Layers. With the Adobe Illustrator – Avenza MAPublisher writer, it is possible to create an Adobe Illustrator document containing data from formats that are not natively supported by Avenza MAPublisher using the power of FME format translations within FME Workbench. The Adobe Illustrator – Avenza MAPublisher writer provides the following capabilities: MAPublisher 8.6 for Adobe Illustrator supports FME FFS file import. This means that any format that can be converted to FFS through FME can be translated to an Adobe Illustrator document. l FME FFS support: l Batch Import Into Adobe Illustrator Files/Templates: Import data into existing Adobe Illustrator documents with preconfigured styles applied on-the-fly using autoassign functionality and fit the imported data to the page and to existing or new MAP Views (with FME Auto license for MAPublisher). Adobe Illustrator – Avenza MAPublisher Quick Facts About Quick Facts Tables Format Type Identifier MAPUBLISHER Reader/Writer Writer Licensing Level Professional Dependencies l l Avenza MAPublisher 8.6 and newer Adobe Illustrator Dataset Type File Feature Type FME Feature Type names Typical File Extensions .ffs (with conjoined .ai/.ait) Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support No Generic Color Support Yes Spatial Index No - 105 - Overview Schema Required No Transaction Support No Geometry Type Attribute fme_type Encoding Support Yes Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles yes polygon yes circular arc yes raster no donut polygon yes solid no elliptical arc yes surface no ellipses yes text yes line yes z values no none yes Writer Overview This module writes into a temporary FME FFS dataset and then translates the data into an Adobe Illustrator file for use with Avenza MAPublisher. Because it is not possible to access all the wide range of controls that Adobe Illustrator provides to create a feature-rich map from within another application you may want to create a preset file in Adobe Illustrator that will be used as a template for your destination data first. It is typical that the data read into a new destination map will include data that lies outside the extents of the template map. To fit the data to the extents of the map, you must enable the Fit to Page After Adding Data option. Data can added to a template containing a MAP View or a new MAP View can be created if one doesn't exist. Imported data is automatically assigned a MAP Layer type by MAPublisher. Note: Tip: use the MAP Theme styesheet Auto-Assign option in MAPublisher to automatically have your custom styles applied as data is imported into Adobe Illustrator. After GIS data is successfully imported into Adobe Illustrator, there are several options to handle the document using the Document disposition drop-down options to leave the document open, save it, or save and close it. To save a document using a specified name, enter it into the Destination AI file box and set the document disposition to Save or Save and Close. If you'd like to retain some of the original format attributes, you may want to turn the Strip format attributes option off. - 106 - FME Readers and Writers 2013 SP1 Adobe Illustrator - Avenza MAPublisher Writer Parameters Adobe Illustrator Parameters Initial AI File/Template Browse to the map file that will be used as a template for the destination map. This option opens an existing Adobe Illustrator file (*.ai) or Adobe Illustrator Template file (*.ait). When an Adobe Illustrator document is selected, it is used to determine extents of the map, unless there are pre-existing matching MAP Views in the document. If no file is set for this option, a prompt will appear to create a new document when the import process starts in Adobe Illustrator. Destination AI File and Document Disposition After GIS data is successfully imported into Adobe Illustrator, there are several options to handle the document using the Document disposition drop-down options: l l l Leave open: After the import process is complete, the Adobe Illustrator document will be kept open. Save: After the import process is complete, the Adobe Illustrator document will be saved, but will remain open. Save and close: After the import process is complete, the document will be saved and then closed. To save a document using a specified name, enter it into the Destination AI file box and set the document disposition to Save or Save and Close. Alternatively, you can specify only the Initial AI File, in which case it will be overwritten in the process. When no Destination AI file name is set and the Initial AI file is either a new document or a template, a prompt at the end of the automation process to specify a file name will appear. Existing Document MAP View Fit to Page After Adding Data Enable this option to scale the data (existing and incoming) to fit to the extent of the art board. If Matching MAP View Found When an existing Adobe Illustrator file contains a MAP View with the same coordinate system as the data being imported with MAPublisher-FME Auto, the If Matching Existing MAP View Found option contains several options to handle the imported datasets: l l Create New MAP View: The datasets will be imported to a new MAP View. Prompt the User: A prompt will appear during the automation whether or not the GIS data should be imported to an existing MAP View. With this option, user can - 107 - Overview specify which MAP View to use. This option is useful when there are multiple MAP Views with the same coordinate system available in the specified AI file. l Add data to first matching MAP View: If the specified AI file has multiple MAP Views with the same coordinate system, GIS data via FME Automation will be brought to the first MAP View with the same coordinate system as the one with the GIS dataset being imported. Other Parameters Strip Format Attributes When GIS data is converted to FME Feature Store (FFS) format, the FFS file may contain extra attributes to preserve information of the original data format such as dimension, geometry type, and feature type information. Enable this option to prevent these attributes from being imported into the Adobe Illustrator document. Note that FFS retains all the attribute data from its initial sources, which may include source format-specific attributes, source user attributes, etc. While disabling this option minimizes the amount of data imported, enabling it may result in better rendering of the original dataset features and allow you to perform stylization in MAPublisher based on the original source attributes. Wait for Result from MAPublisher By default, after sending a request to MAPublisher to perform an import operation, FME does not wait for the application to complete it and immediately proceeds to the next item. When this option is enabled, the format writer will wait for MAPublisher to finish its work and report the results to the FME log, rather than having it displayed in MAPublisher. Quit Launched Illustrator if Unused MAPublisher-FME Automation starts Adobe Illustrator if it is not running. Enable this option to quit Adobe Illustrator after the import process if it was launched by FME and it has no other pending requests. If Adobe Illustrator is already running when MAPublisher FME Auto begins, this option will be ignored. Please also note: l l All writers in the workspace should have this option enabled in order for Adobe Illustrator to quit. Depending on timing, Adobe Illustrator may quit and launch multiple times if this option is set, since it makes the decision about quitting only based on the requests that have arrived so far. Character Encoding By default, the current system locale is used to decode language-specific data for attribute definitions and values. This option is the way to specify which encoding should be used to interpret the attribute data in MAPublisher. - 108 - FME Readers and Writers 2013 SP1 FFS File Compression Level This option is inherited from FME FFS writer option and has three settings: None, Medium, and High. A lower compression level will result in faster operation while a higher compression level will result in smaller file sizes. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Feature Representation The Adobe Illustrator - Avenza MAPublisher writer uses FME translation abilities to store FME features through the FFS format, therefore no special attributes apply. All attributes on the feature are read and written. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the - 109 - Overview keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. MAPublisher Writer Directives AIFILESRC This directive specifies the pathname to the map file that will be used as a template for the destination map. This directive is used to open an existing Adobe Illustrator file (*.ai) or Adobe Illustrator Template file (*.ait). When an Adobe Illustrator document is selected, it is used to determine extents of the map, unless there are pre-existing matching MAP Views in the document. If no file is set for this option, a prompt will appear to create a new document when the import process starts in Adobe Illustrator. Required/Optional Optional Workbench Parameter Initial AI File/Template AIFILEDST This directive specifies the pathname to the map file that will be used as the destination map. Alternatively, you can specify only AIFILESRC parameter, in which case it will be overwritten in the process. When AIFILEDST is not provided and AIFILESRC is either a new document or a template, a prompt at the end of the automation process to specify a file name will appear. Required/Optional Optional Workbench Parameter Destination AI File DOCUMENT_POLICY This directive specifies how the document is handled after GIS data is successfully imported into Adobe Illustrator. There are several options: After the import process is complete, the Adobe Illustrator document will be kept open. Leave open: After the import process is complete, the Adobe Illustrator document will be saved, but will remain open. Save: After the import process is complete, the document will be either saved under its current name, or saved as the file name specified by AIFILEDST parameter, if provided, and then will be closed. Save and close: Required/Optional Required - 110 - FME Readers and Writers 2013 SP1 Workbench Parameter Document Disposition DATASET This directive specifies the pathname to an FFS file that will be created by FME Workbench as a temporary storage to transfer the data to Adobe Illustrator. After the import process is complete, the file name can be safely re-used by other writers. Required/Optional Required Workbench Parameter FFS Dataset QUITAPPLICATION This directive is used to open or close Adobe Illustrator. MAPublisher FME Auto starts Adobe Illustrator if it is not running. Enable this option to quit Adobe Illustrator after the import process if it was launched by FME and it has no other pending requests. If Adobe Illustrator is already running when MAPublisher FME Auto begins, this option will be ignored. Please also note that all the writers in the workspace should have this option enabled for Adobe Illustrator to quit. Please also note that depending on timing, Adobe Illustrator may quit and launch multiple times if this option is set since it makes the decision about quitting only based on the requests that have arrived so far. Required/Optional Optional Workbench Parameter Quit Launched Illustrator If Unused MAPVIEW_POLICY When an existing Adobe Illustrator file contains a MAP View with the same coordinate system as the data being imported with MAPublisher-FME Auto, the If Matching Existing MAP View Found option contains several options to handle the imported datasets: Create New MAP View: The datasets will be imported to a new MAP View. A prompt will appear during the automation whether or not the GIS data should be imported to an existing MAP View. With this option, user can specify which MAP View to use. This option is useful when there are multiple MAP Views with the same coordinate system available in the specified Ai file. Prompt the User: If the specified Ai file has multiple MAP Views with the same coordinate system, GIS data via FME Automation will be brought to the first MAP View with the same coordinate system as the one with the GIS dataset being imported. All data to first matching MAP View: Required/Optional - 111 - Overview Required Workbench Parameter If Matching MAP View Found MAPVIEW_AUTOSCALE This directive is used to scale the data (existing and incoming) to fit to the extent of the art board. Required/Optional Optional Workbench Parameter Fit to Page After Adding Data WAIT_FOR_RESULT By default, after sending a request to MAPublisher to perform an import operation, FME does not wait for the application to complete it and immediately proceeds to the next item. If this directive is set to "yes", the format writer will wait for MAPublisher to finish its work and report the results to the FME log, rather than having it displayed in MAPublisher. Required/Optional Optional Workbench Parameter Wait For Result from MAPublisher CODEC_NAME A string of language-specific data encoding for attribute definitions and values. The character encoding is the way to specify what encoding should be used to interpret the attribute data in MAPublisher. Required/Optional Optional Workbench Parameter Character Encoding STRIP_FORMAT_ATTRIBUTES When GIS data is converted to FME Feature Store (FFS) format, the FFS file may contain extra attributes to preserve information of the original data format such as dimension, geometry type, and feature type information. Enable this option to prevent these attributes from being imported into the Adobe Illustrator document. - 112 - FME Readers and Writers 2013 SP1 Note that FFS retains all the attribute data from its initial sources, which may include source format-specific attributes, source user attributes, etc. While disabling this option minimizes the amount of data imported, enabling it may result in better rendering of the original dataset features and allow you to perform stylization in MAPublisher based on the original source attributes. Required/Optional Optional Workbench Parameter Strip Format Attributes - 113 - FME Readers and Writers 2013 SP1 Aeronautical Information Exchange Model (AIXM) Reader/Writer The AIXM Reader/Writer enables FME to read Aeronautical Information Exchange Model format files. This chapter assumes familiarity with the AIXM format. Overview The Aeronautical Information Exchange Model (AIXM) format was developed by EUROCONTROL, the European Organisation for the Safety of Air Navigation, to allow aeronautical data standardization and exchange. The role of AIXM is to enable systems to exchange aeronautical information in the form of XML-encoded data. AIXM Quick Facts About Quick Facts Tables Format Type Identifier AIXM Reader/Writer Both Dataset Type File Licensing Level Professional Dependencies None Feature Type AIXM entity name Typical File Extensions .xml Automated Translation Support No User-Defined Attributes No Coordinate System Support Yes Generic Color Support No Spatial Index Never Schema Required No Transaction Support No Geometry Type Attribute xml_type Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles yes polygon yes circular arc yes raster no - 115 - Aeronautical Information Exchange Model (AIXM) Reader/Writer Geometry Support Geometry Supported? Geometry Supported? donut polygon no solid no elliptical arc no surface no ellipses no text no line yes z values no none yes Reader Overview The AIXM reader presents features by normalizing the XML data into the entities of the AIXM Entity-Relational model. Thus, the feature representation is not equivalent to the AIXM XML format representation of the AIXM E-R model entity. Aeronautical Information Exchange Model (AIXM) Reader Parameters Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Writer Overview The AIXM writer has a fixed output schema that closely resembles the AIXM EntityRelational model. The reader can be connected directly to the writer and the output file will be nearly identical to the original source file. - 116 - FME Readers and Writers 2013 SP1 Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (seeAbout Feature Attributes), special FME feature attributes are used by the AIXM reader to store the characteristics of the features it reads. The AIXM Reader module utilizes the XML Reader module in processing the AIXM XML file. Thus, the feature representation is similar to the feature representation of the XML Reader module. The format attribute, xml_type, which may identify the geometry type of the feature, is identical in intent to the same attribute set by the XML Reader. Details of this attribute can be found in the XML Reader/Writer documentation. Attribute Name Contents aixm_update_ID When an AIXM Update message changes the natural key that identifies an object, then this attribute will hold the old natural key of the object to be updated. aixm_update_group_no This attribute determines the order of the AIXM Group elements within the output file. The values of this attribute are integers, and identifies the feature with a specific group. When all features are received by the AIXM writer, features are grouped according to the values of their aixm_update_group_no attribute, and the groups are written in ascending order of through group numbers. If this attribute is not specified, then the feature will be grouped with group number zero. aixm_update_name The value of this attribute specifies the ‘name’ attribute of the AIXM Group element that holds the feature. aixm_update_subname The value of this attribute specifies the ‘sub-name’ attribute of the AIXM Group element that holds the feature. aixm_update_reason The value of this attribute specifies the ‘reason’ attribute of the AIXM Group element that holds the feature. aixm_update_type The value of this attribute determines the type of the AIXM Update message for that particular feature: New, Update, or Withdrawn. aixm_noseq The AIXM reader normalizes the XML schema. After this transformation, child elements that composed a parent element may become independent features. If the child elements were ordered within the parent element, then this attribute will hold the sequence number that determines the child element’s placement within a parent element. - 117 - Aeronautical Information Exchange Model (AIXM) Reader/Writer Attribute Name Contents aixm_update_changed This is a list attribute that holds the names of attributes that are flagged as changed in an AIXM Update message. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. Reader Directives The suffixes shown below are prefixed by the current in a mapping file. By default, the for the AIXM reader is AIXM. DATASET Required/Optional: Required The value for this directive is the path of the AIXM file to be read. A typical mapping file fragment specifying an input AIXM dataset looks like: AIXM_DATASET /usr/data/aixm.xml - 118 - FME Readers and Writers 2013 SP1 Workbench Parameter: Source Aeronautical Information Exchange Model (AIXM) File (s) INTERPOLATE Required/Optional: Optional The value for this directive determines whether non-linear interpolation will be performed between two vertices of an area or line geometry. This keyword will also determine the representation of geometry data. Further information on this topic can be found under the Feature Representation heading. An example mapping file fragment specifying that interpolation should be performed looks like: INTERPOLATE Yes SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE 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 - 119 - Aeronautical Information Exchange Model (AIXM) Reader/Writer Optional Mapping File Syntax _SEARCH_ENVELOPE_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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope Writer Directives The directives processed by the AIXM writer are listed below. The suffixes shown will be prefixed by the current in a mapping file. By default, the for the AIXM writer is AIXM. DATASET Required/Optional: Required The value for this keyword is the path of the output AIXM file. A typical mapping file fragment specifying an output AIXM file looks like: AIXM_DATASET /usr/data/aixm.xml Workbench Parameter: Destination Aeronautical Information Exchange Model (AIXM)  File WRITE_MODE Required/Optional: Optional The value for this keyword determines the type of AIXM file, either an AIXM Snapshot or AIXM Update, produced by the writer. Valid values are UPDATE and SNAPSHOT. The default value is UPDATE: AIXM_WRITE_MODE UPDATE Workbench Parameter: AIXM writer mode - 120 - FME Readers and Writers 2013 SP1 ORIGIN Required/Optional: Optional The value for this keyword is a string that determines the originator of the AIXM message: AIXM_ORIGIN ABC Workbench Parameter: Origin CREATED Required/Optional: Optional The value for this keyword determines the date and time that the AIXM message was created. The string should be a valid XML dateTime string: AIXM_CREATED 2002-10-10 Workbench Parameter: Created EFFECTIVE Required/Optional: Optional The value for this keyword determines the date and time that the AIXM message becomes effective. The string should be a valid XML dateTime string: AIXM_CREATED 2002-10-10 Workbench Parameter: Effective USE_CHG Required/Optional: Optional The value for this keyword determines whether the ‘chg’ XML attributes will be added to each XML element written by the writer. Valid values are YES and NO. If the value is YES, then XML elements whose names appear in the aixm_update_changed format specific attribute will have an XML attribute named ‘chg’ with a value of ‘1’ inserted. The default value for this keyword is YES: AIXM_USE_CHG YES Workbench Parameter: Add 'chg' attributes - 121 - FME Readers and Writers 2013 SP1 Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer Note: This format is not supported by FME Base Edition. This format requires an extra-cost plug-in. Please contact Safe Software for details. The AIRCOM ENTERPRISE Map Data Reader/Writer provides FME with access to AIRCOM International’s ENTERPRISE format. Overview The AIRCOM ENTERPRISE format is a collection of different types of data. These types of data include height, clutter, vector, text, building vector, and population vector. The data is stored in a hierarchy of directories, with each subdirectory containing a different type of data. Each subdirectory will contain an index.txt file that will act as a guide to the location and type of data that is in the directory. There can be an unlimited number of subdirectories under the main directory. These subdirectories can have any name that is legal for that operating system, but each subdirectory can only contain one type of data. The index.txt file contained in each subdirectory contains different fields depending upon the type of data contained in that subdirectory. The type of data that is stored is described below: ENTERPRISE Quick Facts About Quick Facts Tables Format Type Identifier ENTERPRISE Reader/Writer Both Dataset Type Reader: File, Writer: Directory Licensing Level Professional Dependencies Extra-cost plug-in Feature Type Feature Name Typical File Extensions .txt Automated Translation Support No User-Defined Attributes No Coordinate System Support No Generic Color Support No Spatial Index No Schema Required No Transaction Support No Encoding Support No Geometry Type Attribute enterprise_type - 123 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles yes polygon yes circular arc yes raster yes donut polygon no solid no elliptical arc no surface no ellipses no text no line yes z values no none yes Band Interpretations Int16 Palette Key Interpretations UInt8, UInt16 Palette Value Interpretations String Nodata Value -9999 for height Cell Origin (x, y) 0, 0 Rotation Support No GCP Support No World File Support No TAB File Support No Height Data The data file name corresponds to a binary file that contains height values for each square on the raster defined by the easting-northing coordinates. Clutter Data The data file name corresponds to a binary file that contains key values for the each square on the raster defined by the easting-northing coordinates. The key values correspond to strings found in the menu.txt file. Array Data The data file name corresponds to a binary file that contains array values for the each square on the raster defined by the easting-northing coordinates. Vector Data Each data file listed in the index file contains a set of 2D vectors that all have the same feature name. - 124 - FME Readers and Writers 2013 SP1 Text Data Each data file listed in the index file contains a set of text features that all have the same feature name. Population Vector Data Each data file listed in the index file contains a set of 2D polygons that all have the same feature name. Building Vector Data Each data file listed in the index file contains a set of 2D polygons that all have the same feature name. For reading, the FME considers an AIRCOM ENTERPRISE dataset to be the location of an index.txt file in one of the ENTERPRISE subdirectories. For writing, the dataset is the name of the subdirectory to write a single ENTERPRISE type. The FME reader can automatically determine which type of data is in this subdirectory. The FME writer determines which ENTERPRISE type is being written and creates an appropriate directory structure and index.txt file for the destination dataset. Reader Overview The ENTERPRISE reader produces FME features for all feature data held in those files listed in the index.txt file. The reader only returns the feature names selected using the DEF or IDs keywords. If none were specified, then all the features are read. When the index.txt file is exhausted, the ENTERPRISE reader is closed. Aircom ENTERPRISE Map Data/ASSET Data Reader Parameters Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. - 125 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer Writer Overview The ENTERPRISE writer creates and writes feature data of a single type (Vector, Clutter, Heights, etc.) into a single directory specified by the DATASET directive. The directory need not exist before the translation occurs. Any old files in the directory may be overwritten with the new feature data without warning. The type of data that will be written by FME is determined by what is selected in the data type drop-down list in the ENTERPRISE settings box. If first_feature is selected, the first feature routed to the ENTERPRISE writer by FME determines the type of data that will be written and all subsequent features will be written out as that type, if possible. Each of the other options corresponds to the selected ENTERPRISE feature type being written out. Note: Types enterprise_vector, enterprise_vector_point, enterprise_ vector_line, and enterprise_vector_polygon may all be written to the same dataset. ENTERPRISE only supports a limited set of coordinate systems. Please consult your ENTERPRISE documentation to ensure that you are writing data using one of the supported coordinate systems. FME Raster Features FME raster features represent raster data and use several concepts that are unlike those used in the handling of vector data. See About FME Rasters. The Height feature type supports rasters with a single numeric band. The Clutter feature type supports rasters with a single band that has a String palette. The Array feature type supports multiple numeric bands. The exact makeup of the bands depends on the array type (see the enterprise_array_type attribute). Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. The attribute types created by the ENTERPRISE format are listed below. Field Type Description char() Character fields store fixed-length strings. The width parameter controls the maximum characters that can be stored by the field. When a character field is written, it is right-padded with blanks, or truncated, to fit the width. decimal(,) Decimal fields store single and double precision - 126 - FME Readers and Writers 2013 SP1 Field Type Description floating point values. The width parameter is the total number of characters allocated to the field, including the decimal point. The decimals parameter controls the precision of the data and is the number of digits to the right of the decimal. ENTERPRISE features consist of geometry and attribute information. All ENTERPRISE FME features contain the enterprise_type attribute that identifies the geometric type. Depending on the geometric type, the feature may contain additional attributes specific to the geometric type. These are described in subsequent sections. Attribute Name Contents enterprise_type The ENTERPRISE geometric type of this entity. Range: enterprise_height| enterprise_clutter| enterprise_array| enterprise_vector| enterprise_vector_point| enterprise_vector_line| enterprise_vector_polygon| enterprise_buildpop| enterprise_text Default: No default enterprise_data_file_name The filename this feature came from (or should be written to) as listed in the index.txt file. Range: Default: or data.txt Height Rasters enterprise_type: enterprise_height ENTERPRISE height features represent a raster of 3D values, where the z-coordinate reflects the height value for the raster square whose top-left corner is defined by the (x, y) point. These features have one special attribute associated with them. Attribute Name Contents enterprise_raster_filename The root filename of the feature that is being represented. Clutter Rasters enterprise_type: enteprise_clutter - 127 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer ENTERPRISE height features represent a raster of 2D values, but where the zcoordinate reflects a key value for the raster square whose top-left corner is defined by the (x, y) point. The key value is a classified string value. These features have one special attribute associated with them. Attribute Name Contents enterprise_raster_filename The root filename of the feature that is being represented. Array Rasters enterprise_type: enteprise_array ENTERPRISE array features represent a raster of 2D values, but where the zcoordinate reflects an array field value for the raster square whose top-left corner is defined by the (x, y) point. The array field value is an integer value. These features have four special attribute associated with them. Attribute Name Contents enterprise_raster_file_type The raster file type of the raster feature that is being represented. The value can only be “coverage” for now. enterprise_array_type The array type of the raster feature that is being represented. This attribute depends on the raster file type. For “coverage” raster file type, this attribute can have one of the following values: best_server_array nth_best_server_array worst_interferer_array total_interference_array worst_connection_array average_connection_array total_received_array enterprise_array_field The field name of the array of the raster feature that is being represented. This attribute depends on the array type. This attribute can have one of the following values: number_of_servers cell_key layer_key signal_level ci_level carrier connection - 128 - FME Readers and Writers 2013 SP1 Attribute Name Contents level not_used Vectors enterprise_type: enterprise_vector enterprise_type: enterprise_vector_point enterprise_type: enterprise_vector_line enterprise_type: enterprise_vector_polygon ENTERPRISE vector features represent linear features and are 2D. These features have the following special attribute associated with them. Attribute Name Contents enterprise_description The description of the feature as stored in the dataset. Maximum size is 12 characters. enterprise_feature_name The name of the feature as stored in the dataset. Maximum size is 254 characters. Building Height or Population Polygons enterprise_type: enterprise_buildpop ENTERPRISE buildpop features represent closed polygonal features that are 2D. These features have the following special attributes associated with them. Attribute Name Contents enterprise_description The description of the feature as stored in the dataset. Maximum size is 12 characters. enterprise_attribute_file_name The filename this feature came from (or should be written to) as listed in the index.txt file. Range: Default:_att or data_att.txt enterprise_attribute_value A numeric value associated with that feature. This is either the height of the building or the population of the area represented by the polygon. Range: Any real number enterprise_attribute_ description The description of the attribute for the feature as stored in the dataset. Maximum size is 12 characters. enterprise_feature_name The name of the feature as stored in the dataset. Maximum size is 254 characters. - 129 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer Text enterprise_type: enterprise_text ENTERPRISE text features hold text information. A single 2D position is associated with the text block. Text features may have the following special attributes associated with them. Attribute Name Contents enterprise_text_string The text string of the feature. Maximum size is 254 characters. enterprise_text_size The size of the text string of the feature. This is ignored when writing. When reading, this is initially set to a multiple of the MBR of the file the text is read from. Maximum size is 254 characters. enterprise_feature_name The name of the feature as stored in the dataset. Maximum size is 254 characters. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the - 130 - FME Readers and Writers 2013 SP1 keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. Reader Directives The suffixes shown are prefixed by the current in a mapping file. By default, the for the ENTERPRISE reader is ENTERPRISE. DATASET Required/Optional: Required The value for this keyword is the path of the input index.txt file to be read. This dataset MUST be a file called index.txt. Example: ENTERPRISE_DATASET /usr/data/aircom/europe/index.txt Workbench Parameter: Source Aircom ENTERPRISE Map Data/ASSET Data File(s) MERGE_FEATURE_NAMES Required/Optional: Optional Specifies whether or not to group common feature names in the source index.txt file. If this directive is set to YES, the rows in the index file with common feature names will be grouped as one feature name. If this is changed to NO, each row in the index file will be treated as a unique feature name. All feature names will be made unique by adding the filename to the feature name. Value: YES | NO Default Value: YES Example: The following example shows a generated unique feature name from the filename myfile.txt and the feature name myfeaturename. myfeaturename Workbench Parameter: Merge Feature Names SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE - 131 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer 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 _SEARCH_ENVELOPE_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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope - 132 - FME Readers and Writers 2013 SP1 Writer Directives The suffixes shown are prefixed by the current in a mapping file. By default, the for the ENTERPRISE writer is ENTERPRISE. 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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope DATA_TYPE Required/Optional: Optional The optional definition specifies only the type or class of data that the writer will output. Values: first_feature height clutter building_raster backdrops vector population_vector building_vector "text" Note: The ENTERPRISE writer can only output one of these types during a translation, and all features will be attempted to be written out as this type, if possible. Tip:  If you wish to write out several different types at once, you may consider using FME’s MultiWriter, which will direct each of the ENTERPRISE writers being used to write out a different type. Default Value: first_feature If this keyword is not specified, the default first_feature is used. In this case, the data type of the first feature that is passed to the writer determines what type of data the writer will produce. Example: - 133 - Aircom ENTERPRISE Map Data/ASSET Data Reader/Writer _DATA_TYPE vector - 134 - FME Readers and Writers 2013 SP1 APT Reader The APT Reader allows FME to read APT files. Overview The APT is a published ASCII format used in design systems. It is a three-dimensional (3D) system. APT files store both feature geometry and attribution, and have an .apt file name extension. The extension is added to the basename of the APT file. The APT reader supports the storage of point, line, and polygon geometric data in .apt files. The APT format also stores features with no geometry (which are referred to as having a geometry of none). APT Quick Facts About Quick Facts Tables Format Type Identifier APT Reader/Writer Reader Licensing Level Professional Dependencies None Dataset Type File base name Feature Type Feature Name Typical File Extensions .apt Automated Translation Support Yes User-Defined Attributes No Coordinate System Support No Generic Color Support No Spatial Index Never Schema Required Not applicable Transaction Support No Geometry Type Attribute apt_type Geometry Support Geometry Supported? Geometry Supported? aggregate no point yes circles no polygon no - 135 - APT Reader Geometry Support Geometry Supported? Geometry Supported? circular arc no raster no donut polygon no solid no elliptical arc no surface no ellipses no text no line no z values yes none yes Reader Overview The APT reader then extracts features from a file one at a time, and passes them on to the rest of the FME for further processing. The reader finishes when it reaches the end of the file. APT Reader Parameters Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. - 136 - FME Readers and Writers 2013 SP1 APT features consist of geometry and attributes. The attribute names are defined in the DEF line and there is a value for each attribute in each APT feature. The table below lists the attributes contained in all APT features. Attribute Name Contents apt_type The APT geometric type of this entity. Range: apt_point|apt_none Default: No default apt_ival This is the i coordinate to the point that is in normal vector. Range: Floating Point Number Default: Blank apt_jval This is the j coordinate to the point that is in normal vector. Range: Floating Point Number Default: Blank apt_kval This is the k coordinate to the point that is in normal vector. Range: Floating Point Number Default: Blank Points apt_type: apt_point APT point features specify a single x and y coordinate in addition to any associated user-defined attributes. There are no special FME attributes for the APT point type. Currently only point features are supported. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). - 137 - APT Reader A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. Reader Directives The following paragraphs contain the directives processed by the APT reader. The suffixes shown are prefixed by the current in a mapping file. By default, the for the APT reader is APT. DATASET Required/Optional: Required Contains the directory name of the input APT files. The value for this keyword is the file path of the APT file to be read. A typical mapping file fragment specifying an input APT dataset looks like: APT_DATASET /usr/data/apt/aptfile.apt Workbench Parameter: Source APT File(s) DEF Required/Optional Optional This keyword defines the APT file, and each APT file must be defined before it can be read. The definition specifies the base name of the file, and the names and the types of all attributes. The syntax of a APT DEF line is: _DEF \ [ ]+ - 138 - FME Readers and Writers 2013 SP1 The basename specified on the APT DEF lines is constructed by using either the file name without the extension specified by the DATASET keyword, or using apt_record (used only when APT is the source). APT files require at least one attribute to be defined. The attribute definition given must match the definition of the file being read. If it does not, translation is halted and the true definition of the APT file’s attributes gets logged to the log file. The following table shows the attribute types supported. Field Type Description char() Character fields store fixed-length strings. The width parameter controls the maximum number of characters that can be stored by the field. No padding is required for strings shorter than this width. date Date fields store dates as character strings with the format YYYYMMDD. number(, ) Number fields store single and double precision floating point values. The width parameter is the total number of characters allocated to the field, including the decimal point. The decimals parameter controls the precision of the data and is the number of digits to the right of the decimal. logical Logical fields store TRUE/FALSE data. Data read or written from and to such fields must always have a value of either true or false. The following mapping file fragment defines a APT file DEF line when APT is the source file format. APT_DEF apt_record \ apt_ival char(254) \ apt_jval char(254) \ apt_kval char(254) SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE - 139 - APT Reader 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 _SEARCH_ENVELOPE_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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope - 140 - FME Readers and Writers 2013 SP1 ARC Digitized Raster Graphics (ADRG) Reader Note: This format is not supported by FME Base Edition. This format requires the Advanced Raster Pack license. Contact Safe Software for details. The ADRG Reader module enables FME to access data in the Arc-Digitized Raster Graphics (ADRG) format. Overview ADRG is a standard National Imagery and Mapping Agency (NIMA) digital product designed to support applications that require a raster map background display. ADRG is a military format that conforms to the ISO 8211 standard. ADRG data is divided into geographic data sets as Distribution Rectangles (DRs). ADRG directories contain a general information file (.GEN extension) and one or more ADRG zone distribution rectangle (ZDR) image files (.IMG extension). The GEN file provides image parameters and support data for the ZDR image files associated with a DR. For each dataset, image data within a ZDR image file is returned as a single feature, since this feature will contain the entire image data of one ZDR image file. All ADRG data is assumed to be in LL84. Data in polar zones will be automatically converted to LL84, which may result in some distortion of the image. ADRG Quick Facts About Quick Facts Tables Format Type Identifier ADRG Reader/Writer Reader Licensing Level Professional Dependencies Advanced Raster Pack Dataset Type File Feature Type ADRG or Typical File Extensions .gen and .img Automated Translation Support Yes User-Defined Attributes Through TAB files Coordinate System Support Yes Generic Color Support No Spatial Index No - 141 - ARC Digitized Raster Graphics (ADRG) Reader Schema Required No Transaction Support No Encoding Support No Geometry Type Attribute adrg_type Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles no polygon yes circular arc no raster yes donut polygon yes solid no elliptical arc no surface no ellipses no text no line yes z values no none yes Band Interpretations Red8, Green8, Blue8 Palette Key Interpretations not applicable Palette Value Interpretations not applicable Nodata Value 0,0,0 Cell Origin (x, y) 0.5, 0.5 Rotation Support No GCP Support No World File Support No TAB File Support Yes Reader Overview FME considers a single ADRG general information file to be a dataset. The ADRG general information file contains the ZDR image file names. The image files are raster files containing pixel data, and each pixel in the file is a point in a single FME raster feature. ARC Digitized Raster Graphics (ADRG) Reader Parameters Dataset Parameters Group by GEN Filename The only feature type this reader will use is the reader type name, which in this case is ADRG. No (default): - 142 - FME Readers and Writers 2013 SP1 The feature type of each dataset is the filename (without the path or the extension) of the dataset. Yes: Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. FME Raster Features FME raster features represent raster data and use several concepts that are unlike those used in the handling of vector data. See About FME Rasters. ADRG only supports rasters that have a Red8 band, a Green8 band, and a Blue8 band. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see See " About Feature Attributes" on page 15), this format adds the - 143 - ARC Digitized Raster Graphics (ADRG) Reader format-specific attributes described in this section. ADRG features specify a matrix of x, y coordinates and 3-byte RGB pixels. Attribute Name Contents adrg_type This will always be adrg_raster. adrg_noz The number of zone image files. adrg_rty The record id number. adrg_prt The product type. adrg_nam The ZDR image name. adrg_zna The ARC zone number. adrg_swo The westernmost longitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. adrg_swa The southernmost latitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. adrg_neo The easternmost longitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. adrg_nea The northernmost latitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. adrg_arv The ARC value Asz (adjusted for scale and zone), which is the number of pixels per 360 degrees longitude. adrg_brv The ARC value Bs (adjected for scale), which is the number of pixels per 360 degrees latitude. adrg_lso The longitude of the upper left corner of the ZDR image in WGS 84 coordinates. adrg_pso The latitude of the upper left corner of the ZDR image in WGS 84 coordinates. adrg_txt Free text (e.g., digitizing system description). adrg_nul The row number of the upper right corner of the ZDR image (in pixels). adrg_nus The column number of the upper right corner of the ZDR image (in pixels). adrg_nll The row number of the lower left corner of the ZDR - 144 - FME Readers and Writers 2013 SP1 Attribute Name Contents image (in pixels). adrg_nls The column number of the lower left corner of the ZDR image (in pixels). adrg_nfl The image height (in tiles). adrg_nfc The image width (in tiles). adrg_pnc The number of pixels per tile row. adrg_pnl The number of rows per tile. adrg_pcb The number of bits per pixel count. adrg_pvb The number of bits per pixel value. adrg_bad The GEO DATA FILE name. adrg_ws1 The lower band edge wavelength in nanometers. adrg_ws2 The upper band edge wavelength in nanometers. adrg_tif The tile index map flag (true indicates there are tiles with no data; false indicates that all tiles contain RGB graphic data). Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. - 145 - ARC Digitized Raster Graphics (ADRG) Reader Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. Reader Directives The suffixes shown in the directives below are prefixed by the current in a mapping file. By default, the for the ADRG reader is ADRG. DATASET Required/Optional: Required The value for this directive is the name of a single ADRG general information file. The normal extension for the general information files is .gen. An example of the DATASET keyword in use is: ADRG_DATASET “C:\DATA\ADRG\AGCA0101.GEN” Workbench Parameter: Source ADRG File(s) GROUP_BY_DATASET Required/Optional: Required The value for this directive is either Yes or No. When the value is set to No, the only feature type this reader will use is the reader type name, which in this case is ADRG. 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. The default value for this directive is No. An example of the GROUP_BY_DATASET keyword in use is: GROUP_BY_DATASET “Yes” SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax - 146 - FME Readers and Writers 2013 SP1 _SEARCH_ENVELOPE 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 _SEARCH_ENVELOPE_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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope - 147 - ARC Digitized Raster Graphics (ADRG) Reader 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 - 148 - FME Readers and Writers 2013 SP1 ARC Standard Raster Product (ASRP) Reader Note: This format is not supported by FME Base Edition. This format requires the Advanced Raster Pack license. Contact Safe Software for details. The ARC Standard Raster Product (ASRP) Reader allows FME to access data in the ASRP format. Overview ASRP is a military format that conforms to the ISO 8211 standard, and its data is derived directly from ADRG. ASRP data is divided into geographic data sets as Distribution Rectangles (DRs). ASRP directories contain a general information file (.GEN extension) and one or more ASRP zone distribution rectangle (ZDR) image files (.IMG extension)). The GEN file provides image parameters and support data for the ZDR image files associated with a DR. For each dataset, image data within a ZDR image file is returned as a single feature, since this feature will contain the entire image data of one ZDR image file. All ASRP data is assumed to be in LL84. Data in polar zones will be automatically converted to LL84, which may result in some distortion of the image. ASRP Quick Facts About Quick Facts Tables Format Type Identifier ASRP Reader/Writer Reader Licensing Level Professional Dependencies Advanced Raster Pack Dataset Type File Feature Type ASRP or Typical File Extensions .gen and .img Automated Translation Support Yes User-Defined Attributes Through TAB files Coordinate System Support Yes Generic Color Support No Spatial Index No Schema Required No Transaction Support No Encoding Support No Geometry Type Attribute asrp_type - 149 - ARC Standard Raster Product (ASRP) Reader Geometry Support Geometry Supported? Geometry Supported? aggregate no point no circles no polygon no circular arc no raster yes donut polygon no solid no elliptical arc no surface no ellipses no text no line no z values no none no Band Interpretations not applicable Palette Key Interpretations UInt8 Palette Value Interpretations RGB24 Nodata Value 0,0,0 Cell Origin (x, y) 0.5, 0.5 Rotation Support No GCP Support No World File Support No TAB File Support Yes Reader Overview FME considers a single ASRP general information file to be a dataset. The ASRP general information file contains the ZDR image file names. The image files are raster files containing pixel data, and each pixel in the file is a point in a single FME raster feature. ARC Standard Raster Product (ASRP) Reader Parameters Dataset Parameters Group by GEN Filename No (default): The only feature type this reader will use is the reader type name, which in this case is ASRP. Yes: The feature type of each dataset is the filename (without the path or the extension) of the dataset. Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a - 150 - FME Readers and Writers 2013 SP1 workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. About Mapping File Directives Most mapping file directives correspond directly to a Reader or Writer parameter. To see detailed technical information for any format parameters, open the corresponding Mapping File Directives book in the table of contents. FME Raster Features FME raster features represent raster data and use several concepts that are unlike those used in the handling of vector data. See About FME Rasters. ASRP only supports rasters that have a single UInt8 band with an RGB24 palette. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. ASRP features specify a matrix of x, y coordinates and 3-byte RGB pixels. Attribute Name asrp_type Contents This will always be asrp_raster. - 151 - ARC Standard Raster Product (ASRP) Reader asrp_noz The number of zone image files. asrp_rty The record id number. asrp_prt The product type. asrp_nam The ZDR image name. asrp_zna The ARC zone number. asrp_swo The westernmost longitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. asrp_swa The southernmost latitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. asrp_neo The easternmost longitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. asrp_nea The northernmost latitude of the extent within the zone (including the overlapped region) of the unpadded cartographic image in arc degrees. asrp_arv The ARC value Asz (adjusted for scale and zone), which is the number of pixels per 360 degrees longitude. asrp_brv The ARC value Bs (adjusted for scale), which is the number of pixels per 360 degrees latitude. asrp_lso The longitude of the upper left corner of the ZDR image in WGS 84 coordinates. asrp_pso The latitude of the upper left corner of the ZDR image in WGS 84 coordinates. asrp_txt Free text (e.g., digitizing system description). asrp_nul The row number of the upper right corner of the ZDR image (in pixels). asrp_nus The column number of the upper right corner of the ZDR image (in pixels). asrp_nll The row number of the lower left corner of the ZDR image (in pixels). asrp_nls The column number of the lower left corner of the ZDR image (in pixels). asrp_nfl The image height (in tiles). - 152 - FME Readers and Writers 2013 SP1 asrp_nfc The image width (in tiles). asrp_pnc The number of pixels per tile row. asrp_pnl The number of rows per tile. asrp_pcb The number of bits per pixel count. asrp_pvb The number of bits per pixel value. asrp_bad The GEO DATA FILE name. asrp_ws1 The ON-color-code value (0 - 255) asrp_ws2 The OFF-color-code value (0 - 255) asrp_tif The tile index map flag (true indicates there are tiles with no data; false indicates that all tiles contain RGB graphic data). Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the - 153 - ARC Standard Raster Product (ASRP) Reader keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. Reader Directives The suffixes shown are prefixed by the current in a mapping file. By default, the for the ASRP reader is ASRP. DATASET Required/Optional: Required The value for this directive is the name of a single ASRP general information file. The normal extension for the general information files is .gen. An example of the DATASET directive in use is: ASRP_DATASET “C:\DATA\ASRP\AGCA0101.GEN” Workbench Parameter: Source ASRP File(s) GROUP_BY_DATASET Required/Optional: Required The value for this directive is either Yes or No. When the value is set to No, the only feature type this reader will use is the reader type name, which in this case is ASRP. 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. The default value for this directive is No. An example of the GROUP_BY_DATASET keyword in use is: GROUP_BY_DATASET “Yes” SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled. Required/Optional Optional - 154 - FME Readers and Writers 2013 SP1 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 _SEARCH_ENVELOPE_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 _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 - 155 - ARC Standard Raster Product (ASRP) Reader 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 - 156 - FME Readers and Writers 2013 SP1 ASPRS LIDAR Data Exchange Format (LAS) Reader/Writer Format Note: This format is not supported by FME Base Edition. The American Society Photogrammetry and Remote Sensing (ASPRS) LIDAR (LAS) Reader allows FME to read LIDAR (data exchange format standard) LAS specifications. Overview The LAS file is intended to contain LIDAR point records. The data will generally be put into this format from software (provided by LIDAR hardware vendors) which combines GPS, IMU, and laser pulse range data to produce X, Y, and Z point data. The intention of the data format is to provide an open format that allows different LIDAR hardware and software tools to output data in a common format. FME supports LAS versions 1.0, 1.1, and 1.2. The format contains binary data consisting of a header block, Variable Length Records (VLRs), and point data. Note: Reading and writing of arbitrary VLRs is not currently supported; only defined georeferencing information VLRs are supported. About Point Clouds A point cloud is a type of geometry that is useful for storing large amounts of data, typically gathered from LIDAR applications. The use of LIDAR allows for fast and accurate collection of data, such as for forestry canopy measurements, or landscape modeling. Point cloud geometry allows for quick and efficient processing of a large collection of vertices in 3D space that represent the external surfaces of objects. Together, these vertices form a model which can be transformed, and visualized. Some operations of the point cloud geometry involve thinning, splitting, and combining to produce a more useable set of vertices. This is an example point cloud image: - 157 - Overview Associated with each vertex are a number of properties called components, which contain a value that describes the point. These component values can be used to classify different sections of the collection of points contained in the point cloud geometry. The specific set of components stored by the point cloud is referred to as the interpretation. The default value specifies the value that will be assigned to the component when no other information is available. For example, this could occur if writing a point cloud to a format that requires a certain component to be present, but that component does not exist on the input point cloud. Default Value Interpretation Allowed Values Intensity 1.7E +/- 308 (15 digits) 0 The magnitude of the intensity of the pulse return. Color 0 to 65,535 0 The color of the object at the point, in RGB color. Classification 0 to 65,535 0 The classification value categorizes the points into fields, such as ground, building, water, etc. Returns 1-5 1 The return value is the return number from a pulse. Number of returns 1-5 1 The total number of detected returns from a single pulse. Angle -90 to 90 0 The angle of the pulse that the point was scanned at. Flight line 0 to 4,294,967,295 0 The flight line number the point was detected in. Scan Direction 0 and 1 0 The direction in which a scanning mirror was directed when the point was detected. Point ID 1 to 65,535 0 This point ID is indicative of the point origin. POSIX time 1.7E +/- 308 (15 0 Used to express the time, - 158 - Description FME Readers and Writers 2013 SP1 Interpretation Default Value Allowed Values digits) Description as the number of seconds elapsed since UTC January 1st, 1970. User data 0 to 65,535 0 The user data value is for the user to use. GPS time and GPS week GPS Week: 1.7E +/308 (15 digits) 0 Together, these two values express the time since January 6th, 1980. The GPS Week represents a week number, and the GPS time represents the number of seconds into a week. 0 The flight line edge value is a flag for points that lie on the edge of the scan, along the flight line. GPS Time: 0 to 65, 535 Flight line Edge 1 for points on the edge, 0 otherwise. LAS Quick Facts About Quick Facts Tables Format Type Identifier LAS Reader/Writer Both Licensing Level Professional Dependencies None Dataset Type Reader: File, Writer: Directory Feature Type LAS or Typical File Extensions .las .laz Automated Translation Support Yes User-Defined Attributes No Coordinate System Support Yes Generic Color Support No Spatial Index Never Schema Required Not Applicable Transaction Support No Geometry Type Attribute las_type Encoding Support No - 159 - Overview Geometry Support Geometry Supported? Geometry Supported? aggregate no point no circles no point cloud yes circular arc no polygon no donut polygon no raster no elliptical arc no solid no ellipses no surface no line no text no none no z values no Point Cloud Component Data Type Notes fmepc_angle REAL64 Range: -90 to 90 fmepc_classification UINT8 fmepc_color_r UINT16 Only supported in version 1.1+ fmepc_color_g UINT16 Only supported in version 1.1+ fmepc_color_b UINT16 Only supported in version 1.1+ fmepc_flight_line_edge UINT8 Range: 0 to 1 fmepc_flight_line not supported While not directly supported, flight line will be written as point source ID if point source ID does not exist on the point cloud. fmepc_gps_time REAL64 fmepc_gps_week not supported fmepc_intensity UINT16 fmepc_number_of_returns UINT8 Range: 1 to 5 fmepc_point_source_id UINT16 Only supported in version 1.1+ - 160 - FME Readers and Writers 2013 SP1 fmepc_posix_time not supported fmepc_return UINT8 Range: 1 to 5 fmepc_scan_direction UINT8 Range: 0 to 1 fmepc_user_data UINT8 (version 1.1+) or UINT16 (version 1.0) Reader Overview FME considers a single LAS file to be a dataset. Each dataset contains a single FME point cloud feature. ASPRS Lidar Data Exchange Format (LAS) Reader Parameters Dataset Parameters Group By Filename/Dataset If you select this option, feature types are grouped by dataset, and are named using the filename of each dataset (without the path or the extension). If you do not select this option, the only feature type this reader will use is the reader type name. Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. - 161 - Overview Writer Overview FME considers a dataset to be a directory name. The feature type of each dataset is the filename. The LAS writer distinguishes duplicate output files by appending numbers to the filenames. ASPRS Lidar Data Exchange Format (LAS) Writer Parameters ASPRS LAS Version Select the version number of ASPRS LAS from the drop-down list. Compress Files This parameter enables or disables compression when writing an LAS file. Compression significantly decreases file size; compressed files are often only 10-20% of the original size. However, compressed files take longer to read than uncompressed files. Note: This parameter applies only to machines using the Windows operating system. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. Attribute Name Contents las_type This will always be las_point_cloud. las_file_creation_date The date on which this file was created (LAS 1.1 and 1.2), or the date on which the data was collected (LAS 1.0). las_file_source_id The file source ID. A value of zero is interpreted to mean that an ID has not been assigned. las_generating_software Description of the generating software. las_gps_time_type Specifies the meaning of GPS Time in the Point Records. Only present in LAS 1.2 or later. A value of 0 indicates that GPS time in the point record fields is GPS Week Time (the same as previous versions of LAS). A value of 1 indicates that GPS Time is standard GPS Time (satellite GPS Time) minus 1 x 109. The offset moves the time back to near zero to improve floating point resolution. las_project_id A complete Globally Unique Identifier to serve as a project ID. By assigning a Project - 162 - FME Readers and Writers 2013 SP1 ID and using a File Source ID (defined above) every file within a project and every point within a file can be uniquely identified, globally. las_system_identifier A string identifying the hardware system or operation that generated the data. las_version The version of the LAS file. las_vertical_coordsys_code The GeoTIFF code identifying the vertical coordinate system. las_vertical_datum_code The GeoTIFF code identifying the vertical datum. las_vertical_units_code The GeoTIFF code identifying the units of the vertical coordinate system. Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. - 163 - Overview Reader Directives The directives listed below are processed by the LAS reader. The suffixes shown are prefixed by the current in a mapping file. By default, the for the LAS reader is LAS. DATASET The value for this directive is the LAS file to be read. Required/Optional Required Mapping File Syntax LAS_DATASET /usr/data/test.las Workbench Parameter Source ASPRS LAS File(s) GROUP_BY_DATASET The value for this directive can be either Yes or No. When the value is set to No, the only feature type this reader will use is the reader type name, which in this case is LAS. 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. The default value for this directive is No. Required/Optional Required Mapping File Syntax LAS_DATASET /usr/data/test.las Workbench Parameter Source ASPRS LAS File(s) SEARCH_ENVELOPE This directive specifies a bounding box used to filter the input features. Only features that interact with the bounding box are returned. If this directive is not specified, then all features are returned.This directive is only honoured by the MITAB-based MapInfo reader in FME. This is the only MapInfo reader available on the UNIX platforms supported by FME, and can optionally be enabled on Windows platforms by renaming the mitab.dll in the FME home directory to mapinfo.dll. Mapping File Syntax _SEARCH_ENVELOPE - 164 - FME Readers and Writers 2013 SP1 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 _SEARCH_ENVELOPE_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 _CLIP_TO_ENVELOPE [yes | no] Workbench Parameter Clip To Envelope - 165 - Overview 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 Writer Directives The directives listed below are processed by the LAS writer. The suffixes shown are prefixed by the current in a mapping file. By default, the for the LAS writer is LAS. DATASET The value for this directive is the path of the output directory where the data will be written.. Required/Optional Required Mapping File Syntax LAS_DATASET /usr/data/ Workbench Parameter Destination ASPRS LAS Directory VERSION The version of the LAS file to be written. - 166 - FME Readers and Writers 2013 SP1 Required/Optional Optional Values 1.0 | 1.1 | 1.2 (default) Mapping File Syntax LAS_DATASET VERSION 1.1 Workbench Parameter ASPRS LAS Version ARCGIS_LAS_DATASET This directive identifies the name of the Esri ArcGIS LAS Dataset file to create. The .lasd file produced using this directive will reference all the LAS files created by the FME LAS Writer during the translation. An .lasd file is required to work with LAS files in the Esri ArcGIS environment. By default, the .lasd file will be written to the same directory as the .las files to which it refers. To write the .lasd to a different directory, use a fully qualified path. This directive applies to machines using the Windows operating system. Note that this option is currently incompatible with compression. When writing compressed LAS files, a .lasd file will not be generated. Note: To use this directive, you must install and license both ArcGIS 10.1 (or newer) and the 3D Analyst extension. Required/Optional Optional Values Mapping File Syntax LAS_ARCGIS_LAS_DATASET terrain.lasd Workbench Parameter ArcGIS LAS Dataset (.lasd) COMPUTE_STATISTICS_ON_ARCGIS_LAS_DATASET This directive is applicable when an ArcGIS LAS Dataset is written. It determines whether to calculate statistics for the LAS files referenced by the ArcGIS LAS Dataset. Required/Optional Optional - 167 - Overview Values Yes | No (default) Mapping File Syntax LAS_COMPUTE_STATISTICS_ON_ARCGIS_LAS_DATASET Yes Workbench Parameter Compute Statistics on ArcGIS LAS Dataset USE_RELATIVE_PATHS_IN_ARCGIS_LAS_DATASET This directive is applicable when an ArcGIS LAS Dataset is written. It determines whether the references to the LAS files within the ArcGIS LAS Dataset are stored using relative or absolute path names. Use relative paths when the LAS files referenced by the ArcGIS LAS Dataset will be moved from their original location (for example, moved to a server). Required/Optional Optional Values Yes (default) | No Mapping File Syntax LAS_USE_RELATIVE_PATHS_IN_ARCGIS_LAS_DATASET No Workbench Parameter Use Relative Paths in ArcGIS LAS Dataset COMPRESSION Enables or disables compression when writing an LAS file. Compression will significantly decrease file size: compressed files are often only 10-20% of the original size. However, compressed files take longer to read than uncompressed files. This directive applies to machines using the Windows operating system. Required/Optional Optional Values Yes | No (default) Mapping File Syntax LAS_COMPRESSION YES - 168 - FME Readers and Writers 2013 SP1 Workbench Parameter Compress Files RESCALE_COORDINATES The LAS format stores coordinates as int32 values with a scale and offset factor. Since FME stores coordinates as real64 values, there is no guarantee that LAS will be able to store the coordinate data as is. To resolve this, the LAS writer will rescale coordinates to span the int32 range (2147483647 to 2147483647) and calculate a new scale and offset factor to preserve the original coordinate values as closely as possible. However, this rescaling may slightly distort some coordinates if they were already safely storable as int32. To disable this rescaling, set this option to No. Required/Optional Optional Values Yes (default) | No Mapping File Syntax RESCALE_COORDINATES YES Workbench Parameter Re-scale Coordinates ASTM E57 Reader Writer Format Note: This format is not supported by FME Base Edition. The ASTM E57 Reader/Writer allows FME to access data in the E57 format. Overview The E57 file format is a compact, vendor-neutral format for storing point clouds, images, and metadata produced by 3D imaging systems, such as laser scanners. A single E57 file may contain any number of point clouds and rasters. E57 files are structured as a tree. A path is a string that specifies the sequence of element names when traversing the tree. Point cloud data is read from path /data3D. Raster data is read from path /images2D. An E57 file may contain attributes and geometry traits. Elements at the root of the tree are treated as attributes, e.g. /guid. Elements within a geometry node will be treated as geometry traits, e.g. /data3D/0/points/guid. - 169 - ASTM E57 Reader Writer Note: All features will share the same attributes, but traits will differ per feature. Point Cloud Each point cloud may contain an arbitrary set of components, and each component may have an arbitrary data type. A mapping between E57 element and FME component may be specified through the COMPONENT_MAP directive. For example, /data3D/0/points/colorRed could be mapped to FME component fmepc_color_r. The following is the set of standard E57 component names, and the corresponding default FME component name: E57 Element FME Component cartesianX fmepc_x cartesianY fmepc_y cartesianZ fmepc_z sphericalRange sphericalAzimuth sphericalElevation rowIndex columnIndex returnCount returnIndex fmepc_return timeStamp fmepc_gps_time intensity fmepc_intensity colorRed fmepc_color_r colorGreen fmepc_color_g colorBlue fmepc_color_b cartesianInvalidState sphericalInvalidState isTimeStampInvalid isIntensityInvalid Point clouds in E57 may have either Cartesian coordinates or spherical coordinates. If a dataset only contains spherical coordinates, the cartesianX, cartesianY, and cartesianZ elements may still be selected as part of the component map, in which case the spherical values will be converted to Cartesian values. - 170 - FME Readers and Writers 2013 SP1 Raster Each image node, e.g. /images2D/0/, contains a raster. These images may be stored as one of four representations: visualReferenceRepresentation, pinholeRepresentation, sphericalRepresentation, or cylindricalRepresentation. The representation type controls which additional properties are stored (see the Feature Representation section for more details). Note: One image node may actually contain two rasters: one of the set {  pinholeRepresentation, sphericalRepresentation, or cylindricalRepresentation}, and one visualReferenceRepresentation node. In this case, the reader will produce an aggregate geometry that holds both rasters. Similarly, the writer can ingest aggregates of two rasters. Note: Raster data is stored within an E57 file as PNG or JPEG blobs. An image mask may optionally be stored separately from the image data. When reading, FME will combine the image mask and data into a single raster. Additional Notes E57 elements that that are not part of the set (i.e. user attributes, traits, or components not in the table above) should be stored in "Extensions." Each extension in a file shall be defined by a prefix and namespace. Extensions are controlled in FME through the e57_extensions{}.prefix and e57_extensions{}.uri format attributes. On reading, these attributes specify the extensions in the source dataset. On writing, these attributes may be used to define extensions. User attributes, traits, and components should be stored in extensions to ensure compatibility with other E57 readers. So for example, instead of writing a user attribute called "myAttr", one might would write a user attribute called "ext:myAttr", and define the "ext" extension through the e57_extensions{}.prefix and e57_extensions{}.uri format attributes. E57 Quick Facts Format Type Identifier E57 Reader/Writer Both Licensing Level Professional Dependencies Reader: None Writer: None Dataset Type Reader: File Writer: Directory Feature Type [_][_ ] - 171 - ASTM E57 Reader Writer Typical File Extensions .e57 Automated Translation Support Yes User-Defined Attributes Yes Coordinate System Support Yes Generic Color Support No Spatial Index No Schema Required No Transaction Support No Encoding Support UTF8 Geometry Type e57_type Band Interpretations PNG: Red8, Red16, Green8, Green16, Blue8, Blue16, Alpha8, Alpha16, Gray8, Gray16 JPEG: Red8, Green8, Blue8, Gray8 Palette Key Interpretations PNG: UInt8 JPEG: N/A Palette Value Interpretations PNG: RGB24 JPEG: N/A Nodata Value PNG: Any JPEG: N/A Cell Origin (x, y) 0.5, 0.5 Rotation Support No GCP Support No World File Support No TAB File Support No Geometry Supported? Geometry Supported? aggregate no point no circles no polygon no - 172 - FME Readers and Writers 2013 SP1 Geometry Supported? Geometry Supported? circular arc no raster yes donut polygon no solid no elliptical arc no surface no ellipses no text no line no z values yes None no point cloud yes Point Cloud Component Data Type fmepc_angle arbitrary fmepc_classification arbitrary fmepc_color_r arbitrary fmepc_color_g arbitrary fmepc_color_b arbitrary fmepc_flight_line_edge arbitrary fmepc_flight_line arbitrary fmepc_gps_time arbitrary fmepc_gps_week arbitrary fmepc_intensity arbitrary fmepc_number_of_returns arbitrary fmepc_point_source_id arbitrary fmepc_posix_time arbitrary fmepc_return arbitrary fmepc_scan_direction arbitrary fmepc_user_data arbitrary Notes Reader Overview FME considers a single E57 file to be a dataset. Each dataset contains one or more point cloud and raster features. ASTM E57 Reader Parameters Dataset Parameters Group By Filename/Dataset - 173 - ASTM E57 Reader Writer If you select this option, feature types are grouped by dataset, and are named using the filename of each dataset (without the path or the extension). If you do not select this option, the only feature type this reader will use is the reader type name. Group By Subdataset If you select this option, feature types are grouped by subdataset, and are named using the subdataset name. If you do not select this option, the only feature type this reader will use is the reader type name. If both Group by Filename and Group by Subdataset are specified, feature type names are in the format filename_subdatasetname. Point Cloud Component Mapping Click here Use this matrix to map E57 element names to FME point cloud components. Each FME component that is mapped will appear in the point cloud geometry. Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. - 174 - FME Readers and Writers 2013 SP1 Writer Overview FME considers a dataset to be a directory name. The feature type of each dataset is the filename. ASTM E57 Writer Parameters Point Cloud Component Mapping Use this matrix to map FME point cloud components to E57 element names. Raster Default Raster Format Specifies the underlying format to which rasters are written. Feature Representation In addition to the generic FME feature attributes that FME Workbench adds to all features (see About Feature Attributes), this format adds the format-specific attributes described in this section. Attribute Name Contents e57_type This will always be e57_point_cloud. e57_creation_datetime Date and time that the file was created. e57_creation_datetime_ isatomicclockreferenced This attribute will be present with a value of 1 if, and only if, the time stored in e57_creation_ datetime is obtained from an atomic clock time source. Shall be either 0 or 1. e57_extensions{}.prefix A list of extension prefixes. e57_extensions{}.uri A list of the URI for each extension. e57_format_name Name of the format. Shall contain the string "ASTM E57 3D Imaging Data File". This is a reader attribute. e57_guid A globally unique identification (GUID) String for the current version of the file. e57_library_version The version identifier for the E57 file format library that wrote the file. e57_geometry_index The index of this point cloud or raster in the file. e57_version_major The major version number of the file format. This is a reader attribute. e57_version_minor The minor version number of the file format. - 175 - ASTM E57 Reader Writer Attribute Name Contents This is a reader attribute. This format adds the following format-specific traits for point cloud geometries. Trait Name Contents e57_acquisition_start The start date and time that the data was acquired. e57_acquisition_start_ isatomicclockreferenced This attribute will be present with a value of 1 if, and only if, the time stored in e57_acquisition_start is obtained from an atomic clock time source. Shall be either 0 or 1. e57_acquisition_end The end date and time that the data was acquired. e57_acquisition_end_ isatomicclockreferenced This attribute will be present with a value of 1 if, and only if, the time stored in e57_acquisition_end is obtained from an atomic clock time source. Shall be either 0 or 1. e57_atmospheric_pressure The atmospheric pressure, measured at the sensor, at the time of data collection (in Pascals). e57_description A description of the point cloud. e57_guid A globally unique identifier for the current version of the point cloud. e57_original_guids{} A list of of globally unique identifiers identifying the data set (or sets) from which the points in this point cloud originated. e57_relative_humidity The percentage relative humidity, measured at the sensor, at the time of data collection. e57_sensor_hardware_version The version identifier for the sensor hardware at the time of data collection. e57_sensor_model The model name or number for the sensor used to collect the points in this point cloud. e57_sensor_serial_number The serial number for the sensor used to collect the points in this point cloud. e57_sensor_software_version The version identifier for the software used for the data collection. e57_sensor_vendor The name of the manufacturer for the sensor used to collect the points in this point cloud. e57_temperature The ambient temperature, measured at the sensor, at the time of data collection (in degrees Celsius). This format adds the following format-specific traits for raster geometries. - 176 - FME Readers and Writers 2013 SP1 Trait Name Contents e57_acquisition_datetime The date and time that the image was acquired. e57_acquisition_datetime_ isatomicclockreferenced This attribute will be present with a value of 1 if, and only if, the time stored in e57_acquisition_datetime is obtained from an atomic clock time source. Shall be either 0 or 1. e57_associated_pointcloud_ The globally unique identifier for the point cloud object guid that was being acquired when the picture was taken. e57_description A user-defined description for the image. e57_image_representation The representation of the image. Values are visualReferenceRepresentation, pinholeRepresentation, sphericalRepresentation, and cylindricalRepresentation. e57_raster_format The underlying format in which the raster is stored. Either PNGRASTER or JPEG. e57_rotation_w The scalar part of the rotation quaternion. e57_rotation_x The i coefficient of the rotation quaternion. e57_rotation_y The j coefficient of the rotation quaternion. e57_rotation_z The k coefficient of the rotation quaternion. e57_sensor_model The model name or number for the sensor. e57_sensor_serial_number The serial number for the sensor. e57_sensor_vendor The name of the manufacturer for the sensor used to collect the image. e57_separate_image_mask Whether the image mask (alpha band) is stored in a separate blob from the data. This format adds the following format-specific traits for raster geometries with an image representation of pinholeRepresentation: Trait Name Contents e57_focal_length The camera’s focal length (in meters). e57_pixel_height The height of the pixels in the camera (in meters). e57_pixel_width The width of the pixels in the camera (in meters). e57_principal_point_x The X coordinate in the image of the principal point, (in pixels). The principal point is the intersection of the z axis of the camera. e57_principal_point_y The Y coordinate in the image of the principal point (in pixels). - 177 - ASTM E57 Reader Writer This format adds the following format-specific traits for raster geometries with an image representation of sphericalRepresentation: Trait Name Contents e57_pixel_height The width of a pixel in the image (in radians). e57_pixel_width The height of a pixel in the image (in radians). This format adds the following format-specific traits for raster geometries with an image representation of cylindricalRepresentation: Trait Name Contents e57_pixel_height The height of a pixel in the image (in meters). e57_pixel_width The width of a pixel in the image (in radians). e57_principal_point_y The Y coordinate in the image of the principal point (in pixels). This is the intersection of the z = 0 plane with the image. e57_radius The closest distance from the cylindrical image surface to the center of projection (that is, the radius of the cylinder) (in meters). Format Mapping File Directives Note: FME translations were originally based entirely on Mapping Files. Mapping files still exist under the surface but the interface has been almost entirely replaced by Workbench's graphical interface. Information on mapping files is included in this manual for technical reference purposes. Mapping Files are ASCII text files that contain a series of rules that specify the FME readers, writers, and transformations (in Workbench, these are represented by transformers). A mapping file (.fme) is a series of commands for FME to perform. Mapping files use functions and factories to transform the data. They also contain the definition and parameters for the readers and writers. A mapping file can be run through the FME Quick Translator. Before FME Workbench was designed and developed (about 2001), this was the only way to configure a translation process. You can create a mapping file either by manually programming it or by using FME Workbench. In Workbench, there is still an Export as .fme tool on the toolbar. The Workbench file format itself (.fmw file) is partially a mapping file with an XML header. When FME runs a workspace it is converted into a mapping file. Since mapping files are written in a plain ASCII format, so you can use any text editor to edit them. To see what a mapping file looks like: select one or more transformers in Workbench, copy them, and then paste them in a text editor. The mapping file equivalent of those transformers will be pasted. - 178 - FME Readers and Writers 2013 SP1 Directives and Reader/Writer Keywords Directives are processed by the reader or writer. Directives are prefixed by the current or in a mapping file. By default, the keywords for formats are the format shortname (viewable in the Formats Gallery, or in the Format Quick Facts tables. WriterDirectives The suffixes shown are prefixed by the current in a mapping file. By default, the for the ASTM E57 writer is E57. DATASET The path of the output directory where the data will be written. Required/Optional Required Mapping File Syntax E57_DATASET C:\data\ Workbench Parameter Destination ASTM E57 Directory COMPONENT_MAP This directive maps each E57 element names to FME point cloud components. Values + Required/Optional Required Workbench Parameter Component Mapping DEFAULT_RASTER_FORMAT This directive sets the underlying format to which rasters will be written. This may be overridden at the geometry level by setting the e57_raster_format trait. Values PNGRASTER , JPEG Required/Optional Optional - 179 - ASTM E57 Reader Writer Workbench Parameter Default Raster Format WRITE_INTEGER_COORDINATES This directive specifies whether coordinates should be written as integers instead of floating point values. Writing integer coordinates will produce smaller files, but values may be less accurate. Note that this affects all E57 elements that are mapped from fmepc_x, fmepc_y, or fmepc_z. It will not affect any elements mapped from other FME components. For example, if this option was set to Yes and fmepc_intensity was mapped to cartesianX, cartesianX would still be written as floating point. Values YES | NO Required/Optional Optional Workbench Parameter Write Integer Coordinates - 180 - FME Readers and Writers 2013 SP1 Australian Asset Design & As Constructed (ADAC) XML Reader/Writer Format Note: This format is not supported by FME Base Edition. The ADAC XML format is developed by the Asset Design & As Constructed (ADAC) consortium. This reader/writer supports the ADAC XML version 3.0.1 and 4.0.0. Further information on ADAC can be found at http://www.adac.com.au. Overview An ADAC XML document consists of a root ADAC element containing various data structures from civil engineering assets. ADAC v3 defines the following asset themes: l Sewerage l Roads l Water l Stormwater l Cadastre For backwards compatibility, the interpretation/mapping of the ADAC v3 assets remains unchanged. ADAC v4 defines the following asset themes: l Sewerage l Transport l WaterSupply l StormWater l OpenSpace l Cadastre l Surface l Enhancements l Supplementary ADAC Quick Facts About Quick Facts Tables Format Type Identifier ADAC - 181 - Australian Asset Design & As Constructed (ADAC) XML Reader/Writer Reader/Writer Both Licensing Level Professional Dependencies None Dataset Type File Feature Type The ADAC asset structures Typical File Extensions .xml Automated Translation Support Yes User-Defined Attributes No Coordinate System Support Yes Generic Color Support No Spatial Index Never Schema Required No Transaction Support No Geometry Type xml_type Geometry Support Geometry Supported? Geometry Supported? aggregate yes point yes circles yes polygon yes circular arc yes raster no donut polygon yes solid no elliptical arc yes surface no ellipses yes text yes line yes z values yes none yes Reader Overview The ADAC reader creates FME features from the various ADAC asset structures. The reader now supports ADAC v4. The asset structures in v4 are mapped differently from the ADAC v3. See the Feature Representation section for details. Coordinate Systems FME ADAC features are tagged with a coordinate system when the reader finds a mapping between the name specified in the ADAC element and an FME coordinate system name. The ADAC - 182 - FME Readers and Writers 2013 SP1 is a child of the element which is a child of the ADAC element. Australian Asset Design and As-Constructed (ADAC) Reader Parameters Schema Attributes Additional Attributes to Expose This parameter exposes Format Attributes in Workbench when you create a workspace: l l In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime. In a non-dynamic scenario where you have multiple feature types, it is convenient to expose additional attributes from one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace. Search Envelope Use 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. Clip to Search Envelope Check this box if you want to remove any portions of exported features outside the area of interest. Writer Overview The ADAC writer generates ADAC v4 XML files. The writer has fixed feature types, which are the same as the schema used by the ADAC v4 reader. See the Feature Representation section for details on the writer feature types. Feature Representation ADAC v3 The ADAC XML reader recognizes the following ADAC v 3.0.1 asset structures: l l Sewerage asset: Manhole, PipeNonPressure, PipePressure, Valve, Fitting, House_Connection. Roads asset: Pavement, Parking, RoadEdge, RoadIsland, RoadPathway, PramRamp, RoadSubsoilDrain. - 183 - Australian Asset Design & As Constructed (ADAC) XML Reader/Writer l Water asset: Pipe, Valve, Hydrant, Meter, Fittings, Maintenance_Hole. l Stormwater asset: ManholePit, EndStructure, Pipe, SurfaceDrainage. l Cadastre asset: LandParcel. l OtherData asset: Object. The feature type names for ADAC FME features closely resemble the naming for the ADAC v3 XML document. Feature type names are whitespace separated combinations of theme and asset structure names. For example, “Sewerage Valve”, “Water Valve”, “Stormwater Pipe”, and “Cadastre LandParcel”. Attribute names also closely resemble their XML counterpart. The non-geometrical, non-repeating, and non-nested child elements, i.e., the simple type elements whose maxOccurs is 1, of an asset structure are mapped with their names unchanged. For example, the simple type child element of the element is mapped as the “OutletType” attribute of the “Stormwater ManholePit” feature. Non-geometrical nested child elements, i.e., the complex type elements, of an asset are mapped as whitespace separated combinations of child and descendant elements. For example, the complex type child element of the element creates the following FME attributes in a “Stormwater ManholePit” feature: “ChamberSize Blankend”, “ChamberSize PS”, “ChamberSize Rectangular” and “ChamberSize Circular”. Most non-geometrical child elements in an asset structure are non-repeating, these are mapped as simple, atomic FME attribute values. Repeating non-geometrical child elements, i.e., those with maxOccurs greater than 1 or unbounded, such as the element, are mapped as CSV values. The geometry for a feature is mapped from the various ADAC geometry elements. Some ADAC asset structures, such as the “RoadSubsoilDrain”, may have more than one geometry, these are mapped as aggregates. Two special FME geometry traits are assigned to the geometries to help identify their original ADAC role. The “adac_ geometry” trait identifies the original ADAC XML geometry element, while the “adac_ geometry_parent” trait identifies the geometry’s parent. Data not explicitly defined in the ADAC schema is supported in the ADAC XML via the “OtherData” asset model. This asset model element can contain one or more child elements, and each can contain one or more