MiscCuts/DataQualCut/DataQualCut.h

/*
 * DataQualCut.h
 *
 *  Created on: 10-mar-2009
 *      Author: N. Mori
 */

#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.
 */

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: DEFAULT (meaning Level-2 for TRK, CALO, TOF, ANT, TRG, ORB).
   */

  DataQualCut(const char *cutName, unsigned int cutMask=DEFAULT) :
    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. 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 #ANT if AC data is missing or corrupted.
   * @return #TRG 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	pam-fi	1.1	/*
2			* DataQualCut.h
3			*
4			* Created on: 10-mar-2009
5	pam-fi	1.2	* Author: N. Mori
6	pam-fi	1.1	*/
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	pam-fi	1.2
20	pam-fi	1.1	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	pam-fi	1.2	* Default: DEFAULT (meaning Level-2 for TRK, CALO, TOF, ANT, TRG, ORB).
30	pam-fi	1.1	*/
31
32	pam-fi	1.2	DataQualCut(const char *cutName, unsigned int cutMask=DEFAULT) :
33	pam-fi	1.1	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	pam-fi	1.2	* if the data has been correctly unpacked. If it finds missing or corrupted data, it
43	pam-fi	1.1	* will stop the check and return a code corresponding to the missing/corrupted detector data.
44			*
45			* @param event The event to analyze.
46			* @return #CUTOK if all the checked data are present and not corrupted.
47			* @return #TRK if Tracker data is missing or corrupted.
48			* @return #CALO if Calo level2 data is missing or corrupted.
49			* @return #CALO_L1 if Calo level1 data is missing
50			* @return #TOF if ToF data is missing or corrupted.
51	pam-fi	1.2	* @return #ANT if AC data is missing or corrupted.
52			* @return #TRG if Trigger data is missing or corrupted.
53	pam-fi	1.1	* @return #ORB if Orbital Info data is missing.
54			*/
55			int Check(PamLevel2 *event);
56
57			private:
58
59			unsigned int _cutMask;
60
61			};
62			#endif /* DATAQUALCUT_H_ */