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

#ifndef ALIHLTMUONMANSOTRACK_H
#define ALIHLTMUONMANSOTRACK_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   AliHLTMUONMansoTrack.h
/// @author Artur Szostak <artursz@iafrica.com>
/// @date   29 Sep 2007
/// @brief  Declaration of the Manso track class used to store converted track data.
///

#include "TObject.h"
#include "TVector3.h"

class AliHLTMUONTriggerRecord;
class AliHLTMUONRecHit;

/**
 * AliHLTMUONMansoTrack stores converted dHLT raw track data as 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 AliHLTMUONMansoTrack : public TObject
{
	/**
	 * Stream operator for usage with std::ostream classes.
	 * Allows usage such as:
	 *   AliHLTMUONMansoTrack t; std::cout << t;
	 */
	friend std::ostream& operator << (
			std::ostream& stream,
			const AliHLTMUONMansoTrack& track
		);

public:

	/**
	 * Constructor for creating a track object with none, some or all 4 hits
	 * specified. Note: this class does not take ownership of the hit or trigger
	 * record objects and will not attempt to delete them.
	 * @param id       The track ID number which must be unique for any event.
	 * @param sign     The particle's sign: -1, 1 or 0 if unknown.
	 * @param px       X component of the particle's momentum (GeV/c).
	 * @param py       Y component of the particle's momentum (GeV/c).
	 * @param pz       Z component of the particle's momentum (GeV/c).
	 * @param chi2     The chi squared of the track fit.
	 * @param trigrec  Corresponding trigger record used as a seed to find
	 *                 this track.
	 * @param hit7     Hit on chamber 7, tracking station 4.
	 * @param hit8     Hit on chamber 8, tracking station 4.
	 * @param hit9     Hit on chamber 9, tracking station 5.
	 * @param hit10    Hit on chamber 10, tracking station 5.
	 * @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.
	 */
	AliHLTMUONMansoTrack(
			Int_t id = -1, Int_t sign = 0,
			Float_t px = 0, Float_t py = 0, Float_t pz = 0,
			Float_t chi2 = -1,
			const AliHLTMUONTriggerRecord* trigrec = NULL,
			const AliHLTMUONRecHit* hit7 = NULL,
			const AliHLTMUONRecHit* hit8 = NULL,
			const AliHLTMUONRecHit* hit9 = NULL,
			const AliHLTMUONRecHit* hit10 = NULL,
			Float_t zf = 0, Float_t qbl = 0
		);
	
	/**
	 * Default destructor.
	 */
	virtual ~AliHLTMUONMansoTrack() {}

	/**
	 * Returns the track 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 chi squared of the track fit, indicating the quality of
	 * the fit.
	 */
	Float_t Chi2() const { return fChi2; }

	/**
	 * Returns the trigger record corresponding to this track.
	 * If NULL is returned then no trigger record was found.
	 */
	const AliHLTMUONTriggerRecord* TriggerRecord() const { return fTrigRec; }

	/**
	 * Returns tje hit found on the specified tracking chamber.
	 * If NULL is returned then no hit was found or set.
	 * @param chamber  Specifies the chamber for which to return the hit.
	 *                 Valid values are in the range [7..10].
	 */
	const AliHLTMUONRecHit* Hit(Int_t chamber) const;
	
	/**
	 * Prints the details of the track.
	 * @param option  A case sensitive string that can contain one of the
	 *     following strings:
	 *       "compact" - Prints just the momentum, sign and ID of the track
	 *                   in a terse format.
	 *       "detail" - Prints also the hit information.
	 *       "all" - Prints all known information about this track.
	 *     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 AliHLTMUONMansoTrack& track) const;

	bool operator != (const AliHLTMUONMansoTrack& track) const
	{
		return not this->operator == (track);
	}
	
	/**
	 * 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; }

private:

	// Do not allow copying of this class.
	AliHLTMUONMansoTrack(const AliHLTMUONMansoTrack& track);
	AliHLTMUONMansoTrack& operator = (const AliHLTMUONMansoTrack& track);
	
	Int_t fId; ///< Track ID number which is unique for a particular event.
	Int_t fSign;  ///< The sign of the particle.
	TVector3 fMomentum; ///< Momentum vector of the particle in GeV/c.
	Float_t fChi2; ///< Chi squared of fit.
	const AliHLTMUONTriggerRecord* fTrigRec;  ///< Corresponding trigger record.
	const AliHLTMUONRecHit* fHit[4];   ///< Particle hits on tracking chambers 7 to 10.
	
	// The following is debugging information and may not be filled if the
	// dHLT components were not set to produce this information.
	
	// Parameters used in momentum estimation:
	Float_t fZmiddle; ///< Particle momentum X component in GeV/c.
	Float_t fQBL;     ///< The integrated magnetic field times the field polarity in (T.m) tesla metres.

	ClassDef(AliHLTMUONMansoTrack, 4); // Manso track object containing data converted from a dHLT internal track structure.
};

#endif // ALIHLTMUONMANSOTRACK_H
Commit	Line	Data
753896cd	1	#ifndef ALIHLTMUONMANSOTRACK_H
	2	#define ALIHLTMUONMANSOTRACK_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 AliHLTMUONMansoTrack.h
	11	/// @author Artur Szostak <artursz@iafrica.com>
	12	/// @date 29 Sep 2007
	13	/// @brief Declaration of the Manso track class used to store converted track data.
	14	///
	15
	16	#include "TObject.h"
	17	#include "TVector3.h"
753896cd	18
450e0b36	19	class AliHLTMUONTriggerRecord;
450e0b36	20	class AliHLTMUONRecHit;
753896cd	21
	22	/**
	23	* AliHLTMUONMansoTrack stores converted dHLT raw track data as a ROOT object.
450e0b36	24	* This class is mainly for testing or as a helper object for dHLT specific analysis,
450e0b36	25	* since it is sometimes easier to store and handle ROOT objects.
753896cd	26	*/
	27	class AliHLTMUONMansoTrack : public TObject
	28	{
	29	/**
	30	* Stream operator for usage with std::ostream classes.
	31	* Allows usage such as:
	32	* AliHLTMUONMansoTrack t; std::cout << t;
	33	*/
	34	friend std::ostream& operator << (
	35	std::ostream& stream,
	36	const AliHLTMUONMansoTrack& track
	37	);
	38
	39	public:
	40
	41	/**
	42	* Constructor for creating a track object with none, some or all 4 hits
	43	* specified. Note: this class does not take ownership of the hit or trigger
	44	* record objects and will not attempt to delete them.
	45	* @param id The track ID number which must be unique for any event.
	46	* @param sign The particle's sign: -1, 1 or 0 if unknown.
	47	* @param px X component of the particle's momentum (GeV/c).
	48	* @param py Y component of the particle's momentum (GeV/c).
	49	* @param pz Z component of the particle's momentum (GeV/c).
	50	* @param chi2 The chi squared of the track fit.
	51	* @param trigrec Corresponding trigger record used as a seed to find
	52	* this track.
	53	* @param hit7 Hit on chamber 7, tracking station 4.
	54	* @param hit8 Hit on chamber 8, tracking station 4.
	55	* @param hit9 Hit on chamber 9, tracking station 5.
	56	* @param hit10 Hit on chamber 10, tracking station 5.
	57	* @param zf The Z coordinate of the middle of the magnetic field assumed
	58	* during momentum calculation.
	59	* @param qbl The integrated magnetic field strength assumed during momentum
	60	* calculation.
	61	*/
	62	AliHLTMUONMansoTrack(
	63	Int_t id = -1, Int_t sign = 0,
	64	Float_t px = 0, Float_t py = 0, Float_t pz = 0,
	65	Float_t chi2 = -1,
	66	const AliHLTMUONTriggerRecord* trigrec = NULL,
	67	const AliHLTMUONRecHit* hit7 = NULL,
	68	const AliHLTMUONRecHit* hit8 = NULL,
	69	const AliHLTMUONRecHit* hit9 = NULL,
	70	const AliHLTMUONRecHit* hit10 = NULL,
	71	Float_t zf = 0, Float_t qbl = 0
	72	);
	73
450e0b36	74	/**
	75	* Default destructor.
	76	*/
753896cd	77	virtual ~AliHLTMUONMansoTrack() {}
	78
	79	/**
	80	* Returns the track ID number, which is unique for an event.
	81	*/
	82	Int_t Id() const { return fId; }
	83
	84	/**
	85	* Returns the sign of the particle: -1, 1 or 0 if the sign is unknown.
	86	*/
	87	Int_t Sign() const { return fSign; }
	88
	89	/**
	90	* Returns the momentum vector with components in GeV/c.
	91	*/
	92	const TVector3& Momentum() const { return fMomentum; }
	93
	94	/**
	95	* Returns the X component of the particle's momentum in GeV/c.
	96	*/
	97	Double_t Px() const { return fMomentum.Px(); }
	98
	99	/**
	100	* Returns the Y component of the particle's momentum in GeV/c.
	101	*/
	102	Double_t Py() const { return fMomentum.Py(); }
	103
	104	/**
	105	* Returns the Z component of the particle's momentum in GeV/c.
	106	*/
	107	Double_t Pz() const { return fMomentum.Pz(); }
	108
	109	/**
	110	* Returns the momentum magnitude of the particle in GeV/c.
	111	*/
	112	Double_t P() const { return fMomentum.Mag(); }
	113
	114	/**
	115	* Returns the transverse momentum of the particle in GeV/c.
	116	*/
	117	Double_t Pt() const { return fMomentum.Pt(); }
	118
	119	/**
	120	* Returns the polar angle of the momentum vector in radians.
	121	*/
	122	Double_t Polar() const { return fMomentum.Theta(); }
	123
	124	/**
	125	* Returns the azimuthal angle of the transverse momentum in radians.
	126	*/
	127	Double_t Phi() const { return fMomentum.Phi(); }
	128
	129	/**
	130	* Returns the chi squared of the track fit, indicating the quality of
	131	* the fit.
	132	*/
	133	Float_t Chi2() const { return fChi2; }
	134
	135	/**
	136	* Returns the trigger record corresponding to this track.
	137	* If NULL is returned then no trigger record was found.
	138	*/
	139	const AliHLTMUONTriggerRecord* TriggerRecord() const { return fTrigRec; }
	140
141	/**
142	* Returns tje hit found on the specified tracking chamber.
143	* If NULL is returned then no hit was found or set.
144	* @param chamber Specifies the chamber for which to return the hit.
145	* Valid values are in the range [7..10].
146	*/
147	const AliHLTMUONRecHit* Hit(Int_t chamber) const;
148
149	/**
150	* Prints the details of the track.
151	* @param option A case sensitive string that can contain one of the
152	* following strings:
153	* "compact" - Prints just the momentum, sign and ID of the track
154	* in a terse format.
155	* "detail" - Prints also the hit information.
156	* "all" - Prints all known information about this track.
157	* If the string contains an empty option or NULL then the default is
158	* to print compactly.
159	*/
160	virtual void Print(Option_t* option = NULL) const;
161
162	// Methods inherited from TObject
163	virtual Bool_t IsSortable() const { return kTRUE; }
164	Int_t Compare(const TObject* obj) const;
165
166	// Implement comparison operators.
167	bool operator == (const AliHLTMUONMansoTrack& track) const;
168
169	bool operator != (const AliHLTMUONMansoTrack& track) const
170	{
171	return not this->operator == (track);
172	}
462e3880	173
	174	/**
	175	* Returns the Z coordinate in the middle of the magnetic field used to
	176	* calculate the momentum.
	177	*/
	178	Float_t Zmiddle() const { return fZmiddle; }
	179
	180	/**
	181	* Returns the integrated magnetic field strength times polarity used in
	182	* the calculation of the momentum. Value returned in (T.m) tesla metres.
	183	*/
	184	Float_t QBL() const { return fQBL; }
753896cd	185
	186	private:
	187
	188	// Do not allow copying of this class.
	189	AliHLTMUONMansoTrack(const AliHLTMUONMansoTrack& track);
	190	AliHLTMUONMansoTrack& operator = (const AliHLTMUONMansoTrack& track);
	191
450e0b36	192	Int_t fId; ///< Track ID number which is unique for a particular event.
	193	Int_t fSign; ///< The sign of the particle.
	194	TVector3 fMomentum; ///< Momentum vector of the particle in GeV/c.
	195	Float_t fChi2; ///< Chi squared of fit.
	196	const AliHLTMUONTriggerRecord* fTrigRec; ///< Corresponding trigger record.
	197	const AliHLTMUONRecHit* fHit[4]; ///< Particle hits on tracking chambers 7 to 10.
753896cd	198
	199	// The following is debugging information and may not be filled if the
	200	// dHLT components were not set to produce this information.
	201
	202	// Parameters used in momentum estimation:
450e0b36	203	Float_t fZmiddle; ///< Particle momentum X component in GeV/c.
462e3880	204	Float_t fQBL; ///< The integrated magnetic field times the field polarity in (T.m) tesla metres.
753896cd	205
462e3880	206	ClassDef(AliHLTMUONMansoTrack, 4); // Manso track object containing data converted from a dHLT internal track structure.
753896cd	207	};
	208
	209	#endif // ALIHLTMUONMANSOTRACK_H