Some improved documentation

git-svn-id: file:///afs/psi.ch/project/sls_det_software/svn/slsDetectorCalibration@15 113b152e-814d-439b-b186-022a431db7b5
This commit is contained in:
bergamaschi
2013-12-16 16:01:20 +00:00
parent 4111c65e37
commit 22f20507db
6 changed files with 30 additions and 24 deletions

View File

@@ -44,9 +44,10 @@ class singlePhotonDetector {
/**
Constructor (no error checking if datasize and offsets are compatible!)
\param s detector data structure to be used
\param d detector data structure to be used
\param csize cluster size (should be an odd number). Defaults to 3
\param nsigma number of rms to discriminate from the noise. Defaults to 5
\param sign 1 if photons are positive, -1 if negative
\param cm common mode subtraction algorithm, if any. Defaults to NULL i.e. none
\param nped number of samples for pedestal averaging
\param nd number of dark frames to average as pedestals without photon discrimination at the beginning of the measurement
@@ -269,7 +270,7 @@ class singlePhotonDetector {
#ifdef MYROOT1
/** generates a tree and maps the branches
\param tname name for the tree
\param iframe pointer to the frame number
\param iFrame pointer to the frame number
\returns returns pointer to the TTree
*/
TTree *initEventTree(char *tname, int *iFrame=NULL) {