Skip to content

← diagnostics package

PrintToConsole

Print the given data to the console.

This is mainly useful for debugging. Note that the data can be quite large and therefore create a lot of logspam -- make use of the options to print only those aspects of the data that you are interested in. You can optionally save the output to a file as well, for easy post-hoc reference. Version 1.1.0

Ports/Properties

data

Data to process.

  • verbose name: Data
  • default value: None
  • port type: DataPort
  • value type: object (can be None)
  • data direction: INOUT

List of stream names for which to generate output.

  • verbose name: Streams To Print
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

only_nonempty

Only print non-empty packets.

  • verbose name: Only Nonempty
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

Print packets in a compact format. If enabled, this overrides the other options for selective printing, so uncheck to print specific items (such as properties, markers, etc.)

  • verbose name: Print Compact
  • default value: True
  • port type: BoolPort
  • value type: bool (can be None)

Print the data contents and the shape.

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

Print list of markers contained in the packet, if any.

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

Print stream properties (chunk props).

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

Print channel names, if any." "

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

Print time range covered by the data, if any.

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

Print trial/instance information in the data, if any.

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

Print axis information.

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

save_to_file

Full path of a file to save output to (in addition to printing to the console); leave blank to not save output to disk.

  • verbose name: Save To File
  • default value:
  • port type: StringPort
  • 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)