AliPhysics  a6017e1 (a6017e1)
AliEmcalCorrectionComponent Class Reference

Base class for correction components in the EMCal correction framework. More...

#include <AliEmcalCorrectionComponent.h>

Inheritance diagram for AliEmcalCorrectionComponent:

Public Member Functions

 AliEmcalCorrectionComponent ()
 
 AliEmcalCorrectionComponent (const char *name)
 
virtual ~AliEmcalCorrectionComponent ()
 
virtual Bool_t Initialize ()
 
virtual void UserCreateOutputObjects ()
 
virtual void ExecOnce ()
 
virtual Bool_t Run ()
 
virtual Bool_t UserNotify ()
 
virtual Bool_t CheckIfRunChanged ()
 
void GetEtaPhiDiff (const AliVTrack *t, const AliVCluster *v, Double_t &phidiff, Double_t &etadiff)
 
void UpdateCells ()
 
void GetPass ()
 
void FillCellQA (TH1F *h)
 
Int_t InitBadChannels ()
 
AliParticleContainerAddParticleContainer (const char *n)
 
AliTrackContainerAddTrackContainer (const char *n)
 
AliMCParticleContainerAddMCParticleContainer (const char *n)
 
AliClusterContainerAddClusterContainer (const char *n)
 
void AdoptParticleContainer (AliParticleContainer *cont)
 
void AdoptTrackContainer (AliTrackContainer *cont)
 
void AdoptMCParticleContainer (AliMCParticleContainer *cont)
 
void AdoptClusterContainer (AliClusterContainer *cont)
 
AliParticleContainerGetParticleContainer (Int_t i=0) const
 
AliParticleContainerGetParticleContainer (const char *name) const
 
AliClusterContainerGetClusterContainer (Int_t i=0) const
 
AliClusterContainerGetClusterContainer (const char *name) const
 
AliMCParticleContainerGetMCParticleContainer (Int_t i=0) const
 
AliMCParticleContainerGetMCParticleContainer (const char *name) const
 
AliTrackContainerGetTrackContainer (Int_t i=0) const
 
AliTrackContainerGetTrackContainer (const char *name) const
 
void RemoveParticleContainer (Int_t i=0)
 
void RemoveClusterContainer (Int_t i=0)
 
AliEMCALRecoUtilsGetRecoUtils () const
 
AliVCaloCells * GetCaloCells () const
 
TListGetOutputList () const
 
void SetCaloCells (AliVCaloCells *cells)
 
void SetRecoUtils (AliEMCALRecoUtils *ru)
 
void SetInputEvent (AliVEvent *event)
 
void SetMCEvent (AliMCEvent *mcevent)
 
void SetUsingInputEvent (bool b=true)
 
void SetEMCALGeometry (AliEMCALGeometry *geometry)
 
void SetCentralityBin (Int_t bin)
 
void SetCentrality (Double_t cent)
 
void SetNcentralityBins (Int_t n)
 
void SetVertex (Double_t *vertex)
 
void SetIsESD (Bool_t isESD)
 
void SetCustomBadChannels (TString customBC)
 
void SetYAMLConfiguration (PWG::Tools::AliYAMLConfiguration config)
 Set YAML Configuration. More...
 
template<typename T >
bool GetProperty (std::string propertyName, T &property, bool requiredProperty=true, std::string correctionName="")
 Retrieve property. More...
 

Protected Attributes

PWG::Tools::AliYAMLConfiguration fYAMLConfig
 Contains the YAML configuration used to configure the component. More...
 
Bool_t fCreateHisto
 Flag to make some basic histograms. More...
 
Int_t fRun
 ! Run number More...
 
TString fFilepass
 Input data pass number. More...
 
Bool_t fGetPassFromFileName
 Get fFilepass from file name. More...
 
AliEmcalCorrectionEventManager fEventManager
 Minimal task which inherits from AliAnalysisTaskSE and manages access to the event. More...
 
Bool_t fEsdMode
 flag for ESD More...
 
AliMCEvent * fMCEvent
 ! MC More...
 
Double_t fCent
 ! Event centrality More...
 
Int_t fNcentBins
 How many centrality bins (this member copied from AliAnalysisTaskEmcal) More...
 
Int_t fCentBin
 ! Event centrality bin More...
 
