Skip to content

← file_system package

RecordToREC

Record data packets to a rec file.

This file format is native to NeuroPype, and can store any data that is computable by it. This node supports writing both the result of offline and online processing pipelines to a file. The resulting file can subsequently be played back using the Play back REC node. REC is a niche file format that is mostly meant for testing, debugging, or recreating NeuroPype data streams, but is not supported by any other software -- for general-purpose data interchange, consider using the HDF5 format. Implementation notes: the file format is based on Python's pickle system. Since pickle is very flexible, files obtained from the internet may be infected by viruses or could otherwise have been tampered with, and should be treated with the same caution as, e.g., foreign MS Word documents. Version 1.0.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

Filename to record packets to. Can be the full path or a relative path or filename if `output_root is specified.

  • verbose name: Filename
  • default value: untitled.rec
  • 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)

protocol_ver

Pickle protocol version. This is the internal protocol version to use. Older software may not be able to read files created with the latest version, but version 3 is supported by all NeuroPype releases.

  • verbose name: Protocol Ver
  • default value: 3
  • port type: IntPort
  • value type: int (can be None)

verbose

Produce verbose output.

  • verbose name: Verbose
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

retrievable

Upload Parts so they can be retrieved individually.

  • verbose name: Retrievable Parts
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

delete_parts

Delete parts after all data is recorded and uploaded. Only applicable is Retrievable parts is set to True.

  • verbose name: Delete Parts After Completion
  • default value: True
  • port type: BoolPort
  • value type: bool (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)