1 /**************************************************************************
2 * Copyright(c) 1998-2007, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
16 /* $Id: AliAnalysisMuonUtility.cxx 47782 2011-02-24 18:37:31Z martinez $ */
18 //-----------------------------------------------------------------------------
19 /// \class AliAnalysisMuonUtility
20 /// Static tilities for muon analysis
21 /// The class allows to treat AODs and ESDs
22 /// as well as MC AODs and MC in a transparent way
24 /// \author Diego Stocco
25 //-----------------------------------------------------------------------------
27 #include "AliAnalysisMuonUtility.h"
32 #include "TLorentzVector.h"
36 #include "AliAODEvent.h"
37 #include "AliAODHeader.h"
38 #include "AliAODMCHeader.h"
39 #include "AliAODMCParticle.h"
40 #include "AliAODTrack.h"
41 #include "AliAODTZERO.h"
42 #include "AliESDEvent.h"
43 #include "AliESDMuonTrack.h"
44 #include "AliESDTZERO.h"
45 #include "AliInputEventHandler.h"
47 #include "AliMCEvent.h"
48 #include "AliMCParticle.h"
49 #include "AliVVertex.h"
53 #include "AliCFGridSparse.h"
56 ClassImp(AliAnalysisMuonUtility) // Class implementation in ROOT context
60 //________________________________________________________________________
61 Bool_t AliAnalysisMuonUtility::IsAODEvent ( const AliVEvent* event )
63 /// Check if event is from ESD or AOD
64 return ( event->IsA() == AliAODEvent::Class() );
67 //________________________________________________________________________
68 Bool_t AliAnalysisMuonUtility::IsAODTrack ( const AliVParticle* track )
70 /// Check if track is from ESD or AOD
71 return ( track->IsA() == AliAODTrack::Class() );
74 //________________________________________________________________________
75 Bool_t AliAnalysisMuonUtility::IsMuonTrack ( const AliVParticle* track )
77 /// Check if track has muon tracker info
78 return ( IsAODTrack(track) ) ? static_cast<const AliAODTrack*>(track)->IsMuonTrack() : static_cast<const AliESDMuonTrack*>(track)->ContainTrackerData();
81 //________________________________________________________________________
82 Bool_t AliAnalysisMuonUtility::IsMuonGhost ( const AliVParticle* track )
84 /// Check if track has trigger info
85 return ( IsAODTrack(track) ) ? kFALSE : ( ! static_cast<const AliESDMuonTrack*>(track)->ContainTrackerData() );
88 //________________________________________________________________________
89 Double_t AliAnalysisMuonUtility::GetRabs ( const AliVParticle* track )
92 return ( IsAODTrack(track) ) ? static_cast<const AliAODTrack*>(track)->GetRAtAbsorberEnd() : static_cast<const AliESDMuonTrack*>(track)->GetRAtAbsorberEnd();
95 //________________________________________________________________________
96 Double_t AliAnalysisMuonUtility::GetThetaAbsDeg ( const AliVParticle* track )
98 /// Get Theta at absorber end (in deg)
99 return TMath::ATan( GetRabs(track) / 505. ) * TMath::RadToDeg();
102 //________________________________________________________________________
103 Int_t AliAnalysisMuonUtility::GetMatchTrigger ( const AliVParticle* track )
105 /// Get match trigger
106 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->GetMatchTrigger() : static_cast<const AliESDMuonTrack*>(track)->GetMatchTrigger();
109 //________________________________________________________________________
110 Double_t AliAnalysisMuonUtility::GetChi2perNDFtracker ( const AliVParticle* track )
112 /// Get the normalized chi2 of the tracker track
113 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->Chi2perNDF() : static_cast<const AliESDMuonTrack*>(track)->GetNormalizedChi2();
116 //________________________________________________________________________
117 Double_t AliAnalysisMuonUtility::GetChi2MatchTrigger ( const AliVParticle* track )
119 /// Get the normalized chi2 of the tracker-trigger track matching
120 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->GetChi2MatchTrigger() : static_cast<const AliESDMuonTrack*>(track)->GetChi2MatchTrigger();
123 //________________________________________________________________________
124 Double_t AliAnalysisMuonUtility::GetXatVertex ( const AliVParticle* track )
128 if ( IsAODTrack(track) ) {
130 static_cast<const AliAODTrack*>(track)->GetXYZ(vtxPos);
133 else coor = static_cast<const AliESDMuonTrack*>(track)->GetNonBendingCoor();
138 //________________________________________________________________________
139 Double_t AliAnalysisMuonUtility::GetYatVertex ( const AliVParticle* track )
143 if ( IsAODTrack(track) ) {
145 static_cast<const AliAODTrack*>(track)->GetXYZ(vtxPos);
148 else coor = static_cast<const AliESDMuonTrack*>(track)->GetBendingCoor();
153 //________________________________________________________________________
154 Double_t AliAnalysisMuonUtility::GetZatVertex ( const AliVParticle* track )
158 if ( IsAODTrack(track) ) {
160 static_cast<const AliAODTrack*>(track)->GetXYZ(vtxPos);
163 else coor = static_cast<const AliESDMuonTrack*>(track)->GetZ();
168 //________________________________________________________________________
169 Double_t AliAnalysisMuonUtility::GetXatDCA ( const AliVParticle* track )
172 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->XAtDCA() : static_cast<const AliESDMuonTrack*>(track)->GetNonBendingCoorAtDCA();
175 //________________________________________________________________________
176 Double_t AliAnalysisMuonUtility::GetYatDCA ( const AliVParticle* track )
179 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->YAtDCA() : static_cast<const AliESDMuonTrack*>(track)->GetBendingCoorAtDCA();
182 //________________________________________________________________________
183 Bool_t AliAnalysisMuonUtility::IsTrkChamberHit( Int_t chamber, const AliVParticle* track )
185 /// Check if the given tracking chamber has been fired
186 if (chamber < 0 || chamber > 9) return kFALSE;
187 return IsAODTrack(track) ? static_cast<const AliAODTrack*>(track)->HitsMuonChamber(chamber) : static_cast<const AliESDMuonTrack*>(track)->IsInMuonClusterMap(chamber);
190 //________________________________________________________________________
191 UInt_t AliAnalysisMuonUtility::GetMUONTrigHitsMapTrk ( const AliVParticle* track )
193 /// Get hit pattern in trigger chambers from tracker track extrapolation
194 return ( IsAODTrack(track) ) ? const_cast<AliAODTrack*>(static_cast<const AliAODTrack*>(track))->GetMUONTrigHitsMapTrk() : static_cast<const AliESDMuonTrack*>(track)->GetHitsPatternInTrigChTrk();
197 //________________________________________________________________________
198 UInt_t AliAnalysisMuonUtility::GetMUONTrigHitsMapTrg ( const AliVParticle* track )
200 /// Get hit pattern in trigger chambers from tracker track extrapolation
201 return ( IsAODTrack(track) ) ? const_cast<AliAODTrack*>(static_cast<const AliAODTrack*>(track))->GetMUONTrigHitsMapTrg() : static_cast<const AliESDMuonTrack*>(track)->GetHitsPatternInTrigCh();
204 //________________________________________________________________________
205 Int_t AliAnalysisMuonUtility::GetLoCircuit ( const AliVParticle* track )
209 if ( IsAODTrack (track) ) {
210 UInt_t pattern = const_cast<AliAODTrack*>(static_cast<const AliAODTrack*>(track))->GetMUONTrigHitsMapTrg();
211 loCircuit = AliESDMuonTrack::GetCrossedBoard(pattern);
213 else loCircuit = static_cast<const AliESDMuonTrack*>(track)->LoCircuit();
218 //________________________________________________________________________
219 TString AliAnalysisMuonUtility::GetFiredTriggerClasses ( const AliVEvent* event )
221 /// Check if track is from ESD or AOD
222 return ( IsAODEvent(event) ) ? static_cast<const AliAODEvent*>(event)->GetFiredTriggerClasses() : static_cast<const AliESDEvent*>(event)->GetFiredTriggerClasses();
225 //________________________________________________________________________
226 Int_t AliAnalysisMuonUtility::GetNTracks ( const AliVEvent* event )
229 /// Return the number of tracks in event
231 return ( IsAODEvent(event) ) ? static_cast<const AliAODEvent*>(event)->GetNTracks() : static_cast<const AliESDEvent*>(event)->GetNumberOfMuonTracks();
234 //________________________________________________________________________
235 UInt_t AliAnalysisMuonUtility::GetL0TriggerInputs ( const AliVEvent* event )
238 /// Return the L0 trigger inputs
240 return ( IsAODEvent(event) ) ? static_cast<const AliAODEvent*>(event)->GetHeader()->GetL0TriggerInputs() : static_cast<const AliESDEvent*>(event)->GetHeader()->GetL0TriggerInputs();
243 //________________________________________________________________________
244 UInt_t AliAnalysisMuonUtility::GetL1TriggerInputs ( const AliVEvent* event )
247 /// Return the L1 trigger inputs
249 return ( IsAODEvent(event) ) ? static_cast<const AliAODEvent*>(event)->GetHeader()->GetL1TriggerInputs() : static_cast<const AliESDEvent*>(event)->GetHeader()->GetL1TriggerInputs();
252 //________________________________________________________________________
253 UInt_t AliAnalysisMuonUtility::GetL2TriggerInputs ( const AliVEvent* event )
256 /// Return the L2 trigger inputs
258 return ( IsAODEvent(event) ) ? static_cast<const AliAODEvent*>(event)->GetHeader()->GetL2TriggerInputs() : static_cast<const AliESDEvent*>(event)->GetHeader()->GetL2TriggerInputs();
261 //________________________________________________________________________
262 AliVParticle* AliAnalysisMuonUtility::GetTrack ( Int_t itrack, const AliVEvent* event )
265 /// Get the current track
267 AliVParticle* track = 0x0;
268 if ( IsAODEvent(event) ) track = static_cast<const AliAODEvent*>(event)->GetTrack(itrack);
270 AliESDEvent* esdEvent = const_cast<AliESDEvent*>(static_cast<const AliESDEvent*> (event));
271 track = esdEvent->GetMuonTrack(itrack);
276 //________________________________________________________________________
277 Double_t AliAnalysisMuonUtility::MuonMass2()
279 /// A usefull constant
280 return 1.11636129640000012e-02;
283 //________________________________________________________________________
284 TLorentzVector AliAnalysisMuonUtility::GetTrackPair ( const AliVParticle* track1, const AliVParticle* track2 )
289 const AliVParticle* tracks[2] = {track1, track2};
291 TLorentzVector vec[2];
292 for ( Int_t itrack=0; itrack<2; ++itrack ) {
293 Double_t trackP = tracks[itrack]->P();
294 Double_t energy = TMath::Sqrt(trackP*trackP + MuonMass2());
295 vec[itrack].SetPxPyPzE(tracks[itrack]->Px(), tracks[itrack]->Py(), tracks[itrack]->Pz(), energy);
298 TLorentzVector vecPair = vec[0] + vec[1];
303 //________________________________________________________________________
304 Bool_t AliAnalysisMuonUtility::IsAODMCTrack( const AliVParticle* mcParticle )
306 /// Check if track is from AOD MC
307 return ( mcParticle->IsA() == AliAODMCParticle::Class() );
310 //________________________________________________________________________
311 Bool_t AliAnalysisMuonUtility::IsMCTrack( const AliVParticle* mcParticle )
313 /// Check if track is MC track
314 return ( mcParticle->IsA() == AliAODMCParticle::Class() || mcParticle->IsA() == AliMCParticle::Class() );
318 //________________________________________________________________________
319 Double_t AliAnalysisMuonUtility::GetMCVertexZ ( const AliVEvent* event, const AliMCEvent* mcEvent )
323 if ( IsAODEvent(event) ) {
324 AliAODMCHeader* aodMCHeader = static_cast<AliAODMCHeader*> (static_cast<const AliAODEvent*>(event)->FindListObject(AliAODMCHeader::StdBranchName()));
325 vz = aodMCHeader->GetVtxZ();
327 else if ( mcEvent ) vz = mcEvent->GetPrimaryVertex()->GetZ();
328 else AliErrorClass("No MC event found");
332 //________________________________________________________________________
333 Int_t AliAnalysisMuonUtility::GetMotherIndex ( const AliVParticle* mcParticle )
336 /// Return the mother index
338 return ( IsAODMCTrack(mcParticle) ) ? static_cast<const AliAODMCParticle*>(mcParticle)->GetMother() : static_cast<const AliMCParticle*>(mcParticle)->GetMother();
341 //________________________________________________________________________
342 Int_t AliAnalysisMuonUtility::GetDaughterIndex ( const AliVParticle* mcParticle, Int_t idaughter )
345 /// Return the daughter index
346 /// idaughter can be:
347 /// 0 -> first daughter
348 /// 1 -> last daughter
350 if ( idaughter < 0 || idaughter > 1 ) {
351 AliErrorClass(Form("Requested daughter %i Daughter index can be either 0 (first) or 1 (last)", idaughter));
355 if ( IsAODMCTrack(mcParticle) ) return static_cast<const AliAODMCParticle*>(mcParticle)->GetDaughter(idaughter);
357 if ( idaughter == 0 ) return static_cast<const AliMCParticle*>(mcParticle)->GetFirstDaughter();
358 else return static_cast<const AliMCParticle*>(mcParticle)->GetLastDaughter();
361 //________________________________________________________________________
362 Bool_t AliAnalysisMuonUtility::IsPrimary ( const AliVParticle* mcParticle, const AliMCEvent* mcEvent )
364 /// Check if the particle is primary
366 Bool_t isPrimary = kFALSE;
367 if ( IsAODMCTrack(mcParticle) ) isPrimary = static_cast<const AliAODMCParticle*>(mcParticle)->IsPrimary();
368 else if ( mcEvent ) {
369 // First get the index of the current particle in the stack.
370 // For this: get the mother, and get its daughter.
371 // Since the mother can have many daughters, you can come up to a "sister"
372 // of the particle. Nevertheless, if it is primary, then also the particle itself should be.
373 Int_t imother = static_cast<const AliMCParticle*> (mcParticle)->GetMother();
374 if ( imother < 0 ) isPrimary = kTRUE;
375 else if ( static_cast<const AliMCParticle*>(mcEvent->GetTrack(imother))->GetFirstDaughter() < const_cast<AliMCEvent*>(mcEvent)->GetNumberOfPrimaries() ) isPrimary = kTRUE;
377 else AliWarningClass("There is no MC info");
381 //________________________________________________________________________
382 UInt_t AliAnalysisMuonUtility::GetMCProcess ( const AliVParticle* mcParticle )
385 /// WARNING: the method may fail when running on AODs for old MC production,
386 /// the information was propagated to the AOD level only recently
387 UInt_t mcProcess = 0;
388 if ( IsAODMCTrack(mcParticle) ) {
389 mcProcess = const_cast<AliAODMCParticle*>(static_cast<const AliAODMCParticle*>(mcParticle))->GetMCProcessCode();
391 else if ( mcParticle->IsA() == AliMCParticle::Class() ) {
392 mcProcess = static_cast<const AliMCParticle*>(mcParticle)->Particle()->GetUniqueID();
394 else AliWarningClass("There is no MC info");
398 //________________________________________________________________________
399 UInt_t AliAnalysisMuonUtility::GetStatusCode ( const AliVParticle* mcParticle )
401 /// Get particle status code
402 UInt_t statusCode = 0;
403 if ( IsAODMCTrack(mcParticle) ) {
404 statusCode = static_cast<const AliAODMCParticle*>(mcParticle)->GetStatus();
406 else if ( mcParticle->IsA() == AliMCParticle::Class() ) {
407 statusCode = static_cast<const AliMCParticle*>(mcParticle)->Particle()->GetStatusCode();
409 else AliWarningClass("There is no MC info");
413 //________________________________________________________________________
414 AliVVertex* AliAnalysisMuonUtility::GetVertexSPD ( const AliVEvent* event )
420 AliVVertex* primaryVertex = ( IsAODEvent(event) ) ? (AliVVertex*)static_cast<const AliAODEvent*>(event)->GetPrimaryVertexSPD() : (AliVVertex*)static_cast<const AliESDEvent*>(event)->GetPrimaryVertexSPD();
421 return primaryVertex;
425 //________________________________________________________________________
426 TString AliAnalysisMuonUtility::GetPassName ( const AliInputEventHandler* eventHandler )
428 /// Get pass name from event
430 // At present there is no straightforward way to get the pass name.
431 // The pass name is usually written in the path to the ESDs/AODs
432 // but this won't work for:
433 // - MC data (no pass info available)
436 TString filePath = "";
437 const AliVEvent* event = eventHandler->GetEvent();
438 if ( IsAODEvent(event) ) {
439 // In AODs, the header contains the path to the input ESD event
440 // However, sometimes there is not the FULL path of the ESDs.
441 // In that case we cannot extract the pass number.
442 // To increase the possibility of getting the pass number,
443 // try first to find the info in the AOD header
444 // (which is a priori safer because it works even on local copies of AODs)
445 // and if it does not work, directly check the path to the AOD
446 filePath = static_cast<const AliAODEvent*> (event)->GetHeader()->GetESDFileName();
447 TString passName = GetPassName(filePath.Data());
448 if ( passName.IsNull() ) AliWarningClass("Check again with the AOD path");
449 else return passName;
452 filePath = eventHandler->GetTree()->GetCurrentFile()->GetName();
453 return GetPassName(filePath.Data());
457 //________________________________________________________________________
458 Int_t AliAnalysisMuonUtility::GetPassNumber ( const AliInputEventHandler* eventHandler )
460 /// Get pass number from event
462 // At present there is no straightforward way to get the pass number.
463 // The pass number is usually written in the path to the ESDs/AODs
464 // but this won't work for:
465 // - MC data (no pass info available)
468 TString passName = GetPassName(eventHandler);
469 return GetPassNumber(passName);
473 //________________________________________________________________________
474 TString AliAnalysisMuonUtility::GetPassName ( const char* str )
477 /// Get pass name from string
480 TString currName(str);
481 TObjArray* array = currName.Tokenize("/");
483 TString passName = "";
484 for ( Int_t ientry=0; ientry<array->GetEntries(); ientry++ ) {
485 TString currToken = static_cast<TObjString*>(array->At(ientry))->GetString();
486 TString checkToken(currToken);
487 checkToken.ToUpper();
488 if ( checkToken.Contains("PASS") || checkToken.Contains("MUON_CALO") ) {
489 passName = currToken;
496 if ( passName.IsNull() ) AliWarningClass(Form("Cannot find pass name in: %s", str));
501 //________________________________________________________________________
502 Int_t AliAnalysisMuonUtility::GetPassNumber ( const char* str )
505 /// Get pass number from string
508 TString currName(str);
510 Int_t idx = currName.Index("PASS");
512 // Remove all of the words before PASS (and remove the word PASS itself)
513 currName.Remove(0,idx+4);
514 // Cut the word from the end untill only the digits are left
515 // (In this way we can extract the pass number even if it has more than one digit)
516 while ( ! currName.IsDigit() && currName.Length() > 0 ) {
517 currName.Remove(currName.Length()-1);
520 if ( currName.Length() > 0 ) return currName.Atoi();
523 AliWarningClass(Form("Cannot find pass number in: %s", str));
527 //________________________________________________________________________
528 TString AliAnalysisMuonUtility::GetTrackHistory ( const AliVParticle* track, const AliMCEvent* mcEvent, Bool_t verbose )
531 /// Get string containing particle history
532 /// Useful when debugging MC
534 TString trackHistory = "";
535 if ( ! mcEvent ) return trackHistory;
536 Int_t fakeMother = 999999999;
537 Int_t imother = IsMCTrack(track) ? fakeMother : track->GetLabel();
539 while ( imother >= 0 ) {
540 const AliVParticle* part = ( imother == fakeMother ) ? track : mcEvent->GetTrack(imother);
541 if ( ! part ) break; // In principle not needed...but for some old MC it breaks sometimes
542 TParticlePDG* partPdg = TDatabasePDG::Instance()->GetParticle(part->PdgCode());
543 TString pname = ( partPdg ) ? partPdg->GetName() : Form("%i",part->PdgCode());
544 if ( ! trackHistory.IsNull() ) trackHistory.Append(" <- ");
545 if ( imother != fakeMother ) trackHistory.Append(Form("%i ", imother));
546 trackHistory.Append(Form("(%s)", pname.Data()));
547 if ( verbose ) trackHistory.Append(Form(" [vz %g mc %i]", part->Zv(), GetMCProcess(part)));
548 imother = AliAnalysisMuonUtility::GetMotherIndex(part);
553 //________________________________________________________________________
554 Bool_t AliAnalysisMuonUtility::EAGetTZEROFlags(const AliVEvent* event, Bool_t& backgroundFlag, Bool_t& pileupFlag, Bool_t& satelliteFlag)
556 // get the TZERO decisions
557 // return false if there's no tzero information in this event
561 if ( event->IsA() == AliESDEvent::Class() )
563 const AliESDTZERO* tzero = static_cast<AliESDEvent*>(const_cast<AliVEvent*>(event))->GetESDTZERO();
566 backgroundFlag = tzero->GetBackgroundFlag();
567 pileupFlag = tzero->GetPileupFlag();
568 satelliteFlag = tzero->GetSatellite();
572 else if ( event->IsA() == AliAODEvent::Class() )
574 AliAODTZERO* tzero = static_cast<const AliAODEvent*>(event)->GetTZEROData();
577 backgroundFlag = tzero->GetBackgroundFlag();
578 pileupFlag = tzero->GetPileupFlag();
579 satelliteFlag = tzero->GetSatellite();
585 AliErrorClass(Form("Unknown class for the event = %s",event->ClassName()));
591 //_______________________________________________________________________
592 Bool_t AliAnalysisMuonUtility::SetSparseRange(AliCFGridSparse* gridSparse,
593 Int_t ivar, TString labelName,
594 Double_t varMin, Double_t varMax,
598 /// Set range in a smart way.
599 /// Allows to select a bin from the label.
600 /// Check the bin limits.
604 Int_t minVarBin = -1, maxVarBin = -1;
605 TAxis* axis = gridSparse->GetAxis(ivar);
608 printf("Warning: Axis %i not found in %s", ivar, gridSparse->GetName());
612 if ( ! labelName.IsNull() ) {
613 minVarBin = axis->FindBin(labelName.Data());
614 maxVarBin = minVarBin;
615 if ( minVarBin < 1 ) {
616 printf("Warning: %s: label %s not found. Nothing done", gridSparse->GetName(), labelName.Data());
620 else if ( option.Contains( "USEBIN" ) ) {
621 minVarBin = (Int_t)varMin;
622 maxVarBin = (Int_t)varMax;
625 minVarBin = axis->FindBin(varMin);
626 maxVarBin = axis->FindBin(varMax);
629 if ( axis->GetFirst() == minVarBin && axis->GetLast() == maxVarBin ) return kFALSE;
631 gridSparse->SetRangeUser(ivar, axis->GetBinCenter(minVarBin), axis->GetBinCenter(maxVarBin));