pymodelfit.core.scale_and_offset_model

pymodelfit.core.scale_and_offset_model(model, scaleparname='A', offsetparname='C', scaleval=1, offsetval=0)[source]

A convinience function to generate a CompositeModel with a multiplicative scale and an additive offset on the wrapped model. (e.g. A m(x)+C)

Parameters:
  • model (FunctionModel object or string) – the model to wrap (or a name of a model that will be created)
  • scaleparname (string) – name for the parameter controlling the scaling factor
  • offsetparname (string) – name for the parameter controlling the additive offset value
  • scaleval (float) – The initial value for the scale parameter.
  • offsetval (float) – The initial value for the offset parameter.
Returns:

a CompositeModel (or subclass) object

Previous topic

pymodelfit.core.scale_model

Next topic

pymodelfit.core.intersect_models

This Page