← reporting 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.0.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, one per stream.

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

• 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 to take first one.

  • 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)