drippy.multifactor
==================

.. py:module:: drippy.multifactor

.. autoapi-nested-parse::

   Plotting functions for multi-factor/DOE models.



Functions
---------

.. autoapisummary::

   drippy.multifactor._get_figure_and_multi_axes
   drippy.multifactor.doe_scatter_plot
   drippy.multifactor.doe_mean_plot
   drippy.multifactor.doe_sd_plot
   drippy.multifactor.contour_plot


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

.. py:function:: _get_figure_and_multi_axes(fig: matplotlib.figure.Figure | None, axes: numpy.ndarray | None, n: int) -> tuple[matplotlib.figure.Figure, numpy.ndarray]

.. py:function:: doe_scatter_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, axes: numpy.ndarray | None = None) -> tuple[matplotlib.figure.Figure, numpy.ndarray]

   Creates scatter plots of y vs each factor.

   One subplot per factor in data.factors.

   :param data: EDAData container. Requires factors.
   :param fig: Matplotlib figure. If None, creates new figure.
   :param axes: 1-D array of Axes, one per factor. If None,
                creates new axes.

   :returns: (fig, axes) where axes is a 1-D array of Axes.


.. py:function:: doe_mean_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, axes: numpy.ndarray | None = None) -> tuple[matplotlib.figure.Figure, numpy.ndarray]

   Creates mean plots of y grouped by each factor's levels.

   Shows group means connected by a line and a horizontal grand-mean
   reference line for each factor.

   :param data: EDAData container. Requires factors.
   :param fig: Matplotlib figure. If None, creates new figure.
   :param axes: 1-D array of Axes, one per factor. If None,
                creates new axes.

   :returns: (fig, axes) where axes is a 1-D array of Axes.


.. py:function:: doe_sd_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, axes: numpy.ndarray | None = None) -> tuple[matplotlib.figure.Figure, numpy.ndarray]

   Creates standard deviation plots of y by each factor's levels.

   Shows group standard deviations connected by a line and a horizontal
   overall-SD reference line for each factor.

   :param data: EDAData container. Requires factors.
   :param fig: Matplotlib figure. If None, creates new figure.
   :param axes: 1-D array of Axes, one per factor. If None,
                creates new axes.

   :returns: (fig, axes) where axes is a 1-D array of Axes.


.. py:function:: contour_plot(data: drippy.data.EDAData, fig: matplotlib.figure.Figure | None = None, ax: matplotlib.axes.Axes | None = None, doe: bool = False) -> tuple[matplotlib.figure.Figure, matplotlib.axes.Axes]

   Creates a contour plot of y over the 2D factor space.

   Uses tricontourf for robustness with irregular/DOE grids.

   :param data: EDAData container. Requires exactly 2 factors.
   :param fig: Matplotlib figure. If None, creates new figure.
   :param ax: Matplotlib axes. If None, creates new axes.
   :param doe: If True, overlays design point markers.

   :returns: The figure and axes containing the plot.