Skip to content

← file_system package

ImportH5

Import data from an h5 file.

This node imports data in HDF5 format, assuming the NeuroPype Baryon file format, which is is supported among others by the ExportH5 node. This node can import any data that can be represented by the NeuroPype Packet data structure, including multiple streams with any number of (possibly) annotated axes as well as arbitrary meta-data. Note that there are many other file formats that also happen to utilize HDF5 besides NeuroPype's H5 format, which this node will not recognize. More Info... Version 1.2.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)

rdcc_nbytes

Total size of the raw data chunk cache in bytes. The default size is 1024**2 (1 MB) per dataset.

  • verbose name: Rdcc Nbytes
  • default value: 1048576
  • port type: IntPort
  • value type: int (can be None)

rdcc_nslots

Number of chunk slots in the raw data chunk cache for this file.

  • verbose name: Rdcc Nslots
  • default value: 521
  • port type: IntPort
  • value type: int (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)