MiscCuts/DataQualCut/DataQualCut.h

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

#ifndef DATAQUALCUT_H_
#define DATAQUALCUT_H_

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

#include "../../PamCutBase/PamCutBase.h"

/*! @brief The event and data quality cut.
 * This cut ensures that all the data relative to the various detectors is
 * present in the current event and that it has been correctly read.
 */
//TODO: vedere se includere il ND e S4, chiedere riguardo al controllo su ORB che non c'e' in PamLevel2::IsGood()
class DataQualCut: public PamCut {

public:
  /*! @brief Constructor.
DataQualCut.h
   *
   * @param cutName The cut's name.
   * @param cutMask An integer whose binary code would provide a mask for the cuts to apply;
   *        use a DETECTORCODE or a combination of them to enable the corresponding checks.
   *        Default: ALL (meaning all Level 2 detectors except S4 and ND).
   */

  DataQualCut(const char *cutName, unsigned int cutMask=ALL) :
    PamCut(cutName), _cutMask(cutMask) {
  }
  /*! @brief Destructor. */
  ~DataQualCut() {
  }

  /*! @brief The event and data quality check.
   *
   * This method checks if the pointers to the various detectors level 2 data are present and
   * if the data has been correctly unpacked, in this order:
   * Tracker, Calo, ToF, AC, Trigger, Orbital Info. If it finds missing or corrupted data, it
   * will stop the check and return a code corresponding to the missing/corrupted detector data.
   *
   * @param event The event to analyze.
   * @return #CUTOK if all the checked data are present and not corrupted.
   * @return #TRK if Tracker data is missing or corrupted.
   * @return #CALO if Calo level2 data is missing or corrupted.
   * @return #CALO_L1 if Calo level1 data is missing
   * @return #TOF if ToF data is missing or corrupted.
   * @return #AC if AC data is missing or corrupted.
   * @return #TRIG if Trigger data is missing or corrupted.
   * @return #ORB if Orbital Info data is missing.
   */
  int Check(PamLevel2 *event);

private:

  unsigned int _cutMask;

};
#endif /* DATAQUALCUT_H_ */
1	/*
2	* DataQualCut.h
3	*
4	* Created on: 10-mar-2009
5	* Author: Nicola Mori, S. Ricciarini
6	*/
7
8	#ifndef DATAQUALCUT_H_
9	#define DATAQUALCUT_H_
10
11	/! @file DataQualCut.h The DataQualCut class definition file /
12
13	#include "../../PamCutBase/PamCutBase.h"
14
15	/*! @brief The event and data quality cut.
16	* This cut ensures that all the data relative to the various detectors is
17	* present in the current event and that it has been correctly read.
18	*/
19	//TODO: vedere se includere il ND e S4, chiedere riguardo al controllo su ORB che non c'e' in PamLevel2::IsGood()
20	class DataQualCut: public PamCut {
21
22	public:
23	/*! @brief Constructor.
24	DataQualCut.h
25	*
26	* @param cutName The cut's name.
27	* @param cutMask An integer whose binary code would provide a mask for the cuts to apply;
28	* use a DETECTORCODE or a combination of them to enable the corresponding checks.
29	* Default: ALL (meaning all Level 2 detectors except S4 and ND).
30	*/
31
32	DataQualCut(const char *cutName, unsigned int cutMask=ALL) :
33	PamCut(cutName), _cutMask(cutMask) {
34	}
35	/! @brief Destructor. /
36	~DataQualCut() {
37	}
38
39	/*! @brief The event and data quality check.
40	*
41	* This method checks if the pointers to the various detectors level 2 data are present and
42	* if the data has been correctly unpacked, in this order:
43	* Tracker, Calo, ToF, AC, Trigger, Orbital Info. If it finds missing or corrupted data, it
44	* will stop the check and return a code corresponding to the missing/corrupted detector data.
45	*
46	* @param event The event to analyze.
47	* @return #CUTOK if all the checked data are present and not corrupted.
48	* @return #TRK if Tracker data is missing or corrupted.
49	* @return #CALO if Calo level2 data is missing or corrupted.
50	* @return #CALO_L1 if Calo level1 data is missing
51	* @return #TOF if ToF data is missing or corrupted.
52	* @return #AC if AC data is missing or corrupted.
53	* @return #TRIG if Trigger data is missing or corrupted.
54	* @return #ORB if Orbital Info data is missing.
55	*/
56	int Check(PamLevel2 *event);
57
58	private:
59
60	unsigned int _cutMask;
61
62	};
63	#endif /* DATAQUALCUT_H_ */