Skip to content

← file_system package

ExportSET

Export non-streaming continuous data to an EEGLAB set file.

This node accepts a packet that is assumed to hold the entire recording to save (i.e., non-streaming data), and writes it to a .set file. This node further assumes that the data is a 2d array with a space axis (channels) and a time axis (samples). Note that this node currently cannot save segmented ("epoched") data, which is characterized by the presence of an instance axis in addition to time and space. There may also optionally be a second stream in the packet to save that holds markers, which will be written out as event markers into the set file. If this node is used after ICA has been performed it will back project the IC activations to the channel time series and store the ICA streams as fields in the EEG structure. Note: some processing nodes will insert axis types that this node cannot handle, such as feature axes (in the case of feature-extraction nodes). If your data has such axes, you can first replace those axes by a space axis (using the Override Axis node), or fold additional axes into the space or time axis (using the Fold Into Axis node). EEGLAB is a quite versatile environment for working with EEG data, and is a commonly-used target for data processed with NeuroPype for additional investigation. More Info... Version 1.3.0

Ports/Properties

data

Input signal.

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

filename

File name to export data to. Can be the full path or a relative path or filename if `output_root is specified.

  • verbose name: Filename
  • default value: untitled.set
  • port type: StringPort
  • value type: str (can be None)

output_root

Path to the output folder; if specified, the filename will be relative to this folder. Alternatively, this can be left empty and the full path may be specified in filename).

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

file_version

Specify the MAT-File version of the SET file to export. Version 7.3 MAT-files use an HDF5 based format

  • verbose name: File Version
  • default value: >=7.3
  • port type: EnumPort
  • value type: str (can be None)

boundary_events

Add boundary events where there are a significant number of dropped samples.

  • verbose name: Add Boundary Events
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

max_dropped

Maximum dropped samples allowed before a boundary condition event is inserted.

  • verbose name: Max Allowed Dropped Samples
  • default value: 2
  • port type: IntPort
  • value type: int (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)

cloud_host

Cloud storage host to use (if any). You can override this option to select from what kind of cloud storage service data should be downloaded. On some environments (e.g., on NeuroScale), the value Default will be map to the default storage provider on that environment.

  • verbose name: Cloud Host
  • default value: Default
  • port type: EnumPort
  • value type: str (can be None)

cloud_account

Cloud account name on storage provider (use default if omitted). You can override this to choose a non-default account name for some storage provider (e.g., Azure or S3.). On some environments (e.g., on NeuroScale), this value will be default-initialized to your account.

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

cloud_bucket

Cloud bucket to read from (use default if omitted). This is the bucket or container on the cloud storage provider that the file would be written to. On some environments (e.g., on NeuroScale), this value will be default-initialized to a bucket that has been created for you.

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

cloud_credentials

Secure credential to access cloud data (use default if omitted). These are the security credentials (e.g., password or access token) for the the cloud storage provider. On some environments (e.g., on NeuroScale), this value will be default-initialized to the right credentials for you.

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