[u/mrichter/AliRoot.git] / HLT / MUON / AliHLTMUONTriggerRecord.h

#ifndef ALIHLTMUONTRIGGERRECORD_H
#define ALIHLTMUONTRIGGERRECORD_H
/* This file is property of and copyright by the ALICE HLT Project        *
 * ALICE Experiment at CERN, All rights reserved.                         *
 * See cxx source for full Copyright notice                               */

// $Id$

///
/// @file   AliHLTMUONTriggerRecord.h
/// @author Artur Szostak <artursz@iafrica.com>
/// @date   29 Sep 2007
/// @brief  Declaration of the trigger record structure in ROOT object format for dHLT.
///

#include "TObject.h"
#include "TVector3.h"
#include <ostream>

/**
 * Trigger record class containing information about a dimuon L0 trigger
 * local board decision in a ROOT object.
 * This class is mainly for testing or as a helper object for dHLT specific analysis,
 * since it is sometimes easier to store and handle ROOT objects.
 */
class AliHLTMUONTriggerRecord : public TObject
{
	/**
	 * Stream operator for usage with std::ostream classes.
	 * Allows usage such as:
	 *   AliHLTMUONTriggerRecord tr; std::cout << tr;
	 */
	friend std::ostream& operator << (
			std::ostream& stream,
			const AliHLTMUONTriggerRecord& trigrec
		);

public:

	/**
	 * Constructor for creating a new trigger record.
	 * @param id    The trigger record ID number unique for an event.
	 * @param sign  The particle's sign. Must be -1, 1 or 0 if the sign is unknown.
	 * @param px    X component of the particle's momentum.
	 * @param py    Y component of the particle's momentum.
	 * @param pz    Z component of the particle's momentum.
	 * @param sourceDDL  The DDL from which this trigger record originates.
	 * @param zf    The Z coordinate of the middle of the magnetic field assumed
	 *              during momentum calculation.
	 * @param qbl   The integrated magnetic field strength assumed during momentum
	 *              calculation.
	 */
	AliHLTMUONTriggerRecord(
			Int_t id = -1,
			Int_t sign = 0,
			Float_t px = 0,
			Float_t py = 0,
			Float_t pz = 0,
			Int_t sourceDDL = -1,
			Float_t zf = 0,
			Float_t qbl = 0
		);
	
	/**
	 * Default destructor.
	 */
	virtual ~AliHLTMUONTriggerRecord() {}

	/**
	 * Returns the trigger record ID number, which is unique for an event.
	 */
	Int_t Id() const { return fId; }

	/**
	 * Returns the sign of the particle: -1, 1 or 0 if the sign is unknown.
	 */
	Int_t Sign() const { return fSign; }

	/**
	 * Returns the momentum vector with components in GeV/c.
	 */
	const TVector3& Momentum() const { return fMomentum; }

	/**
	 * Returns the X component of the particle's momentum in GeV/c.
	 */
	Double_t Px() const { return fMomentum.Px(); }

	/**
	 * Returns the Y component of the particle's momentum in GeV/c.
	 */
	Double_t Py() const { return fMomentum.Py(); }

	/**
	 * Returns the Z component of the particle's momentum in GeV/c.
	 */
	Double_t Pz() const { return fMomentum.Pz(); }

	/**
	 * Returns the momentum magnitude of the particle in GeV/c.
	 */
	Double_t P() const { return fMomentum.Mag(); }

	/**
	 * Returns the transverse momentum of the particle in GeV/c.
	 */
	Double_t Pt() const { return fMomentum.Pt(); }

	/**
	 * Returns the polar angle of the momentum vector in radians.
	 */
	Double_t Polar() const { return fMomentum.Theta(); }

	/**
	 * Returns the azimuthal angle of the transverse momentum in radians.
	 */
	Double_t Phi() const { return fMomentum.Phi(); }

