.. title:: TraceBase

lisa.trace.TraceBase
====================


.. autoclass:: lisa.trace::TraceBase
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.trace.TraceBase.ana`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceBase
         
         
            Allows calling an analysis method on the trace, sharing the dataframe cache.
      * - :attr:`~lisa.trace.TraceBase.available_events`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Set of available events on that trace.
      * - :attr:`~lisa.trace.TraceBase.basetime`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Absolute timestamp when the tracing started.
      * - :attr:`~lisa.trace.TraceBase.end`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            The timestamp of the last trace event.
      * - :attr:`~lisa.trace.TraceBase.endtime`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Absolute timestamp when the tracing stopped.
      * - :attr:`~lisa.trace.TraceBase.start`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            The timestamp of the first trace event.
      * - :attr:`~lisa.trace.TraceBase.time_range`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Duration of that trace (difference between :attr:`start` and :attr:`end`).
      * - :attr:`~lisa.trace.TraceBase.trace_state`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            State of the trace object that might impact the output of dataframe getter functions like :meth:`lisa.trace.TraceBase.df_event`.
      * - :attr:`~lisa.trace.TraceBase.window`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Same as ``(trace.start, trace.end)``.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.trace.TraceBase.__enter__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
      * - :meth:`~lisa.trace.TraceBase.__exit__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
      * - :meth:`~lisa.trace.TraceBase.__getitem__`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Slice the trace with the given time range.
      * - :meth:`~lisa.trace.TraceBase.df_event`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceBase
         
         
            Get a dataframe containing all occurrences of the specified trace event in the parsed trace.
      * - :meth:`~lisa.trace.TraceBase.get_view`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace._InternalTraceBase
         
         
            Get a view on a trace.
      * - :meth:`~lisa.trace.TraceBase.show`
        -
         
         .. withrefctx::
            :module: lisa.trace
            :class: lisa.trace.TraceBase
         
         
            Open the parsed trace using the most appropriate native viewer.
   


Properties
----------


.. autoproperty:: lisa.trace::TraceBase.ana



.. autoproperty:: lisa.trace::TraceBase.available_events



.. autoproperty:: lisa.trace::TraceBase.basetime



.. autoproperty:: lisa.trace::TraceBase.end



.. autoproperty:: lisa.trace::TraceBase.endtime



.. autoproperty:: lisa.trace::TraceBase.start



.. autoproperty:: lisa.trace::TraceBase.time_range



.. autoproperty:: lisa.trace::TraceBase.trace_state



.. autoproperty:: lisa.trace::TraceBase.window



.. autoproperty:: lisa.trace::TraceBase.analysis



.. autoproperty:: lisa.trace::TraceBase.task_ids



Methods
-------


.. automethod:: lisa.trace::TraceBase.__enter__



.. automethod:: lisa.trace::TraceBase.__exit__



.. automethod:: lisa.trace::TraceBase.__getitem__



.. automethod:: lisa.trace::TraceBase.df_event



.. automethod:: lisa.trace::TraceBase.get_view



.. automethod:: lisa.trace::TraceBase.show



.. automethod:: lisa.trace::TraceBase.add_events_deltas



.. automethod:: lisa.trace::TraceBase.df_all_events



.. automethod:: lisa.trace::TraceBase.df_events



.. automethod:: lisa.trace::TraceBase.get_task_by_name



.. automethod:: lisa.trace::TraceBase.get_task_by_pid



.. automethod:: lisa.trace::TraceBase.get_task_id



.. automethod:: lisa.trace::TraceBase.get_task_ids



.. automethod:: lisa.trace::TraceBase.get_task_name_pids



.. automethod:: lisa.trace::TraceBase.get_task_pid



.. automethod:: lisa.trace::TraceBase.get_task_pid_names



.. automethod:: lisa.trace::TraceBase.get_tasks