Skip to content

← statistics package

CumulativeAverage

Calculate the cumulative average of the data over time.

This node does not change the shape or axes of the signal, but each value will be replaced by the average of values up to that point. Note that this node maintains internal state. Also, this node assumes that the data has a time axis. More Info... Version 1.1.0

Ports/Properties

data

Data to process.

  • verbose name: Data
  • default value: None
  • port type: DataPort
  • value type: Packet (can be None)
  • data direction: INOUT

axis

Axis over which the statistic should be aggregated. For instance, if this is set to time, then the mean will be computed over time.

  • verbose name: Take Statistics Along Axis
  • default value: time
  • port type: ComboPort
  • value type: str (can be None)

ignore_nans

If enabled, nan values are skipped.

  • verbose name: Ignore Nan Values
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

subtract

Subtract from data.

  • verbose name: Subtract From Data
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

update_for

Update for the first this many samples. After that the cumulative average will not be further updated.

  • verbose name: Update For
  • default value: None
  • port type: IntPort
  • value type: int (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)