hermpy.data.data-containers
===========================

.. py:module:: hermpy.data.data-containers


Classes
-------

.. autoapisummary::

   hermpy.data.data-containers.DataContainer
   hermpy.data.data-containers.Timeseries
   hermpy.data.data-containers.Spectrogram


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

.. py:class:: DataContainer

   Bases: :py:obj:`Protocol`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto[T](Protocol):
           def meth(self) -> T:
               ...


   .. py:method:: quickplot() -> None


.. py:class:: Timeseries

   Bases: :py:obj:`DataContainer`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto[T](Protocol):
           def meth(self) -> T:
               ...


   .. py:attribute:: table
      :type:  astropy.table.QTable


   .. py:attribute:: time_column
      :type:  str
      :value: 'UTC'



   .. py:attribute:: metadata
      :type:  dict[str, str]


   .. py:method:: quickplot() -> None


.. py:class:: Spectrogram

   Bases: :py:obj:`DataContainer`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto[T](Protocol):
           def meth(self) -> T:
               ...


   .. py:attribute:: data
      :type:  xarray.Dataset


   .. py:attribute:: time_dimension
      :type:  str
      :value: 'UTC'



   .. py:attribute:: metadata
      :type:  dict[str, str]


   .. py:method:: quickplot() -> None