API

The public Application Programming Interface (API) of DataLab offers a set of functions to access the DataLab features.

Note

For more details about the sigima package, please refer to the Sigima documentation. The Sigima API is especially useful to write scripts that can be run in DataLab (see Macros) or to develop plugins (see Plugins).

Note

A significant part of the DataLab graphical layer is provided by the sigimax package: generic main window, configuration system, dockable plot widgets, HDF5 workspace and browser, log viewer and scientific dialogs. Those classes are documented in the SigimaX documentation, and are the ones to look at when building a Qt scientific application on the same foundation (see The DataLab Platform).

Public features:

• Proxy objects (datalab.control.proxy)
  • Remote proxy
  • Local proxy
  • Proxy context manager
  • Calling processor methods using proxy objects

Internal features:

• GUI
• Main window
• Panel
• Action handler
• Object model
• Object view
• Plot handler
• ROI editor
• Processor
• Docks
• HDF5 I/O