MiscCuts/InclInfoQualCut/InclInfoQualCut.h

/*
 * InclInfoQualCut.h
 *
 *  Created on: 27-marth-2010
 *      Author: Vitaly Malakhov
 */

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

#ifndef INCLINFOQUALCUT_H_
#define INCLINFOQUALCUT_H_

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

/*! @brief The inclination info data quality cut: rejects events with norm of quaternions
 *         is not inside corridor 0.999 - 1.0001 and Time Gap betwean nearest real (not interpolated) 
 *          quaternions more than an upper threshold.
 */
class InclInfoQualCut: public PamCut {

public:
  /*! @brief Constructor.
   *
   * @param cutName The cut's name.
   * @param TimeGapMax The maximum time gap accepted value in sec. It is value between nearesr not interpolated
   *                  quaternions, default value is 300 seconds.
   */
  InclInfoQualCut(const char* cutName, float timeGapMax = 300) :
    PamCut(cutName), _norm(-1.), _timeGapMax(timeGapMax) {
  }
  /*! @brief Destructor. */
  ~InclInfoQualCut() {
  }

  /*! @brief The inclination info quality check.
   *
   * @param event The event to analyze.
   * @return #CUTOK if TimeGap <= TimeGapMax and norm of quaternions lies inside a corridor 0.999 - 1.0001
   */
  int Check(PamLevel2 *event);

private:
  float _norm;
  float _timeGapMax;
};

#endif /* INCLINFOQUALCUT_H_ */
1	/*
2	* InclInfoQualCut.h
3	*
4	* Created on: 27-marth-2010
5	* Author: Vitaly Malakhov
6	*/
7
8	/! @file InclInfoQualCut.h The InclInfoQualCut class definition file /
9
10	#ifndef INCLINFOQUALCUT_H_
11	#define INCLINFOQUALCUT_H_
12
13	#include "../../PamCutBase/PamCutBase.h"
14
15	/*! @brief The inclination info data quality cut: rejects events with norm of quaternions
16	* is not inside corridor 0.999 - 1.0001 and Time Gap betwean nearest real (not interpolated)
17	* quaternions more than an upper threshold.
18	*/
19	class InclInfoQualCut: public PamCut {
20
21	public:
22	/*! @brief Constructor.
23	*
24	* @param cutName The cut's name.
25	* @param TimeGapMax The maximum time gap accepted value in sec. It is value between nearesr not interpolated
26	* quaternions, default value is 300 seconds.
27	*/
28	InclInfoQualCut(const char* cutName, float timeGapMax = 300) :
29	PamCut(cutName), _norm(-1.), _timeGapMax(timeGapMax) {
30	}
31	/! @brief Destructor. /
32	~InclInfoQualCut() {
33	}
34
35	/*! @brief The inclination info quality check.
36	*
37	* @param event The event to analyze.
38	* @return #CUTOK if TimeGap <= TimeGapMax and norm of quaternions lies inside a corridor 0.999 - 1.0001
39	*/
40	int Check(PamLevel2 *event);
41
42	private:
43	float _norm;
44	float _timeGapMax;
45	};
46
47	#endif /* INCLINFOQUALCUT_H_ */