qspec.analyze.draw_sigma2d  (  x ,  y ,  sigma_x ,  sigma_y ,  corr ,  n = 1 ,  ** kwargs  )[source]

Draws the $n\sigma$ bounds of the given data points $(x, y)$ with standard deviations $(\sigma_x, \sigma_y)$ and correlation $\rho_{xy}$.

Parameters:

xndarray | Iterable

The $x$ data.

yndarray | Iterable

The $y$ data.

sigma_xndarray | Iterable

The standard deviation $\sigma_x$ of the x data.

sigma_yndarray | Iterable

The standard deviation $\sigma_y$ of the y data.

corrndarray | Iterable

The correlation coefficients $\rho_{xy}$ between the x and y data.

nint

The maximum sigma region $n$ to draw.

kwargsNone

Additional keyword arguments are passed to plt.plot(). Use key fmt to specify the third argument of plt.plot().

Returns:

outNone