:orphan:


===============
Example Gallery
===============

In this section, we present illustrative examples for importing files
serialized with the CSD model, using the `csdmpy` package.
Because the CSD model allows multi-dimensional datasets with multiple dependent
variables, we use a shorthand notation of :math:`d\mathrm{D}\{p\}` to
indicate that a dataset has a :math:`p`-component dependent variable defined
on a :math:`d`-dimensional coordinate grid.
In the case of `correlated datasets`, the number of components in each
dependent variable is given as a list within the curly braces, `i.e.`,
:math:`d\mathrm{D}\{p_0, p_1, p_2, ...\}`.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    </div>

Scalar, 1D{1} datasets
======================

The 1D{1} datasets are one dimensional, :math:`d=1`, with one single-component,
:math:`p=1`, dependent variable. These datasets are the most common, and we,
therefore, provide a few examples from various fields of science.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Global Mean Sea Level rise dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_0_gmsl_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_0_gmsl.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Global Mean Sea Level rise dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Nuclear Magnetic Resonance (NMR) dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_1_NMR_bloch_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_1_NMR_bloch.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Nuclear Magnetic Resonance (NMR) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Electron Paramagnetic Resonance (EPR) dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_2_EPR_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_2_EPR.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Electron Paramagnetic Resonance (EPR) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Gas Chromatography dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_3_GS_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_3_GS.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Gas Chromatography dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Fourier Transform Infrared Spectroscopy (FTIR) dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_4_FTIR_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_4_FTIR.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Fourier Transform Infrared Spectroscopy (FTIR) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ultraviolet–visible (UV-vis) dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_5_UV-vis_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_5_UV-vis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ultraviolet–visible (UV-vis) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Mass spectrometry (sparse) dataset">

.. only:: html

  .. image:: /auto_examples/1D_1_examples/images/thumb/sphx_glr_plot_6_Mass_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_1D_1_examples_plot_6_Mass.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mass spectrometry (sparse) dataset</div>
    </div>


.. raw:: html

    </div>

Scalar, 2D{1} datasets
======================

The 2D{1} datasets are two dimensional, :math:`d=2`, with one
single-component dependent variable, :math:`p=1`. Following are some
2D{1} example datasets from various scientific fields expressed in CSDM
format.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Astronomy dataset">

.. only:: html

  .. image:: /auto_examples/2D_1_examples/images/thumb/sphx_glr_plot_0_astronomy_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_2D_1_examples_plot_0_astronomy.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Astronomy dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Nuclear Magnetic Resonance (NMR) dataset">

.. only:: html

  .. image:: /auto_examples/2D_1_examples/images/thumb/sphx_glr_plot_1_NMR_satrec_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_2D_1_examples_plot_1_NMR_satrec.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Nuclear Magnetic Resonance (NMR) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Transmission Electron Microscopy (TEM) dataset">

.. only:: html

  .. image:: /auto_examples/2D_1_examples/images/thumb/sphx_glr_plot_2_TEM_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_2D_1_examples_plot_2_TEM.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Transmission Electron Microscopy (TEM) dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Labeled Dataset">

.. only:: html

  .. image:: /auto_examples/2D_1_examples/images/thumb/sphx_glr_plot_3_labeled_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_2D_1_examples_plot_3_labeled.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Labeled Dataset</div>
    </div>


.. raw:: html

    </div>

Vector datasets
===============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Vector, 1D{2} dataset">

.. only:: html

  .. image:: /auto_examples/vector/images/thumb/sphx_glr_plot_0_vector_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_vector_plot_0_vector.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Vector, 1D{2} dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Vector, 2D{2} dataset">

.. only:: html

  .. image:: /auto_examples/vector/images/thumb/sphx_glr_plot_1_vector_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_vector_plot_1_vector.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Vector, 2D{2} dataset</div>
    </div>


.. raw:: html

    </div>


Tensor datasets
===============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Diffusion tensor MRI, 3D{6} dataset">

.. only:: html

  .. image:: /auto_examples/tensor/images/thumb/sphx_glr_plot_0_3D_diff_tensor_mri_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_tensor_plot_0_3D_diff_tensor_mri.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Diffusion tensor MRI, 3D{6} dataset</div>
    </div>


.. raw:: html

    </div>

Pixel datasets
==============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Image, 2D{3} datasets">

.. only:: html

  .. image:: /auto_examples/pixel/images/thumb/sphx_glr_plot_0_image_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_pixel_plot_0_image.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Image, 2D{3} datasets</div>
    </div>


.. raw:: html

    </div>

Correlated datasets
===================

The Core Scientific Dataset Model (CSDM) supports multiple dependent
variables that share the same `d`-dimensional coordinate grid, where
:math:`d>=0`.
We call the dependent variables from these datasets as `correlated datasets`.
Following are a few examples of the correlated dataset.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Scatter, 0D{1,1} dataset">

.. only:: html

  .. image:: /auto_examples/correlated_examples/images/thumb/sphx_glr_plot_0_0D11_dataset_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_correlated_examples_plot_0_0D11_dataset.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Scatter, 0D{1,1} dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Meteorological, 2D{1,1,2,1,1} dataset">

.. only:: html

  .. image:: /auto_examples/correlated_examples/images/thumb/sphx_glr_plot_1_meteorology_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_correlated_examples_plot_1_meteorology.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Meteorological, 2D{1,1,2,1,1} dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Astronomy, 2D{1,1,1} dataset (Creating image composition)">

.. only:: html

  .. image:: /auto_examples/correlated_examples/images/thumb/sphx_glr_plot_2_astronomy_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_correlated_examples_plot_2_astronomy.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Astronomy, 2D{1,1,1} dataset (Creating image composition)</div>
    </div>


.. raw:: html

    </div>

Sparse datasets
===============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Sparse along one dimension, 2D{1,1} dataset">

.. only:: html

  .. image:: /auto_examples/sparse/images/thumb/sphx_glr_plot_0_1D_sparse_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_sparse_plot_0_1D_sparse.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Sparse along one dimension, 2D{1,1} dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Sparse along two dimensions, 2D{1,1} dataset">

.. only:: html

  .. image:: /auto_examples/sparse/images/thumb/sphx_glr_plot_1_2D_sparse_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_sparse_plot_1_2D_sparse.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Sparse along two dimensions, 2D{1,1} dataset</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/1D_1_examples/index.rst
   /auto_examples/2D_1_examples/index.rst
   /auto_examples/vector/index.rst
   /auto_examples/tensor/index.rst
   /auto_examples/pixel/index.rst
   /auto_examples/correlated_examples/index.rst
   /auto_examples/sparse/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_