ATLAS Offline Software
JetConstituentModifierBase.cxx
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 // Source file for the JetConstituentModifierBase.h
6 // // Michael Nelson, CERN & University of Oxford
7 
10 #include "xAODPFlow/PFO.h"
11 #include "xAODPFlow/FlowElement.h"
13 
15 #ifndef XAOD_STANDALONE
16  declareInterface<IJetConstituentModifier>(this);
17 #endif
18  declareProperty("InputType", m_inputType);
19  declareProperty("ApplyToChargedPFO", m_applyToChargedPFO);
20  declareProperty("ApplyToNeutralPFO", m_applyToNeutralPFO);
21 }
22 
24 {
25  // Test that we are operating on the type of object that
26  // we will be writing out.
27  // By implication, any supporting containers should not
28  // be the ones passed to this method...
29  if(!cont->empty() && cont->front()->type() != m_inputType) {
30  ATH_MSG_ERROR("Object type mismatch! This tool expects " << m_inputType
31  << ", but received " << cont->front()->type());
32  return StatusCode::FAILURE;
33  }
34 
35  ATH_CHECK(process_impl(cont));
36 
37  return StatusCode::SUCCESS;
38 }
39 
40 
42 {
43  switch(m_inputType) {
44  // The main (only?) application is origin-correcting LC topoclusters
45  // By convention we leave the raw p4 unmodified
47  {
48  xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
49  clus->setCalEta(eta);
50  clus->setCalPhi(phi);
51  }
52  break;
53  default:
54  // Should not get here, because type-checking should happen in process()
55  ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
56  return StatusCode::FAILURE;
57  }
58  return StatusCode::SUCCESS;
59 }
60 
62  const SG::AuxElement::Accessor<float>* weightAcc) const
63 {
64  switch(m_inputType) {
66  {
67  xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
68  // Clusters get pt via the energy
69  // This currently leaves the mass unaltered.
70  if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? e / clus->calE() : 0.;
71  clus->setCalE(e);
72  }
73  break;
75  {
76  xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
77  if( (m_applyToChargedPFO && pfo->isCharged()) ||
78  (m_applyToNeutralPFO && !pfo->isCharged()) ) {
79  if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
80  // KTJ: Temporary fix
81  // Defeats the purpose, but we need to use this to reset the 4-vec cache
82  pfo->setP4(pt, pfo->eta(), pfo->phi());
83  }
84  }
85  break;
87  {
88  xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
89  if( (m_applyToChargedPFO && pfo->isCharged()) ||
90  (m_applyToNeutralPFO && !pfo->isCharged()) ) {
91  if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? pt / pfo->pt() : 0.;
92  pfo->setP4(pt, pfo->eta(), pfo->phi(), 0.);
93  }
94  }
95  break;
97  {
99  if( tcc->taste() != 0) {
100  if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? pt / tcc->pt() : 0.;
101  tcc->setParameters(pt, tcc->eta(), tcc->phi(), tcc->m(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
102  }
103  }
104  break;
105  default:
106  // Should not get here, because type-checking should happen in process()
107  ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
108  return StatusCode::FAILURE;
109  }
110  return StatusCode::SUCCESS;
111 }
112 
114  const SG::AuxElement::Accessor<float>* weightAcc) const {
115  switch(m_inputType) {
117  {
118  xAOD::CaloCluster* clus = static_cast<xAOD::CaloCluster*>(obj);
119  // This currently leaves the mass unaltered
120  if(weightAcc) (*weightAcc)(*clus) = clus->calE() > 0. ? p4.e() / clus->calE() : 0.;
121  clus->setCalE(p4.e());
122  clus->setCalEta(p4.eta());
123  clus->setCalPhi(p4.phi());
124  }
125  break;
127  {
128  xAOD::PFO* pfo = static_cast<xAOD::PFO*>(obj);
129  // The PFO setter defaults to m=0
130  if( (m_applyToChargedPFO && pfo->isCharged()) ||
131  (m_applyToNeutralPFO && !pfo->isCharged()) ) {
132  if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
133  pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
134  }
135  }
136  break;
138  {
139  xAOD::FlowElement* pfo = static_cast<xAOD::FlowElement*>(obj);
140  if( (m_applyToChargedPFO && pfo->isCharged()) ||
141  (m_applyToNeutralPFO && !pfo->isCharged()) ) {
142  if(weightAcc) (*weightAcc)(*pfo) = pfo->pt() > 0. ? p4.pt() / pfo->pt() : 0.;
143  pfo->setP4(p4.pt(),p4.eta(),p4.phi(),p4.mass());
144  }
145  }
146  break;
148  {
149  xAOD::TrackCaloCluster* tcc = static_cast<xAOD::TrackCaloCluster*>(obj);
150  if( tcc->taste() != 0) {
151  if(weightAcc) (*weightAcc)(*tcc) = tcc->pt() > 0. ? p4.pt() / tcc->pt() : 0.;
152  tcc->setParameters(p4.pt(), p4.eta(), p4.phi(), p4.mass(), xAOD::TrackCaloCluster::Taste(tcc->taste()), tcc->trackParticleLink(), tcc->caloClusterLinks());
153  }
154  break;
155  }
156 
157  default:
158  // Should not get here, because type-checking should happen in process()
159  ATH_MSG_ERROR("No specialisation for object type " << m_inputType);
160  return StatusCode::FAILURE;
161  }
162  return StatusCode::SUCCESS;
163 }
JetConstituentModifierBase::process
StatusCode process(xAOD::IParticleContainer *cont) const override final
Definition: JetConstituentModifierBase.cxx:23
JetConstituentModifierBase::m_applyToNeutralPFO
bool m_applyToNeutralPFO
Definition: JetConstituentModifierBase.h:63
JetConstituentModifierBase::setEtaPhi
StatusCode setEtaPhi(xAOD::IParticle *obj, float eta, float phi) const
Definition: JetConstituentModifierBase.cxx:41
xAOD::PFO_v1::pt
virtual double pt() const
The transverse momentum ( ) of the particle.
Definition: PFO_v1.cxx:52
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:64
JetConstituentModifierBase::JetConstituentModifierBase
JetConstituentModifierBase(const std::string &name)
Definition: JetConstituentModifierBase.cxx:14
SG::Accessor
Helper class to provide type-safe access to aux data.
Definition: Control/AthContainers/AthContainers/Accessor.h:66
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:79
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
xAOD::CaloCluster_v1::calE
flt_t calE() const
Geet Energy in signal state CALIBRATED.
xAOD::TrackCaloCluster_v1
Class describing a TrackCaloCluster.
Definition: TrackCaloCluster_v1.h:25
JetConstituentModifierBase.h
TrackCaloCluster.h
JetConstituentModifierBase::process_impl
virtual StatusCode process_impl(xAOD::IParticleContainer *) const
Definition: JetConstituentModifierBase.h:33
asg
Definition: DataHandleTestTool.h:28
test_pyathena.pt
pt
Definition: test_pyathena.py:11
xAOD::CaloCluster_v1::setCalEta
void setCalEta(flt_t)
Set for signal state CALIBRATED.
Definition: CaloCluster_v1.cxx:311
xAOD::FlowElement_v1::pt
virtual double pt() const override
xAOD::IParticle
Class providing the definition of the 4-vector interface.
Definition: Event/xAOD/xAODBase/xAODBase/IParticle.h:40
JetConstituentModifierBase::m_applyToChargedPFO
bool m_applyToChargedPFO
Definition: JetConstituentModifierBase.h:62
xAOD::CaloCluster
CaloCluster_v1 CaloCluster
Define the latest version of the calorimeter cluster class.
Definition: Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloCluster.h:19
xAOD::TrackCaloCluster
TrackCaloCluster_v1 TrackCaloCluster
Reference the current persistent version:
Definition: TrackCaloCluster.h:12
xAOD::TrackCaloCluster_v1::pt
virtual double pt() const
The transverse momentum ( ) of the particle.
xAOD::FlowElement_v1::isCharged
bool isCharged() const
Definition: FlowElement_v1.cxx:56
PFO.h
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:59
xAOD::CaloCluster_v1::setCalPhi
void setCalPhi(flt_t)
Set for signal state CALIBRATED.
Definition: CaloCluster_v1.cxx:316
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
FlowElement.h
CaloCluster.h
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
xAOD::FlowElement
FlowElement_v1 FlowElement
Definition of the current "pfo version".
Definition: FlowElement.h:16
DataVector::front
const T * front() const
Access the first element in the collection as an rvalue.
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
xAODType::ParticleFlow
@ ParticleFlow
The object is a particle-flow object.
Definition: ObjectType.h:41
JetConstituentModifierBase::setP4
StatusCode setP4(xAOD::IParticle *obj, const xAOD::JetFourMom_t &p4, const SG::AuxElement::Accessor< float > *weightAcc=nullptr) const
Definition: JetConstituentModifierBase.cxx:113
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
xAOD::PFO_v1::isCharged
bool isCharged() const
is a charged PFO
Definition: PFO_v1.cxx:251
xAOD::JetFourMom_t
ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > JetFourMom_t
Base 4 Momentum type for Jet.
Definition: JetTypes.h:17
xAOD::PFO_v1
Class describing a particle flow object.
Definition: PFO_v1.h:35
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
JetConstituentModifierBase::setEnergyPt
StatusCode setEnergyPt(xAOD::IParticle *obj, float e, float pt, const SG::AuxElement::Accessor< float > *weightAcc=nullptr) const
Definition: JetConstituentModifierBase.cxx:61
xAOD::TrackCaloCluster_v1::taste
virtual int taste() const
The taste of the particle.
JetConstituentModifierBase::m_inputType
unsigned int m_inputType
Definition: JetConstituentModifierBase.h:60
DiTauMassTools::MaxHistStrategyV2::e
e
Definition: PhysicsAnalysis/TauID/DiTauMassTools/DiTauMassTools/HelperFunctions.h:26
xAOD::TrackCaloCluster_v1::Taste
Taste
Type of TrackCaloCluster - Charged - Neutral - Combined.
Definition: TrackCaloCluster_v1.h:30
python.PyAthena.obj
obj
Definition: PyAthena.py:135
DataVector::empty
bool empty() const noexcept
Returns true if the collection is empty.
xAOD::FlowElement_v1
A detector object made of other lower level object(s)
Definition: FlowElement_v1.h:25