FME Transformers: 2024.1

Categories
Filters and Joins

Filters and Joins

Spatial Analysis

Spatial Analysis

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

Filters and Joins

Spatial Analysis

Spatial Analysis

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

PointOnAreaOverlayer

Performs a Point in Polygon overlay. Points may receive containing area attributes, and areas may receive contained point attributes (spatial join).

Jump to Configuration

Typical Uses

  • Finding which areas that points fall inside
  • Finding which and how many points are contained within areas

How does it work?

The PointOnAreaOverlayer compares points and polygons. Each point may receive the attributes of the area(s) it is contained in, and each containing area may receive the attributes of each point it contains.

Intersections between area features are not computed. FME considers points on the boundary of an area as “in”, and so if a point falls exactly on the line between two polygons, it will be considered "in" both areas.

Aggregates can either be deaggregated before processing or rejected.

Examples

In this example, we have a point dataset of food vendors and a set of polygons representing neighborhoods.

To find which neighborhood a vendor is in, we connect the food vendor points to the Point input port, and the neighborhoods to the Area input port.

In the parameters dialog, the default settings will provide the correct results. Note that the Accumulation Mode is set to Merge Incoming, which will add attributes from the containing neighborhood polygon to each point.

Looking at the food vendor points output, we can see that the containing neighborhood attributes have been added.

Looking at the area output, the _overlaps attribute tells us how many food vendors exist in each neighborhood.

Using the same food vendor points and neighborhood polygons as the previous example, we can also build a list attribute that contains all of the food vendors for a given neighborhood.

In the parameters dialog, enable Generate List on Output ‘Area’ , give the list a name, and select the attributes to be included.

Inspecting the output, we can see that the Fairview neighborhood contains 7 food vendors, and the names and descriptions of those vendors are contained in a list attribute.

Usage Notes

  • If you have a lot of features to process, you can improve overlay performance by also using the Clipper transformer. The Clipper also provides different options for a point that falls exactly on a line. See the Clipper example from the FME Community for information on how to use less memory using the Clippers First parameter.
  • If you have a lot of Point features in particular, you can reduce memory usage of the PointOnAreaOverlayer by using the Areas First parameter.
  • Note that where Point geometries are expected as input, PointCloud geometries are not supported.
  • The PointOnAreaOverlayer does not have a tolerance option for position.

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

Point (including text) features against which areas will be compared.

Area features against which points will be compared.

Output Ports

Point features, with attributes added according to transformer parameter configuration. Geometry is unmodified.

Area features, with attributes added according to transformer parameter configuration. Geometry is unmodified.

Features with invalid geometries will be rejected and output via this port.

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

INVALID_POINT_GEOMETRY_TYPE
INVALID_POLYGON_GEOMETRY_TYPE
INVALID_POLYGON_GEOMETRY_VERTICES
INVALID_POLYGON_GEOMETRY_DEGENERATE
EXTRA_POLYGON_FEATURE

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.

Areas First

If Areas First is set to Yes, then the PointOnAreaOverlayer assumes that all Area features will enter the transformer before any Point features. This can reduce memory use of the PointOnAreaOverlayer if you have many Point features to overlay. Any further Area features that arrive after the first Point feature will be logged with a warning and discarded.

If the Complete Groups parameter is set to When Group Changes, the Areas First requirement applies to each group separately. This means that the Area and Point features from the first group must enter the transformer before the Area and Point features from the second group.

Aggregate Handling

Choose how aggregate geometries are to be handled.

Deaggregate: Decompose aggregates into their individual components.

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

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.

Merge Attributes

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 ‘Point’

When enabled, adds a list attribute to the Point output features, and the attributes of each area containing an output point are added to that point's list.

Note that no intersections between area features are computed.

‘Point’ 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 'Point' List

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

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

Selected Attributes

Enabled when Add To 'Point' 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 point contained by 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 'Area' List is set to Selected Attributes. Specify the attributes you wish to be included.

Overlap Count

The Overlap Count Attribute added to output point 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 point features that they contained.

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 PointOnAreaOverlayer 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.