The HasyUtils module

The module HasyUtils contains some helper functions. Documentation can be found within ipython, e.g.:

In [1]: import HasyUtils

In [2]: HasyUtils.ssa?
Type:        function
String form: <function ssa at 0x7fe62edaaaa0>
File:        /usr/lib/python2.7/dist-packages/HasyUtils/ssa.py
Definition:  HasyUtils.ssa(xIn, yIn, flagNbs=False, stbr=3)
Docstring:
performs a simple scan analysis
input: 
  xIn, yIn, numpy arrays
  flagNbs,  no background subtraction
  stbr,     signal to background ratio
returns: 
  dct['status']
  dct['reason']   0: ok, 1: np < 6, 2: stbr, 3: no y(i) > 0., 
                  4, 5: midpoint calc, 6: max outside x-range
                  7: not numpy array
  dct['cms']      center of mass
  dct['integral'] 
  dct['midpoint'] midpoint
  dct['fwhm'] 
  dct['peak_x'] 
  dct['peak_y']
  dct['back_int'] background integral
  dct['r_back']   right background
  dct['l_back']   left background

Information can be attained using the Python help system:

 
In [15]: import HasyUtils

In [16]: HasyUtils.fioReader?
Type:       classobj
String Form:HasyUtils.fioReader.fioReader
File:       /usr/lib/pymodules/python2.7/HasyUtils/fioReader.py
Docstring:
represents an entire file with several columns
input:   name of the .fio file
returns: object containing: 
    self.comments
    self.user_comments
    self.parameters
    self.columns
    self.fileName
Constructor information:
 Definition:HasyUtils.fioReader(self, fileName)