Sigima
======

**Sigima** is an advanced Python library for *scientific image and signal processing*.
It provides a wide range of functionalities for analyzing and processing data, including signal filtering, image enhancement, and feature extraction. Sigima is based on a simple but effective object-oriented design, making it easy to use and extend.

With Sigima, do in 3 lines of code what would normally take dozens of lines:

.. code-block:: python

    import numpy as np
    import sigima.objects
    import sigima.proc.image

    data = np.random.normal(100, 30, (100, 100))  # Prepare test image data

    img = sigima.objects.create_image("Noisy", data)  # Create the image object
    img.roi = sigima.objects.create_image_roi("circle", [30, 30, 20])  # Define ROI
    result = sigima.proc.image.gaussian_filter(img, sigma=5.0)  # Apply Gaussian filter

.. figure:: _static/DataLab-Banner.svg
    :align: center
    :width: 300 px
    :class: dark-light no-scaled-link

    Developed and maintained by the DataLab Platform Developers, **Sigima** powers the computation backend of `DataLab <https://www.datalab-platform.com>`_.

.. only:: html and not latex

    .. grid:: 2 2 4 4
        :gutter: 1 2 3 4

        .. grid-item-card:: :octicon:`rocket;1em;sd-text-info`  User Guide
            :link: user_guide/index
            :link-type: doc

            Installation, overview, and features

        .. grid-item-card:: :octicon:`code;1em;sd-text-info`  Examples
            :link: ../auto_examples/index
            :link-type: doc

            Gallery of examples

        .. grid-item-card:: :octicon:`book;1em;sd-text-info`  API
            :link: api/index
            :link-type: doc

            Reference documentation

        .. grid-item-card:: :octicon:`gear;1em;sd-text-info`  Contributing
            :link: contributing/index
            :link-type: doc

            Getting involved in the project


Try it Online
-------------

**Experience Sigima instantly in your browser** — no installation required!

.. image:: https://img.shields.io/badge/Try_it-online-blue?logo=jupyter
   :target: https://notebook.link/github/DataLab-Platform/Sigima/tree/main/notebooks/?path=notebooks/sigima_basic_example.ipynb
   :alt: Try it online

Click the badge above to open a basic example notebook in a live JupyterLite
environment powered by `notebook.link <https://notebook.link/>`_. This service,
developed by `QuantStack <https://quantstack.net/>`_, enables sharing and running
Jupyter notebooks directly in the browser with zero setup.

Simply run the cells to explore:

- Creating signal and image objects
- Applying processing functions
- Visualizing results inline


Sigima has been funded by the following stakeholders:

.. list-table::
    :header-rows: 0

    * - |nlnet_logo|
      - `NLnet Foundation <https://nlnet.nl>`_, as part of the NGI0 Commons Fund, backed by the European Commission, has funded the `redesign of DataLab's core architecture <https://nlnet.nl/project/DataLab/>`_.

    * - |cea_logo|
      - `CEA <https://www.cea.fr>`_, the French Alternative Energies and Atomic Energy Commission, is the major investor in DataLab, and is the main contributor to the project.

    * - |codra_logo|
      - `CODRA`_, a software engineering and editor firm, has supported DataLab open-source journey since its inception (see `here <https://codra.net/en/offer/software-engineering/datalab/>`_).

.. |cea_logo| image:: images/logos/cea.svg
    :width: 64px
    :height: 64px
    :target: https://www.cea.fr
    :class: dark-light no-scaled-link

.. |codra_logo| image:: images/logos/codra.svg
    :width: 64px
    :height: 64px
    :target: https://codra.net
    :class: dark-light no-scaled-link

.. |nlnet_logo| image:: images/logos/nlnet.svg
    :width: 64px
    :height: 64px
    :target: https://nlnet.nl
    :class: dark-light no-scaled-link


.. only:: latex and not html

  .. toctree::
    :maxdepth: 2
    :caption: Contents

    user_guide/index
    auto_examples/index
    api/index
    contributing/index
    release_notes/index


.. _DataLab: https://www.datalab-platform.com
.. _CODRA: https://codra.net/
