pydox.commodities.PlotParams

class PlotParams(level: int = None, watermark: str = '', dpi: int = None, uid: str = '')

A placeholder for plotting parameters to be communicated from high to low-level APIs

Notes

About the `level` attribute

The level attribute does not relate to where in the code the plot is created. It is an attribute that is intended to be used by a function to check whether a plot should be generated or not.

This provides a mechanism to define the minimal level of figures to be generated in the configuration. It can be seen as a logging level, but for plots.

Example: If a function defines its own plot as a level 2, the plot should be generated only if PlotParams.level is higher or equal to 2.

The default value is from the configuration parameter plots.level.

Expected list of possible values for level:

• 0 < 10: Plots with debug purposes, related to low level data manipulation at load time

• 10 < 20: Plots related to input or intermediate data, eg: data used as input for a fit/computation (basically the final state of input data loading and pre-processing, to be used by a fit)

• >= 20: Plots related to fit/computation results

See also

do.commodities.VALID_FIGURE_CATEGORIES

__init__(level: int = None, watermark: str = '', dpi: int = None, uid: str = '') → None

Methods

__init__([level, watermark, dpi, uid])
get([obj])	Return a pydox.commodities.PlotParams instance from an object

Attributes

dpi	'plots.dpi'
level	'plots.level'
uid	Calibration or CalibrationSet uid, possibly for a specific configuration.
watermark	A string to be printed on top of any plot.