Background Class Reference

List of all members.

Public Member Functions
def	__init__
Public Attributes
	areaScale
	The Background area scaling factor (GET only).
	exposure
	The exposure time keyword value [float] (GET only).
	fileName
	The spectrum's file name [string] (GET only).
	isPoisson
	Boolean flag, True if spectrum has Poisson errors (GET only).
	values
	Tuple of floats containing the background rates array in counts/cm^2-sec (GET only).
	variance
	Tuple of floats containing the variance of each channel (GET only).

---

Detailed Description

Background spectral data class.

Public instance attributes (implemented as properties):

   areaScale    -- The Background area scaling factor (GET only).
                   Either a single float (if file stores it as a keyword),
                      or a Tuple of floats (if file stores column). 
                   
   exposure     -- The exposure time keyword value [float] (GET only).
   
   fileName     -- The spectrum's file name [string] (GET only).
   
   isPoisson    -- Boolean flag, True if spectrum has Poisson errors 
                      (GET only).
   
   values       -- Tuple of floats containing the background rates array in 
                      counts/cm^2-sec (GET only).
                   
   variance     -- Tuple of floats containing the variance of each 
                      channel (GET only).

---

Constructor & Destructor Documentation

def __init__	(		self,
			backTuple,
			parent
	)

Construct a Background object.

Intended for creation by a Spectrum object only.
The parent arg should be the Spectrum object's self pointer.

---

Member Data Documentation

areaScale

The Background area scaling factor (GET only).

 Either a single float (if file stores it as a keyword),
    or a Tuple of floats (if file stores column).
 

exposure

The exposure time keyword value [float] (GET only).

fileName

The spectrum's file name [string] (GET only).

isPoisson

Boolean flag, True if spectrum has Poisson errors (GET only).

values

Tuple of floats containing the background rates array in counts/cm^2-sec (GET only).

variance

Tuple of floats containing the variance of each channel (GET only).

---

The documentation for this class was generated from the following file:

• spectrum.py