DCBase::DCBase Class Reference

List of all members.

Public Member Functions

def __init__
def __del__
def set_pars_dict
def add_par
def del_par
def clear_pars
def pars_dict
def par
def pars_text
def set_history_dict
def add_history_record
def del_history_record
def clear_history
def history_dict
def history_record
def history_text
def save_history_file
def load_history_file
def save_base
def group_name
def is_base_group
def load_base
def tsec_to_tstr
def tstr_to_tsec
def print_base
def make_record

Detailed Description

Base class for the Detector Calibration (DC) project.

   Parameters
   
   cmt : str - string of comment associated with derived class object.

Definition at line 92 of file DCBase.py.


Member Function Documentation

def DCBase::DCBase::__del__ (   self  ) 

Definition at line 112 of file DCBase.py.

def DCBase::DCBase::__init__ (   self,
  cmt = None 
)

Definition at line 98 of file DCBase.py.

def DCBase::DCBase::add_history_record (   self,
  rec,
  tsec = None 
)

Definition at line 152 of file DCBase.py.

def DCBase::DCBase::add_par (   self,
  k,
  v 
)

Definition at line 122 of file DCBase.py.

def DCBase::DCBase::clear_history (   self  ) 

Definition at line 170 of file DCBase.py.

def DCBase::DCBase::clear_pars (   self  ) 

Definition at line 130 of file DCBase.py.

def DCBase::DCBase::del_history_record (   self,
  k 
)

Definition at line 166 of file DCBase.py.

def DCBase::DCBase::del_par (   self,
  k 
)

Definition at line 126 of file DCBase.py.

def DCBase::DCBase::group_name (   self,
  grp 
)

Definition at line 241 of file DCBase.py.

def DCBase::DCBase::history_dict (   self  ) 

Definition at line 174 of file DCBase.py.

def DCBase::DCBase::history_record (   self,
  tsec 
)

Definition at line 178 of file DCBase.py.

def DCBase::DCBase::history_text (   self,
  tsfmt = None 
)

Returns (str) history records preceded by the time stamp as a text

Definition at line 182 of file DCBase.py.

def DCBase::DCBase::is_base_group (   self,
  name,
  grp 
)

Definition at line 245 of file DCBase.py.

def DCBase::DCBase::load_base (   self,
  name,
  grp 
)

Definition at line 249 of file DCBase.py.

def DCBase::DCBase::load_history_file (   self,
  path = 'history.txt',
  verb = False 
)

Load history from the text file

Definition at line 198 of file DCBase.py.

def DCBase::DCBase::make_record (   self,
  action = '',
  key = '',
  cmt = False 
)

Returns string record combined with comment.

Parameters

action : str - description of method action,
key    : str - key for hdf5 group or dataset name,
cmt    : str/None/False - additional comment or no-comment: False is used to turn off history record, None - no-comment.

Definition at line 311 of file DCBase.py.

def DCBase::DCBase::par (   self,
  k 
)

Definition at line 138 of file DCBase.py.

def DCBase::DCBase::pars_dict (   self  ) 

Definition at line 134 of file DCBase.py.

def DCBase::DCBase::pars_text (   self  ) 

Definition at line 142 of file DCBase.py.

def DCBase::DCBase::print_base (   self,
  offset = '  ' 
)

Print content of dictionaries of parameters and history

Definition at line 296 of file DCBase.py.

def DCBase::DCBase::save_base (   self,
  grp 
)

Definition at line 236 of file DCBase.py.

def DCBase::DCBase::save_history_file (   self,
  path = 'history.txt',
  verb = False 
)

Save history in the text file

Definition at line 188 of file DCBase.py.

def DCBase::DCBase::set_history_dict (   self,
  d 
)

Definition at line 146 of file DCBase.py.

def DCBase::DCBase::set_pars_dict (   self,
  d 
)

Definition at line 116 of file DCBase.py.

def DCBase::DCBase::tsec_to_tstr (   self,
  tsec,
  tsfmt = None,
  addfsec = True 
)

converts float tsec like 1471035078.908067 to the string 2016-08-12T13:51:18.908067

Definition at line 278 of file DCBase.py.

def DCBase::DCBase::tstr_to_tsec (   self,
  tstr,
  tsfmt = None 
)

converts string tstr like 2016-08-12T13:51:18.908067 to the float time in seconds 1471035078.908067

Definition at line 286 of file DCBase.py.


The documentation for this class was generated from the following file:
Generated on 19 Dec 2016 for PSDMSoftware by  doxygen 1.4.7