Skip to content

← markers package

ExportMarkers

Write all markers and matching timestamps to a 2-column CSV file.

Useful for exporting behavioral data for further processing. The CSV file is written to the same folder as the file being processed. If multiple streams are found, a CSV file is written for each one. (Not for streaming data.) Version 1.1.1

Ports/Properties

data

Data to process.

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

stream

Name of stream containing markers. Leave empty to write a CSV file for each marker stream found. Wildcards are supported, i.e. mystream* will select the first stream whose name starts with mystream.

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

filename

File name to record to (csv). Usually this is the name of the file being processed, which can be wired into here. If unspecified, the source_url property in the data stream will be used, if present. The marker stream name (usually "markers") will be appended to this filename, plus a .csv extension (so no need to specify here).

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

output_root

Path for the output root folder.

  • verbose name: Output Root
  • default value:
  • port type: StringPort
  • value type: str (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)

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)