.. title:: FrequencyAnalysis lisa.analysis.frequency.FrequencyAnalysis ========================================= .. autoclass:: lisa.analysis.frequency::FrequencyAnalysis :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.analysis.frequency.FrequencyAnalysis.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.frequency.FrequencyAnalysis.df_cpu_frequency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Same as :meth:`df_cpus_frequency` but for a single CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_cpu_frequency_residency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Get per-CPU frequency residency, i.e. amount of time CPU `cpu` spent at each frequency. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_cpu_frequency_transition_rate` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Compute frequency transition rate of a given CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_cpu_frequency_transitions` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Compute number of frequency transitions of a given CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_cpus_frequency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Similar to ``trace.df_event('cpu_frequency')``, with ``userspace@cpu_frequency_devlib`` support. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_domain_frequency_residency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Get per-frequency-domain frequency residency, i.e. amount of time each domain at each frequency. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.df_peripheral_clock_effective_rate` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Dataframe of peripheral clock frequencies. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.get_average_cpu_frequency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Get the average frequency for a given CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_cpu_frequencies` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot frequency for the specified CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_cpu_frequency_residency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot per-CPU frequency residency. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_cpu_frequency_transitions` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot frequency transitions count of the specified CPU. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_domain_frequencies` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot frequency trend for all frequency domains. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_domain_frequency_residency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot the frequency residency for all frequency domains. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_domain_frequency_transitions` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot frequency transitions count for all frequency domains. * - :meth:`~lisa.analysis.frequency.FrequencyAnalysis.plot_peripheral_frequency` - .. withrefctx:: :module: lisa.analysis.frequency :class: lisa.analysis.frequency.FrequencyAnalysis Plot frequency for the specified peripheral clock frequency. * - :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:: FrequencyAnalysis.name :canonical: lisa.analysis.frequency.FrequencyAnalysis.name :value: 'frequency' .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. Properties ---------- .. autoproperty:: lisa.analysis.frequency::FrequencyAnalysis.logger Methods ------- .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_cpu_frequency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_cpu_frequency_residency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_cpu_frequency_transition_rate .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_cpu_frequency_transitions .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_cpus_frequency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_domain_frequency_residency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_peripheral_clock_effective_rate .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_average_cpu_frequency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_cpu_frequencies .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_cpu_frequency_residency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_cpu_frequency_transitions .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_domain_frequencies .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_domain_frequency_residency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_domain_frequency_transitions .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_peripheral_frequency .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.cache .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.call_on_trace .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.df_method .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_all_events .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_analysis_classes .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_default_plot_path .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_df_methods .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_logger .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.get_plot_methods .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.log_locals .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.plot_method .. automethod:: lisa.analysis.frequency::FrequencyAnalysis.save_plot