Skip to content

← spectral package

PowerSpectra

A meta-node that segments and calculates the Power Spectra on segmented data.

Collapses the time axis. Converts to decibels. Version 1.0.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

time_bounds

Time range in seconds relative to the event, within which data will be selected to represent the individual trials. Express in this format: -1.5, 2 (will select from 1.5 seconds before the event to 2 seconds after).

verbose name
Time Bounds
default value
[-0.2, 0.6]
port type
Port
value type
object (can be None)

subwindow_length

Sub-window length for averaging. This node will extract successive windows from the given data of this length, which are overlapped according to the overlap samples parameter. Longer windows will give a higher-resolution (but potentially less smooth and more noisy) spectrum.

verbose name
Subwindow Length
default value
0.5
port type
FloatPort
value type
float (can be None)

subwindow_overlap

Overlap between successive sub-windows, expressed as a fraction of the sub-window length. This determines by how much successive sub-windows are overlapped. Using a higher value will yield finer stepping in time without a change in temporal or frequency detail (since the time axis will be correspondingly more smooth to counter the finer stepping). If not given, defaults to half of the sub-window length. If the sub-window length is expressed in samples, this value can also be expressed in samples.

verbose name
Subwindow Overlap
default value
None
port type
FloatPort
value type
float (can be None)

fft_size

Length of the FFT used. Using a higher number will yield a finer stepping along the frequency axis, without a change in frequency or temporal detail (the frequency axis will be correspondingly more smooth to counter the finer stepping). If not given, it defaults to the sub-window length.

verbose name
Fft Size
default value
512
port type
IntPort
value type
int (can be None)

onesided

Return one-sided spectrum. If disabled, a two-sided (meaning: symmetric about the middle) spectrum will be computed, which is redundant for real-valued data, but required for complex-valued data (for complex data, the spectrum is always two-sided.

verbose name
Onesided
default value
True
port type
BoolPort
value type
bool (can be None)

unit

Unit in which the sub-window length is expressed. By default this is seconds, but samples can also be used if necessary.

verbose name
Unit Used For Sub-Window Length.
default value
seconds
port type
EnumPort
value type
str (can be None)

frequency_normalization_alpha

The exponent of 1/f^alpha used in the correction. Set to None to determine the value automatically.

verbose name
Frequency Normalization Alpha
default value
1.0
port type
FloatPort
value type
float (can be None)

channel_range

Comma separated list of channels/ROIs to be retained. Leave blank or set to 'all' to include all previously selected channels/ROIs.

verbose name
Channel Range
default value
:
port type
Port
value type
object (can be None)

frequency_range

Frequency range for which to plot the spectra.

verbose name
Frequency Range
default value
1...50
port type
Port
value type
object (can be None)

output

Compute the mean of all trials or output the per trials data.

verbose name
Output
default value
mean
port type
EnumPort
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)