.. title:: NotebookAnalysis

lisa.analysis.notebook.NotebookAnalysis
=======================================


.. autoclass:: lisa.analysis.notebook::NotebookAnalysis
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Attributes
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.analysis.notebook.NotebookAnalysis.name`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.AnalysisHelpers
         
         
            Name of the analysis class.
   
   
   .. 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()``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.analysis.notebook.NotebookAnalysis.__getattr__`
        -
         
         .. withrefctx::
            :module: lisa.analysis.notebook
            :class: lisa.analysis.notebook.NotebookAnalysis
      * - :meth:`~lisa.analysis.notebook.NotebookAnalysis.df_all_events`
        -
         
         .. withrefctx::
            :module: lisa.analysis.notebook
            :class: lisa.analysis.notebook.NotebookAnalysis
         
         
            Provide a dataframe with an ``info`` column containing the textual human-readable representation of the events fields.
      * - :meth:`~lisa.analysis.notebook.NotebookAnalysis.plot_event_field`
        -
         
         .. withrefctx::
            :module: lisa.analysis.notebook
            :class: lisa.analysis.notebook.NotebookAnalysis
         
         
            Plot a signal represented by the filtered values of a field of an event.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.cache` :sup:`inherited`
        -
         
         .. 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` :sup:`inherited`
        -
         
         .. 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` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
         
         
            Dataframe function decorator.
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_all_events` :sup:`inherited`
        -
         
         .. 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` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.analysis.base
            :class: lisa.analysis.base.TraceAnalysisBase
      * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_default_plot_path` :sup:`inherited`
        -
         
         .. 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` :sup:`inherited`
        -
         
         .. 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.
   


Attributes
----------


.. attribute:: NotebookAnalysis.name
   :canonical: lisa.analysis.notebook.NotebookAnalysis.name
   :value: 'notebook'

   
   .. withrefctx::
      :module: lisa.analysis.base
      :class: lisa.analysis.base.AnalysisHelpers
   
   
      Name of the analysis class.
   



Properties
----------


.. autoproperty:: lisa.analysis.notebook::NotebookAnalysis.logger



Methods
-------


.. automethod:: lisa.analysis.notebook::NotebookAnalysis.__getattr__



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.df_all_events



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.plot_event_field



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.cache



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.call_on_trace



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.df_method



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_all_events



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_analysis_classes



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_default_plot_path



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_df_methods



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_logger



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.get_plot_methods



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.log_locals



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.plot_method



.. automethod:: lisa.analysis.notebook::NotebookAnalysis.save_plot