Int_t fNbins
 No. of pt bins. More...
 
Double_t fMinBinPt
 Min pt in histograms. More...
 
Double_t fMaxBinPt
 Max pt in histograms. More...
 
Double_t fVertex [3]
 ! Event vertex More...
 
AliEMCALGeometry * fGeom
 ! Geometry object More...
 
Int_t fMinMCLabel
 Minimum MC label value for the tracks/clusters being considered MC particles. More...
 
TObjArray fClusterCollArray
 Cluster collection array. More...
 
TObjArray fParticleCollArray
 Particle/track collection array. More...
 
AliVCaloCells * fCaloCells
 ! Pointer to CaloCells More...
 
AliEMCALRecoUtilsfRecoUtils
 Pointer to RecoUtils. More...
 
TListfOutput
 ! List of output histograms More...
 
TString fBasePath
 Base folder path to get root files. More...
 
TString fCustomBadChannelFilePath
 Custom path to bad channel map OADB file. More...
 

Private Member Functions

 AliEmcalCorrectionComponent (const AliEmcalCorrectionComponent &)
 
AliEmcalCorrectionComponentoperator= (const AliEmcalCorrectionComponent &)
 

Detailed Description

Base class for correction components in the EMCal correction framework.

Base class for all correction components in the EMCal Correction Framework. Each correction component corresponds to a correction needed for the EMCal. Creation, configuration, and execution of all of the components is handled by AliEmcalCorrectionTask. Each new component is automatically registered through the AliEmcalCorrectionComponentFactory class, and is thus automatically available to execute. Components are configured through a set of YAML configuration files stored in AliYAMLConfiguration. For more information about the steering, see AliEmcalCorrectionTask.

Author
Raymond Ehlers raymo.nosp@m.nd.e.nosp@m.hlers.nosp@m.@yal.nosp@m.e.edu, Yale University
James Mulligan james.nosp@m..mul.nosp@m.ligan.nosp@m.@yal.nosp@m.e.edu, Yale University
Date
Jul 8, 2016

Definition at line 43 of file AliEmcalCorrectionComponent.h.

Constructor & Destructor Documentation

AliEmcalCorrectionComponent::AliEmcalCorrectionComponent ( )

Default constructor

Definition at line 30 of file AliEmcalCorrectionComponent.cxx.

AliEmcalCorrectionComponent::AliEmcalCorrectionComponent ( const char *  name)

Standard constructor

Definition at line 65 of file AliEmcalCorrectionComponent.cxx.

AliEmcalCorrectionComponent::~AliEmcalCorrectionComponent ( )
virtual

Destructor

Definition at line 99 of file AliEmcalCorrectionComponent.cxx.

AliEmcalCorrectionComponent::AliEmcalCorrectionComponent ( const AliEmcalCorrectionComponent )
private

Member Function Documentation

AliClusterContainer* AliEmcalCorrectionComponent::AddClusterContainer ( const char *  n)
inline

Definition at line 67 of file AliEmcalCorrectionComponent.h.

AliMCParticleContainer* AliEmcalCorrectionComponent::AddMCParticleContainer ( const char *  n)
inline

Definition at line 66 of file AliEmcalCorrectionComponent.h.

AliParticleContainer* AliEmcalCorrectionComponent::AddParticleContainer ( const char *  n)
inline

Definition at line 64 of file AliEmcalCorrectionComponent.h.

AliTrackContainer* AliEmcalCorrectionComponent::AddTrackContainer ( const char *  n)
inline

Definition at line 65 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::AdoptClusterContainer ( AliClusterContainer cont)
inline
void AliEmcalCorrectionComponent::AdoptMCParticleContainer ( AliMCParticleContainer cont)
inline

Definition at line 70 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::AdoptParticleContainer ( AliParticleContainer cont)
inline
void AliEmcalCorrectionComponent::AdoptTrackContainer ( AliTrackContainer cont)
inline

Definition at line 69 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::ExecOnce ( )
virtual
void AliEmcalCorrectionComponent::FillCellQA ( TH1F *  h)
AliVCaloCells* AliEmcalCorrectionComponent::GetCaloCells ( ) const
inline
AliClusterContainer* AliEmcalCorrectionComponent::GetClusterContainer ( Int_t  i = 0) const
inline

Definition at line 74 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionClusterizer::Run().

