format_params

This module introduces uniform plot formatting and parameter label generation.

Module Contents

Functions

set_global_plot_formatting()

Set formatting that affects all subsequent plots.

param_labels([aux_bands, ref_band])

Return properly formatted parameter labels

set_global_plot_formatting()[source]

Set formatting that affects all subsequent plots.

param_labels(aux_bands=None, ref_band=None)[source]

Return properly formatted parameter labels for plotting.

Parameters:

aux_bands (array-like, optional) – The auxiliary bands for naming, in order. Defaults to None, in which case we assume only the base band.

Returns:

plot_labels – All properly formatted plotting labels.

Return type:

list