	/**
	 * Returns the hit coordinate on the specified chamber in the AliRoot
	 * coordinate system.
	 * @param chamber  The chamber for which to fetch the hit. Valid values
	 *                 are in the range [11..14].
	 */
	const TVector3& Hit(Int_t chamber) const;

	/**
	 * Returns the X coordinate of the reconstructed hit in centimetres.
	 * @param chamber  The chamber for which to fetch the X coordinate.
	 *                 Valid values are in the range [11..14].
	 */
	Double_t X(Int_t chamber) const { return Hit(chamber).X(); }

	/**
	 * Returns the Y coordinate of the reconstructed hit in centimetres.
	 * @param chamber  The chamber for which to fetch the Y coordinate.
	 *                 Valid values are in the range [11..14].
	 */
	Double_t Y(Int_t chamber) const { return Hit(chamber).Y(); }

	/**
	 * Returns the Z coordinate of the reconstructed hit in centimetres.
	 * @param chamber  The chamber for which to fetch the Z coordinate.
	 *                 Valid values are in the range [11..14].
	 */
	Double_t Z(Int_t chamber) const { return Hit(chamber).Z(); }
	
	/**
	 * Returns the source DDL from which this trigger record originates.
	 * -1 is returned if this was not set.
	 */
	Int_t SourceDDL() const { return fSourceDDL; }
	
	/**
	 * Returns the detector element ID number for the hit on the specified
	 * chamber. -1 is returned if this information was not set.
	 * @param chamber  The chamber for which to fetch the detector element ID.
	 *                 Valid values are in the range [11..14].
	 */
	Int_t DetElemId(Int_t chamber) const;
	
	/**
	 * Returns the 16 bit X pattern from the local board.
	 * -1 is returned if this information was not set.
	 * @param chamber  The chamber for which to fetch the bit pattern.
	 *                 Valid values are in the range [11..14].
	 * \param board  The board for which to fetch the bit pattern in the range [0..2].
	 *             0 indicates the previous board, 1 the central and 2 the next board.
	 */
	Int_t PatternX(Int_t chamber, Int_t board) const;
	
	/**
	 * Returns the 16 bit Y pattern from the local board.
	 * -1 is returned if this information was not set.
	 * @param chamber  The chamber for which to fetch the bit pattern.
	 *                Valid values are in the range [11..14].
	 * \param board  The board for which to fetch the bit pattern in the range [0..2].
	 *             0 indicates the previous board, 1 the central and 2 the next board.
	 */
	Int_t PatternY(Int_t chamber, Int_t board) const;
	
	/**
	 * Returns the Z coordinate in the middle of the magnetic field used to
	 * calculate the momentum.
	 */
	Float_t Zmiddle() const { return fZmiddle; }
	
	/**
	 * Returns the integrated magnetic field strength times polarity used in
	 * the calculation of the momentum. Value returned in (T.m) tesla metres.
	 */
	Float_t QBL() const { return fQBL; }
	
	/**
	 * Sets the hit coordinate (in AliRoot global coordinates) on the
	 * given chamber.
	 * @param chamber  The chamber for which to set the hit. Valid values
	 *                 are in the range [11..14].
	 * @param x  The X coordinate of the hit in centimetres.
	 * @param y  The Y coordinate of the hit in centimetres.
	 * @param z  The Z coordinate of the hit in centimetres.
	 */
	void SetHit(Int_t chamber, Float_t x, Float_t y, Float_t z);
	
	/**
	 * Sets the hit coordinate on a given chamber with the detection element ID.
	 * @param chamber  The chamber for which to set the hit. Valid values
	 *                 are in the range [11..14].
	 * @param x  The X coordinate of the hit in centimetres.
	 * @param y  The Y coordinate of the hit in centimetres.
	 * @param z  The Z coordinate of the hit in centimetres.
	 * @param detElemId The detection element ID where the hit was found.
	 */
	void SetHit(Int_t chamber, Float_t x, Float_t y, Float_t z, Int_t detElemId);
	
