Collections/EffCollection/EffCollection.h

/*
 * EffCollection.h
 *
 *  Created on: 10/ago/2009
 *      Author: Nicola Mori
 */

/*! @file EffCollection.h The EffCollection class definition file. */

#ifndef EFFCOLLECTION_H_
#define EFFCOLLECTION_H_

#include "../VerboseCollection/VerboseCollection.h"

/*! @enum EffCollection_ErrMethod to select the method of error computation */
enum EffCollection_ErrMethod {
  EFFERR_SERGIO, ///< Flag for Sergio Ricciarini's Fortran routine
  EFFERR_ROOT
///< Flag for ROOT TGraphAsymErrors::BayesDivide()
};

/*! @brief A verbose collection which computes the efficiency of a set of cuts.
 *
 * This class subdivides the cuts it contains into two classes: selection and detector
 * cuts; detector cuts are evaluated after selection cuts. The collection will compute the
 * efficiency of the whole detector cuts set evaluated using an efficiency sample selected
 * by the selection cuts. Actions will be divided in selection and detector actions as well:
 * adding a selection action, it will be placed after all the selection cuts inserted since
 * the action insertion, and before all detector cuts. Detector actions are placed after all
 * the cuts.
 * This class implements specific methods to add selection and detector cuts; cuts added
 * with the standard #AddCut method will be treated as detector cuts. The same for actions.
 * Error computation is done either using Sergio Ricciarini's Fortran routine or ROOT's
 * TGraphAsimmErrors::BayesDivide(). For both methods, the efficiency is arbitrarily set to
 * 1.1 when less than 8 events survive the selection cuts. This is needed to avoid convergence
 * problems in Sergio's routine, and the ROOT output has been consequently adapted to this
 * convention.
 *
 */
class EffCollection: public VerboseCollection {

public:

  /*! @brief Constructor.
   *
   * @param collectionName The collection's name.
   * @param outFileBase The output file base name. If "", no file output will be produced; otherwise,
   *                    a file named outFilebase + collection's name + ".txt" will be produced, containing
   *                    the number of events surviving the detector cuts (1st column), the selection cuts (2nd column),
   *                    the efficiency (3rd column), the lower (4th column) and upper (5th column) length
   *                    of the efficiency's error bar.
   * @param errMethod The method to use for error computation. Possible values are defined in #EffCollection_ErrMethod.
   * @param owns If true, the collection will own the cuts and the actions, ie., it will
   *             destroy them in its destructor.
   */
  EffCollection(const char *collectionName, TString outFileBase = "", int errMethod = EFFERR_ROOT, bool owns = true);

  /*! @brief Destructor. */
  ~EffCollection() {

  }

  /*! @brief Adds a detector cut to the collection.
   *
   * For EffCollection, cuts added wit #AddCut will be treated as detector cuts.
   *
   * @param cut The PamCut-derived object to add to the collection.
   */
  void AddCut(PamCut *cut) {
    AddDetectorCut(cut);
  }

  /*! @brief Adds a detector cut to the collection.
   *
   * Adds a detector cut. Calling #AddCut will add a detector cut as well, and not a
   * selection cut.
   * @param cut The PamCut-derived object to add to the collection.
   */
  void AddDetectorCut(PamCut *cut);

  /*! @brief Adds a selection cut to the collection.
   *
   * Adds a selection cut. Notice that calling #AddCut will add a detector cut , and not a
   * selection cut.
   * @param cut The PamCut-derived object to add to the collection.
   */
  void AddSelectionCut(PamCut *cut);

  /*! @brief Adds an action to the detector cuts queue.
   *
   * For EffCollection, actions added wit #AddAction will be inserted in the detector cuts queue.
   *
   * @param action The CollectionAction-derived object to add to the collection.
   */
  void AddAction(CollectionAction *action) {
    AddDetectorAction(action);
  }

