pydox.commodities.Params

class Params(fit_drift: bool, initial_gain: Data, initial_drift: Data, cycles: Any, dummy: int)

A dataclass to hold a unique parameter set for one computation

This class produces instances that type as pydox.commodities.ParameterSet.

Notes

• These parameters are from any group of the configuration, but shared by ALL methods

• Each parameter has a unique value, even if a list is supplied in the configuration

• Instance of pydox.commodities.Params are expected to be produced by Workflow._flatten_configs() and to fill values of a ConfigsDict type.

• There is no reason to do not have parameters from outside the configuration

• Create children to be specific about one method parameters

__init__(fit_drift: bool, initial_gain: Data, initial_drift: Data, cycles: Any, dummy: int) → None

Methods

__init__(fit_drift, initial_gain, ...)

Attributes

uid	Return a unique identifier string for this set of parameters
fit_drift	A boolean to set if a drift is to be computed or not
initial_gain	Initial value/error of the gain
initial_drift	Initial value/error of the drift
cycles	Argo float cycle numbers to be used
dummy