Skip to content

← file_system package

FileInfoExtraction

Extract metadata from a file containing signal data and (optionally) events, including filename, size, date created, date modified, number of channels, number of timepoints, sampling rate, and the list of channels.

The contents of the metadata dictionary (in XDF files, if any) are also included. If a marker stream is found, it will extract the number of events (markers), number of unique events, and a list of unique events and their counts. The output is a dictionary of dictionaries, where each key is the stream name and the value is a dictionary of the above metadata, depending on the stream type (signal or event). Version 1.1.0

Ports/Properties

data

Data to process.

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

file_metadata

A dictionary of file metadata.

verbose name
File Metadata
default value
None
port type
DataPort
value type
dict (can be None)
data direction
OUT

filename

Path to the data file. If specified, this takes precedence over the source_url stored in the data. This can be the same file path wired into an Import node. Supports cloud-hosted files when cloud storage options are configured.

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

ident

Figure identifier. This identifier can be referenced in report templates.

verbose name
Ident
default value
fileinfo1
port type
StringPort
value type
str (can be None)

signal_stream

Name of signal stream to extract data from. Leave empty extract data from all signal streams.

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

max_events

Maximum number of event types to retain. This node will print information about the k most frequent event types.

verbose name
Max Events
default value
100
port type
IntPort
value type
int (can be None)

max_channel_names

Max number of channel names to print. Leave empty for all. Set to 0 to print no channel names.

verbose name
Max Channel Names
default value
None
port type
IntPort
value type
int (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)