FME Transformers: 2024.2
FME Transformers: 2024.2
PointOnPointOverlayer
Performs an overlay of points on points. Each point may receive attributes from any point within a specified distance (tolerance), performing a spatial join. Geometry is not altered.
Typical Uses
- Aggregating data from multiple points in the same location
- Combining attributes from different co-located point datasets
- Relating text or labels to point data
How does it work?
The PointOnPointOverlayer compares all point features that enter through the Point input port against each other. Each point may receive attributes from all other points located within the specified tolerance distance (a spatial join). Points also receive a count of the number of matched points encountered.
Geometry is unaltered.
Aggregates/multipoint geometries can either be deaggregated before processing or rejected.
Examples
Example: Aggregating information within a point dataset
In this example, we start with a single point dataset of reported crimes, over many years. The points are routed into the Point input port of the PointOnPointOverlayer.
There are two tasks we want to accomplish.
First, we want to count how many crimes were reported at any given location within the dataset. The Overlap Count attribute will tell us how many other points were found within 2 meters of the location (as defined in the Point Tolerance parameter, with the data in a UTM projection, ground units in meters).
Second, we will build a list attribute that contains the type of each report in the location. We enable Generate List, and add the Selected Attribute TYPE to a list named IncidentType.
The points are output with no changes to their geometry, but with new attributes added. The example point selected now has an _overlaps value of 6, indicating that six points (crime reports) in total are at this location.
The IncidentType list collects the Type attribute from each of the matching points.
Usage Notes
- Note that where point geometries are expected as input, point cloud geometries are not supported.
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.
Spatial Transformers Comparison
Transformer |
Can Merge Attributes |
Alters Geometry |
Counts Related Features |
Creates List |
Supported Types* |
Recommended For |
---|---|---|---|---|---|---|
SpatialFilter | Yes | No | No | No |
|
|
SpatialRelator | Yes | No | Yes | Yes |
|
|
AreaOnAreaOverlayer | Yes | Yes | Yes | Yes |
|
|
LineOnAreaOverlayer | Yes | Yes | Yes | Yes |
|
|
LineOnLineOverlayer | Yes | Yes | Yes | Yes |
|
|
PointOnAreaOverlayer | Yes | No | Yes | Yes |
|
|
PointOnLineOverlayer | Yes | Yes | Yes | Yes |
|
|
PointOnPointOverlayer | Yes | No | Yes | Yes |
|
|
Intersector | Yes | Yes | Yes | Yes |
|
|
Clipper | Yes | Yes | No | No |
|
|
NeighborFinder | Yes | In some cases | No | Yes |
|
|
TopologyBuilder | Yes | Yes | No | Yes |
|
|
* Note that Curve includes Lines, Arcs, and Paths. Area includes Polygons, Donuts, and Ellipses.
The Effect of Spatial Transformer Choice on Performance
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
Point features against which all other input points will be compared.
Output Ports
Point
Point features, with attributes added according to transformer parameter configuration. Geometry is unmodified.
<Rejected>
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
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 Processing
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:
Considerations for Using Group By
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. |
General
Point Tolerance |
Each input point has the attributes from any other point within the Point Tolerance distance merged onto it. |
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. |
Attribute Accumulation
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 and measures that are being added to the original feature from the incoming feature. |
Generate List
When enabled, adds a list attribute to the Point output features, and the attributes of matching points are added to that feature’s list.
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 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 List is set to Selected Attributes. Specify the attributes you wish to be included. |
Output Attribute Name
Overlap Count |
The Overlap Count Attribute added to output point features holds the number of point features to which the point was near. |
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.
How to Set Parameter Values
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.
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.
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.
Content Types
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
FME and workspace-specific parameters may be used. | |
Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
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:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
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 |
|
Feature Holding |
Yes |
Dependencies | |
Aliases | |
History |
FME Community
The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.
Search for all results about the PointOnPointOverlayer 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.