FME Transformers: 2024.1

Categories
Filters and Joins

Filters and Joins

Spatial Analysis

Spatial Analysis

Categories
Filters and Joins

Filters and Joins

Spatial Analysis

Spatial Analysis

NeighborhoodAggregator

Creates aggregates of features based on their proximity to each other. Each aggregate that is created covers approximately the neighborhood width and height (measured in feature ground units).

This transformer is used to reduce the data volume of "wallpaper" types of features that have no individual attributes. The resulting aggregates can be output to a system using many fewer records than if each feature was output by itself. For systems that support aggregates, or multi-part features, this can result in substantial performance improvements and greatly decrease storage requirements.

Example

Configuration

Parameters

Group By

If you do not select Group By attributes, then all features fall into the same group.

When you select Group By attributes, this transformer will aggregate the geometries of the input features, based on the selection in the Group By parameter. Each group of features that have the same values for the Group By attributes will be processed independently of other groups.

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.

Neighborhood Width and Neighborhood Height

These parameters, measured in ground units, divide the input space into cells. The result is a grid of cells that expands in all directions from the origin (0,0). The center of the bounding box of each input feature is used to determine the cell for the feature. Once all input features have been read, an aggregate feature is created from all features in each cell. If linear features are input, they will have pseudo nodes removed from within their cells to further reduce the number of separate entities. No such reduction is done to any polygons or donuts that enter.

Note  To view the grid of cells that is created from these parameters, use the 2DGridCreator. Specify 0,0 for Starting X Coordinate and Starting Y Coordinate, respectively, and the same values for Column Width and Row Height as Neighborhood Width and Neighborhood Height, respectively.

Minimum Neighborhood Members

When you set this parameter, neighborhoods with fewer than the specified number of features are merged with a vertical neighbor area in order to increase the number of members. You can prevent this from happening by setting the parameter to 0 (zero).

Accumulation Mode

If Drop Incoming Attributes is chosen, the output feature will not preserve any input attributes. If Merge Incoming Attributes is chosen, the output feature will merge all input attributes. If Use Attributes From One Feature is chosen, the output feature will get attributes from only one input feature.

 

Generate List

List Name

If a List Name is specified, then all attributes of an input feature will be stored as part of a list attribute entry in the output feature.

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: Every attribute from all input features that created an output feature will be added to the list specified in List Name.

Selected Attributes: Only the attributes specified in the Selected Attributes parameter will be added to the list specified in List Name.

Selected Attributes

The attributes to be added to the list when Add To List is Selected Attributes.

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.

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 NeighborhoodAggregator on the FME Community.

Keywords: MBR "minimum bounding rectangle" Clumper NeighbourhoodAggregator