FME Transformers: 2024.1

Categories
Filters and Joins

Filters and Joins

Spatial Analysis

Spatial Analysis

Related Transformers
AreaOnAreaOverlayer
Bufferer
Clipper
Intersector
LineOnLineOverlayer
NeighborFinder
PointOnAreaOverlayer
PointOnLineOverlayer
PointOnPointOverlayer
SpatialFilter
SpatialRelator
TopologyBuilder
Categories
Filters and Joins

Filters and Joins

Spatial Analysis

Spatial Analysis

Related Transformers
AreaOnAreaOverlayer
Bufferer
Clipper
Intersector
LineOnLineOverlayer
NeighborFinder
PointOnAreaOverlayer
PointOnLineOverlayer
PointOnPointOverlayer
SpatialFilter
SpatialRelator
TopologyBuilder

LineOnAreaOverlayer

Performs a line-on-area overlay, either splitting lines where they intersect area boundaries or subdividing areas where split by lines. Attributes may be shared between related lines and areas (spatial join).

Jump to Configuration

Typical Uses

  • Splitting lines where they cross the boundary of a polygon
  • Splitting polygons where crossed by lines
  • Identifying which polygons contain or intersect lines
  • Identifying lines that intersect or fall within areas

How does it work?

The LineOnAreaOverlayer compares lines and polygons, splitting geometry where they intersect.

It has two modes:

  • Split Lines With Areas: Lines are split where they intersect with a polygon boundary. Each resulting piece may receive the attributes of the area(s) it is contained in, and each containing area may receive the attributes of the line(s) that either fall within or intersect it (a spatial join). Features also receive a count of the number of overlaps encountered.

  • Split Areas With Lines: Areas are subdivided where they are split by lines or sets of lines. Only lines that split areas are considered for attribute merging and overlap counts.

Aggregates can either be deaggregated before processing or rejected.

Examples

In this example, we perform an overlay of bike path lines on neighborhood polygons. The source data looks like this, where the highlighted line is a bike path line feature that crosses from one neighborhood to another.

We want to accomplish two tasks in this example:

  • splitting the lines where they intersect with a neighborhood boundary
  • assigning new attributes (perform a spatial join)
    • add the neighborhood attributes to the bike path
    • add all of the contained bike path names to the neighborhood polygon as a list attribute

In the workspace, the bike paths are connected to the Line input port, and the neighborhoods are connected to the Area input port.

In the LineOnAreaOverlayer parameters dialog, we make the following selections:

  • Mode: Split Lines With Areas
  • Attribute Accumulation: Merge Incoming (this is the default). This will merge the attributes from the features on to each other, which will add the neighborhood information to the segmented bike paths. However, it does not add multiple attribute values, and so we also:
  • (Optional) Generate List On Output ‘Area’: This creates a list attribute on the output areas. By choosing Selected Attributes, and then PathName, only the bike path names will be added.

Viewing the output, we can see that the selected bike path has been split where it crosses the neighborhood boundary, and the neighborhood attributes for Mount Pleasant have been added to it.

The containing neighborhood encountered 18 overlaps, and now has a list attribute containing the bike path names.

In this example, we have a single polygon covering the extent of Stanley Park.

The park is crossed by numerous roads and pathways, and we want to divide the park polygon into pieces based on these lines.

Both the park and the roads are routed into a LineOnAreaOverlayer.

In the parameters dialog, Mode is set to Split Areas With Lines.

The lines are output unchanged, and the park polygon has been subdivided into smaller areas where the roads and paths cross it.

Usage Notes

Choosing a Spatial Transformer

Many transformers can assess spatial relationships and perform spatial joins - analyzing topology, merging attributes, and sometimes modifying geometry. Generally, choosing the one that is most specific to the task you need to accomplish will provide the optimal performance results. If there is more than one way to do it (which is frequently the case), time spent on performance testing alternate methods may be worthwhile.

To correctly analyze spatial relationships, all features should be in the same coordinate system. The Reprojector may be useful for reprojecting features within the workspace.

Transformer

Can Merge Attributes

Alters Geometry

Counts Related Features

Creates List

Supported Types*

Recommended For
SpatialFilter Yes No No No
  • Point
  • Text
  • Curve
  • Area
  • Testing for the existence of spatial relationships between two sets of features, and routing them according to whether they pass or fail the test(s).
SpatialRelator Yes No Yes Yes
  • Point
  • Text
  • Curve
  • Area
  • Identifying the nature of spatial relationships between two sets of features.
