Skip to content

← statistics package

CurveArea

Integrate area under the curve (AUC) using the composite trapezoidal rule of the data over a given axis.

The chosen axis will be removed from the data and replaced by a new one-element feature axis. In the special case that the curve length is taken over time, a dummy time axis will be retained, unless this behavior is overriden using the force feature axis parameter. More Info... Version 0.0.1

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 to calculate the area under the curve. This axis will drop out of the data and be replaced by a dummy one-element axis (of type feature or time, depending on settings). Note that if time axis or instance axis (with timestamps) is selected the timestamps will be used for dictating the spacing/width of each computed trapezoid area, for any other axis the spacing size will always be 1.

  • verbose name: Axis To Calculate Curve Area Over
  • default value: time
  • port type: EnumPort
  • value type: str (can be None)

force_feature_axis

Always create a feature axis, even when the area under the curve is taken over time. If this is False, then a time axis will instead be created if the curve area is taken over time.

  • verbose name: Force Feature Axis
  • default value: False
  • port type: BoolPort
  • value type: bool (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)