Previous: , Up: Spectrum Generators   [Contents][Index]


6.2.3 spectrum( name [, optargs] )

This function specifies an arbitrary, binned spectrum to simulate. name is a string used for identification purposes. Note that the ‘file’ optional argument is for now not optional; it must be specified.

The following optional arguments are recognized:

file

The name of the file containing the spectrum.

format

The format of the file. It defaults to ‘rdb’. It may be one of:

rdb

The file is in an rdb table. There must be at least three columns, which denote the limits of the bins and the flux within each bin. The names of the columns may be specified by the emin, emax, and flux optional arguments.

emin

The name of the column containing the minimum edge of a bin, in keV, for those formats for which it is appropriate. It defaults to ‘emin’.

emax

The name of the column containing the maximum edge of a bin, in keV, for those formats for which it is appropriate. It defaults to ‘emax’.

flux

The name of the column containing the flux (for those formats for which it is appropriate). It defaults to ‘flux’.

units

The units in which the spectrum is specified. It may be one of ‘ergs/s/cm2/kev’, ‘kev/s/cm2/kev’, or ‘photons/s/cm2’.

scale

An arbitrary scale factor to apply to the spectrum. It defaults to ‘1.0’.


Previous: , Up: Spectrum Generators   [Contents][Index]