Scale1D

class sherpa.models.basic.Scale1D(name='scale1d')

Bases: sherpa.models.basic.Const1D

A constant model for one-dimensional data.

This is a specialized form of the Const1D model where the integrate flag is turned off.

c0

The amplitude of the model.

See also

Box1D, Const1D, Delta1D, Scale2D, StepLo1D, StepHi1D

Notes

The functional form of the model for points is:

f(x) = ampl

and for an integrated grid it is:

f(xlo,xhi) = ampl * (xhi - xlo)

This later case will only be used if the integrate attribute is set to True.

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, **kwargs)	The class RegriddableModel1D allows the user to evaluate in the requested space then interpolate onto the data space.
reset()
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

thawedparhardmaxes

thawedparhardmins

thawedparmaxes

thawedparmins

thawedpars

Methods Documentation

apply(outer, *otherargs, **otherkwargs)

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

get_center()

guess(dep, *args, **kwargs)

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, **kwargs)

The class RegriddableModel1D allows the user to evaluate in the requested space then interpolate onto the data space. An optional argument ‘interp’ enables the user to change the interpolation method.

Examples

>>> import numpy as np
>>> from sherpa.models.basic import Box1D
>>> mybox = Box1D()
>>> request_space = np.arange(1, 10, 0.1)
>>> regrid_model = mybox.regrid(request_space, interp=linear_interp)

reset()

set_center(*args, **kwargs)

startup(cache)

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()