Package park :: Package modelling :: Module assembly :: Class Fitness

Class Fitness

Container for theory and data.

The fit object compares theory with data.

TODO: what to do with fittable metadata (e.g., footprint correction)? TODO: what results are returned to the application for plotting?

Instance Methods

__init__(self, model=None, data=None)
Define a Fitness object based on theory and data.

source code

residuals(self)
Return residuals for current parameter values.

source code

residuals_deriv(self, pars=[])
Return derivative of residuals with respect to the parameters. source code

set(self, **kw)
Set parameters in the model.

source code

abort(self)
Abort execution of the model if possible.

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables
	data = `None`
	model = `None`

Properties
	parameterset Fittable parameters
	derivs Parameters with analytic derivatives
Inherited from `object`: `__class__`

Method Details

init(self, model=None, data=None)
(Constructor)

source code

Define a Fitness object based on theory and data.

Overrides: object.__init__

residuals(self)

source code

Return residuals for current parameter values. See park.data.Data1D.residuals for details.

residuals_deriv(self, pars=`[]`)

source code

Return derivative of residuals with respect to the parameters. See park.data.Data1D.residuals_deriv for details.

set(self, **kw)

source code


Set parameters in the model.

User convenience function.  This allows a user with an assembly
of models in a script to for example set the fit range for
parameter 'a' of the model::
    assembly[0].set(a=[5,6])

Raises KeyError if the parameter is not in parameterset.

Property Details

parameterset

Fittable parameters

Get Method:: _parameterset(self)

derivs

Parameters with analytic derivatives

Get Method:: _derivs(self)

Class Fitness

__init__(self, model=None, data=None) (Constructor)

residuals(self)

residuals_deriv(self, pars=[])

set(self, **kw)

parameterset

derivs

init(self, model=None, data=None)
(Constructor)

residuals_deriv(self, pars=`[]`)