Skip to content

← deprecated package

SanityCheck

Deprecated: use the Gate Check node instead, which now covers all of these criteria (and more).

Check data coming from a file for certain criteria. Passes the data through if all criteria pass, and passes None otherwise. Designed for offline data, such as to terminate a pipeline if data would cause an error. Outputs the failed checks to a text file with the same path as the original file, with .errors.txt suffix added. Version 1.0.1

Ports/Properties

data

Data

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

eeg_stream

Name of EEG stream to check. Leave empty to check the first signal stream found.

verbose name
Eeg Stream
default value
None
port type
StringPort
value type
str (can be None)

required_streams

List of stream names which must be present in the data packet.

verbose name
Required Streams
default value
[]
port type
ListPort
value type
list (can be None)

has_data

The packet must contain data (data tensor not empty).

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

min_length

Minimum data length, in seconds, based on the difference between the first and last time stamps.

verbose name
Min Length
default value
None
port type
IntPort
value type
int (can be None)

max_length

Maximum data length, in seconds, based on the difference between the first and last time stamps. (Catch very large files that would cause a memory error.)

verbose name
Max Length
default value
None
port type
IntPort
value type
int (can be None)

required_axes

List of axes which must be present in the data, at minimum.

verbose name
Required Axes
default value
['time', 'space']
port type
ListPort
value type
list (can be None)

excluded_axes

List of axes which must NOT be present in the data.

verbose name
Excluded Axes
default value
[]
port type
ListPort
value type
list (can be None)

marker_stream

Packet must contain a marker stream.

verbose name
Marker Stream
default value
False
port type
BoolPort
value type
bool (can be None)

required_markers

List of markers which must appear at least once in a marker stream.

verbose name
Required Markers
default value
[]
port type
ListPort
value type
list (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)