PAMELA%20software/PamCut/CommonDefs.h

/*
 * CommonDefs.h
 *
 *  Created on: 10-mar-2009
 *      Author: Nicola Mori
 */

/*! @file CommonDefs.h A header file with all the common definitions for the PamCut framework.
 */

#ifndef COMMONDEFS_H_
#define COMMONDEFS_H_

/*! @brief The implementations of PamCut::Check() must return this value if the event satisfy the cut*/
const int CUTOK = -1;

const float POSITIVE = 1.0; ///< Positive sign alias
const float NEGATIVE = -1.0; ///< Negative sign alias

/*! @enum DETECTORCODE
 * The values for each detector correspond to a binary code associated to that detector.
 * These can be arithmetically added to create a binary code for a set of detectors.
 */
enum DETECTORCODE {
  TRK = 1, ///< Code for Tracker
  CALO = 2, ///< Code for Calorimeter level2
  TOF = 4, ///< Code for ToF
  ANT = 8, ///< Code for AntiCoincidence
  TRG = 16, ///< Code for Trigger
  ORB = 32, ///< Code for Orbital Info
  DEFAULT = 63, ///< TRK, CALO, TOF, ANT, TRG, ORB
  ND = 64, ///< Code for Neutron Detector
  CALO_L1 = 128
///< Code for Calorimeter level1
};

/*! @enum TOFLAYERS Flags to identify layers. */
enum TOFLAYERS {
  S11 = 1, ///< S11.
  S12 = 2, ///< S12.
  S21 = 4, ///< S21.
  S22 = 8, ///< S22.
  S31 = 16, ///< S31.
  S32 = 32
///< S32.
};

/*! @var TOFNPADLAYER
 * The number of pads in each ToF layer. S11 corresponds to element 0, S12 to element 1 and so on.
 */
const int TOFNPADLAYER[6] = { 8, 6, 2, 2, 3, 3 };

/*! @var H_MASS
 * Proton mass
 */
const float H_MASS = 0.93827203; // GeV (pdg.web.cern.ch)

/*! @var HE4_MASS
 * Helium 4 mass
 */
const float HE4_MASS = 3.7274; // GeV (http://hyperphysics.phy-astr.gsu.edu/Hbase/pertab/He.html)

/*! @var HE3_MASS
 * Helium 3 mass
 */
const float HE3_MASS = 2.8084; // GeV (http://hyperphysics.phy-astr.gsu.edu/Hbase/pertab/He.html)

/*! @var E_MASS
 * Electron mass
 */
const float E_MASS = 0.000510998; // GeV (from PDG)

/*! @brief A simple matrix class.
 *
 *  This class defines a matrix built by STL vectors. It is basically a variable-dimension
 *  vector of vectors. It is intended as a container and not for algebraic manipulations.
 *  The class provides a standard access operator [] and a resize method.
 */
template<class T>
class SimpleMatrix {

public:
  /*! @brief Constructor
   *
   * The constructor will build an nRows x nCols matrix, initialized with a default value. If T
   * is a class with no default constructor, a default value for T must be provided, which will
   * be replicated in every matrix element.
   *
   * @param nRows The number of rows.
   * @param nCols The number of columns
   * @param elements The initialization value for the matrix elements.
   */
  SimpleMatrix(unsigned int nRows = 0, unsigned int nCols = 0, T elements = T()) :
    _matrix(nRows, std::vector<T>(nCols, elements)) {

  }

  /*! @brief Standard accessor.
   *
   * @param i The desired row.
   * @return The i-th row (a vector).
   */
  std::vector<T>& operator[](int i) {
    return _matrix[i];
  }

  /*! @brief Returns the number of rows.
   *
   * @return The number of rows.
   */
  unsigned int GetNRows() {
    return _matrix.size();
  }

  /*! @brief Returns the number of columns.
   *
   * @return The number of columns.
   */
  unsigned int GetNCols() {
    return _matrix[0].size();
  }

  /*! @brief Resizes the matrix.
   *
   * If new rows or columns are added, they are initialized to the default value; if T
   * is a class with no default constructor, a default value for T must be provided, which will
   * be replicated in every new matrix element. No modification
   * is done to existing elements (except for those that will be eventually removed).
   *
   * @param nRows The new number of rows.
   * @param nCols The new number of columns.
   * @param elements The initialization value for the new matrix elements.
   */
  void Resize(unsigned int nRows, unsigned int nCols, T elements = T()) {

    _matrix.resize(nRows, std::vector<T>(nCols, elements));
    for (unsigned int i = 0; i < _matrix.size(); i++)
      _matrix[i].resize(nCols, elements);
  }

private:

  std::vector<std::vector<T> > _matrix;
};

