Group Statistics

apama.analyticskit.blocks.core.GroupStatistics

Generates periodic aggregate values across all the devices in a group for which the block has received input values.

This block generates the following aggregate values:

Minimum

Maximum

Device Count

Average

Standard Deviation

Variance

The block can operate over a time-bounded window that is specified with the Window Duration parameter. If this parameter is not specified, the block uses an unbounded window. Output is generated periodically as specified by the Output Period parameter.

If a window is configured, the block uses a set of 20 buckets, so the expired value is an approximation to the nearest bucket interval.

Note: The Group Statistics block calculates and generates aggregate values for the group as a whole (not for individual devices). To generate aggregates for an individual device in a group, use the Average (Mean), Standard Deviation, or Minimum/Maximum blocks. The Group Statistics block only considers devices from which it has received input values.

Parameters

Name | Description | Type | Notes |

Window Duration (secs) | If present, the amount of time (in seconds) for which values are to be kept in the window. This must be a finite and positive number. | float | Optional |

Output Period (secs) | The amount of time (in seconds) between each output. This must be a finite and positive number. | float | Default: 5.0 |

Input Port Details

Name | Description | Type |

Value | Input value for which the aggregate values are to be calculated. | float |

Output Port Details

Name | Description | Type |

Minimum | The smallest input value (closest to negative infinity) across all the devices in a group. | float |

Maximum | The largest input value (closest to positive infinity) across all the devices in a group. | float |

Device Count | The number of devices in a group for which input values have been received so far. | float |

Average | The sum of the value multiplied by how long it stays at that value divided by the total time and the device count. | float |

Standard Deviation | The standard deviation of the input values across all the devices in a group. | float |

Variance | The variance of the input values across all the devices in a group. | float |