  /*! @brief Adds an action to the detector cuts queue.
   *
   * Adds a detector action, ie., an action placed in the detector cuts queue. Calling #AddAction will
   * add a detector action as well, and not a selection action.
   *
   * @param action The CollectionAction-derived object to add to the collection.
   */
  void AddDetectorAction(CollectionAction *action);

  /*! @brief Adds an action to the selection cuts queue.
   *
   * Adds a selection action, ie., an action placed in the selection cuts queue. Notice that calling
   * #AddAction will add a detector action, and not a selection action.
   *
   * @param action The CollectionAction-derived object to add to the collection.
   */
  void AddSelectionAction(CollectionAction *action);


  /*! @brief The pre-analysis task definition.
   *
   * This override of the Setup() method sets up the selection and detector cuts and actions
   *
   * @param events The PamLevel2 pointer to the events that will be analyzed. Used only as parameter for
   *          VerboseCollection::Setup().
   */
  void Setup(PamLevel2 *events);

  /*! @brief Applies the selection and detector cuts to the current event.
    *
    * @param event The event to analyze.
    * @return CUTOK if the event survives all the selection and detector cuts.
    */

  int ApplyCut(PamLevel2 *event);

  /*TODO: redefine GetCut and the other methods to comply with the new selection/detector cuts structure. */

  /*! @brief The post analysis task.
   *
   */
  void Finalize();

protected:

  /*! This collection contains the selection cuts. */
  SmartCollection _selCollection;

  /*! This collection contains the detector cuts. */
  SmartCollection _detCollection;

  /*! The base name of the output file. */
  TString _outFileBase;

  /*! The method used for error computation. */
  int _errMethod;

  /*! The number of events surviving the detector cuts. */
  unsigned int _det;

  /*! The number of events surviving the selection cuts. */
  unsigned int _sel;

};

