ExportH5¶
Export data to a file in HDF5 format.
Since the HDF5 format is very flexible, this node can store any data that is computable by NeuroPype. Note that this node should be used with offline processing pipelines, as it cannot stream data to disk incrementally (this would be required when trying to save the output of an online processing pipeline). The HDF5 file format is quite widespread and can be opened by many data analysis packages, including MATLAB(tm). However, with any of those systems you will still have to find your way through the data that you imported, which reflects the way data is organized in NeuroPype. The organization is as a packet with one or more chunks (if there is more than one stream in the data), each of which has meta-data-properties, as well as an n-dimensional array that has n axes of various types (e.g., time, space, instance, feature, frequency, and so on). These axis types have type-specific meta-data, such as the sampling rate in the time axis as well as all the time points for the individual samples in the data). More Info... Version 1.0.0
Ports/Properties¶
data¶
Input signal.
filename¶
File name to export data to. Can be the full path or a relative path or filename if `output_root is specified.
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).
rename_on_write¶
Rename file on write. Useful when writing to disk is used as a means of transferring data between pipelines, since it ensures that the file only shows up once fully written. Only supported on the local file system.
chunk_data¶
Set this to True to auto-chunk data on disk. Or set it to a tuple to determine chunk size. e.g. (100, 100) will store data in scattered chunks of size (100, 100). Can take a dictionary to set the chunk size per stream.
compression¶
rdcc_nbytes¶
Total size of the raw data chunk cache in bytes. The default size is 1024**2 (1 MB) per dataset.
set_breakpoint¶
Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.
metadata¶
User-definable meta-data associated with the node. Usually reserved for technical purposes.
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.
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.
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.
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.