#endif /* COMMONDEFS_H_ */
1	pam-fi	1.1	/*
2			* CommonDefs.h
3			*
4			* Created on: 10-mar-2009
5			* Author: Nicola Mori
6			*/
7
8			/*! @file CommonDefs.h A header file with all the common definitions for the PamCut framework.
9			*/
10
11			#ifndef COMMONDEFS_H_
12			#define COMMONDEFS_H_
13
14			/! @brief The implementations of PamCut::Check() must return this value if the event satisfy the cut/
15			const int CUTOK = -1;
16
17	pam-fi	1.9	const float POSITIVE = 1.0; ///< Positive sign alias
18			const float NEGATIVE = -1.0; ///< Negative sign alias
19
20	pam-fi	1.1	/*! @enum DETECTORCODE
21			* The values for each detector correspond to a binary code associated to that detector.
22			* These can be arithmetically added to create a binary code for a set of detectors.
23			*/
24			enum DETECTORCODE {
25			TRK = 1, ///< Code for Tracker
26	pam-fi	1.2	CALO = 2, ///< Code for Calorimeter level2
27	pam-fi	1.1	TOF = 4, ///< Code for ToF
28	pam-fi	1.6	ANT = 8, ///< Code for AntiCoincidence
29			TRG = 16, ///< Code for Trigger
30	pam-fi	1.1	ORB = 32, ///< Code for Orbital Info
31	pam-fi	1.6	DEFAULT = 63, ///< TRK, CALO, TOF, ANT, TRG, ORB
32			ND = 64, ///< Code for Neutron Detector
33			CALO_L1 = 128
34	pam-fi	1.3	///< Code for Calorimeter level1
35	pam-fi	1.2	};
36
37	pam-fi	1.4	/! @enum TOFLAYERS Flags to identify layers. /
38			enum TOFLAYERS {
39			S11 = 1, ///< S11.
40			S12 = 2, ///< S12.
41			S21 = 4, ///< S21.
42			S22 = 8, ///< S22.
43			S31 = 16, ///< S31.
44			S32 = 32
45			///< S32.
46			};
47
48	pam-fi	1.2	/*! @var TOFNPADLAYER
49			* The number of pads in each ToF layer. S11 corresponds to element 0, S12 to element 1 and so on.
50			*/
51			const int TOFNPADLAYER[6] = { 8, 6, 2, 2, 3, 3 };
52
53	pam-fi	1.7	/*! @var H_MASS
54			* Proton mass
55			*/
56	pam-fi	1.8	const float H_MASS = 0.93827203; // GeV (pdg.web.cern.ch)
57	pam-fi	1.7
58			/*! @var HE4_MASS
59			* Helium 4 mass
60			*/
61	pam-fi	1.8	const float HE4_MASS = 3.7274; // GeV (http://hyperphysics.phy-astr.gsu.edu/Hbase/pertab/He.html)
62	pam-fi	1.7
63			/*! @var HE3_MASS
64			* Helium 3 mass
65			*/
66	pam-fi	1.8	const float HE3_MASS = 2.8084; // GeV (http://hyperphysics.phy-astr.gsu.edu/Hbase/pertab/He.html)
67	pam-fi	1.7
68			/*! @var E_MASS
69			* Electron mass
70			*/
71	pam-fi	1.8	const float E_MASS = 0.000510998; // GeV (from PDG)
72	pam-fi	1.7
73	pam-fi	1.2	/*! @brief A simple matrix class.
74			*
75			* This class defines a matrix built by STL vectors. It is basically a variable-dimension
76	pam-fi	1.3	* vector of vectors. It is intended as a container and not for algebraic manipulations.
77			* The class provides a standard access operator [] and a resize method.
78	pam-fi	1.2	*/
79			template<class T>
80			class SimpleMatrix {
81
82			public:
83			/*! @brief Constructor
84			*
85			* The constructor will build an nRows x nCols matrix, initialized with a default value. If T
86			* is a class with no default constructor, a default value for T must be provided, which will
87			* be replicated in every matrix element.
88			*
89			* @param nRows The number of rows.
90			* @param nCols The number of columns
91			* @param elements The initialization value for the matrix elements.
92			*/
93	pam-fi	1.5	SimpleMatrix(unsigned int nRows = 0, unsigned int nCols = 0, T elements = T()) :
94	pam-fi	1.3	_matrix(nRows, std::vector<T>(nCols, elements)) {
95	pam-fi	1.2
96			}
97
98			/*! @brief Standard accessor.
99			*
100			* @param i The desired row.
101			* @return The i-th row (a vector).
102			*/
103			std::vector<T>& operator[](int i) {
104			return _matrix[i];
105			}
106
107			/*! @brief Returns the number of rows.
108			*
109			* @return The number of rows.
110			*/
111			unsigned int GetNRows() {
112	pam-fi	1.3	return _matrix.size();
113	pam-fi	1.2	}
114
115			/*! @brief Returns the number of columns.
116			*
117			* @return The number of columns.
118			*/
119			unsigned int GetNCols() {
120	pam-fi	1.3	return _matrix[0].size();
121			}
122
123			/*! @brief Resizes the matrix.
124			*
125			* If new rows or columns are added, they are initialized to the default value; if T
126			* is a class with no default constructor, a default value for T must be provided, which will
127			* be replicated in every new matrix element. No modification
128			* is done to existing elements (except for those that will be eventually removed).
129			*
130			* @param nRows The new number of rows.
131			* @param nCols The new number of columns.
132			* @param elements The initialization value for the new matrix elements.
133			*/
134			void Resize(unsigned int nRows, unsigned int nCols, T elements = T()) {
135
136			_matrix.resize(nRows, std::vector<T>(nCols, elements));
137			for (unsigned int i = 0; i < _matrix.size(); i++)
138			_matrix[i].resize(nCols, elements);
139	pam-fi	1.2	}
140
141			private:
142
143			std::vector<std::vector<T> > _matrix;
144	pam-fi	1.1	};
145
146			#endif /* COMMONDEFS_H_ */