]> git.uio.no Git - u/mrichter/AliRoot.git/commitdiff
New class description
authorskowron <skowron@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 7 Jul 2004 13:04:30 +0000 (13:04 +0000)
committerskowron <skowron@f7af4fe6-9843-0410-8265-dc069ae4e863>
Wed, 7 Jul 2004 13:04:30 +0000 (13:04 +0000)
ANALYSIS/AliAODParticleBaseCut.cxx
ANALYSIS/AliAODParticleBaseCut.h
ANALYSIS/AliAODParticleCut.h

index f1bfb7a56087c248b9dd3e92199423a9ed0ebcde..7d2755f8f904fa1ce7d5d074074e7667b1e0bdde 100644 (file)
@@ -1,5 +1,26 @@
 #include "AliAODParticleBaseCut.h"
-
+//__________________________________________________________________________
+////////////////////////////////////////////////////////////////////////////
+//                                                                        //
+// class AliAODParticleBaseCut                                            //
+//                                                                        //
+// Set of classes for performing cuts on particle properties of           //
+// AliAODParticleBaseCut is a base class for "base                        //
+// particle cuts". Further, there are implemented classes that performs   //
+// cuts on the most common particle properties like pt, pseudo rapidity,  //
+// angles, anergy, etc.                                                   //
+//                                                                        //
+// There are also implemeted base cuts that perform logical operations    //
+// on results of base particle cuts: AliAODOrCut and  AliAODAndCut.       //
+//                                                                        //
+// Each base cut has a property, thet allows to distinguish them.         //
+// This functionality is used by the interface methods of Particle Cut    //
+// that allows easy update ranges.                                        //
+//                                                                        //
+// more info: http://aliweb.cern.ch/people/skowron/analyzer/index.html    //
+// responsible: Piotr Skowronski@cern.ch                                  //
+//                                                                        //
+////////////////////////////////////////////////////////////////////////////
 
 
 #include <Riostream.h>
index 68ad0723ee11d14d6b8d27e1a78cf81167f10628..79bd2cd9140c98953068b80a82b2b9c9dd4dfc1a 100644 (file)
@@ -1,5 +1,28 @@
 #ifndef ALIAODPARTICLEBASECUT_H
 #define ALIAODPARTICLEBASECUT_H
+//__________________________________________________________________________
+////////////////////////////////////////////////////////////////////////////
+//                                                                        //
+// class AliAODParticleBaseCut                                            //
+//                                                                        //
+// Set of classes for performing cuts on particle properties of           //
+// AliAODParticleBaseCut is a base class for "base                        //
+// particle cuts". Further, there are implemented classes that performs   //
+// cuts on the most common particle properties like pt, pseudo rapidity,  //
+// angles, anergy, etc.                                                   //
+//                                                                        //
+// There are also implemeted base cuts that perform logical operations    //
+// on results of base particle cuts: AliAODOrCut and  AliAODAndCut.       //
+//                                                                        //
+// Each base cut has a property, thet allows to distinguish them.         //
+// This functionality is used by the interface methods of Particle Cut    //
+// that allows easy update ranges.                                        //
+//                                                                        //
+// more info: http://aliweb.cern.ch/people/skowron/analyzer/index.html    //
+// responsible: Piotr Skowronski@cern.ch                                  //
+//                                                                        //
+////////////////////////////////////////////////////////////////////////////
+
 
 #include <TObject.h>
 #include "AliVAODParticle.h"
index 2189c1ea109d33d88015a72d6beb6be5c2370709..0c12b445ed52234353114e1ace7ed16594e74e37 100644 (file)
@@ -5,24 +5,34 @@
 //                                                                        //
 // class AliAODParticleCut                                                //
 //                                                                        //
-// Classes for single particle cuts                                       //
-// User should use only AliAODParticleCut, eventually                     //
-// EmptyCut which passes all particles                                    //
+// Classes for single particle cuts.                                      //
+// User should use mainly AliAODParticleCut interface methods,            //
+// eventually EmptyCut which passes all particles.                        //
+//                                                                        //
 // There is all interface for setting cuts on all particle properties     //
-// The main method is Pass - which returns                                //
+// The main method is Rejected - which returns                            //
 //         True to reject particle                                        //
 //         False in case it meets all the criteria of the given cut       //
 //                                                                        //
-// User should create (and also destroy) cuts himself                     // 
-// and then pass them to the Analysis And Function by a proper method     //
+// This class has the list of base particle  cuts that perform check on   //
+// single property. Particle  is rejected if any of cuts rejects it.      //
+// There are implemented logical base cuts that perform logical           //
+// operations on results of two other base cuts. Using them user can      //
+// create a tree structure of a base cuts that performs sophisticated     //
+// cut.                                                                   //
+//                                                                        //
+// User can also implement a base cut that performs complicated           //
+// calculations, if it is only more convenient and/or efficint.           //
 //                                                                        //
+// User should delete created cuts  himself                               //
+// because when setting a cut, other objects (functions,analyses,         //
+// readers, other cuts) make their own copy of a cut.                     //
 //                                                                        //
-// more info: http://alisoft.cern.ch/people/skowron/analyzer/index.html   //
-// responsible: Piotr Skowronski@cern.ch                                   //
+// more info: http://aliweb.cern.ch/people/skowron/analyzer/index.html    //
+// responsible: Piotr Skowronski@cern.ch                                  //
 //                                                                        //
 ////////////////////////////////////////////////////////////////////////////
 
-
 #include <TObject.h>
 #include "AliVAODParticle.h"
 #include "AliAODParticleBaseCut.h"