Index: trunk/MagicSoft/Mars/manalysis/MCT1ReadAscii.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MCT1ReadAscii.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MCT1ReadAscii.cc (revision 765) @@ -28,4 +28,7 @@ // MCT1ReadAscii // // // +// Reads a ascii file with CT1 data. The file description and some example // +// files can be found on the Magic homepage. // +// // ///////////////////////////////////////////////////////////////////////////// @@ -45,4 +48,10 @@ ClassImp(MCT1ReadAscii) +// -------------------------------------------------------------------------- +// +// Default constructor. Creates an array which stores the file names of +// the files which should be read. If a filename is given it is added +// to the list. +// MCT1ReadAscii::MCT1ReadAscii(const char *fname, const char *name, @@ -60,4 +69,8 @@ } +// -------------------------------------------------------------------------- +// +// Delete the filename list and the input stream if one exists. +// MCT1ReadAscii::~MCT1ReadAscii() { @@ -67,11 +80,12 @@ } +// -------------------------------------------------------------------------- +// +// Add this file as the last entry in the chain +// void MCT1ReadAscii::AddFile(const char *txt) { - // - // Add this file as the last entry in the chain - // - const int sz = fFileNames->GetSize(); - const int tsz = strlen(txt)+1; + const int sz = fFileNames->GetSize(); + const int tsz = strlen(txt)+1; fFileNames->Set(sz+tsz); @@ -80,4 +94,8 @@ } +// -------------------------------------------------------------------------- +// +// This opens the next file in the list and deletes its name from the list. +// Bool_t MCT1ReadAscii::OpenNextFile() { @@ -128,4 +146,11 @@ } +// -------------------------------------------------------------------------- +// +// Open the first file in the list. Check for the output containers or create +// them if they don't exist. +// +// Initialize the size of the MPedestalCam container to 127 pixels (CT1 camera) +// Bool_t MCT1ReadAscii::PreProcess(MParList *pList) { @@ -159,4 +184,8 @@ } +// -------------------------------------------------------------------------- +// +// Read apedestal entry (line) from the file +// void MCT1ReadAscii::ReadPedestals() { @@ -185,4 +214,8 @@ } +// -------------------------------------------------------------------------- +// +// Read a data entry (line) from the file +// void MCT1ReadAscii::ReadData() { @@ -218,4 +251,12 @@ } +// -------------------------------------------------------------------------- +// +// Check for the event number and depending on this number decide if +// pedestals or event data has to be read. +// +// If the end of the file is reached try to open the next in the list. If +// there is now next file stop the eventloop. +// Bool_t MCT1ReadAscii::Process() { Index: trunk/MagicSoft/Mars/manalysis/MHillas.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MHillas.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MHillas.cc (revision 765) @@ -47,4 +47,8 @@ ClassImp(MHillas) +// -------------------------------------------------------------------------- +// +// Default constructor. +// MHillas::MHillas(const char *name, const char *title) : fAlpha(0), fTheta(0), fWidth(0), fLength(0), fSize(0), fDist(0), fEllipse(NULL) @@ -56,4 +60,8 @@ } +// -------------------------------------------------------------------------- +// +// Destructor. Deletes the TEllipse if one exists. +// MHillas::~MHillas() { @@ -61,4 +69,8 @@ } +// -------------------------------------------------------------------------- +// +// Print the hillas Parameters to *fLog +// void MHillas::Print(Option_t *) { @@ -71,4 +83,8 @@ } +// -------------------------------------------------------------------------- +// +// call the Paint function of the Ellipse if a TEllipse exists +// void MHillas::Paint(Option_t *) { @@ -79,14 +95,14 @@ } +// -------------------------------------------------------------------------- +// +// Instead of adding MHillas itself to the Pad +// (s. AppendPad in TObject) we create an ellipse, +// which is added to the Pad by it's Draw function +// You can remove it by deleting the Ellipse Object +// (s. Clear() ) +// void MHillas::Draw(Option_t *) { - // - // Instead of adding MHillas itself to the Pad - // (s. AppendPad in TObject) we create an ellipse, - // which is added to the Pad by it's Draw function - // You can remove it by deleting the Ellipse Object - // (s. Clear() ) - // - Clear(); @@ -112,4 +128,8 @@ } +// -------------------------------------------------------------------------- +// +// If a TEllipse object exists it is deleted +// void MHillas::Clear(Option_t *) { @@ -122,11 +142,11 @@ } +// -------------------------------------------------------------------------- +// +// Calculate the Hillas parameters from a cerenkov photon event +// (The calcualtion is some kind of two dimentional statistics) +// Bool_t MHillas::Calc(MGeomCam &geom, MCerPhotEvt &evt) { - // - // Calculate the Hillas parameters from a cerenkov photon event - // (The calcualtion is some kind of two dimentional statistics) - // - const UInt_t nevt = evt.GetNumPixels(); Index: trunk/MagicSoft/Mars/manalysis/MHillasCalc.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MHillasCalc.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MHillasCalc.cc (revision 765) @@ -26,5 +26,7 @@ ///////////////////////////////////////////////////////////////////////////// // // -// MHillas Calc // +// MHillasCalc // +// // +// This is a task to calculate the Hillas parameters from each event // // // ///////////////////////////////////////////////////////////////////////////// @@ -42,4 +44,8 @@ ClassImp(MHillasCalc) +// -------------------------------------------------------------------------- +// +// Default constructor. +// MHillasCalc::MHillasCalc(const char *name, const char *title) { @@ -48,4 +54,10 @@ } +// -------------------------------------------------------------------------- +// +// Check for a MCerPhotEvt object from which the Hillas are calculated. +// Try to find the Geometry conatiner. And try to find the output +// (Hillas) container or create one. +// Bool_t MHillasCalc::PreProcess( MParList *pList ) { @@ -71,12 +83,13 @@ } +// -------------------------------------------------------------------------- +// +// If you want do complex descisions inside the calculations +// we must move the calculation code inside this function +// +// If the calculation wasn't sucessfull skip this event +// Bool_t MHillasCalc::Process() { - // - // If you want do complex descisions inside the calculations - // we must move the calculation code inside this function - // - // If the calculation wasn't sucessfull skip this event - // return fHillas->Calc(*fGeomCam, *fCerPhotEvt) ? kTRUE : kCONTINUE; } Index: trunk/MagicSoft/Mars/manalysis/MImgCleanStd.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MImgCleanStd.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MImgCleanStd.cc (revision 765) @@ -24,4 +24,12 @@ \* ======================================================================== */ +///////////////////////////////////////////////////////////////////////////// +// +// MImgCleanStd +// +// This is the standard image cleaning. If you want to know how it works +// Please look at the three CleanSteps and Process +// +///////////////////////////////////////////////////////////////////////////// #include "MImgCleanStd.h" @@ -36,11 +44,14 @@ ClassImp(MImgCleanStd) +// -------------------------------------------------------------------------- +// +// Default constructor. Here you can specify the cleaning levels. If you +// don't specify them the 'common standard' values 2.5 and 3.0 (sigma +// above mean) are used +// MImgCleanStd::MImgCleanStd(const Float_t lvl1, const Float_t lvl2, const char *name, const char *title) : fCleanLvl1(lvl1), fCleanLvl2(lvl2) { - // - // the default constructor - // *fName = name ? name : "MImgCleanStd"; *fTitle = title ? title : "Task which does a standard image cleaning"; @@ -49,12 +60,12 @@ } +// -------------------------------------------------------------------------- +// +// This method looks for all pixels with an entry (photons) +// that is three times bigger than the noise of the pixel +// (std: 3 sigma, clean level 1) +// void MImgCleanStd::CleanStep1() { - // - // This method looks for all pixels with an entry (photons) - // that is three times bigger than the noise of the pixel - // (std: 3 sigma, clean level 1) - // - const Int_t entries = fEvt->GetNumPixels(); @@ -76,11 +87,11 @@ } +// -------------------------------------------------------------------------- +// +// check if the survived pixel have a neighbor, that also +// survived +// void MImgCleanStd::CleanStep2() { - // - // check if the survived pixel have a neighbor, that also - // survived - // - const Int_t entries = fEvt->GetNumPixels(); @@ -142,11 +153,12 @@ } +// -------------------------------------------------------------------------- +// +// Look for the boundary pixels around the core pixels +// if a pixel has more than 2.5 (clean level 2) sigma, and +// a core neigbor it is declared as used. +// void MImgCleanStd::CleanStep3() { - // - // Look for the boundary pixels around the core pixels - // if a pixel has more than 2.5 (clean level 2) sigma, and - // a core neigbor it is declared as used. - // const Int_t entries = fEvt->GetNumPixels(); @@ -202,10 +214,11 @@ } +// -------------------------------------------------------------------------- +// +// check if MEvtHeader exists in the Parameter list already. +// if not create one and add them to the list +// Bool_t MImgCleanStd::PreProcess (MParList *pList) { - // - // check if MEvtHeader exists in the Parameter list already. - // if not create one and add them to the list - // fCam = (MGeomCam*)pList->FindObject("MGeomCam"); if (!fCam) @@ -225,4 +238,8 @@ } +// -------------------------------------------------------------------------- +// +// Cleans the image. +// Bool_t MImgCleanStd::Process() { Index: trunk/MagicSoft/Mars/manalysis/MPedestalCam.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MPedestalCam.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MPedestalCam.cc (revision 765) @@ -36,4 +36,8 @@ ClassImp(MPedestalCam) +// -------------------------------------------------------------------------- +// +// Default constructor. Creates a MPedestalPix object for each pixel +// MPedestalCam::MPedestalCam(const char *name, const char *title) { @@ -50,6 +54,11 @@ } +// -------------------------------------------------------------------------- +// +// Delete the array conatining the pixel pedest information +// MPedestalCam::~MPedestalCam() { + // FIXME: Do we have to delete the objects itself? delete fArray; } Index: trunk/MagicSoft/Mars/manalysis/MPedestalPix.cc =================================================================== --- trunk/MagicSoft/Mars/manalysis/MPedestalPix.cc (revision 764) +++ trunk/MagicSoft/Mars/manalysis/MPedestalPix.cc (revision 765) @@ -33,6 +33,4 @@ #include "MPedestalPix.h" -//#include - #include "MLog.h"