Skip to content

← file_system package

ImportNeuroExplorer

Import data from a NeuroExplorer dataset.

This node loads analog signals, digital events, and neural event data from a NeuroExplorer dataset. The canonical file extension for this format is .NEX. More Info... Version 0.1.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 dataset 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)

segments

List of segment indices to import (0-based). For data sets with multiple segments (blocks of trials, recording discontinuities, etc), list the segments to be imported. Set to None (default) to import all segments. Segments that fall outside time_bounds, if specified, will be ignored.

  • verbose name: Segments To Import
  • default value: None
  • port type: ListPort
  • value type: list (can be None)

time_bounds

Time limits for data import. Set to None (default) to import all available data (depending on segments). Segments specified in segments that fall outside time_bounds will be ignored. Samples with times within time_bounds but which fall outside segments, if specified, will be ignored.

  • verbose name: Import Time Range
  • default value: None
  • port type: ListPort
  • value type: list (can be None)

load_signals

Load analog signals into an analogsignals stream. Set to False to save loading time if analog signals are not needed.

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

signal_autoscale

Auto-scale analog signal to Voltage (float). Set to False to keep data in original format (int).

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

load_events

Load events into a markers stream.

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

load_spiketrains

Load spiketrains into spiketrains stream. Set to False to save loading time if spikes/spiketrains are not needed.

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

load_waveforms

Load waveforms of spiking events into waveforms chunk. Set to False to save loading time e.g. if spikes and/or waveforms will be re-extracted later.

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

verbose

Print verbose diagnostics.

  • verbose name: Verbose
  • default value: False
  • 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)