API

The public Application Programming Interface (API) of Sigima offers a set of functions that can be used to access the DataLab computational backend. This API is designed to be simple and effective, allowing users to perform signal and image processing tasks with ease.

Submodule	Purpose
sigima.tools	Algorithms for data analysis (operating on NumPy arrays) which purpose is to fill in the gaps of common scientific libraries (NumPy, SciPy, scikit-image, etc.), offering consistent tools for computation functions (see sigima.proc)
sigima.params	Sets of parameters for configuring computation functions (these parameters are instances of guidata.dataset.DataSet objects)
sigima.objects	Object model for signals and images (sigima.objects.SignalObj and sigima.objects.ImageObj), scalar results (sigima.objects.GeometryResult and sigima.objects.TableResult), and related functions
sigima.proc	Computation functions, which operate on signal and image objects (sigima.objects.SignalObj or sigima.objects.ImageObj) and return signal or image objects, or scalar results (sigima.objects.GeometryResult or sigima.objects.TableResult).
sigima.config	Configuration management for the Sigima library, including options for data paths, translations, and other settings.
sigima.client	Client interface for connecting to DataLab application through XML-RPC protocol, providing remote control capabilities for signal and image processing workflows.
sigima.viz	Visualization tools for interactive display of signal and image objects, supporting PlotPy and Matplotlib backends for testing, debugging, and Jupyter notebook analysis.

Public features:

• Tools (sigima.tools)
  • Check functions
  • Signal Processing Tools
  • Image Processing Tools
  • Data Type Conversion Tools
  • Coordinate Conversion Tools
• Parameters (sigima.params)
  • Introduction to DataSet Parameters
  • I/O parameters
  • Common parameters
  • Signal parameters
  • Image parameters
• Model classes for signals and images (sigima.objects)
  • Scalar results
  • Common features of signals and images
  • Signals
  • Images
• Computation (sigima.proc)
  • Common processing features
  • Signal processing features
  • Image processing features
  • Decorators and utilities
  • Title Formatting System
• Configuration (sigima.config)
• DataLab Client (sigima.client)
  • From an IDE
  • From a third-party application
  • Supported features
  • Additional features
  • API
• sigima.viz — Visualization Tools
  • Backend Selection
  • Module Attributes
  • Quick Start
  • Viewing Functions
  • Low-Level Viewing Functions
  • Creation Functions
  • Backend Differences