PyXspec  1.0.3
Public Member Functions | Public Attributes
ChainManager Class Reference

List of all members.

Public Member Functions

def __init__
def __call__
def __iadd__
def __isub__
def clear
def show
def stat

Public Attributes

 defBurn
 Default burn length for new Chain objects (orig = 0).
 defFileType
 Default output file format (orig = "fits").
 defLength
 Default chain length (orig = 100).
 defProposal
 Default chain proposal (orig = "gaussian fit").
 defRand
 Default randomization setting (orig = False).
 defTemperature
 Default chain temperature (orig = 1.0).

Detailed Description

Monte Carlo Markov Chain container.

This is a singleton - only 1 instance allowed

Public instance attributes:

   These are the values which will be used when creating new Chain objects,
   unless they are explicitly overridden as arguments to the Chain class
   constructor.  For more detail, see the descriptions for the
   corresponding attributes in the Chain class doc.
   
   defBurn         -- Default burn length for new Chain objects (orig = 0).
   defFileType     -- Default output file format (orig = "fits").
   defLength       -- Default chain length (orig = 100).
   defProposal     -- Default chain proposal (orig = "gaussian fit").
   defRand         -- Default randomization setting (orig = False).
   defTemperature  -- Default chain temperature (orig = 1.0).


Constructor & Destructor Documentation

def __init__ (   self)

Member Function Documentation

def __call__ (   self,
  index 
)
Get a Chain object from the AllChains container.

   index -- The index of a currently loaded chain file.  The list
      of currently loaded chains can be seen with the
      AllChains.show() method.  The valid range is:
      1 <= index <= nLoadedChains.
      
   Note that the returned Chain object's modifiable attributes will
   be initialized with the current AllChains def<attribute> settings.
   
   Example:
      # Load 2 chains from pre-existing files:
      AllChains += "chain1.fits"
      AllChains += "chain2.fits"
      # and get a Chain object for the 2nd chain:
      c2 = AllChains(2)
         
def __iadd__ (   self,
  chain 
)
Load a pre-existing chain into the AllChains container.

Argument may be a currently existing chain object which had been
 unloaded earlier:
    AllChains += myChain1  
the filename of an existing chain file:
    AllChains += "chainFile.fits"
or the filename of a new chain:
    AllChains += "newChainFile.fits" # This will also perform a chain
                             # run using the default settings.
        
def __isub__ (   self,
  chain 
)
Unload one or more chain objects from container.

Argument may either be a chain object:
    AllChains -= myChain1            
a filename:
    AllChains -= "chainFile.fits"            
the chain's current index [int] in the AllChains container:
    AllChains -= 2            
or a '*' to unload ALL chains (equivalent to AllChains.clear()):
    AllChains -= '*'

def clear (   self)
Unload all chains from container
def show (   self)
Display information for current attributes and loaded chains.
def stat (   self,
  parIdx 
)
Display statistical information on a particular chain parameter.

   parIdx -- The parameter index number, including optional model
       name: [<modName>:]<idx>.  May be entered as a string
       or int (if no model name).            
     

Member Data Documentation

Default burn length for new Chain objects (orig = 0).

Default output file format (orig = "fits").

Default chain length (orig = 100).

Default chain proposal (orig = "gaussian fit").

Default randomization setting (orig = False).

Default chain temperature (orig = 1.0).


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