ATLAS Offline Software
Toggle main menu visibility
Loading...
Searching...
No Matches
Reconstruction
Jet
JetRecTools
JetRecTools
JetConstituentModifierBase.h
Go to the documentation of this file.
1
/*
2
Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
3
*/
4
5
//JetConstituentModifierBase.h
6
7
#ifndef JETRECTOOLS_JETCONSTITUENTMODIFIERBASE_H
8
#define JETRECTOOLS_JETCONSTITUENTMODIFIERBASE_H
9
12
13
#include "
AsgTools/AsgTool.h
"
14
#include "
xAODBase/IParticleContainer.h
"
15
#include "
JetInterface/IJetConstituentModifier.h
"
16
#include "
xAODJet/Jet.h
"
17
#include "
AthContainers/CurrentContext.h
"
18
19
20
// JetConstituentModifierBase provides default execute () behaviour
21
// to all JetConstituentModifier tools. Can be used in Rootcore, without
22
// the need for a sequence.
23
24
class
JetConstituentModifierBase
:
public
asg::AsgTool
,
virtual
public
IJetConstituentModifier
{
25
ASG_TOOL_CLASS
(
JetConstituentModifierBase
,
IJetConstituentModifier
)
26
public
:
27
JetConstituentModifierBase
(
const
std::string & name);
28
29
// Implement the IJetConstituentModifier interface
30
// Do some type-checking on the input container
31
StatusCode
process
(
xAOD::IParticleContainer
* cont,
const
EventContext& ctx)
const
override
final
;
32
// Concrete implementation method to be overridden by child tools
33
// We pass a pointer here, because some of the type-specific tools
34
// will want to cast to the right container type
35
virtual
StatusCode
process_impl
(
xAOD::IParticleContainer
*
/*cont*/
,
const
EventContext&
/*ctx*/
)
const
36
{
37
ATH_MSG_ERROR
(
"This is the JetConstituentModifierBase class, no corrections implemented!"
);
38
return
StatusCode::FAILURE;
39
}
40
41
virtual
StatusCode
configure_decor_handle_keys
() {
42
return
StatusCode::SUCCESS;
43
}
44
45
void
setInputContainer
(
const
std::string& cont) {
m_inputContainer
= cont;}
46
void
setOutputContainer
(
const
std::string& cont) {
m_outputContainer
= cont;}
47
void
setInputChargedContainer
(
const
std::string& cont) {
m_inputChargedContainer
= cont;}
48
void
setOutputChargedContainer
(
const
std::string& cont) {
m_outputChargedContainer
= cont;}
49
void
setInputNeutralContainer
(
const
std::string& cont) {
m_inputNeutralContainer
= cont;}
50
void
setOutputNeutralContainer
(
const
std::string& cont) {
m_outputNeutralContainer
= cont;}
51
52
53
54
protected
:
55
// Define four-momentum setters that will handle type-specific operations
56
// Multiple versions are needed that only correct particular four-vector
57
// components, to avoid producing unnecessary shallow copy branches
58
59
// Setter for eta/phi
60
StatusCode
setEtaPhi
(
xAOD::IParticle
* obj,
float
eta
,
float
phi
)
const
;
61
// Setter for e/pt
62
StatusCode
setEnergyPt
(
xAOD::IParticle
* obj,
float
e,
float
pt)
const
;
63
// Setter for full four-vector
64
StatusCode
setP4
(
xAOD::IParticle
* obj,
const
xAOD::JetFourMom_t
& p4)
const
;
65
// Get the correction factor for a given object, based on the corrected energy and pt, or the corrected four-vector
66
float
getCorrectionFactor
(
xAOD::IParticle
* obj,
const
float
& corrected_energy,
const
float
& corrected_pt)
const
;
67
float
getCorrectionFactor
(
xAOD::IParticle
* obj,
const
xAOD::JetFourMom_t
& corrected_p4)
const
;
68
69
// We need to know the output type so that we can set the p4 appropriately,
70
// because IParticle does not specify the p4 encoding.
71
// The user must explicitly set what sort of object they modify
72
// Define as a basic integer type because Gaudi
73
// doesn't support arbitrary property types
74
unsigned
int
m_inputType
=
xAOD::Type::Other
;
75
76
std::string
m_inputContainer
;
77
std::string
m_outputContainer
;
78
std::string
m_inputChargedContainer
;
79
std::string
m_inputNeutralContainer
;
80
std::string
m_outputChargedContainer
;
81
std::string
m_outputNeutralContainer
;
82
83
84
bool
m_applyToChargedPFO
=
true
;
85
bool
m_applyToNeutralPFO
=
true
;
86
};
87
88
#endif
89
eta
Scalar eta() const
pseudorapidity method
Definition
AmgMatrixBasePlugin.h:83
phi
Scalar phi() const
phi method
Definition
AmgMatrixBasePlugin.h:67
ASG_TOOL_CLASS
#define ASG_TOOL_CLASS(CLASSNAME, INT1)
Definition
AsgToolMacros.h:68
AsgTool.h
CurrentContext.h
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x,...)
Definition
AthMsgStreamMacros.h:47
Jet.h
IJetConstituentModifier.h
IJetConstituentModifier
Definition
IJetConstituentModifier.h:17
JetConstituentModifierBase::getCorrectionFactor
float getCorrectionFactor(xAOD::IParticle *obj, const float &corrected_energy, const float &corrected_pt) const
Definition
JetConstituentModifierBase.cxx:158
JetConstituentModifierBase::setEnergyPt
StatusCode setEnergyPt(xAOD::IParticle *obj, float e, float pt) const
Definition
JetConstituentModifierBase.cxx:63
JetConstituentModifierBase::m_applyToNeutralPFO
bool m_applyToNeutralPFO
Definition
JetConstituentModifierBase.h:85
JetConstituentModifierBase::setInputNeutralContainer
void setInputNeutralContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:49
JetConstituentModifierBase::JetConstituentModifierBase
JetConstituentModifierBase(const std::string &name)
Definition
JetConstituentModifierBase.cxx:16
JetConstituentModifierBase::setEtaPhi
StatusCode setEtaPhi(xAOD::IParticle *obj, float eta, float phi) const
Definition
JetConstituentModifierBase.cxx:43
JetConstituentModifierBase::m_inputChargedContainer
std::string m_inputChargedContainer
Definition
JetConstituentModifierBase.h:78
JetConstituentModifierBase::m_outputNeutralContainer
std::string m_outputNeutralContainer
Definition
JetConstituentModifierBase.h:81
JetConstituentModifierBase::setOutputNeutralContainer
void setOutputNeutralContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:50
JetConstituentModifierBase::process_impl
virtual StatusCode process_impl(xAOD::IParticleContainer *, const EventContext &) const
Definition
JetConstituentModifierBase.h:35
JetConstituentModifierBase::m_outputContainer
std::string m_outputContainer
Definition
JetConstituentModifierBase.h:77
JetConstituentModifierBase::setOutputChargedContainer
void setOutputChargedContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:48
JetConstituentModifierBase::m_inputContainer
std::string m_inputContainer
Definition
JetConstituentModifierBase.h:76
JetConstituentModifierBase::m_inputNeutralContainer
std::string m_inputNeutralContainer
Definition
JetConstituentModifierBase.h:79
JetConstituentModifierBase::m_inputType
unsigned int m_inputType
Definition
JetConstituentModifierBase.h:74
JetConstituentModifierBase::setP4
StatusCode setP4(xAOD::IParticle *obj, const xAOD::JetFourMom_t &p4) const
Definition
JetConstituentModifierBase.cxx:110
JetConstituentModifierBase::m_applyToChargedPFO
bool m_applyToChargedPFO
Definition
JetConstituentModifierBase.h:84
JetConstituentModifierBase::setInputContainer
void setInputContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:45
JetConstituentModifierBase::setOutputContainer
void setOutputContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:46
JetConstituentModifierBase::configure_decor_handle_keys
virtual StatusCode configure_decor_handle_keys()
Definition
JetConstituentModifierBase.h:41
JetConstituentModifierBase::m_outputChargedContainer
std::string m_outputChargedContainer
Definition
JetConstituentModifierBase.h:80
JetConstituentModifierBase::setInputChargedContainer
void setInputChargedContainer(const std::string &cont)
Definition
JetConstituentModifierBase.h:47
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition
AsgTool.h:47
xAOD::IParticle
Class providing the definition of the 4-vector interface.
Definition
Event/xAOD/xAODBase/xAODBase/IParticle.h:41
process
const std::string process
Definition
fbtTestBasics.cxx:76
xAODType::Other
@ Other
An object not falling into any of the other categories.
Definition
ObjectType.h:34
xAOD::IParticleContainer
DataVector< IParticle > IParticleContainer
Simple convenience declaration of IParticleContainer.
Definition
xAOD/xAODBase/xAODBase/IParticleContainer.h:32
xAOD::JetFourMom_t
ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > JetFourMom_t
Base 4 Momentum type for Jet.
Definition
JetTypes.h:17
IParticleContainer.h
Generated on
for ATLAS Offline Software by
1.17.0