Package: file_system

Filesystem-related nodes.

These nodes perform file-system related operations, such as loading and saving data to/from files on disk, and in some cases from network storage. Typically, the data packets that these nodes produce (in case of loader/importer nodes) or accept (in case of saver/exporter nodes) represent whole recordings, i.e., they are not streaming chunks. A small subset of nodes in this category works with streaming data. Some nodes perform auxiliary file system tasks, such as manipulating directories. Node classes in this package are: - nodes starting with Import: these nodes load data from files on disk - nodes starting with Export: these nodes save data to files on disk - nodes starting with Path: common path operations acting on strings When importing data from standard time-series file formats (e.g., EDF, BDF, SET), the data is typically loaded into a Packet with one Chunk (aka stream) per modality, for example 'eeg' or 'nirs', which has a time axis and a space axis. With many file formats, auxiliary measures (such as emg, accelerometer etc) will appear multiplexed in the primary modality's channels. Any event markers (or other sporadic annotations) present in the data will appear in a 'markers' modality, which has only an instance axis (where the .times array of the axis has time stamps in seconds relative to some arbitrary time base and the .data array of the axis is a record array that can be indexed either by field name (e.g., 'Marker') or by index). Other file formats (e.g., H5) are considerably more flexible and can produce a greater variety of data structure and axes, although the specific importer may only allow a restricted set of data representations in the file.

Nodes in this package:

• Export CSV
  Export data into a csv file.

• Export EDF
  Export EEG data to a file in the EDF+ or BDF+ format.

• Export HDF5
  Export data to a file in HDF5 format.

• Export JSON
  Export data to a file in JSON format.

• Export MAT
  Export data to a file in MAT format.

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

• Export Structure
  Save a dictionary to disk.

• Export Plaintext
  Export a string to a file in plaintext format.

• Export YAML
  Export data to a file in YAML format.

• File Information Extraction
  Extract metadata from a file containing signal data and (optionally) events, including filename, size, date created, date modified, number of channels, number of timepoints, sampling rate, and the list of channels.

• Get Current Working Directory
  Returns the current working directory of the application as a string.

• Get Identifiers From Path
  Extract subject/session identifiers from the source filename.

• Import Axon abf
  Import data from an Axon dataset.

• Import BCI2000 dat
  Import data from a BCI2000 dataset.

• Import BIDS Metadata
  Import metadata from BIDS sidecar files and apply it to an existing data packet.

• Import Brainvision
  Import data from a BrainVision .V

• Import CGX
  Import data from a CGX File.

• Import CSV
  Import a CSV file containing EEG, or other non-signal data.

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

• Import File
  Import data from a supported file format.

• Import HDF5
  Import data from an h5 file.

• Import NSX
  Import data from a Blackrock dataset.

• Import Neuralynx
  Import data from a Neuralynx dataset.

• Import NEX
  Import data from a NeuroExplorer dataset.

• Import Nirs
  Import data from a .n

• Import PLX
  Import data from a Plexon dataset.

• Import SET
  Import data from an EEGLAB set file.

• Import Snirf
  Import data from a .s

• Import Spike2
  Import data from a Spike2 dataset.

• Import Structure
  Import a dictionary from disk.

• Import TDT
  Import data from a TDT dataset.

• Import Plaintext
  Import a plaintext file into a string.

• Import VHDR
  Import data from a BrainProducts .v

• Import XDF
  Import data from an xdf file.

• Get Absolute Path
  Make the given file path absolute if it is not yet.

• Get Directory of Path
  Extract the directory part of a file path string.

• Check Path Exists
  Check if the given path (file or directory) exists.

• Get File Extension of Path
  Extract the file extension of a file path (without the leading dot).

• Get Filename of Path
  Extract the filename part of a file path string, including the file extension.

• Path Iterator
  Iterate over a list of path names.

• Play back REC
  Play back the content of a previously recorded rec file.

• Record to CSV
  Record data into a csv file.

• Record to REC
  Record data packets to a rec file.

• Record to XDF
  Record data into a xdf file.

• Skip If Exists
  Skip this file path if the checked path already exists.

• Upload File To Cloud
  Upload a local file to your Neuroscale cloud storage, or another cloud storage service.

• Wait For Files
  Wait for file(s) matching a certain criteria to exist in filesystem before continuing operation.