Last modified: December 2023

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/scale2d.html
Jump to: Description · Example · ATTRIBUTES · Notes · Bugs · See Also


AHELP for CIAO 4.16 Sherpa

scale2d

Context: models

Synopsis

A constant model for two-dimensional data.

Syntax

scale2d

Description

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


Example

>>> create_model_component("scale2d", "mdl")
>>> print(mdl)

Create a component of the scale2d model and display its default parameters. The output is:

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.c0       thawed            1 -3.40282e+38  3.40282e+38           

ATTRIBUTES

The attribute for this object is:

Attribute Definition
c0 The amplitude of the model.

Notes

The functional form of the model for points is:

f(x0, x1) = ampl

and for an integrated grid it is:

f(x0lo, x1lo, x0hi, x1hi) = ampl * (x0hi - x0lo)
                                 * (x1hi - x1lo)

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


Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

models
const2d, scale1d