PyXspec  1.0.4
Public Member Functions | Public Attributes
RModel Class Reference

List of all members.

Public Member Functions

def __init__
def __getattribute__
def __setattr__
def off

Public Attributes

 parameterNames
 List of the response model's parameter names (get only).
 isOn
 Boolean flag showing the On/Off status of the RModel (get only).

Detailed Description

Response Model class.

Response models are functions which act upon the detector RMF.   XSPEC
currently has just one response model: 'gain', which is a built-in attribute
of the Response class.  RModel objects are not intended for stand-alone
creation: its __init__ function should be considered private.

Public instance attributes.

   <parameters>   -- When RModel is ON, it contains an attribute of type
                       Parameter for every parameter in the model.  An
                       RModel is turned ON by a 'set' operation on ANY
                       of its parameters.  For example with the 'gain'
                       RModel:
                       
                       resp.gain.offset = .03
                       
                       automatically creates 'offset' AND 'slope' 
                       parameters if they don't already exist ('slope' 
                       would be initialized to its default value of 1.0). 
                       The shift is then applied immediately to the 
                       Response object 'resp'.
                       
                       When RModel is OFF (see the RModel.off() method),
                       the parameters are not accessible.  
   
   isOn           -- Boolean flag showing the On/Off status of the RModel
                       (get only).
                       
   parameterNames -- List of the response model's parameter names
                       (get only).
                           


Constructor & Destructor Documentation

def __init__ (   self,
  resp,
  parNames,
  rmodName 
)
RModel constructor.

   Intended for internal use only.

Member Function Documentation

def __getattribute__ (   self,
  name 
)
def __setattr__ (   self,
  attrName,
  value 
)
def off (   self)
Remove response parameters and turn the model OFF.

The Response is restored to its original state.


Member Data Documentation

Boolean flag showing the On/Off status of the RModel (get only).

List of the response model's parameter names (get only).


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