Skip to content

Inspecting Objects

emzed_gui.inspect() is the main entry point for opening GUI inspectors for supported emzed objects.

Supported Inputs

  • Table: opens the table explorer
  • list[Table] or tuple[Table, ...]: opens the table explorer in multi-table mode
  • PeakMap: opens the peakmap explorer

Unsupported object types raise ValueError.

Basic Usage

from emzed_gui.inspect import inspect

inspect(table)
inspect([table1, table2])
inspect(peakmap)

Dispatch Behavior

inspect() dispatches to the specialized GUI explorer based on the input type:

  • tables use the table explorer
  • peak maps use the peakmap explorer

Additional positional and keyword arguments are forwarded to the selected specialized inspector.

Return Values

Tables

  • modal mode returns True if the table was modified, else False
  • non-modal mode returns the TableExplorer window instance

Peak Maps

  • modal mode returns the selected rows from the peakmap explorer
  • non-modal mode shows the window and returns None

Common Options

  • modal=True: open as a blocking dialog
  • parent=None: parent Qt widget

Table-Specific Options

  • offerAbortOption
  • close_callback
  • custom_buttons_config

Peakmap-Specific Options

  • peakmap2: optional second peakmap for comparison
  • table: optional related table context
  • window: optional initial view window