gncpy.plotting.init_plotting_opts

init_plotting_opts(f_hndl=None, lgnd_loc=None, sig_bnd=1, time_vec=None, true_states=None, rng=Generator(PCG64) at 0x7F25934574A0, meas_inds=None, marker='o', ttl_fontsize=12, ttl_fontstyle='normal', ttl_fontfamily='sans-serif', ax_fontsize=10, ax_fontstyle='normal', ax_fontfamily='sans-serif')[source]

Processes common plotting options in a common interface.

Parameters:

  • f_hndl (matplotlib figure, optional) – Current to figure to plot on. Pass None to create a new figure. The default is None.

  • lgnd_loc (string, optional) – Location of the legend. Set to none to skip creating a legend. The default is None.

  • sig_bnd (int, optional) – If set and the covariances are saved, the sigma bounds are scaled by this number and plotted for each track. The default is 1.

  • time_vec (list, optional) – List of time values. The default is None.

  • true_states (list, optional) – Each element is a N x 1 numpy array representing the true state. If not given true states are not plotted. The default is None.

  • rng (numpy random generator, optional) – For generating random numbers. The default is rnd.default_rng(1).

  • meas_inds (list, optional) – List of indices in the measurement vector to plot if this is specified all available measurements will be plotted. Note, x-axis is first, then y-axis. Also note, if gating is on then gated measurements will not be plotted. The default is None.

  • marker (string, optional) – Shape to use as a marker, can be any valid value used by matplotlib. The default is ‘o’.

  • ttl_fontsize (int, optional) – Title font size. The default is 12.

  • ttl_fontstyle (string, optional) – Matplotlib font style for the title. The default is ‘normal’.

  • ttl_fontfamily (string, optional) – Matplotlib font family for the title. The default is ‘sans-serif’.

  • ax_fontsize (int, optional) – Axis label font size. The default is 10.

  • ax_fontstyle (string, optional) – Matplotlib font style for the axis label. The default is ‘normal’.

  • ax_fontfamily (string, optional) – Matplotlib font family for the axis label. The default is ‘sans-serif’.

Returns:

opts – Plotting options with default values where custom ones were not specified.

Return type:

dict