AliClusterContainer* AliEmcalCorrectionComponent::GetClusterContainer ( const char *  name) const
inline

Definition at line 75 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::GetEtaPhiDiff ( const AliVTrack *  t,
const AliVCluster *  v,
Double_t phidiff,
Double_t etadiff 
)

Calculate \(\phi\) and \(\eta\) difference between a track (t) and a cluster (c). The position of the track is obtained on the EMCAL surface

Parameters
[in]tTrack to check
[in]vCluster to check
[out]phidiffDistance in \(\phi\) between cluster and track
[out]etadiffDistance in \(\eta\) between cluster and track

Definition at line 179 of file AliEmcalCorrectionComponent.cxx.

Referenced by AliEmcalCorrectionClusterHadronicCorrection::ApplyHadCorrOneTrack(), AliEmcalCorrectionClusterHadronicCorrection::DoMatchedTracksLoop(), AliEmcalCorrectionClusterTrackMatcher::DoMatching(), and AliEmcalCorrectionClusterTrackMatcher::UpdateClusters().

AliMCParticleContainer* AliEmcalCorrectionComponent::GetMCParticleContainer ( Int_t  i = 0) const
inline

Definition at line 76 of file AliEmcalCorrectionComponent.h.

AliMCParticleContainer* AliEmcalCorrectionComponent::GetMCParticleContainer ( const char *  name) const
inline

Definition at line 77 of file AliEmcalCorrectionComponent.h.

TList* AliEmcalCorrectionComponent::GetOutputList ( ) const
inline

Definition at line 84 of file AliEmcalCorrectionComponent.h.

AliParticleContainer* AliEmcalCorrectionComponent::GetParticleContainer ( Int_t  i = 0) const
inline
AliParticleContainer* AliEmcalCorrectionComponent::GetParticleContainer ( const char *  name) const
inline

Definition at line 73 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::GetPass ( )

Get pass from filename. Sets pass in fFilepass.

Definition at line 241 of file AliEmcalCorrectionComponent.cxx.

Referenced by Run().

template<typename T >
bool AliEmcalCorrectionComponent::GetProperty ( std::string  propertyName,
T property,
bool  requiredProperty = true,
std::string  correctionName = "" 
)

Retrieve property.

Get the requested property from the YAML configuration. This function is generally used by AliEmcalCorrectionComponent derived tasks as a wrapper around the more complicated functions to retrieve properties.

Parameters
[in]propertyNameName of the property to retrieve
[out]propertyContainers the retrieved property
[in]requiredPropertyTrue if the property is required
[in]correctionNameName of the correction from where the property should be retrieved
Returns
True if the property was set successfully

Definition at line 161 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionPHOSCorrections::Initialize(), AliEmcalCorrectionCellEmulateCrosstalk::Initialize(), AliEmcalCorrectionClusterEnergyVariation::Initialize(), AliEmcalCorrectionCellEnergy::Initialize(), AliEmcalCorrectionCellBadChannel::Initialize(), AliEmcalCorrectionClusterExotics::Initialize(), AliEmcalCorrectionCellCombineCollections::Initialize(), AliEmcalCorrectionClusterNonLinearity::Initialize(), AliEmcalCorrectionClusterHadronicCorrection::Initialize(), AliEmcalCorrectionClusterizer::Initialize(), Initialize(), AliEmcalCorrectionClusterTrackMatcher::Initialize(), and SetYAMLConfiguration().

AliEMCALRecoUtils* AliEmcalCorrectionComponent::GetRecoUtils ( ) const
inline

Definition at line 82 of file AliEmcalCorrectionComponent.h.

Referenced by AliCaloPhotonCuts::InitializeEMCAL().

AliTrackContainer* AliEmcalCorrectionComponent::GetTrackContainer ( Int_t  i = 0) const
inline

Definition at line 78 of file AliEmcalCorrectionComponent.h.

AliTrackContainer* AliEmcalCorrectionComponent::GetTrackContainer ( const char *  name) const
inline

Definition at line 79 of file AliEmcalCorrectionComponent.h.

Int_t AliEmcalCorrectionComponent::InitBadChannels ( )
AliEmcalCorrectionComponent& AliEmcalCorrectionComponent::operator= ( const AliEmcalCorrectionComponent )
private
void AliEmcalCorrectionComponent::RemoveClusterContainer ( Int_t  i = 0)
inline

