Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The descriptiveFunctionGroup defines the contents of the descriptive tabel. Several sub-table can be configured (see sample).

Functions supported are:

Info functions (if this type of function is specified, the display provides a hint to select a column in the table in order to get more descriptive information):

  • info: displays parameter (long name+id), location (long name+id) 
  • infoLocationId
  • infoLocationName
  • infoModuleinstance
  • infoParameterId
  • infoParameterName

Time series information available

  • count: total number of populated records
  • missings: total number of missings
  • completed: number of records flagged as completed (gap filling)
  • corrected: number of records flagged as corrected
  • reliables: number of records flagged reliable
  • unreliables: number of records flagged unreliable
  • doubtfuls: number of recorsd flagged doubtfull
  • startTime
  • endTime

Basic statistics

Descriptive statistical functions

The descriptive statistics functions are functions that are used for descriptive statistics. They can be defined to describe the distribution of the data (e.g. mean, min, max) or the data itself (info, start_time). All descriptive statistical functions produce a single value for a time series.

The descriptive functions results are displayed in group boxes that are named according to the group names that have been defined in the configuration file.

Attributes:
• function: Can be one of the functions below.
Information functions:

  • info: Name of the time series
  • start_time Start time of the time series in the view period
  • end_time: End time of the time series in the view period
    Grouping functions:
  • count: Number of time steps in the view period
  • missings: Number of missing values in the view period
  • doubtfuls: Number of doubtful values in the view period
  • reliables: Number of reliable values in the view period
  • unreliables: Number of unreliable values in the view period
    Statistical functions:
  • mean: Mean value in the view period
  • min: Lowest value in the view period
  • max: Highest value in the view period
  • percentile: Percentile in the view period for a given percentage (requires one or more value elements to define percentages; see below)
  • standard_deviation: Standard deviation in the view period
  • sum: Sum of the values in the view period
    • ignoreMissings: when true, missing values are ignored and each function will be calculated from the available values within the current time window.
    When false, calculated values will be set to missing if one or more values within the current time window are missing.

Duration curve

A duration curve illustrates the relationship between parameter values and their duration. When selected, the current graphs are replaced with duration curves.

Attributes:

  • function: always duration.
  • Moving average
    A moving average calculates the mean value of the time window directly before the current value.

Attributes:

  • function: always moving_average.
  • ignoreMissings: when true, missing values are ignored and each average will be calculated from the available values within the current time window.
    When false, calculated values will be set to missing if one or more values within the current time window are missing.

movingAccumulationTimeSpan

Time spans that the user selects from using the slider.

  • Central moving average
    A central moving average calculates the mean value of the time window of which the current value is in the middle. It is the same as the moving average, but shifted to the past for half the time window.

Attributes:

  • function: always central_moving_average.
  • ignoreMissings: when true, missing values are ignored and each average will be calculated from the available values within the current time window.
    When false, calculated values will be set to missing if one or more values within the current time window are missing.
    movingAccumulationTimeSpan
    Time spans that the user selects from using the slider.
  • max
  • mean
  • min
  • standardDeviation
  • sum
  • percentile: value exceeded X% of time (where the percentiles X are defined in the value-element)

for more details, a Word-attachement is available.