Changeset 3957 for trunk/MagicSoft/Mars/macros/readMagic.C

Timestamp:

05/04/04 15:27:25 (20 years ago)

Author:

tbretz

Message:

*** empty log message ***

File:

• trunk/MagicSoft/Mars/macros/readMagic.C (modified) (13 diffs)

trunk/MagicSoft/Mars/macros/readMagic.C

@@ -16 +16 @@
 !
 !
-!   Author(s): Thomas Bretz  12/2000 <mailto:tbretz@uni-sw.gwdg.de>
-!
-!   Copyright: MAGIC Software Development, 2000-2001
+!   Author(s): Thomas Bretz  12/2000 <mailto:tbretz@astro.uni-wuerzburg.de>
+!
+!   Copyright: MAGIC Software Development, 2000-2004
 !
 !
 \* ======================================================================== */
 
+///////////////////////////////////////////////////////////////////////////
+//
+// readMagic.C
+// ===========
+//
+// This is a demonstration program showing how to do particular processing
+// on a single event basis. Here we simply display uncleand und cleand
+// images.
+// Therefor MInteractiveTask is used, which gives you the possibility
+// to develop new tasks without the need of compilation.
+// The input is a merpp raw-data file.
+//
+///////////////////////////////////////////////////////////////////////////
 
 Bool_t HandleInput()
 {
+    // This must be there to get accesss to the GUI while the macro
+    // is still running!
+
     TTimer timer("gSystem->ProcessEvents();", 50, kFALSE);
     while (1)
@@ -46 +62 @@
 }
 
+//
+// Setup the data-members of your 'virtual' class
+//
 MHCamera display[4];
 
@@ -52 +71 @@
 MTaskList *fTaskList;
 
+//
+// Called like all PreProcess functions of tasks. Get the access to
+// the containers necessary for you.
+//
 Int_t PreProcess(MParList *plist)
 {
+    // Get parameter and tasklist, see Process
     fParList = plist;
     fTaskList = (MTaskList*)plist->FindObject("MTaskList");
 
+    // Get camera geoemtry
     MGeomCam *geomcam = (MGeomCam*)plist->FindObject("MGeomCam");
 
+    // setup canvas and camera-histograms
     c = new TCanvas("Events", "Real Events", 600, 600);
     c->SetBorderMode(0);
@@ -73 +99 @@
 }
 
+//
+// Called like all Process functions of tasks. Process a single
+// event - here display it.
+//
 Int_t Process()
 {
+    // For simplicity we search in the Process function for the
+    // objects. This is deprectaed! Store the pointers to the objects
+    // as data member and get the pointers in PreProcess.
     MReadMarsFile *read = (MReadMarsFile*)fTaskList->FindObject("MRead");
     MClone *clone = (MClone*)fTaskList->FindObject("MClone");
@@ -80 +113 @@
     MGeomCam *geom = (MGeomCam*)fParList->FindObject("MGeomCam");
 
+    // Ouput event number
     cout << "Event #" << read->GetNumEntry() << ":" << endl;
 
+    // Fill the data into your camera-histograms
     display[0].SetCamContent(*(MCerPhotEvt*)clone->GetClone());
     display[1].SetCamContent(*(MCerPhotEvt*)fParList->FindObject("MCerPhotEvt"));
@@ -87 +122 @@
     display[3].SetCamContent(*(MCameraData*)fParList->FindObject("MCameraData"));
 
+    // Setup the cleaning level histogram
     TArrayF lvl(2);
     lvl[0] = clean->GetCleanLvl2();
@@ -92 +128 @@
     display[3].SetLevels(lvl);
 
+    // Update the display
     for (int i=1; i<=4; i++)
     {
@@ -98 +135 @@
     }
 
+    // print the data on the console
     ((MHillas*)fParList->FindObject("MHillas"))->Print(*geom);
     ((MHillasExt*)fParList->FindObject("MHillasExt"))->Print(*geom);
     ((MNewImagePar*)fParList->FindObject("MNewImagePar"))->Print(*geom);
 
+    // wait for 'return'
     return HandleInput();
 }
 
+//
+// Called like all PostProcess functions of tasks. Delete
+// instanciated objects.
+//
 Int_t PostProcess()
 {
@@ -111 +154 @@
 
 void readMagic(const char *fname="../Proton*.root")
-{               
+{
+    // Setup parameter- and tasklist
     MParList  plist;
     MTaskList tlist;
@@ -117 +161 @@
     plist.AddToList(&tlist);
 
+    // setup reading task
     MReadMarsFile read("Events", fname);
     read.DisableAutoScheme();
 
+    // setup a task making sure that all arrays are resized correctly
     MGeomApply geomapl;
+
+    // Setup a print task calling TObject::Print
     MPrint print1("MMcEvt");
     MPrint print2("MRawEvtHeader");
+    // Skip them if conatainers are not found
     print1.EnableSkip();
     print2.EnableSkip();
 
+    // Copy MC pedestals to apropriate conatiners (if MC file)
     MMcPedestalCopy   pcopy;
     MMcPedestalNSBAdd pnsb;
+
+    // Calculate signal and pedestal from data (use MCerPhotCalc
+    // in case of MC files)
     MCerPhotAnal2     ncalc;
+
+    // Blind Pixel Treatment (deprecated, will be replaced by
+    // MBadPixel*)
     MBlindPixelCalc   blind;
     blind.SetUseInterpolation();
+
+    // Clone MCerPhotEvt befor eimage cleaning
     MClone            clone("MCerPhotEvt");
+
+    // Setup image cleaning
     MImgCleanStd      clean;
+
+    // Setup calculation of Image parameters
     MHillasCalc       hcalc;
+
+    // Setup intercative task calling the functions defined above
     MTaskInteractive  mytask;
 
@@ -139 +203 @@
     mytask.SetProcess(Process);
 
+    // Setup your tasklist
     tlist.AddToList(&read);
     tlist.AddToList(&geomapl);
@@ -152 +217 @@
     tlist.AddToList(&mytask);
 
+    // Run your analysis
     MEvtLoop evtloop;
     evtloop.SetParList(&plist);
@@ -158 +224 @@
         return;
 
+    // Print statistics information about your loop
     tlist.PrintStatistics();
 }