PyXspec  1.0.4
Public Member Functions | Public Attributes
Parameter Class Reference

List of all members.

Public Member Functions

def __init__
def untie
def __float__
def __add__
def __radd__
def __iadd__
def __mul__
def __rmul__
def __imul__

Public Attributes

 name
 Name of Parameter (GET only).
 values
 List of value floats [val,delta,min,bot,top,max].
 sigma
 The Parameter fit sigma (-1.0 when not applicable) (GET only).
 frozen
 Boolean, if True then parameter is frozen.
 link
 Link expression string (empty if not linked).
 unit
 An optional string for the parameter's units (GET only).
 error
 A tuple containing the results of the most recent fit error command performed on the parameter (GET only).
 prior
 A tuple containing the settings for the prior used when Bayesian inference is turned on.

Detailed Description

Model or response parameter class.

Public instance attributes, implemented as properties.

   name   -- Name of Parameter (GET only).
   
   values -- List of value floats [val,delta,min,bot,top,max].
             This may be set with: 
                string:        x.values = "3.2,,,,1e2, 1e3"
                single float:  x.values = 4.1  (sets 'val' only)
                tuple:         x.values = 8.2,.02, -10.
                list:          x.values = [8.2,.02, -10.]
             Note that Tuple and List input do not allow the use
                of consecutive commas for argument spacing.
                
   sigma  -- The Parameter fit sigma (-1.0 when not applicable) (GET only).
   
   frozen -- Boolean, if True then parameter is frozen.
   
   link   -- Link expression string (empty if not linked).
   
   unit   -- An optional string for the parameter's units (GET only).
   
   error  -- A tuple containing the results of the most recent fit error
               command performed on the parameter (GET only).
               The tuple values are: (error low bound, error high bound,
                  error status code string)
   
   prior  -- A tuple containing the settings for the prior used when
               Bayesian inference is turned on.
               
               Get: Returns a tuple containing:
                 (<priorType>, <optional hyperparameters>)
                 
               Set with:
                  string:   <priorType> 
                  or tuple: (<priorType>, <optional hyperparameters>)
                  Valid priorTypes are "cons", "exp", "jeffreys", "gauss".
                  Hyperparameters should be entered as floats.
   

Constructor & Destructor Documentation

def __init__ (   self,
  parName,
  parStrategy 
)
Parameter constructor.

Not intended for stand-alone creation.  This should only be called
from within Model, Component, or Response classes.

parName -- Parameter name


Member Function Documentation

def __add__ (   self,
  other 
)
def __float__ (   self)
def __iadd__ (   self,
  other 
)
def __imul__ (   self,
  other 
)
def __mul__ (   self,
  other 
)
def __radd__ (   self,
  other 
)
def __rmul__ (   self,
  other 
)
def untie (   self)
Remove parameter link (if any)

Member Data Documentation

A tuple containing the results of the most recent fit error command performed on the parameter (GET only).

 The tuple values are: (error low bound, error high bound,
    error status code string)
 

Boolean, if True then parameter is frozen.

Link expression string (empty if not linked).

Name of Parameter (GET only).

A tuple containing the settings for the prior used when Bayesian inference is turned on.

 Get: Returns a tuple containing:
   (<priorType>, <optional hyperparameters>)
   
 Set with:
    string:   <priorType> 
    or tuple: (<priorType>, <optional hyperparameters>)
    Valid priorTypes are "cons", "exp", "jeffreys", "gauss".
    Hyperparameters should be entered as floats.
 
 

The Parameter fit sigma (-1.0 when not applicable) (GET only).

An optional string for the parameter's units (GET only).

List of value floats [val,delta,min,bot,top,max].

 This may be set with: 
    string:        x.values = "3.2,,,,1e2, 1e3"
    single float:  x.values = 4.1  (sets 'val' only)
    tuple:         x.values = 8.2,.02, -10.
    list:          x.values = [8.2,.02, -10.]
 Note that Tuple and List input do not allow the use
    of consecutive commas for argument spacing.
 

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