Definition at line 81 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::RemoveParticleContainer ( Int_t  i = 0)
inline

Definition at line 80 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetCaloCells ( AliVCaloCells *  cells)
inline
void AliEmcalCorrectionComponent::SetCentrality ( Double_t  cent)
inline

Definition at line 101 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetCentralityBin ( Int_t  bin)
inline

Definition at line 100 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetCustomBadChannels ( TString  customBC)
inline
void AliEmcalCorrectionComponent::SetEMCALGeometry ( AliEMCALGeometry *  geometry)
inline

Definition at line 99 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetInputEvent ( AliVEvent *  event)
inline

Definition at line 89 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetIsESD ( Bool_t  isESD)
inline
void AliEmcalCorrectionComponent::SetMCEvent ( AliMCEvent *  mcevent)
inline

Definition at line 90 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetNcentralityBins ( Int_t  n)
inline

Definition at line 102 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetRecoUtils ( AliEMCALRecoUtils ru)
inline

Definition at line 87 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetUsingInputEvent ( bool  b = true)
inline

If we are using standard input event then the embedded event should not be used! We store whether the embedding event should be used, so we invert the bool here. Then, if it is only set when we see the standard input event, then any single input with the standard input event will be enough to disable the embedded event.

Definition at line 97 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionTask::AddContainersToComponent(), and AliEmcalCorrectionPHOSCorrections::Initialize().

void AliEmcalCorrectionComponent::SetVertex ( Double_t vertex)
inline

Definition at line 103 of file AliEmcalCorrectionComponent.h.

void AliEmcalCorrectionComponent::SetYAMLConfiguration ( PWG::Tools::AliYAMLConfiguration  config)
inline

Set YAML Configuration.

Definition at line 108 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionTask::InitializeComponents().

void AliEmcalCorrectionComponent::UpdateCells ( )

Remove bad cells from the cell list Recalibrate energy and time cells

Definition at line 202 of file AliEmcalCorrectionComponent.cxx.

Referenced by AliEmcalCorrectionCellBadChannel::Run(), AliEmcalCorrectionCellTimeCalib::Run(), and AliEmcalCorrectionCellEnergy::Run().

Bool_t AliEmcalCorrectionComponent::UserNotify ( )
virtual

Notifying the user that the input data file has changed and performing steps needed to be done.

Definition at line 166 of file AliEmcalCorrectionComponent.cxx.

Member Data Documentation

TString AliEmcalCorrectionComponent::fCustomBadChannelFilePath
protected

Custom path to bad channel map OADB file.

Definition at line 137 of file AliEmcalCorrectionComponent.h.

Referenced by InitBadChannels(), and SetCustomBadChannels().

Bool_t AliEmcalCorrectionComponent::fGetPassFromFileName
protected

Get fFilepass from file name.

Definition at line 117 of file AliEmcalCorrectionComponent.h.

Referenced by Initialize(), and Run().

Double_t AliEmcalCorrectionComponent::fMaxBinPt
protected

Max pt in histograms.

Definition at line 126 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionClusterHadronicCorrection::UserCreateOutputObjects().

Double_t AliEmcalCorrectionComponent::fMinBinPt
protected

Min pt in histograms.

Definition at line 125 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionClusterHadronicCorrection::UserCreateOutputObjects().

Int_t AliEmcalCorrectionComponent::fMinMCLabel
protected

Minimum MC label value for the tracks/clusters being considered MC particles.

Definition at line 129 of file AliEmcalCorrectionComponent.h.

Referenced by AliEmcalCorrectionClusterHadronicCorrection::DoMatchedTracksLoop().

Int_t AliEmcalCorrectionComponent::fNbins
protected
Double_t AliEmcalCorrectionComponent::fVertex[3]
protected
PWG::Tools::AliYAMLConfiguration AliEmcalCorrectionComponent::fYAMLConfig
protected

Contains the YAML configuration used to configure the component.

Definition at line 113 of file AliEmcalCorrectionComponent.h.

Referenced by GetProperty(), Initialize(), AliEmcalCorrectionCellEmulateCrosstalk::RetrieveAndSetProperties(), and SetYAMLConfiguration().


The documentation for this class was generated from the following files: