Statistics Module | Crosser Documention

Statistics DocumentationVersion: 2.0.4
Retrieved: 2025-10-09 15:16:22
StatisticsThe module calculates statistics over values from a sequence of messages. The messages to use are specified by configuring a window size, either as a time duration or as a number of messages. The window is 'rolling', i.e. it is shifted with each new input message. Each input message triggers an output message with the calculated statistics added.
The calculations can be grouped based on the values of the optional Group Property. Use this to for example separate data from different sensor by setting the Group Property to a property containing the name of the sensor.
SettingsThe data to calculate statistics on is collected from Value Property.


Name
Requirements
Purpose
Default

Value Property
Length: 1-64
The property that contains the values to calculate statistics on
data

Target Property
Length: 0-64
The property to write the result into. If empty the result is written to the root
 

Group Property
Length: 0-64
The property that contains the name to group on
 

Window Type
Time,Sample
The unit for the rolling window
Second

Time Window Size
1 ms -> 24 hours
The size of the time window
1 Second

Sample Window Size
1 - 1000
The size of the sample window
1

InputThe input must have a property that matches the Value Property property.


Name
Required
Type
Description

[Value Property]
no
string
The property containing the data to collect statistics on

OutputThe module produces one output message for each input message. The calculations are based on the values of the Value Property for the messages in the current window. The window size is specified through the Window Type and either Time Window Size or Sample Window Size settings.
The following calculated values will be added on the specified Target Property:


Name
Type
Description

min
double
Smallest value registered during the current window.

max
double
Largest value registered during the current window.

median
double
The median value during the current window

stdDev
double
The standard deviation during the current window

count
int
The number of registered values during the current window

average
double
The average value during the current window

Name	Requirements	Purpose	Default
Value Property	Length: 1-64	The property that contains the values to calculate statistics on	data
Target Property	Length: 0-64	The property to write the result into. If empty the result is written to the root
Group Property	Length: 0-64	The property that contains the name to group on
Window Type	Time,Sample	The unit for the rolling window	Second
Time Window Size	1 ms -> 24 hours	The size of the time window	1 Second
Sample Window Size	1 - 1000	The size of the sample window	1

Name	Required	Type	Description
[Value Property]	no	string	The property containing the data to collect statistics on

Name	Type	Description
min	double	Smallest value registered during the current window.
max	double	Largest value registered during the current window.
median	double	The median value during the current window
stdDev	double	The standard deviation during the current window
count	int	The number of registered values during the current window
average	double	The average value during the current window

Search Documentation

Process & Analyze

Calculations & Statistics