AreaOnAreaOverlayer Yes Yes Yes Yes
  • Area
  • Finding polygon overlaps and extracting them into new geometry.
LineOnAreaOverlayer Yes Yes Yes Yes
  • Curve and Area
  • Finding intersections between lines and polygons, splitting either where they intersect.
LineOnLineOverlayer Yes Yes Yes Yes
  • Curve
  • Finding intersections between line features, splitting them, and generating new line geometry as well as points representing the intersections.
PointOnAreaOverlayer Yes No Yes Yes
  • Point and Area
  • Text and Area
  • Identifying points that fall within polygons, and merging attributes between them
PointOnLineOverlayer Yes Yes Yes Yes
  • Point and Curve
  • Text and Curve
  • Identifying where points fall on lines, and splitting the lines into new geometry.
PointOnPointOverlayer Yes No Yes Yes
  • Point
  • Text
  • Identifying points in the same location (within a tolerance), and merging attributes between them.
Intersector Yes Yes Yes Yes
  • Point
  • Text
  • Curve
  • Area
  • Finding intersections between all input features, regardless of geometry (including self-intersections), splitting features, and creating new geometry.
Clipper Yes Yes No No
  • Point
  • Text
  • Curve
  • Area
  • Surface
  • Solids
  • Raster
  • Point Cloud
  • Comparing features against a set of Clipper features, and splitting the features at or along the Clipper boundaries. Outputs both new and untouched geometry, identified as either Inside or Outside the Clipper.
NeighborFinder Yes In some cases No Yes
  • Point
  • Text
  • Curve
  • Area
  • Identifying the nearest other feature(s) to each feature being considered, either in another set of features or within the same feature set.
TopologyBuilder Yes Yes No Yes
  • Point
  • Text
  • Curve
  • Area
  • Analyzing spatial relationships between features to compute topology, splitting features and creating new geometry representing topologically significant nodes, edges, and faces, with associated attributes.

* Note that Curve includes Lines, Arcs, and Paths. Area includes Polygons, Donuts, and Ellipses.

Spatial analysis can be processing-intensive, particularly when a large number of features are involved. If you would like to tune the performance of your workspace, this is a good place to start.

When there are multiple ways to configure a workspace to reach the same goal, it is often best to choose the transformer most specifically suited to your task.

If performance is an issue in your workspace, look for alternative methods, guided by geometry.

Configuration

Input Ports

Curve features against which the areas will be compared.

Area features against which the curves will be compared.

Output Ports

When Mode is Split Lines With Areas, line features which have been split at area boundaries, with attributes added as specified in parameters.

When Mode is Split Areas With Lines, line geometry is unmodified.

When Mode is Split Lines With Areas, area features, with attributes added according to transformer parameter configuration. Geometry is unmodified.

When Mode is Split Areas With Lines, subdivided areas with attributes added as specified in parameters. Areas not split by Line features are passed through unchanged.

If a tolerance is specified, line features which were smaller than the tolerance value collapse to a point and are output to this port.

All non-curve features input to the Line input port and all non-area features input to the Area input port are output to this port.

Rejected features will have an fme_rejection_code attribute with one of the following values:

INVALID_LINE_GEOMETRY_TYPE
INVALID_LINE_GEOMETRY_VERTICES
INVALID_GEOMETRY_DEGENERATE
INVALID_POLYGON_GEOMETRY_TYPE
INVALID_POLYGON_GEOMETRY_VERTICES
INVALID_POLYGON_GEOMETRY_DEGENERATE
INVALID_GEOMETRY_NOT_FINITE

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

Group By

The default behavior is to use the entire set of features as the group. This option allows you to select attributes that define which groups to form.

Complete Groups

Select the point in processing at which groups are processed:

When All Features Received

This is the default behavior. Processing will only occur in this transformer once all input is present.

When Group Changes (Advanced)

This transformer will process input groups in order. Changes of the value of the Group By parameter on the input stream will trigger processing on the currently accumulating group. This may improve overall speed (particularly with multiple, equally-sized groups), but could cause undesired behavior if input groups are not truly ordered.

There are two typical reasons for using When Group Changes (Advanced) . The first is incoming data that is intended to be processed in groups (and is already so ordered). In this case, the structure dictates Group By usage - not performance considerations.

The second possible reason is potential performance gains.

Performance gains are most likely when the data is already sorted (or read using a SQL ORDER BY statement) since less work is required of FME. If the data needs ordering, it can be sorted in the workspace (though the added processing overhead may negate any gains).