	/**
	 * Sets the debugging information for the hit on the specified chamber.
	 * @param chamber  The chamber for which to set the debugging information.
	 *                Valid values are in the range [11..14].
	 * @param patternX  Array of X bit pattern from the local boards.
	 * @param patternY  Array of Y bit pattern from the local boards.
	 * \note The bit patterns in the array are in the order: [previous, central, next].
	 */
	void SetHitDebugInfo(Int_t chamber, UShort_t patternX[3], UShort_t patternY[3]);
	
	/**
	 * Sets the debugging information for the hit on the specified chamber.
	 * @param zmiddle  The z coordinate of the middle of the magnetic field.
	 * @param bfieldintegral  The magnetic field integral times field polarity.
	 */
	void SetDebugInfo(Float_t zmiddle, Float_t bfieldintegral);
	
	/**
	 * Prints the details of the trigger record.
	 * @param option  A case sensitive string that can contain one of the
	 *     following strings:
	 *       "compact" - Prints just the momentum, sign and ID of the trigger
	 *                   record in a terse format.
	 *       "detail" - Prints also the hit information.
	 *       "all" - Prints all known information about this trigger record.
	 *     If the string contains an empty option or NULL then the default is
	 *     to print compactly.
	 */
	virtual void Print(Option_t* option = NULL) const;
	
	// Methods inherited from TObject
	virtual Bool_t IsSortable() const { return kTRUE; }
	Int_t Compare(const TObject* obj) const;

	// Implement comparison operators.
	bool operator == (const AliHLTMUONTriggerRecord& trigrec) const;

	bool operator != (const AliHLTMUONTriggerRecord& trigrec) const
	{
		return not this->operator == (trigrec);
	}

private:

	Int_t fId; ///< Each trigger record should have an ID number unique for a given event.
	Int_t fSign;  ///< The sign of the particle: -1 or 1. 0 indicates unknown value.
	TVector3 fMomentum; ///< Momentum vector of the particle in GeV/c.
	TVector3 fHit[4];   ///< hit coordinates on trigger chambers 11 to 14.
	
	// The following is debugging information and may not be filled if the
	// dHLT components were not set to produce this information.
	Int_t fSourceDDL;  ///< The DDL from which this trigger record originates.
	Int_t fDetElemId[4]; ///< The detector element ID for the hit on each chamber 11 to 14.
	Int_t fPatternX[4][3]; ///< The X strip pattern for chambers 11 to 14 and previous, central and next local boards. -1 if invalid.
	Int_t fPatternY[4][3]; ///< The Y strip pattern for chambers 11 to 14 and previous, central and next local boards. -1 if invalid.
	
	// Parameters used in momentum estimation:
	Float_t fZmiddle; ///< Particle momentum X component in GeV/c.
	Float_t fQBL;     ///< The integrated magnetic field times field polarity in (T.m) tesla metres.
		
	ClassDef(AliHLTMUONTriggerRecord, 4);  // Trigger record object translated from dHLT internal raw data.
};

#endif // ALIHLTMUONTRIGGERRECORD_H
Commit	Line	Data
753896cd	1	#ifndef ALIHLTMUONTRIGGERRECORD_H
	2	#define ALIHLTMUONTRIGGERRECORD_H
	3	/* This file is property of and copyright by the ALICE HLT Project *
	4	* ALICE Experiment at CERN, All rights reserved. *
	5	* See cxx source for full Copyright notice */
	6
1d8ae082	7	// $Id$
753896cd	8
450e0b36	9	///
	10	/// @file AliHLTMUONTriggerRecord.h
	11	/// @author Artur Szostak <artursz@iafrica.com>
	12	/// @date 29 Sep 2007
	13	/// @brief Declaration of the trigger record structure in ROOT object format for dHLT.
	14	///
