TemplateModel¶

class sherpa.models.template.TemplateModel(name='templatemodel', pars=(), parvals=None, templates=None)[source] [edit on github]¶

Bases: sherpa.models.model.ArithmeticModel

Attributes Summary

`cache`	The maximum size of the cache.
`ndim`	The dimensionality of the model, if defined, or None.
`thawedparhardmaxes`	The hard maximum values for the thawed parameters.
`thawedparhardmins`	The hard minimum values for the thawed parameters.
`thawedparmaxes`	Access to the maximum limits for the thawed parameters
`thawedparmins`	Access to the minimum limits for the thawed parameters
`thawedpars`	Access to the thawed parameters of the model

Methods Summary

`apply`(outer, otherargs, *otherkwargs)
`cache_clear`()	Clear the cache.
`cache_status`()	Display the cache status.
`calc`(p, x0[, x1])	Evaluate the model on a grid.
`fold`(data)
`get_center`()
`get_x`()
`get_y`()
`guess`(dep, args, *kwargs)	Set an initial guess for the parameter values.
`query`(p)
`reset`()	Reset the parameter values.
`set_center`(args, *kwargs)
`startup`([cache])	Called before a model may be evaluated multiple times.
`teardown`()	Called after a model may be evaluated multiple times.

Attributes Documentation

cache = 5¶: The maximum size of the cache.

ndim = None¶: The dimensionality of the model, if defined, or None.

thawedparhardmaxes¶: The hard maximum values for the thawed parameters.

thawedparhardmins¶: The hard minimum values for the thawed parameters.

thawedparmaxes¶: Access to the maximum limits for the thawed parameters

thawedparmins¶: Access to the minimum limits for the thawed parameters

thawedpars¶: Access to the thawed parameters of the model

Methods Documentation

apply(outer, *otherargs, **otherkwargs) [edit on github]¶

cache_clear() [edit on github]¶: Clear the cache.

cache_status() [edit on github]¶

Display the cache status.

Information on the cache - the number of “hits”, “misses”, and “requests” - is displayed at the INFO logging level.

Example

>>> pl.cache_status()
 powlaw1d.pl                size:    5  hits:   633  misses:   240  check=  873

calc(p, x0, x1=None, *args, **kwargs)[source] [edit on github]¶

Evaluate the model on a grid.

Parameters

p (sequence of numbers) – The parameter values to use. The order matches the pars field.
*args – The model grid. The values can be scalar or arrays, and the number depends on the dimensionality of the model and whether it is being evaluated over an integrated grid or at a point (or points).

fold(data)[source] [edit on github]¶

get_center() [edit on github]¶

get_x()[source] [edit on github]¶

get_y()[source] [edit on github]¶

guess(dep, *args, **kwargs) [edit on github]¶

Set an initial guess for the parameter values.

Attempt to set the parameter values, and ranges, for the model to match the data values. This is intended as a rough guess, so it is expected that the model is only evaluated a small number of times, if at all.

query(p)[source] [edit on github]¶

reset() [edit on github]¶: Reset the parameter values.

set_center(*args, **kwargs) [edit on github]¶

startup(cache=False) [edit on github]¶

Called before a model may be evaluated multiple times.

Parameters: cache (bool, optional) – Should a cache be used when evaluating the models.