Skip to content

← spectral package

PowerBandRatio

Calculates a ratio of precomputed spectral power bands.

The power bands should be present along the feature axis. Allows a weight to be specified for each band, as well as bias constants which are added to the numerator and/or denomenator. Currently only supports numerator and denomenator expressions with one or two operands. The result is only one element along the feature axis, containing the given ratio. Version 1.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

alpha_weight

Weight factor for the alpha power band.

  • verbose name: Alpha Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

beta_weight

Weight factor for the beta power band.

  • verbose name: Beta Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

beta1_weight

Weight factor for the beta power band.

  • verbose name: Beta1 Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

beta2_weight

Weight factor for the beta power band.

  • verbose name: Beta2 Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

delta_weight

Weight factor for the delta power band.

  • verbose name: Delta Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

gamma_weight

Weight factor for the gamma power band.

  • verbose name: Gamma Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

theta_weight

Weight factor for the theta power band.

  • verbose name: Theta Weight
  • default value: 1.0
  • port type: FloatPort
  • value type: float (can be None)

numerator_bias

Constant value added to the numerator.

  • verbose name: Numerator Bias
  • default value: 0.0
  • port type: FloatPort
  • value type: float (can be None)

denomenator_bias

Constant value added to the denominator.

  • verbose name: Denominator Bias
  • default value: 0.0
  • port type: FloatPort
  • value type: float (can be None)

numerator

Formula used to calculate the numerator. Currently supports four operators: + - / * and no parentheses.

  • verbose name: Numerator
  • default value:
  • port type: StringPort
  • value type: str (can be None)

denomenator

Formula used to calculate the numerator. Currently supports four operators: + - / * and no parentheses.

  • verbose name: Denomenator
  • default value:
  • port type: StringPort
  • value type: str (can be None)

ratio_name

The name to be given to the ratio in the Feature axis.

  • verbose name: Ratio Name
  • default value: ratio
  • port type: StringPort
  • value type: str (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)