.. title:: Stats

lisa.stats.Stats
================


.. autoclass:: lisa.stats::Stats
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.stats.Stats.df`
        -
         
         .. withrefctx::
            :module: lisa.stats
            :class: lisa.stats.Stats
         
         
            :class:`pandas.DataFrame` containing the statistics.
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.stats.Stats.get_df`
        -
         
         .. withrefctx::
            :module: lisa.stats
            :class: lisa.stats.Stats
         
         
            Returns a :class:`pandas.DataFrame` containing the statistics.
      * - :meth:`~lisa.stats.Stats.plot_histogram`
        -
         
         .. withrefctx::
            :module: lisa.stats
            :class: lisa.stats.Stats
         
         
            Returns a :class:`matplotlib.figure.Figure` with histogram of the values in the input :class:`pandas.DataFrame`.
      * - :meth:`~lisa.stats.Stats.plot_stats`
        -
         
         .. withrefctx::
            :module: lisa.stats
            :class: lisa.stats.Stats
         
         
            Returns a :class:`matplotlib.figure.Figure` containing the statistics for the class input :class:`pandas.DataFrame`.
      * - :meth:`~lisa.stats.Stats.plot_values`
        -
         
         .. withrefctx::
            :module: lisa.stats
            :class: lisa.stats.Stats
         
         
            Returns a holoviews element with the values in the input :class:`pandas.DataFrame`.
      * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Provides a :class:`logging.Logger` named after ``cls``.
      * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Debugging aid: log the local variables of the calling function.
   


Properties
----------


.. autoproperty:: lisa.stats::Stats.df



.. autoproperty:: lisa.stats::Stats.logger



Methods
-------


.. automethod:: lisa.stats::Stats.get_df



.. automethod:: lisa.stats::Stats.plot_histogram



.. automethod:: lisa.stats::Stats.plot_stats



.. automethod:: lisa.stats::Stats.plot_values



.. automethod:: lisa.stats::Stats.get_logger



.. automethod:: lisa.stats::Stats.log_locals