#endif /* EFFCOLLECTION_H_ */
1	/*
2	* EffCollection.h
3	*
4	* Created on: 10/ago/2009
5	* Author: Nicola Mori
6	*/
7
8	/! @file EffCollection.h The EffCollection class definition file. /
9
10	#ifndef EFFCOLLECTION_H_
11	#define EFFCOLLECTION_H_
12
13	#include "../VerboseCollection/VerboseCollection.h"
14
15	/! @enum EffCollection_ErrMethod to select the method of error computation /
16	enum EffCollection_ErrMethod {
17	EFFERR_SERGIO, ///< Flag for Sergio Ricciarini's Fortran routine
18	EFFERR_ROOT
19	///< Flag for ROOT TGraphAsymErrors::BayesDivide()
20	};
21
22	/*! @brief A verbose collection which computes the efficiency of a set of cuts.
23	*
24	* This class subdivides the cuts it contains into two classes: selection and detector
25	* cuts; detector cuts are evaluated after selection cuts. The collection will compute the
26	* efficiency of the whole detector cuts set evaluated using an efficiency sample selected
27	* by the selection cuts. Actions will be divided in selection and detector actions as well:
28	* adding a selection action, it will be placed after all the selection cuts inserted since
29	* the action insertion, and before all detector cuts. Detector actions are placed after all
30	* the cuts.
31	* This class implements specific methods to add selection and detector cuts; cuts added
32	* with the standard #AddCut method will be treated as detector cuts. The same for actions.
33	* Error computation is done either using Sergio Ricciarini's Fortran routine or ROOT's
34	* TGraphAsimmErrors::BayesDivide(). For both methods, the efficiency is arbitrarily set to
35	* 1.1 when less than 8 events survive the selection cuts. This is needed to avoid convergence
36	* problems in Sergio's routine, and the ROOT output has been consequently adapted to this
37	* convention.
38	*
39	*/
40	class EffCollection: public VerboseCollection {
41
42	public:
43
44	/*! @brief Constructor.
45	*
46	* @param collectionName The collection's name.
47	* @param outFileBase The output file base name. If "", no file output will be produced; otherwise,
48	* a file named outFilebase + collection's name + ".txt" will be produced, containing
49	* the number of events surviving the detector cuts (1st column), the selection cuts (2nd column),
50	* the efficiency (3rd column), the lower (4th column) and upper (5th column) length
51	* of the efficiency's error bar.
52	* @param errMethod The method to use for error computation. Possible values are defined in #EffCollection_ErrMethod.
53	* @param owns If true, the collection will own the cuts and the actions, ie., it will
54	* destroy them in its destructor.
55	*/
56	EffCollection(const char *collectionName, TString outFileBase = "", int errMethod = EFFERR_ROOT, bool owns = true);
57
58	/! @brief Destructor. /
59	~EffCollection() {
60
61	}
62
63	/*! @brief Adds a detector cut to the collection.
64	*
65	* For EffCollection, cuts added wit #AddCut will be treated as detector cuts.
66	*
67	* @param cut The PamCut-derived object to add to the collection.
68	*/
69	void AddCut(PamCut *cut) {
70	AddDetectorCut(cut);
71	}
72
73	/*! @brief Adds a detector cut to the collection.
74	*
75	* Adds a detector cut. Calling #AddCut will add a detector cut as well, and not a
76	* selection cut.
77	* @param cut The PamCut-derived object to add to the collection.
78	*/
79	void AddDetectorCut(PamCut *cut);
80
81	/*! @brief Adds a selection cut to the collection.
82	*
83	* Adds a selection cut. Notice that calling #AddCut will add a detector cut , and not a
84	* selection cut.
85	* @param cut The PamCut-derived object to add to the collection.
86	*/
87	void AddSelectionCut(PamCut *cut);
88
89	/*! @brief Adds an action to the detector cuts queue.
90	*
91	* For EffCollection, actions added wit #AddAction will be inserted in the detector cuts queue.
92	*
93	* @param action The CollectionAction-derived object to add to the collection.
94	*/
95	void AddAction(CollectionAction *action) {
96	AddDetectorAction(action);
97	}
98
99	/*! @brief Adds an action to the detector cuts queue.
100	*
101	* Adds a detector action, ie., an action placed in the detector cuts queue. Calling #AddAction will
102	* add a detector action as well, and not a selection action.
103	*
104	* @param action The CollectionAction-derived object to add to the collection.
105	*/
106	void AddDetectorAction(CollectionAction *action);
107
108	/*! @brief Adds an action to the selection cuts queue.
109	*
110	* Adds a selection action, ie., an action placed in the selection cuts queue. Notice that calling
111	* #AddAction will add a detector action, and not a selection action.
112	*
113	* @param action The CollectionAction-derived object to add to the collection.
114	*/
115	void AddSelectionAction(CollectionAction *action);
116
117
118	/*! @brief The pre-analysis task definition.
119	*
120	* This override of the Setup() method sets up the selection and detector cuts and actions
121	*
122	* @param events The PamLevel2 pointer to the events that will be analyzed. Used only as parameter for
123	* VerboseCollection::Setup().
124	*/
125	void Setup(PamLevel2 *events);
126
127	/*! @brief Applies the selection and detector cuts to the current event.
128	*
129	* @param event The event to analyze.
130	* @return CUTOK if the event survives all the selection and detector cuts.
131	*/
132
133	int ApplyCut(PamLevel2 *event);
134
135	/TODO: redefine GetCut and the other methods to comply with the new selection/detector cuts structure. /
136
137	/*! @brief The post analysis task.
138	*
139	*/
140	void Finalize();
141
142	protected:
143
144	/! This collection contains the selection cuts. /
145	SmartCollection _selCollection;
146
147	/! This collection contains the detector cuts. /
148	SmartCollection _detCollection;
149
150	/! The base name of the output file. /
151	TString _outFileBase;
152
153	/! The method used for error computation. /
154	int _errMethod;
155
156	/! The number of events surviving the detector cuts. /
157	unsigned int _det;
158
159	/! The number of events surviving the selection cuts. /
160	unsigned int _sel;
161
162	};
163
164	#endif /* EFFCOLLECTION_H_ */