.. title:: TraceAnalysisBase

lisa.analysis.base.TraceAnalysisBase
====================================


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

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.utils
            :class: lisa.utils.Loggable
         
         
            Convenience short-hand for ``self.get_logger()``.
      * - :attr:`~lisa.analysis.base.AnalysisHelpers.name` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Name of the analysis class.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.cache`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Decorator to enable caching of the output of dataframe getter function in the trace cache.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.call_on_trace`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Call a method of a subclass on a given trace.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.df_method`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Dataframe function decorator.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_all_events`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Returns the set of all events used by any of the methods.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_analysis_classes`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_default_plot_path`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Return the default path to use to save plots for the analysis.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_df_methods`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
      * - :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.analysis.base.AnalysisHelpers.get_plot_methods` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
      * - :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.
      * - :meth:`~lisa.analysis.base.AnalysisHelpers.plot_method` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Plot function decorator.
      * - :meth:`~lisa.analysis.base.AnalysisHelpers.save_plot` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Save a holoviews element or :class:`matplotlib.figure.Figure` as an image file.
   


Properties
----------


.. autoproperty:: lisa.analysis.base::TraceAnalysisBase.logger



.. autoproperty:: lisa.analysis.base::TraceAnalysisBase.name



Methods
-------


.. automethod:: lisa.analysis.base::TraceAnalysisBase.cache



.. automethod:: lisa.analysis.base::TraceAnalysisBase.call_on_trace



.. automethod:: lisa.analysis.base::TraceAnalysisBase.df_method



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_all_events



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_analysis_classes



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_default_plot_path



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_df_methods



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_logger



.. automethod:: lisa.analysis.base::TraceAnalysisBase.get_plot_methods



.. automethod:: lisa.analysis.base::TraceAnalysisBase.log_locals



.. automethod:: lisa.analysis.base::TraceAnalysisBase.plot_method



.. automethod:: lisa.analysis.base::TraceAnalysisBase.save_plot