753896cd	15
	16	#include "TObject.h"
	17	#include "TVector3.h"
	18	#include <ostream>
	19
	20	/**
	21	* Trigger record class containing information about a dimuon L0 trigger
450e0b36	22	* local board decision in a ROOT object.
	23	* This class is mainly for testing or as a helper object for dHLT specific analysis,
	24	* since it is sometimes easier to store and handle ROOT objects.
753896cd	25	*/
	26	class AliHLTMUONTriggerRecord : public TObject
	27	{
	28	/**
	29	* Stream operator for usage with std::ostream classes.
	30	* Allows usage such as:
	31	* AliHLTMUONTriggerRecord tr; std::cout << tr;
	32	*/
	33	friend std::ostream& operator << (
	34	std::ostream& stream,
	35	const AliHLTMUONTriggerRecord& trigrec
	36	);
	37
	38	public:
	39
	40	/**
	41	* Constructor for creating a new trigger record.
	42	* @param id The trigger record ID number unique for an event.
	43	* @param sign The particle's sign. Must be -1, 1 or 0 if the sign is unknown.
	44	* @param px X component of the particle's momentum.
	45	* @param py Y component of the particle's momentum.
	46	* @param pz Z component of the particle's momentum.
	47	* @param sourceDDL The DDL from which this trigger record originates.
	48	* @param zf The Z coordinate of the middle of the magnetic field assumed
	49	* during momentum calculation.
	50	* @param qbl The integrated magnetic field strength assumed during momentum
	51	* calculation.
	52	*/
	53	AliHLTMUONTriggerRecord(
	54	Int_t id = -1,
	55	Int_t sign = 0,
	56	Float_t px = 0,
	57	Float_t py = 0,
	58	Float_t pz = 0,
	59	Int_t sourceDDL = -1,
	60	Float_t zf = 0,
	61	Float_t qbl = 0
	62	);
450e0b36	63
	64	/**
	65	* Default destructor.
	66	*/
753896cd	67	virtual ~AliHLTMUONTriggerRecord() {}
	68
	69	/**
	70	* Returns the trigger record ID number, which is unique for an event.
	71	*/
	72	Int_t Id() const { return fId; }
	73
	74	/**
	75	* Returns the sign of the particle: -1, 1 or 0 if the sign is unknown.
	76	*/
	77	Int_t Sign() const { return fSign; }
	78
	79	/**
	80	* Returns the momentum vector with components in GeV/c.
	81	*/
	82	const TVector3& Momentum() const { return fMomentum; }
	83
	84	/**
	85	* Returns the X component of the particle's momentum in GeV/c.
	86	*/
	87	Double_t Px() const { return fMomentum.Px(); }
	88
	89	/**
	90	* Returns the Y component of the particle's momentum in GeV/c.
	91	*/
	92	Double_t Py() const { return fMomentum.Py(); }
	93
	94	/**
	95	* Returns the Z component of the particle's momentum in GeV/c.
	96	*/
	97	Double_t Pz() const { return fMomentum.Pz(); }
	98
	99	/**
	100	* Returns the momentum magnitude of the particle in GeV/c.
	101	*/
	102	Double_t P() const { return fMomentum.Mag(); }
	103
	104	/**
	105	* Returns the transverse momentum of the particle in GeV/c.
	106	*/
	107	Double_t Pt() const { return fMomentum.Pt(); }
	108
	109	/**
	110	* Returns the polar angle of the momentum vector in radians.
	111	*/
	112	Double_t Polar() const { return fMomentum.Theta(); }
	113
	114	/**
	115	* Returns the azimuthal angle of the transverse momentum in radians.
	116	*/
	117	Double_t Phi() const { return fMomentum.Phi(); }
	118
	119	/**
	120	* Returns the hit coordinate on the specified chamber in the AliRoot
	121	* coordinate system.
	122	* @param chamber The chamber for which to fetch the hit. Valid values
	123	* are in the range [11..14].
	124	*/
	125	const TVector3& Hit(Int_t chamber) const;
	126
	127	/**
	128	* Returns the X coordinate of the reconstructed hit in centimetres.
450e0b36	129	* @param chamber The chamber for which to fetch the X coordinate.
450e0b36	130	* Valid values are in the range [11..14].
753896cd	131	*/
	132	Double_t X(Int_t chamber) const { return Hit(chamber).X(); }
	133
	134	/**
	135	* Returns the Y coordinate of the reconstructed hit in centimetres.
450e0b36	136	* @param chamber The chamber for which to fetch the Y coordinate.
450e0b36	137	* Valid values are in the range [11..14].
753896cd	138	*/
	139	Double_t Y(Int_t chamber) const { return Hit(chamber).Y(); }
	140
	141	/**
	142	* Returns the Z coordinate of the reconstructed hit in centimetres.
450e0b36	143	* @param chamber The chamber for which to fetch the Z coordinate.
450e0b36	144	* Valid values are in the range [11..14].
753896cd	145	*/
	146	Double_t Z(Int_t chamber) const { return Hit(chamber).Z(); }
	147
	148	/**
	149	* Returns the source DDL from which this trigger record originates.
	150	* -1 is returned if this was not set.
	151	*/
	152	Int_t SourceDDL() const { return fSourceDDL; }
	153
	154	/**
	155	* Returns the detector element ID number for the hit on the specified
	156	* chamber. -1 is returned if this information was not set.
450e0b36	157	* @param chamber The chamber for which to fetch the detector element ID.
450e0b36	158	* Valid values are in the range [11..14].
753896cd	159	*/
	160	Int_t DetElemId(Int_t chamber) const;
	161
	162	/**
	163	* Returns the 16 bit X pattern from the local board.
	164	* -1 is returned if this information was not set.
450e0b36	165	* @param chamber The chamber for which to fetch the bit pattern.
450e0b36	166	* Valid values are in the range [11..14].
462e3880	167	* \param board The board for which to fetch the bit pattern in the range [0..2].
462e3880	168	* 0 indicates the previous board, 1 the central and 2 the next board.
753896cd	169	*/
462e3880	170	Int_t PatternX(Int_t chamber, Int_t board) const;
753896cd	171
	172	/**
	173	* Returns the 16 bit Y pattern from the local board.
	174	* -1 is returned if this information was not set.
450e0b36	175	* @param chamber The chamber for which to fetch the bit pattern.
450e0b36	176	* Valid values are in the range [11..14].
462e3880	177	* \param board The board for which to fetch the bit pattern in the range [0..2].
462e3880	178	* 0 indicates the previous board, 1 the central and 2 the next board.
753896cd	179	*/
462e3880	180	Int_t PatternY(Int_t chamber, Int_t board) const;
753896cd	181
	182	/**
	183	* Returns the Z coordinate in the middle of the magnetic field used to
	184	* calculate the momentum.
	185	*/
	186	Float_t Zmiddle() const { return fZmiddle; }
	187
	188	/**
462e3880	189	* Returns the integrated magnetic field strength times polarity used in
753896cd	190	* the calculation of the momentum. Value returned in (T.m) tesla metres.
	191	*/
	192	Float_t QBL() const { return fQBL; }
	193
	194	/**
	195	* Sets the hit coordinate (in AliRoot global coordinates) on the
	196	* given chamber.
450e0b36	197	* @param chamber The chamber for which to set the hit. Valid values
753896cd	198	* are in the range [11..14].
	199	* @param x The X coordinate of the hit in centimetres.
	200	* @param y The Y coordinate of the hit in centimetres.
	201	* @param z The Z coordinate of the hit in centimetres.
	202	*/
	203	void SetHit(Int_t chamber, Float_t x, Float_t y, Float_t z);
	204
462e3880	205	/**
	206	* Sets the hit coordinate on a given chamber with the detection element ID.
	207	* @param chamber The chamber for which to set the hit. Valid values
	208	* are in the range [11..14].
	209	* @param x The X coordinate of the hit in centimetres.
	210	* @param y The Y coordinate of the hit in centimetres.
	211	* @param z The Z coordinate of the hit in centimetres.
	212	* @param detElemId The detection element ID where the hit was found.
	213	*/
	214	void SetHit(Int_t chamber, Float_t x, Float_t y, Float_t z, Int_t detElemId);
	215
753896cd	216	/**
753896cd	217	* Sets the debugging information for the hit on the specified chamber.
450e0b36	218	* @param chamber The chamber for which to set the debugging information.
450e0b36	219	* Valid values are in the range [11..14].
462e3880	220	* @param patternX Array of X bit pattern from the local boards.
	221	* @param patternY Array of Y bit pattern from the local boards.
	222	* \note The bit patterns in the array are in the order: [previous, central, next].
753896cd	223	*/
462e3880	224	void SetHitDebugInfo(Int_t chamber, UShort_t patternX[3], UShort_t patternY[3]);
	225
	226	/**
	227	* Sets the debugging information for the hit on the specified chamber.
	228	* @param zmiddle The z coordinate of the middle of the magnetic field.
	229	* @param bfieldintegral The magnetic field integral times field polarity.
	230	*/
	231	void SetDebugInfo(Float_t zmiddle, Float_t bfieldintegral);
753896cd	232
	233	/**
	234	* Prints the details of the trigger record.
	235	* @param option A case sensitive string that can contain one of the
	236	* following strings:
	237	* "compact" - Prints just the momentum, sign and ID of the trigger
	238	* record in a terse format.
	239	* "detail" - Prints also the hit information.
	240	* "all" - Prints all known information about this trigger record.
	241	* If the string contains an empty option or NULL then the default is
	242	* to print compactly.
	243	*/
	244	virtual void Print(Option_t* option = NULL) const;
	245
	246	// Methods inherited from TObject
	247	virtual Bool_t IsSortable() const { return kTRUE; }
	248	Int_t Compare(const TObject* obj) const;
	249
	250	// Implement comparison operators.
	251	bool operator == (const AliHLTMUONTriggerRecord& trigrec) const;
	252
	253	bool operator != (const AliHLTMUONTriggerRecord& trigrec) const
	254	{
	255	return not this->operator == (trigrec);
	256	}
	257
	258	private:
	259
450e0b36	260	Int_t fId; ///< Each trigger record should have an ID number unique for a given event.
	261	Int_t fSign; ///< The sign of the particle: -1 or 1. 0 indicates unknown value.
	262	TVector3 fMomentum; ///< Momentum vector of the particle in GeV/c.
	263	TVector3 fHit[4]; ///< hit coordinates on trigger chambers 11 to 14.
753896cd	264
	265	// The following is debugging information and may not be filled if the
	266	// dHLT components were not set to produce this information.
450e0b36	267	Int_t fSourceDDL; ///< The DDL from which this trigger record originates.
450e0b36	268	Int_t fDetElemId[4]; ///< The detector element ID for the hit on each chamber 11 to 14.
462e3880	269	Int_t fPatternX[4][3]; ///< The X strip pattern for chambers 11 to 14 and previous, central and next local boards. -1 if invalid.
462e3880	270	Int_t fPatternY[4][3]; ///< The Y strip pattern for chambers 11 to 14 and previous, central and next local boards. -1 if invalid.
753896cd	271
753896cd	272	// Parameters used in momentum estimation:
450e0b36	273	Float_t fZmiddle; ///< Particle momentum X component in GeV/c.
462e3880	274	Float_t fQBL; ///< The integrated magnetic field times field polarity in (T.m) tesla metres.
753896cd	275
462e3880	276	ClassDef(AliHLTMUONTriggerRecord, 4); // Trigger record object translated from dHLT internal raw data.
753896cd	277	};
	278
	279	#endif // ALIHLTMUONTRIGGERRECORD_H