cuqi.samples.Samples.plot_ci

Samples.plot_ci(percent=95, exact=None, *args, plot_envelope_kwargs=None, **kwargs)

Plots the credibility interval for the samples according to the geometry.

Parameters:

• percent (int) – The percent credibility to plot (i.e. 95, 99 etc.)

• exact (ndarray, default None) – The exact value (for comparison)

• plot_envelope_kwargs (dict, default {}) – Keyword arguments for the plot_envelope method

Returns:

plotting_objects – If 1D plots are generated, the list contains Line2D object of the mean plot, Line2D object of the exact value plot, and PolyCollection or ErrorbarContainer object of the ci envelope plot, respectively.

If 2D plots are generated, the list contains PolyCollection or AxesImage objects for the mean, exact value, ci lower bound, ci upper bound, and the ci width, respectively.

Return type:

list