Cos¶

class sherpa.models.basic.Cos(name='cos')[source]¶

Bases: sherpa.models.model.RegriddableModel1D

One-dimensional cosine function.

period¶: The period of the cosine, in units of the independent axis.

offset¶: The offset (related to the phase) of the cosine.

ampl¶: The amplitude of the cosine.

See also

Sin, Tan

Notes

The functional form of the model for points is:

f(x) = ampl * cos (2 * pi * (x - offset) / period)

and for an integrated grid it is the integral of this over the bin.

Attributes Summary

`thawedparhardmaxes`
`thawedparhardmins`
`thawedparmaxes`
`thawedparmins`
`thawedpars`

Methods Summary

`apply`(outer, otherargs, *otherkwargs)
`calc`(pars, xlo, args, *kwargs)
`get_center`()
`guess`(dep, args, *kwargs)	Set an initial guess for the parameter values.
`regrid`(*arrays)
`reset`()
`set_center`(args, *kwargs)
`startup`()	Called before a model may be evaluated multiple times.
`teardown`()	Called after a model may be evaluated multiple times.

Attributes Documentation

thawedparhardmaxes¶

thawedparhardmins¶

thawedparmaxes¶

thawedparmins¶

thawedpars¶

Methods Documentation

apply(outer, *otherargs, **otherkwargs)¶

calc(pars, xlo, *args, **kwargs)¶

get_center()¶

guess(dep, *args, **kwargs)[source]¶

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.

regrid(*arrays)¶

reset()¶

set_center(*args, **kwargs)¶

startup()¶: Called before a model may be evaluated multiple times.

See also

teardown()

teardown()¶: Called after a model may be evaluated multiple times.

See also

setup()