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"

/*! @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.
 *
 *
 */
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 + "-eff.txt" will be produced, containing the number of
   *                    events surviving the detector cuts (1st column), the selection cuts (2nd column)
   *                    and the efficiency (3rd column).
   */
  EffCollection(const char *collectionName, TString outFileBase = "");

  /*! @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 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 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	/*! @brief A verbose collection which computes the efficiency of a set of cuts.
16	*
17	* This class subdivides the cuts it contains into two classes: selection and detector
18	* cuts; detector cuts are evaluated after selection cuts. The collection will compute the
19	* efficiency of the whole detector cuts set evaluated using an efficiency sample selected
20	* by the selection cuts. Actions will be divided in selection and detector actions as well:
21	* adding a selection action, it will be placed after all the selection cuts inserted since
22	* the action insertion, and before all detector cuts. Detector actions are placed after all
23	* the cuts.
24	* This class implements specific methods to add selection and detector cuts; cuts added
25	* with the standard #AddCut method will be treated as detector cuts. The same for actions.
26	*
27	*
28	*/
29	class EffCollection: public VerboseCollection {
30
31	public:
32
33	/*! @brief Constructor.
34	*
35	* @param collectionName The collection's name.
36	* @param outFileBase The output file base name. If "", no file output will be produced; otherwise,
37	* a file named outFilebase + "-eff.txt" will be produced, containing the number of
38	* events surviving the detector cuts (1st column), the selection cuts (2nd column)
39	* and the efficiency (3rd column).
40	*/
41	EffCollection(const char *collectionName, TString outFileBase = "");
42
43	/! @brief Destructor. /
44	~EffCollection() {
45
46	}
47
48	/*! @brief Adds a detector cut to the collection.
49	*
50	* For EffCollection, cuts added wit #AddCut will be treated as detector cuts.
51	*
52	* @param cut The PamCut-derived object to add to the collection.
53	*/
54	void AddCut(PamCut &cut) {
55	AddDetectorCut(cut);
56	}
57
58	/*! @brief Adds a detector cut to the collection.
59	*
60	* Adds a detector cut. Calling #AddCut will add a detector cut as well, and not a
61	* selection cut.
62	* @param cut The PamCut-derived object to add to the collection.
63	*/
64	void AddDetectorCut(PamCut &cut);
65
66	/*! @brief Adds a selection cut to the collection.
67	*
68	* Adds a selection cut. Notice that calling #AddCut will add a detector cut , and not a
69	* selection cut.
70	* @param cut The PamCut-derived object to add to the collection.
71	*/
72	void AddSelectionCut(PamCut &cut);
73
74	/*! @brief Adds an action to the detector cuts queue.
75	*
76	* For EffCollection, actions added wit #AddAction will be inserted in the detector cuts queue.
77	*
78	* @param action The CollectionAction-derived object to add to the collection.
79	*/
80	void AddAction(CollectionAction &action) {
81	AddDetectorAction(action);
82	}
83
84	/*! @brief Adds an action to the detector cuts queue.
85	*
86	* Adds a detector action, ie., an action placed in the detector cuts queue. Calling #AddAction will
87	* add a detector action as well, and not a selection action.
88	*
89	* @param action The CollectionAction-derived object to add to the collection.
90	*/
91	void AddDetectorAction(CollectionAction &action);
92
93	/*! @brief Adds an action to the selection cuts queue.
94	*
95	* Adds a selection action, ie., an action placed in the selection cuts queue. Notice that calling
96	* #AddAction will add a detector action, and not a selection action.
97	*
98	* @param action The CollectionAction-derived object to add to the collection.
99	*/
100	void AddSelectionAction(CollectionAction &action);
101
102	/*! @brief Applies the selection and detector cuts to the current event.
103	*
104	* @param event The event to analyze.
105	* @return CUTOK if the event survives all the selection and detector cuts.
106	*/
107	int ApplyCut(PamLevel2 *event);
108
109	/TODO: redefine GetCut and the other methods to comply with the new selection/detector cuts structure. /
110
111	/*! @brief The post analysis task.
112	*
113	*/
114	void Finalize();
115
116	protected:
117
118	/! This collection contains the selection cuts. /
119	SmartCollection _selCollection;
120
121	/! This collection contains the detector cuts. /
122	SmartCollection _detCollection;
123
124	/! The base name of the output file. /
125	TString _outFileBase;
126
127	/! The number of events surviving the detector cuts. /
128	unsigned int _det;
129
130	/! The number of events surviving the selection cuts. /
131	unsigned int _sel;
132
133	};
134
135	#endif /* EFFCOLLECTION_H_ */