PyNeb  1.1.2
PyNeb Reference Manua
DataPlot Class Reference

Inherits object.

Public Member Functions

def __init__
 
def plotA
 
def plotAllA
 
def plotRelA
 
def plotOmega
 
def tem_in_K (self, tem_units, tem)
 

Public Attributes

 calling
 
 atom
 
 elem
 
 spec
 
 atom_data
 
 coll_data
 
 ref_tem
 
 atom_rom
 
 n_tem_points
 
 atom_n_max
 
 coll_n_max
 

Detailed Description

Plot transition probabilities and collision strengths from different data sets

Constructor & Destructor Documentation

def __init__ (   self,
  elem = None,
  spec = None,
  all_data = [],
  atom = None,
  n_tem_points = 10000,
  ref_tem = None,
  OmegaInterp = 'Cheb',
  NLevels = None 
)
    Parameters:
- elem         atomic elem 
- spec       ionization stage in spectroscopic notation (I = 1, II = 2, etc.)
- atom        e.g. 'O3'
- all_data       dictionary of all_data to be compared (see above for format)
- [n_tem_points] number of points in the fit (default=100; increase if fit is not smooth)
- [ref_tem]      array of temperature values to be signaled in the plots
- OmegaInterp    interpolating function between Omega values ('Cheb' [default], 'Linear')
    
    Example:
dataplot = pn.DataPlot('O', 3) # initializes the plot
dataplot.plotA() # transition probabilities plot 
dataplot.plotRelA() # relative transition probabilities plot
dataplot.plotOmega() # collision strength plot    

Member Function Documentation

def plotA (   self,
  save = False,
  figsize = (18, 12,
  fignum = None,
  NLevels = None 
)
Plot the log of the A values of each data set 

Parameters:
    - save     if True, saves the plot in a file
    - figsize  figure size (default: [18, 12])
    - fignum    figure Number
def plotAllA (   self,
  save = False,
  figsize = (18, 12,
  fignum = None,
  NLevels = None 
)
Plot the log of the A values of each data set 

Parameters:
    - save     if True, saves the plot in a file
    - figsize  figure size (default: [18, 12])
    - fignum    figure Number
def plotOmega (   self,
  save = False,
  figsize = (18, 12,
  fignum = 1,
  scan_orders = None,
  NLevels = None,
  fig = None 
)
Plot the tabulated collision strengths of each data set and the fit that is performed by PyNeb

Parameters:
    - save     Boolean. Determine if the plot is automatically saved in a file (default: False)
    - figsize  List. figure size in inches (default: [18, 12])
    - fignum   Figure Number
    - scan_orders = None or (min_order, max_order) or (min_order, -1) to go until the max. DEPRECATED!!!
def plotRelA (   self,
  ref_data = None,
  save = False,
  figsize = None,
  fignum = None,
  NLevels = None,
  fig = None 
)
Plot the relative difference of the A of each data set with respect to the reference one

Parameters:
    - ref_data       reference data set for comparing transition probabilities (default=first data ID)
    - save           if True, save the plot in a file (default: False)
    - figsize        figure size (default: [18, 12])
    - fignum         figure number
def tem_in_K (   self,
  tem_units,
  tem 
)
Convert the temperature from the unit of the fits file into K

Parameters:
    - tem_units     'log(K)' or 'K/1000'
    - tem           temperature

Member Data Documentation

atom
atom_data
atom_n_max
atom_rom
calling
coll_data
coll_n_max
elem
n_tem_points
ref_tem
spec