CaloCuts/CaloNHitCut/CaloNHitCut.h

/*
 * CaloNHitCut.h
 *
 *  Created on: 18-mar-2009
 *      Author: Nicola Mori, S. Ricciarini
 */

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

#ifndef NO_CALOAXIS

#ifndef CALONHITCUT_H_
#define CALONHITCUT_H_

#include "../../PamCutBase/PamCutBase.h"
#include <CaloAxis.h>

/*! @brief The number of hits cut for the calorimeter.
 * An event survives this selection if the number of hit planes in the calorimeter
 * is greater than some value. To save computing time, the class
 * assumes that the track is externally computed for each event and stored in
 * CaloAxis objects; pointers to these objects are passed as arguments to the constructor.
 * The Check method will then ignore the PamLevel2 *event and assume that the
 * current content of the CaloAxis objects are relative to the current event.
 * It is an user's task to ensure that these assumptions are fulfilled every time
 * Check or ApplyCut are called.
 *
 * CUT DEPENDENCIES: CaloTrackCut for the existence of the track (it can also provide the CaloAxis objects).
 */

class CaloNHitCut: public PamCut {

public:

  /*! @brief Constructor.
   *
   * The CaloAxis arguments are pointers to objects which contain the calorimeter
   * track information for current event.
   *
   * @param cutName The cut name.
   * @param xCaloAxis The pointer to the CaloAxis object for X axis.
   * @param yCaloAxis The pointer to the CaloAxis object for Y axis.
   * @param nMinHit The minimum number of hits.
   */
  CaloNHitCut(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, int nMinHit=10) :
    PamCut(cutName), _xCaloAxis(xCaloAxis), _yCaloAxis(yCaloAxis), _nMinHit(nMinHit) {
  }
  /*! @brief Destructor. */
  ~CaloNHitCut() {
  }

  /*! @brief The number of hit planes check.
   *
   * The check is done by looking if there is a charge release near the track, using
   * the CaloAxis class. If a charge greater than 0 is found by invoking CaloAxis::GetQ for at
   * least nMinHit planes (both for X and Y) the condition is fulfilled.
   *
   * @param event The event to analyze.
   * @return #CUTOK if the track hits at least nMinHit planes both in X and Y.
   * @return 0 otherwise.
   * @see CaloNHitCut::CaloNHitCut
   */
  int Check(PamLevel2 *event);

private:
  CaloAxis *_xCaloAxis, *_yCaloAxis;
  int _nMinHit;

};
#endif /* CALONHITCUT_H_ */
#endif /* NO_CALOAXIS */
1	/*
2	* CaloNHitCut.h
3	*
4	* Created on: 18-mar-2009
5	* Author: Nicola Mori, S. Ricciarini
6	*/
7
8	/! @file CaloNHitCut.h The CaloNHitCut class definition file /
9
10	#ifndef NO_CALOAXIS
11
12	#ifndef CALONHITCUT_H_
13	#define CALONHITCUT_H_
14
15	#include "../../PamCutBase/PamCutBase.h"
16	#include <CaloAxis.h>
17
18	/*! @brief The number of hits cut for the calorimeter.
19	* An event survives this selection if the number of hit planes in the calorimeter
20	* is greater than some value. To save computing time, the class
21	* assumes that the track is externally computed for each event and stored in
22	* CaloAxis objects; pointers to these objects are passed as arguments to the constructor.
23	* The Check method will then ignore the PamLevel2 *event and assume that the
24	* current content of the CaloAxis objects are relative to the current event.
25	* It is an user's task to ensure that these assumptions are fulfilled every time
26	* Check or ApplyCut are called.
27	*
28	* CUT DEPENDENCIES: CaloTrackCut for the existence of the track (it can also provide the CaloAxis objects).
29	*/
30
31	class CaloNHitCut: public PamCut {
32
33	public:
34
35	/*! @brief Constructor.
36	*
37	* The CaloAxis arguments are pointers to objects which contain the calorimeter
38	* track information for current event.
39	*
40	* @param cutName The cut name.
41	* @param xCaloAxis The pointer to the CaloAxis object for X axis.
42	* @param yCaloAxis The pointer to the CaloAxis object for Y axis.
43	* @param nMinHit The minimum number of hits.
44	*/
45	CaloNHitCut(const char cutName, CaloAxis xCaloAxis, CaloAxis *yCaloAxis, int nMinHit=10) :
46	PamCut(cutName), _xCaloAxis(xCaloAxis), _yCaloAxis(yCaloAxis), _nMinHit(nMinHit) {
47	}
48	/! @brief Destructor. /
49	~CaloNHitCut() {
50	}
51
52	/*! @brief The number of hit planes check.
53	*
54	* The check is done by looking if there is a charge release near the track, using
55	* the CaloAxis class. If a charge greater than 0 is found by invoking CaloAxis::GetQ for at
56	* least nMinHit planes (both for X and Y) the condition is fulfilled.
57	*
58	* @param event The event to analyze.
59	* @return #CUTOK if the track hits at least nMinHit planes both in X and Y.
60	* @return 0 otherwise.
61	* @see CaloNHitCut::CaloNHitCut
62	*/
63	int Check(PamLevel2 *event);
64
65	private:
66	CaloAxis _xCaloAxis, _yCaloAxis;
67	int _nMinHit;
68
69	};
70	#endif /* CALONHITCUT_H_ */
71	#endif /* NO_CALOAXIS */