pyepr.dataset
=============

.. py:module:: pyepr.dataset


Classes
-------

.. toctree::
   :hidden:

   /autoapi/pyepr/dataset/EPRAccessor

.. autoapisummary::

   pyepr.dataset.EPRAccessor


Functions
---------

.. autoapisummary::

   pyepr.dataset.get_all_axes
   pyepr.dataset.get_all_fixed_param
   pyepr.dataset.create_dataset_from_sequence
   pyepr.dataset.create_dataset_from_axes
   pyepr.dataset.create_dataset_from_bruker


Module Contents
---------------

.. py:function:: get_all_axes(sequence)

.. py:function:: get_all_fixed_param(sequence)

.. py:function:: create_dataset_from_sequence(data, sequence, extra_params={})

.. py:function:: create_dataset_from_axes(data, axes, params = {}, axes_labels=None)

   
   Create an xarray dataset from a numpy array and a list of axes.


   :Parameters:

       **data** : np.ndarray
           The data to be stored in the dataset.

       **axes** : list
           A list of numpy arrays containing the axes for each dimension of the data.

       **params** : dict, optional
           A dictionary containing any additional parameters to be stored in the dataset, by default None

       **axes_labels** : list, optional
           A list of labels for each axis, by default None














   ..
       !! processed by numpydoc !!

.. py:function:: create_dataset_from_bruker(filepath)