API

L’interface de programmation d’application (API) publique de Sigima offre un ensemble de fonctions qui peuvent être utilisées pour accéder au backend de calcul DataLab. Cette API est conçue pour être simple et efficace, permettant aux utilisateurs d’effectuer facilement des tâches de traitement de signaux et d’images.

Sous-module	Objectif
sigima.tools	Algorithmes d’analyse de données (fonctionnant sur des tableaux NumPy) dont le but est de combler les lacunes des bibliothèques scientifiques courantes (NumPy, SciPy, scikit-image, etc.), offrant des outils cohérents pour les fonctions de calcul (voir sigima.proc)
sigima.params	Ensembles de paramètres pour configurer les fonctions de calcul (ces paramètres sont des instances d’objets guidata.dataset.DataSet)
sigima.objects	Modèle d’objet pour les signaux et les images (sigima.objects.SignalObj et sigima.objects.ImageObj), résultats scalaires (sigima.objects.GeometryResult et sigima.objects.TableResult), et fonctions associées
sigima.proc	Fonctions de calcul, qui opèrent sur des objets signal et image (sigima.objects.SignalObj ou sigima.objects.ImageObj) et retournent des objets signal ou image, ou des résultats scalaires (sigima.objects.GeometryResult ou sigima.objects.TableResult).
sigima.config	Gestion de la configuration pour la bibliothèque Sigima, y compris les options pour les chemins de données, les traductions et d’autres paramètres.
sigima.client	Interface client pour se connecter à l’application DataLab via le protocole XML-RPC, offrant des capacités de contrôle à distance pour les flux de travail de traitement de signaux et d’images.
sigima.viz	Outils de visualisation pour l’affichage interactif des objets signal et image, prenant en charge les backends PlotPy et Matplotlib pour les tests, le débogage et l’analyse dans les notebooks Jupyter.

Fonctionnalités publiques :

• 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