shnitsel.data.dataset_containers.inter_state
============================================

.. py:module:: shnitsel.data.dataset_containers.inter_state


Classes
-------

.. autoapisummary::

   shnitsel.data.dataset_containers.inter_state.InterState


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

.. py:class:: InterState(frames = None, /, direct_interstate_data = None)

   Bases: :py:obj:`shnitsel.data.dataset_containers.shared.ShnitselDerivedDataset`


   Definition of the protocol to support instantiation from
   xarray dataset structs.


   .. py:attribute:: _original_frames
      :type:  shnitsel.data.dataset_containers.data_series.DataSeries | None


   .. py:property:: delta_energy
      :type: xarray.DataArray



   .. py:property:: energy_interstate
      :type: xarray.DataArray



   .. py:property:: dipole_transition
      :type: xarray.DataArray



   .. py:property:: dipole_transition_norm
      :type: xarray.DataArray



   .. py:property:: nacs
      :type: xarray.DataArray



   .. py:property:: nacs_norm
      :type: xarray.DataArray



   .. py:property:: socs
      :type: xarray.DataArray



   .. py:property:: socs_norm
      :type: xarray.DataArray



   .. py:property:: fosc
      :type: xarray.DataArray



   .. py:method:: as_xr_dataset()

      Base function to implement by classes supporting this protocol
      to allow for standardized conversion to a dataset

      :returns: A tuple of the `io_type_tag` under which the deserializer is registered
                with the Shnitsel Tools framework (or `None` if no
                deserialization is desired/supported)/
                Then the `xr.Dataset that is the result of the conversion.
                And lastly a dict of metadata that might help with deserialization later on.
      :rtype: tuple[str, xr.Dataset, MetaData]

      :raises ValueError: If the conversion failed for some reason.



   .. py:method:: get_type_marker()
      :classmethod:



   .. py:method:: from_xr_dataset(dataset, metadata)
      :classmethod:


      Class method to support standardized deserialization of arbitrary classes.
      Implemented as a class method to avoid need to construct instance for
      deserialization.

      :param cls: The class executing the deserialization.
      :type cls: type[ResType]
      :param dataset: The dataset to be deserialized into the output type.
      :type dataset: xr.Dataset
      :param metadata: Metdatata from the serialization process.
      :type metadata: MetaData

      :returns: The deserialized instance of the target class.
      :rtype: instance of cls

      :raises TypeError: If deserialization of the object was not possible