SimpleParticleDistribution

class SimpleParticleDistribution(**kwargs)[source]

Bases: object

__init__(**kwargs)[source]

Methods

__init__

plot_particles

Plots the approximate PDF represented by the particle distribution

Attributes

num_particles

plot_particles(ind, title='Approximate PDF from Particle Distribution', x_lbl='State', y_lbl='Probability', **kwargs)[source]

Plots the approximate PDF represented by the particle distribution

Parameters:

  • ind (int) – Index of the particle vector to plot.

  • title (string, optional) – Title of the plot. The default is ‘Particle Distribution’.

  • x_lbl (string, optional) – X-axis label. The default is ‘State’.

  • y_lbl (string, optional) – Y-axis label. The default is ‘Probability’.

  • **kwargs (dict) – Additional plotting options for gncpy.plotting.init_plotting_opts() function. Values implemented here are f_hndl, lgnd_loc, and any values relating to title/axis text formatting.

Returns:

fig – Figure object the data was plotted on.

Return type:

matplotlib figure