API reference

This page provides an auto-generated summary of Pydox’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

High-level APIs

Pydox configuration of settings

set_params(param_or_grp[, value])	Set the value of a configuration parameter or (sub)group of parameters
get_params(param[, config])	Retrieve the value of a configuration parameter or (sub)group of parameters
reset_params([param, config, factory])	Reset a configuration parameter to default values
config_print([config])	Render a configuration object as text or HTML
config_files()	Get the list of all available configuration files to build a default configuration

Calibration methods

Calibration([method])

Create a single methodology calibration

MethodInAir(*args, **kwargs)	Implementation of the In-Air calibration method
MethodClimatology(*args, **kwargs)	Quick and dirty implementation for dev purposes

CalibrationSet

CalibrationSet(*args, **kwargs)

Collection of methodology implementations

Low-level APIs

Specific data objects

Params(fit_drift, initial_gain, ...)	A dataclass to hold a unique parameter set for one computation
ParamsInAir(fit_drift, initial_gain, ...)	A unique parameter set for the 'in air' method
ParamsClimatology(fit_drift, initial_gain, ...)	A unique parameter set for the 'climatology' method
PlotParams([level, watermark, dpi, uid])	A placeholder for plotting parameters to be communicated from high to low-level APIs