.. title:: IdleAnalysis lisa.analysis.idle.IdleAnalysis =============================== .. autoclass:: lisa.analysis.idle::IdleAnalysis :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.analysis.idle.IdleAnalysis.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.idle.IdleAnalysis.df_cluster_idle_state_residency` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Compute time spent by a given cluster in each idle state. * - :meth:`~lisa.analysis.idle.IdleAnalysis.df_cpu_idle` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Same as :meth:`df_cpus_idle` but for one CPU. * - :meth:`~lisa.analysis.idle.IdleAnalysis.df_cpu_idle_state_residency` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Compute time spent by a given CPU in each idle state. * - :meth:`~lisa.analysis.idle.IdleAnalysis.df_cpus_idle` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Dataframe of the ``cpu_idle`` event, with the following columns:. * - :meth:`~lisa.analysis.idle.IdleAnalysis.df_cpus_wakeups` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Get a DataFrame showing when CPUs have woken from idle. * - :meth:`~lisa.analysis.idle.IdleAnalysis.plot_cluster_idle_state_residency` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Plot the idle state residency of a cluster. * - :meth:`~lisa.analysis.idle.IdleAnalysis.plot_clusters_idle_state_residency` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Plot the idle state residency of all clusters. * - :meth:`~lisa.analysis.idle.IdleAnalysis.plot_cpu_idle_state_residency` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Plot the idle state residency of a CPU. * - :meth:`~lisa.analysis.idle.IdleAnalysis.signal_cluster_active` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Build a square wave representing the active (i.e. non-idle) cluster time. * - :meth:`~lisa.analysis.idle.IdleAnalysis.signal_cpu_active` - .. withrefctx:: :module: lisa.analysis.idle :class: lisa.analysis.idle.IdleAnalysis Build a square wave representing the active (i.e. non-idle) CPU time. * - :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:: IdleAnalysis.name :canonical: lisa.analysis.idle.IdleAnalysis.name :value: 'idle' .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. Properties ---------- .. autoproperty:: lisa.analysis.idle::IdleAnalysis.logger Methods ------- .. automethod:: lisa.analysis.idle::IdleAnalysis.df_cluster_idle_state_residency .. automethod:: lisa.analysis.idle::IdleAnalysis.df_cpu_idle .. automethod:: lisa.analysis.idle::IdleAnalysis.df_cpu_idle_state_residency .. automethod:: lisa.analysis.idle::IdleAnalysis.df_cpus_idle .. automethod:: lisa.analysis.idle::IdleAnalysis.df_cpus_wakeups .. automethod:: lisa.analysis.idle::IdleAnalysis.plot_cluster_idle_state_residency .. automethod:: lisa.analysis.idle::IdleAnalysis.plot_clusters_idle_state_residency .. automethod:: lisa.analysis.idle::IdleAnalysis.plot_cpu_idle_state_residency .. automethod:: lisa.analysis.idle::IdleAnalysis.signal_cluster_active .. automethod:: lisa.analysis.idle::IdleAnalysis.signal_cpu_active .. automethod:: lisa.analysis.idle::IdleAnalysis.cache .. automethod:: lisa.analysis.idle::IdleAnalysis.call_on_trace .. automethod:: lisa.analysis.idle::IdleAnalysis.df_method .. automethod:: lisa.analysis.idle::IdleAnalysis.get_all_events .. automethod:: lisa.analysis.idle::IdleAnalysis.get_analysis_classes .. automethod:: lisa.analysis.idle::IdleAnalysis.get_default_plot_path .. automethod:: lisa.analysis.idle::IdleAnalysis.get_df_methods .. automethod:: lisa.analysis.idle::IdleAnalysis.get_logger .. automethod:: lisa.analysis.idle::IdleAnalysis.get_plot_methods .. automethod:: lisa.analysis.idle::IdleAnalysis.log_locals .. automethod:: lisa.analysis.idle::IdleAnalysis.plot_method .. automethod:: lisa.analysis.idle::IdleAnalysis.save_plot