Skip to content

← file_system package

ImportEDF

Import data from an edf+, bdf, or gdf file.

This node imports EEG and other modalities of data stored in an EDF/EDF+/BDF file. Each modality will be stored in its own stream, as determined by the channel labels as per the EDF standard. If no modality is specified in the channel labels, EEG is assumed. Each stream will have a 2d array with a space axis (channels) and a time axis (samples). The timestamps per channel are generated based on the recorded sampling rate (as EDF does not store per-sample timestamps). By convention, channel labels in EDF files are formatted as modality space label (e.g., EEG Cz). In Neuropype the modality is stored in the Origin.modality property of the stream rather than each channel. By default, the modality prefix will be stripped from the channel names (e.g., EEG Cz becomes Cz). (You can disable this behavior by setting the strip_modality property to False.) If the file contains events markers (annotations), a stream named 'markers' is created, with an instance axis that indexes the events, where each element along the instance axis has a timestamp and a string with the event type/name. Note: This node also supports GDF files, which require MNE-Python to be installed separately. More Info... Version 2.6.0

Ports/Properties

data

Output signal.

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

filename

Name of the recording file to import. If a relative path is given, a file of this name will be looked up in the standard data directories (/resources and Examples/).

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

stim_channel

The name of the stim channel in the file, in cases where it cannot be automatically deduced. If the file has more than one stim channel, specify as a comma-separated list. Enclose any channel names with spaces in single quotes.

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

exclude_channels

List of channel names to exclude when importing. Typically we recommend using Select Range node after import to filter channels, however, EDF files may contain channels with different sampling rates and it has a known behavior for channels of lower sampling rate to enforce upsampling to the imported channel with the highest sampling rate. Excluding unwanted channels at higher sampling rates during import will avoid this.

  • verbose name: Exclude Channels
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

unit

Unit in which the EEG will be rescaled providing the EDF channels specify their unit and all the channels identified as being EEG have the same unit. uV is the recommended unit (don't change unless necessary for special reasons).

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

strip_modality

If True, strip the modality prefix from channel names (e.g ., "EEG Cz" becomes "Cz") commonly found in EDF files. The modality is stored in the Origin.modality property of the stream. If False, keep the original channel labels as they appear in the EDF file (the modality will still be stored in Origin.modality.

  • verbose name: Strip Modality
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

file_missing

Whether to raise an exception (error) if the file is missing or not found (which may stop the pipeline), or print a log message and continue.

  • verbose name: File Missing
  • default value: raise
  • 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)

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)