PSFModel¶
- class sherpa.instrument.PSFModel(name='psfmodel', kernel=None)[source] [edit on github]¶
Bases:
sherpa.models.model.Model
Convolve a model by another model or data set.
Notes
A number of attributes are displayed as parameters, if set, but are not handled as parameters. The attributes are: kernel, size, centre, and origin.
Attributes Summary
array of size parameters
The dimensionality of the model, if defined, or None.
FFT origin
array of size parameters
The hard maximum values for the thawed parameters.
The hard minimum values for the thawed parameters.
Access to the maximum limits for the thawed parameters
Access to the minimum limits for the thawed parameters
Access to the thawed parameters of the model
Methods Summary
calc
(*args, **kwargs)Evaluate the model on a grid.
fold
(data)get_kernel
(data[, subkernel])guess
(dep, *args, **kwargs)Set an initial guess for the parameter values.
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
- BETTER_RESOLUTION = 1¶
- SAME_RESOLUTION = 0¶
- WORSE_RESOLUTION = -1¶
- center¶
array of size parameters
- ndim = None¶
The dimensionality of the model, if defined, or None.
- origin¶
FFT origin
- size¶
array of size parameters
- 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
- calc(*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_kernel(data, subkernel=True)[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.
- 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.
See also
- teardown() [edit on github]¶
Called after a model may be evaluated multiple times.
See also