Skip to content

← spectral package

PowerBands

Computes the standard power bands for various units (dB, PSD, relative PSD, sqrt(PSD), with configurable frequency ranges.

Note that frequency ranges are not inclusive, meaning that [1, 4] will include frequencies up to but not including 4.0. Replaces the Frequency axis with a Feature axis with the values of each band and the name of that band. This node does not computer power spectral density. So it expects the incoming packet contains a Frequency axis with PSD, and should be preceded by a node that computes PSD (Spectrogram, Power Spectrum, etc.). This node only groups and averages the specified frequencies to create bands, and optionally converts to DB (if 'dB' selected) and performs 1/f normalization (if 'relativePSD' selected) or sqrt (if 'sqrtPSD' selected). Version 1.4.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

unit

Select unit to be used for computing the band ratios. (RelativePSD is computed by dividing by the sum of all frequencies.)

  • verbose name: Unit
  • default value: dB
  • port type: EnumPort
  • value type: str (can be None)

correct_for_falloff

Correct for 1/f frequency fall-off (perform a 1/f^alpha normalization), with an exponent of 1.

  • verbose name: Correct For Falloff
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

average_across_channels

Average the bands across all channels Set to False to output band values for each channel.

  • verbose name: Average Across Channels
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

delta

Lower and upper frequencies for the delta band.

  • verbose name: Delta
  • default value: [1, 3]
  • port type: ListPort
  • value type: list (can be None)

theta

Lower and upper frequencies for the theta band.

  • verbose name: Theta
  • default value: [4, 7]
  • port type: ListPort
  • value type: list (can be None)

alpha

Lower and upper frequencies for the alpha band.

  • verbose name: Alpha
  • default value: [8, 15]
  • port type: ListPort
  • value type: list (can be None)

beta

Lower and upper frequencies for the beta band.

  • verbose name: Beta
  • default value: [16, 31]
  • port type: ListPort
  • value type: list (can be None)

gamma

Lower and upper frequencies for the gamma band.

  • verbose name: Gamma
  • default value: [32, 40]
  • port type: ListPort
  • value type: list (can be None)

custom_bands

User defined frequency bands. You can define as many as you like, with custom names and frequency ranges. Specify as a python dictionary, in the following format: {'theta2': [6,7], 'beta3': [25,31]}. If this parameter is specified, only these bands will be computed and the values specified in the standard band ports (delta, theta, etc.) will be ignored.

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

mean_trim

An optional trim (using a winsorized mean) to be applied to each listed band when calculating the mean, where 0.1 will trim the top and bottom 10% of values. Expressed in the following format: {'beta': 0.1, 'alpha': 0.1} which will apply a 0.1 trim to both beta and alpha.

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

keep_numeric_band_in_names

Keep the bandwidth in the new feature axis names. This will yield feature axis names similar to e.g. alpha2 (10.0-15.0 Hz)

  • verbose name: Keep Numeric Band In Names
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

verbose

Print verbose output.

  • verbose name: Verbose
  • default value: True
  • 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)