← visualization package

InspectPacket

Shows the contents of a Packet, including data tensor values, axes, streams, and markers.

Shows: 1) matrix or vector of values from a data stream based on the axes selected in the properties; 2) a list of the axes in the stream and their values; 3) a list of the streams in the packet and their shape and properties; 4) a list of markers (if a marker stream is selected). If the packet contains multiple streams, a dropdown box is shown so that a particular stream can be selected. (The stream name to display can also be specified in the stream property; this may be recommended for datasets with many streams which may take a while to load.) This is a more legible replacement for the PrintToConsole in cases where windows can pop up. It can be particularly helpful when debugging a pipeline in order to see what the data is like at a given point. Note that in a pipeline with offline data, this node will keep the pipeline running until the window is closed using the 'close' button. Version 3.3.2

Ports/Properties

data

Data to display.

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

show_data_table

Show data from the selected col/row axes, for selected stream.

• verbose name: Show Data Table
• default value: True
• port type: BoolPort
• value type: bool (can be None)

show_axes_table

Show list of the axes and their values, for selected stream.

• verbose name: Show Axes Table
• default value: True
• port type: BoolPort
• value type: bool (can be None)

show_streams_table

Show all streams in the packet and their properties.

• verbose name: Show Streams Table
• default value: False
• port type: BoolPort
• value type: bool (can be None)

show_markers_table

Show the event markers, if any. This will be automatically enabled if a marker stream is selected.

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

stream

Name of stream to display. If empty, the first non-empty stream will be displayed. When used with streaming data, a dropdown box will appear allowing you to switch streams as the pipeline is running. When used with offline data, only a single stream will be shown, so change the stream name here to see a particular stream. Wildcards are supported, i.e. mystream* will display the first stream whose name starts with mystream.

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

stream_name

• verbose name: Stream Name
• default value: None
• port type: AliasPort
• value type: str (can be None)

col_axis

Axis to use for the column data in the data table. If none, a single column will be shown with the data from the row axis.

• verbose name: Col Axis
• default value: time
• port type: ComboPort
• value type: str (can be None)

row_axis

Axis to use for the rows data, in the data table. If none, a single row will be shown with the data from the column axis.

• verbose name: Row Axis
• default value: space
• port type: ComboPort
• value type: str (can be None)

instance_axis_field

If an instance axis is selected as the column or row axis, the values from this field will be displayed in the row or column header, providing this field is present in the data.

• verbose name: Instance Axis Field
• default value: TargetValue
• port type: ComboPort
• value type: str (can be None)

decimals

Number of decimal points to round data to (applies to data table only).

• verbose name: Decimals
• default value: 6
• port type: IntPort
• value type: int (can be None)

show_max_columns

Only show the first X columns (X being the value input here. Set to 0 to show all columns. Warning: Showing all columns on offline data will likely cause the plot to take a long time to come up esp if the file is large.

• verbose name: Show Max Columns
• default value: 20
• port type: IntPort
• value type: int (can be None)

show_max_values

Only show the first X values in an axis. This avoids the plot becoming slow when handling offline data with very long axes (such as many timepoints). Set to 0 to show all values. This setting is ignored (set to 0) for streaming data since it's not an issue there.

• verbose name: Show Max Values
• default value: 50
• port type: IntPort
• value type: int (can be None)

every_n_ticks

Show data only every N ticks. This slows down the display of data (which by default runs at 25Hz). This is only applicable to streaming data and mostly useful for the data table. Setting this to > 1 is not recommended if looking at the Marker table as most markers would not be shown.

• verbose name: Every N Ticks
• default value: 1
• port type: IntPort
• value type: int (can be None)

persist_markers

When viewing streaming data, retain previously received markers in the markers table (showing a list of all markers received) rather than only showing the markers in the current packet (which will flash by quickly).

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

window_title

Set the window title.

• verbose name: Window Title
• default value: Inspect Data Packet
• port type: StringPort
• value type: str (can be None)

font_size

Font size for table data.

• verbose name: Font Size
• default value: 10
• port type: IntPort
• value type: int (can be None)

always_on_top

Window should be always on top.

• verbose name: Always On Top
• default value: True
• port type: BoolPort
• value type: bool (can be None)

keep_window_active

On a non-streaming data, keep the window active and visible after data has been diplayed. If False, this node will report as "finished" and the pipeline will be done if all other nodes have finished as well. However, the window will no longer be interactive.

• verbose name: Keep Window Active
• default value: True
• port type: BoolPort
• value type: bool (can be None)

fewer_buttons

Do not show a minimize and maximize buttons on the window (to give more space for the window title). The window will still have a close button.

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

initial_position

Initial position of the window on the screen. This is given in pixels, and is formatted as [x, y, width, height], where x=0 and y=0 represent the top left corner.

• verbose name: Initial Position
• default value: [20, 20, 800, 800]
• port type: ListPort
• value type: list (can be None)

verbose

Show warnings (i.e ., selected axes not found in data, etc.).

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

ignore_signal_changes

Ignore signal_changed events from other nodes, providing the plot has already initialized.

• verbose name: Ignore Signal Changes
• default value: False
• port type: BoolPort
• value type: bool (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)