FME Transformers: 2024.2

Categories
Calculated Values

Calculated Values

Categories
Calculated Values

Calculated Values

StatisticsCalculator

Calculates statistics based on a designated attribute or set of attributes of the incoming features and adds the results as attributes.

Jump to Configuration

Typical Uses

  • Inspecting and analyzing features
  • Calculating statistics for use in further operations

How does it work?

The StatisticsCalculator receives features and calculates selected statistics on them per attribute. Statistics can be calculated on specific groups of input features as specified by the Group By attribute option. The results are output on each feature out of the Complete port. A summary of the results is output out of the Summary port.

Available statistics include:

  • Minimum
  • Maximum
  • Total Count
  • Sum
  • Mean
  • Median
  • Numeric Count
  • Value Count
  • Range
  • Standard Deviation (Sample or Population)
  • Mode
  • Histogram

The following statistics may also be calculated cumulatively on attributes using advanced settings: min, max, range, mean, stdev, sum, total count, numeric count, and value count. When calculating cumulative statistics, the current results thus far are output on each feature out of the Cumulative port.

Statistics are stored as attributes, named <attribute>.<statisticname>, where <statisticname> will be one of the following: min, max, range, mean, stdev, stdev_p, sum, median, mode, total_count, numeric_count, value_count, histogram.

Histogram statistics are stored as list attributes that pair the attribute value and count for each unique value of the attribute and are named <attribute>.histogram{#}.value and <attribute>.histogram{#}.count where # is a zero-based index of the unique attribute values.

Input Data Handling

Invalid, <null>, and <missing> data are considered invalid and will be skipped when calculating statistics other than total count. If no valid values are processed when calculating a statistic the result will be <null>. Trying to calculate standard deviation on only one value will also result in <null>. Total count, numeric count, and value count will never be <null>. NaN values are explicitly ignored when calculating Min, Max, Range, and Numeric Count.

For example, a calculated sum on all <missing> values will be <null> rather than a potentially misleading and less informative 0. However, if only some values are <missing> or invalid the resulting sum will be the same as if those values were 0.

Usage Notes

  • The StatisticsCalculator transformer has default suffixes and always prepends. Upgraded transformers will retain prepend settings when output attribute names were not prepended before upgrade as well as suffix names to maintain backwards compatibility and avoid disrupting existing workspaces.

Configuration

Input Ports

All features enter the transformer through the Input port.

Output Ports

A single new feature will be output containing the statistics attributes for each group. If features are not grouped, the latter will emit a single feature containing the statistics for the whole set of input features.

No summary features will be generated if no input features are provided.

All Input features will all be passed through this output port with all the statistics attributes for their group added onto them. Note that this will require all Input features to be stored until the end of translation, which can greatly increase the amount of memory and/or temporary disk storage usage.

All Input features will all be passed through this output port with all the statistics attributes to date for their group added onto them. The features pass through this port immediately, each having the statistics computed for the set of features from the first feature in the group through to the current feature. (Note that this differs from the “final” statistics output in the Complete group.)

Parameters

Group By

If Group By attributes are chosen, statistics will be calculated independently within each group of features. This can be used to create a pivot-table-like analysis of values in a data stream.

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.

Calculation Method

Use this setting to specify a method for evaluating values when calculating statistics. This choice will be applied to all data when it enters the transformer, determining whether values should be treated numerically or lexically.

Attribute

Select which attributes to include, one per line.

Statistics

The following statistics may be calculated:

Minimum

The numerical minimum for numeric attributes. The lexical minimum for string attributes.

Maximum

The numerical maximum for numeric attributes. The lexical maximum for string attributes.

Total Count

The input feature count.

Sum

The sum of all values. Undefined for string attributes.

Mean

The average value, calculated as the sum of values divided by the number of values. Undefined for string attributes.

Median

The middle value of the ordered attribute values. If the number of attributes is even, Median returns the average of the two middle values. For string attributes, the first middle value is always used.

Numeric Count

The number of numeric values that entered the transformer. In particular, missing, null, and NaN values are ignored, and are not included in this count.

Value Count

The number of values that entered the transformer, ignoring <null> and <missing>.

When Calculation Method is Numeric , only values that can be converted to numbers will be counted.

Range

The maximum minus the minimum. Undefined for string attributes.

Sample Standard Deviation

The sample standard deviation. Sample standard deviation is measured by the "non-biased" or "n-1" method. Undefined for string attributes.

Population Standard Deviation

The population standard deviation. Undefined for string attributes.

Mode

The most frequent of all the values. If the dataset is bimodal (two or more values occur with the highest frequency) one of the values will be returned randomly.

Histogram

A count for each unique value encountered for the analyzed attribute. The results are given as a structured list of attributes which represent (value,count) pairs.

Select All

This toggle works in conjunction with currently selected rows in the Statistics to Calculate table and will enable or disable all statistic type choices.

Add Attributes...

Provides a pick list of all currently available attributes to perform multiple attribute addition to the Statistics to Calculate table.

Enable this section to calculate cumulative statistics and make the Cumulative output port visible. This table specifies which cumulative statistics to calculate for each attribute.

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