timesead.utils.plot_utils
=========================

.. py:module:: timesead.utils.plot_utils


Functions
---------

.. autoapisummary::

   timesead.utils.plot_utils.plot_error_bars
   timesead.utils.plot_utils.plot_histogram
   timesead.utils.plot_utils.plot_sequence_against_anomaly
   timesead.utils.plot_utils.save_plot
   timesead.utils.plot_utils.set_style


Module Contents
---------------

.. py:function:: plot_error_bars(means: list, deviations: list, ax: Optional[matplotlib.pyplot.Axes] = None, offset: int = 0, **kwargs)

.. py:function:: plot_histogram(data: Optional[List[int]] = None, resolution: int = 100, yticks: Optional[Union[int, List]] = None, ax: Optional[matplotlib.axes.Axes] = None, hist_range: Tuple[int, int] = (0, 1), xticks: Optional[List[int]] = None, **kwargs)

.. py:function:: plot_sequence_against_anomaly(values: List[float], targets: List[float], ax: Optional[matplotlib.axes.Axes] = None, xticks: Optional[Union[int, List]] = None, scatter: bool = True, yticks: bool = True)

   Plot 1D sequence against anomaly windows.

   :param values: Sequence of values to plot against anomalies.
   :type values: List[float]
   :param targets: List of labels taking values in {0,1} of the same length as values.
   :type targets: List[float]
   :param ax: Axes object to use for plotting. Uses current Axes if None.
   :type ax: Optional[mplt.axes.Axes]
   :param xticks: Generates <xticks> xticks if int. Uses xticks directly if List. No xticks if None.
   :type xticks: Optional[Union[int, List]]
   :param scatter: Draw values as line plot or scatter plot.
   :type scatter: bool
   :param yticks: Set yticks.
   :type yticks: bool


.. py:function:: save_plot(path: str)

   Save the current figure and close it.

   :param path: Path to save the figure to.
   :type path: str


.. py:function:: set_style(stylefile: str = os.path.join(RESOURCE_DIRECTORY, 'style', 'timesead.mplstyle'))

   Sets the rcParmaters of matplotlib from a style file.

   :param stylefile: Style file in mplstyle format.
   :type stylefile: str