.. title:: AnalysisHelpers

lisa.analysis.base.AnalysisHelpers
==================================


.. autoclass:: lisa.analysis.base::AnalysisHelpers
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.analysis.base.AnalysisHelpers.name`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Name of the analysis class.
      * - :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.analysis.base.AnalysisHelpers.get_default_plot_path`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Return the default path to use to save plots for the analysis.
      * - :meth:`~lisa.analysis.base.AnalysisHelpers.get_plot_methods`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
      * - :meth:`~lisa.analysis.base.AnalysisHelpers.plot_method`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Plot function decorator.
      * - :meth:`~lisa.analysis.base.AnalysisHelpers.save_plot`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Save a holoviews element or :class:`matplotlib.figure.Figure` as an image file.
      * - :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.analysis.base::AnalysisHelpers.name



.. autoproperty:: lisa.analysis.base::AnalysisHelpers.logger



Methods
-------


.. automethod:: lisa.analysis.base::AnalysisHelpers.get_default_plot_path



.. automethod:: lisa.analysis.base::AnalysisHelpers.get_plot_methods



.. automethod:: lisa.analysis.base::AnalysisHelpers.plot_method



.. automethod:: lisa.analysis.base::AnalysisHelpers.save_plot



.. automethod:: lisa.analysis.base::AnalysisHelpers.get_logger



.. automethod:: lisa.analysis.base::AnalysisHelpers.log_locals



.. automethod:: lisa.analysis.base::AnalysisHelpers.cycle_colors



.. automethod:: lisa.analysis.base::AnalysisHelpers.do_plot



.. automethod:: lisa.analysis.base::AnalysisHelpers.get_next_color



.. automethod:: lisa.analysis.base::AnalysisHelpers.set_axis_cycler



.. automethod:: lisa.analysis.base::AnalysisHelpers.set_axis_rc_params



.. automethod:: lisa.analysis.base::AnalysisHelpers.setup_plot