Index: /trunk/MagicSoft/Mars/mimage/MImgCleanTGB.cc =================================================================== --- /trunk/MagicSoft/Mars/mimage/MImgCleanTGB.cc (revision 2421) +++ /trunk/MagicSoft/Mars/mimage/MImgCleanTGB.cc (revision 2422) @@ -29,217 +29,4 @@ // MImgCleanTGB // -// The Image Cleaning task selects the pixels you use for the Hillas -// parameters calculation. -// -// There are two methods to make the selection: the standard one, as done -// in the analysis of CT1 data, and the democratic one, as suggested by -// W.Wittek. The number of photo-electrons of a pixel is compared with the -// pedestal RMS of the pixel itself (standard method) or with the average -// RMS of the inner pixels (democratic method). -// In both cases, the possibility to have a camera with pixels of -// different area is taken into account. -// The too noisy pixels can be recognized and eventally switched off -// (Unmap: set blind pixels to UNUSED) separately, using the -// MBlindPixelCalc Class. In the MBlindPixelCalc class there is also the -// function to replace the value of the noisy pixels with the interpolation -// of the content of the neighbors (SetUseInterpolation). -// -// Example: -// ... -// MBlindPixelCalc blind; -// blind.SetUseInterpolation(); -// blind.SetUseBlindPixels(); -// -// MImgCleanTGB clean; -// ... -// tlist.AddToList(&blind); -// tlist.AddToList(&clean); -// -// Look at the MBlindPixelCalc Class for more details. -// -// Starting point: default values ---------------------------------------- -// -// When an event is read, before the image cleaning, all the pixels that -// are in MCerPhotEvt are set as USED and NOT CORE. All the pixels belong -// to RING number 1 (like USED pixels). -// Look at MCerPhotPix.h to see how these informations of the pixel are -// stored. -// The default cleaning METHOD is the STANDARD one and the number of the -// rings around the CORE pixel it analyzes is 1. Look at the Constructor -// of the class in MImgCleanTGB.cc to see (or change) the default values. -// -// Example: To modify this setting, use the member functions -// SetMethod(MImgCleanTGB::kDemocratic) and SetCleanRings(UShort_t n). -// -// MImgCleanTGB:CleanStep1 ----------------------------------------------- -// -// The first step of cleaning defines the CORE pixels. The CORE pixels are -// the ones which contain the informations about the core of the electro- -// magnetic shower. -// The ratio (A_0/A_i) is calculated from fCam->GetPixRatio(i). A_0 is -// the area of the central pixel of the camera, A_i is the area of the -// examined pixel. In this way, if we have a MAGIC-like camera, with the -// outer pixels bigger than the inner ones, the level of cleaning in the -// two different regions is weighted. -// This avoids problems of deformations of the shower images. -// The signal S_i and the pedestal RMS Prms_i of the pixel are called from -// the object MCerPhotPix. -// If (default method = kStandard) -//Begin_Html -//       -//End_Html -// the pixel is set as CORE pixel. L_1 (n=1) is called "first level of -// cleaning" (default: fCleanLvl1 = 3). -// All the other pixels are set as UNUSED and belong to RING 0. -// After this point, only the CORE pixels are set as USED, with RING -// number 1. -// -// MImgCleanTGB:CleanStep2 ---------------------------------------------- -// -// The second step of cleaning looks at the isolated CORE pixels and sets -// them to UNUSED. An isolated pixel is a pixel without CORE neighbors. -// At the end of this point, we have set as USED only CORE pixels with at -// least one CORE neighbor. -// -// MImgCleanTGB:CleanStep3 ---------------------------------------------- -// -// The third step of cleaning looks at all the pixels (USED or UNUSED) that -// surround the USED pixels. -// If the content of the analyzed pixel survives at the second level of -// cleaning, i.e. if -//Begin_Html -//       -//End_Html -// the pixel is set as USED. L_2 (n=2) is called "second level of cleaning" -// (default:fCleanLvl2 = 2.5). -// -// When the number of RINGS to analyze is 1 (default value), only the -// pixels that have a neighbor CORE pixel are analyzed. -// -// There is the option to decide the number of times you want to repeat -// this procedure (number of RINGS analyzed around the core pixels = n). -// Every time the level of cleaning is the same (fCleanLvl2) and the pixel -// will belong to ring r+1, 1 < r < n+1. This is described in -// MImgCleanTGB:CleanStep4 . -// -// Dictionary and member functions --------------------------------------- -// -// Here there is the detailed description of the member functions and of -// the terms commonly used in the class. -// -// STANDARD CLEANING: -// ================= -// This is the method used for the CT1 data analysis. It is the default -// method of the class. -// The number of photo-electrons of a pixel (S_i) is compared to the -// pedestal RMS of the pixel itself (Prms_i). To have the comparison to -// the same photon density for all the pixels, taking into account they -// can have different areas, we have to keep in mind that the number of -// photons that hit each pixel, goes linearly with the area of the pixel. -// The fluctuations of the LONS are proportional to sqrt(A_i), so when we -// compare S_i with Prms_i, only a factor sqrt(A_0/A_i) is missing to -// have the same (N.photons/Area) threshold for all the pixels. -// -// !!WARNING: if noise independent from the -// pixel size (example: electronic noise) is introduced, -// then the noise fluctuations are no longer proportional -// to sqrt(A_i), and then the cut value (for a camera with -// pixels of different sizes) resulting from the above -// procedure would not be proportional to pixel size as we -// intend. In that case, democratic cleaning is preferred. -// -// If -//Begin_Html -//       -//End_Html -// the pixel survives the cleaning and it is set as CORE (when L_n is the -// first level of cleaning, fCleanLvl1) or USED (when L_n is the second -// level of cleaning, fCleanLvl2). -// -// Example: -// -// MImgCleanTGB clean; -// //creates a default Cleaning object, with default setting -// ... -// tlist.AddToList(&clean); -// // add the image cleaning to the main task list -// -// DEMOCRATIC CLEANING: -// =================== -// You use this cleaning method when you want to compare the number of -// photo-electons of each pixel with the average pedestal RMS -// (fInnerNoise = fSgb->GetSigmabarInner()) of the inner pixels (for the -// MAGIC camera they are the smaller ones): -//Begin_Html -//       -//End_Html -// In this case, the simple ratio (A_0/A_i) is used to weight the level of -// cleaning, because both the inner and the outer pixels (that in MAGIC -// have a different area) are compared to the same pedestal RMS, coming -// from the inner pixels. -// To calculate the average pedestal RMS of the inner pixels, you have to -// add to the main task list an object of type MSigmabarCalc before the -// MImgCleanTGB object. To know how the calculation of fInnerNoise is done -// look at the MSigmabarCalc Class. -// -// Example: -// -// MSigmabarCalc sbcalc; -// //creates an object that calcutates the average pedestal RMS -// MImgCleanTGB clean; -// ... -// tlist.AddToList(&sbcalc); -// tlist.AddToList(&clean); -// -// Member Function: SetMethod() -// ============================ -// When you call the MImgCleanTGB task, the default method is kStandard. -// -// If you want to switch to the kDemocratic method you have to -// call this member function. -// -// Example: -// -// MImgCleanTGB clean; -// //creates a default Cleaning object, with default setting -// -// clean.SetMethod(MImgCleanTGB::kDemocratic); -// //now the method of cleaning is changed to Democratic -// -// FIRST AND SECOND CLEANING LEVEL -// =============================== -// When you call the MImgCleanTGB task, the default cleaning levels are -// fCleanLvl1 = 3, fCleanLvl2 = 2.5. You can change them easily when you -// create the MImgCleanTGB object. -// -// Example: -// -// MImgCleanTGB clean(Float_t lvl1,Float_t lvl2); -// //creates a default cleaning object, but the cleaning levels are now -// //lvl1 and lvl2. -// -// RING NUMBER -// =========== -// The standard cleaning procedure is such that it looks for the -// informations of the boundary part of the shower only on the first -// neighbors of the CORE pixels. -// There is the possibility now to look not only at the firs neighbors -// (first ring),but also further away, around the CORE pixels. All the new -// pixels you can find with this method, are tested with the second level -// of cleaning and have to have at least an USED neighbor. -// -// They will be also set as USED and will be taken into account during the -// calculation of the image parameters. -// The only way to distinguish them from the other USED pixels, is the -// Ring number, that is bigger than 1. -// -// Example: You can decide how many rings you want to analyze using: -// -// MImgCleanTGB clean; -// //creates a default cleaning object (default number of rings =1) -// clean.SetCleanRings(UShort_t r); -// //now it looks r times around the CORE pixels to find new pixels with -// //signal. -// // // Input Containers: