lib.samples.plotting.plot_samples_2d

lib.samples.plotting.plot_samples_2d(ax, samples, parameters, sigmas=2, method='gaussian_kde', scatter=False, bins=60, colors=None, fill=True, lighten=- 0.5, **kwargs)

Plot 2D samples for parameter.

Parameters

• ax (matplotlib.axes.Axes) – Axes where to plot samples.

• samples (Samples) – Samples to plot.

• parameter (tuple, list, ParameterCollection) – The two parameters to plot samples for.

• sigmas (int, list, array, default=2) – Sigma levels to plot. If scalar, plot levels up to (including) sigmas.

• method (string) –

  Method to interpolate samples on mesh, either:

  • ’gaussian_kde’: Gaussian kernel density estimation, based on scipy.stats.gaussian_kde

  • ’cic’ : Cloud-in-Cell assignment

  • ’histo’ : simple binning.

• scatter (bool, string, default=False) – Whether to plot samples as points. If 'only', plot only points (and not contours).

• bins (int, default=60) – Number of bins i.e. mesh nodes to use.

• colors (list, string, tuple) – Single or list of colors. This list is extended to the number of required sigmas with ligthen.

• fill (bool, default=True) – Whether to fill contours.

• lighten (float, default=-0.5) – Positive number ligthens colors, negative darkens colors.

• kwargs (dict) – Arguments for matplotlib.axes.Axes.contourf() if fill is True, else for matplotlib.axes.Axes.coutour().