Sorting becomes more difficult according to the number of data streams. Multiple streams of data could be almost impossible to sort into the correct order, since all features matching a Group By value need to arrive before any features (of any feature type or dataset) belonging to the next group. In this case, using Group By with When All Features Received may be the equivalent and simpler approach.

Note  Multiple feature types and features from multiple datasets will not generally naturally occur in the correct order.

As with many scenarios, testing different approaches in your workspace with your data is the only definitive way to identify performance gains.

Mode

Split Lines With Areas: Default. Each input line is split at any area boundaries it intersects, and attributes may be shared between related lines and areas (spatial join).

Split Areas With Lines: Each input area is split wherever it is subdivided by line input. Attributes may be shared between areas and their splitting lines (spatial join).

Tolerance

The minimum distance between geometries in 2D before they are considered equal, in ground units. If the tolerance is None, the geometries must be exactly identical to be considered equal. If the tolerance is Automatic, a tolerance will be automatically computed based on the location of the input geometries. Additionally, a custom tolerance may be used.

See Geometry Concepts > Tolerance.

Aggregate Handling

Choose how aggregate geometries are to be handled.

Deaggregate: Decompose aggregates into their individual components. With this setting, the transformer might output more features than were given as inputs.

Reject: Do not process aggregates and output them via the <Rejected> port.

Overlap Count

Split Lines With Areas: The Overlap Count Attribute added to output linear features holds the number of area features that they were inside of. The Overlap Count Attribute added to output area features holds the number of linear features that they contained.

Split Areas With Lines: The Overlap Count Attribute added to output linear features holds the number of area features that they bisected. The Overlap Count Attribute added to output area features holds the number of linear features by which they were bisected. Note that lines may intersect areas without bisecting them, and that these interactions are not recorded in this mode.

If attributes on the incoming and original feature share the same name, but are not geometry attributes that start with fme_, then they are deemed conflicted.

Accumulation Mode

Merge Incoming: The original feature will retain all of its own un-conflicted attributes, and will additionally acquire any un-conflicted attributes that the incoming feature has. This mode will handle conflicted attributes based on the Conflict Resolution parameter.

Prefix Incoming: The original feature will retain all of its own attributes. In addition, the original will acquire attributes reflecting the incoming feature’s attributes, with the name prefixed with the Prefix parameter.

Replace with Single Incoming: The original feature will have all of its attributes removed, except geometry attributes that start with fme_. Then, all of the attributes from one (arbitrary) incoming feature will be placed onto the original.

Conflict Resolution

Use Original: If a conflict occurs, the original values will be maintained.

Use Incoming: If a conflict occurs, the values of the incoming will be transferred onto the original.

Prefix

If the Accumulation Mode parameter is set to Prefix Incoming, this value will prefix attributes that are being added to the original feature from the incoming feature.

 

Generate List on Output ‘Line’

When enabled, adds a list attribute to the Line output features, and the attributes of each area containing (or split by) an output line are added to that line's list.

Note that no intersections between area features are computed.

‘Line’ List Name

Enter a name for the list attribute.

Note  List attributes are not accessible from the output schema in FME Workbench unless they are first processed using a transformer that operates on them, such as ListExploder or ListConcatenator. Alternatively, AttributeExposer can be used.

Add To 'Line' List

All Attributes: All attributes will be added to the output Line features.

Selected Attributes: Enables the Selected Attributes parameter, where specific attributes may be chosen for inclusion.

Selected Attributes

Enabled when Add To List is set to Selected Attributes. Specify the attributes you wish to be included.

 

Generate List on Output ‘Area’

When enabled, adds a list attribute to the Area output features, and the attributes of each line contained by (or that split) an output area are added to that area's list.

Note that no intersections between area features are computed.

‘Area’ List Name

Enter a name for the list attribute.

Note  List attributes are not accessible from the output schema in FME Workbench unless they are first processed using a transformer that operates on them, such as ListExploder or ListConcatenator. Alternatively, AttributeExposer can be used.

Add To 'Area' List

All Attributes: All attributes will be added to the output Area features.

Selected Attributes: Enables the Selected Attributes parameter, where specific attributes may be chosen for inclusion.

Selected Attributes

Enabled when Add To List is set to Selected Attributes. Specify the attributes you wish to be included.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior

Group-Based

Feature Holding

Yes
Dependencies  
Aliases  
History  

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for all results about the LineOnAreaOverlayer on the FME Community.

 

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.