ATLAS Offline Software
Loading...
Searching...
No Matches
Namespaces | Classes | Functions
ParticleJetTools Namespace Reference

Namespaces

namespace  FatVertex

Classes

struct  LabelNames
struct  LabelDecorators
class  IParticleLinker
struct  Particles
class  JetTruthVertexSummaryDecoratorAlg
class  TruthVertexDecoratorAlg

Functions

Amg::Vector3D p3 (const xAOD::TruthVertex *p)
Amg::Vector3D p3 (const xAOD::Jet &j)
Amg::Vector3D signalProcessP3 (const xAOD::TruthEventContainer &)
void setJetLabels (const xAOD::Jet &jet, const Particles &particles, const LabelNames &names)
void setJetLabels (const xAOD::Jet &jet, const Particles &particles, const LabelDecorators &decs)
float partPt (const xAOD::TruthParticle *part)
float partLxy (const xAOD::TruthParticle *part, const Amg::Vector3D &origin)
float partDR (const xAOD::TruthParticle *part, const xAOD::Jet &jet)
int partPdgId (const xAOD::TruthParticle *part)
float positionDPhi (const xAOD::TruthParticle *part, const xAOD::Jet &jet, const Amg::Vector3D &origin)
float positionDEta (const xAOD::TruthParticle *part, const xAOD::Jet &jet, const Amg::Vector3D &origin)
void childrenRemoved (const std::vector< const xAOD::TruthParticle * > &parents, std::vector< const xAOD::TruthParticle * > &children)
template<typename T>
void declareProperties (T &tool, LabelNames *n)
bool isChild (const xAOD::TruthParticle *p, const xAOD::TruthParticle *c)
const xAOD::TruthParticle * get_initial_particle (const xAOD::TruthParticle *part)
std::vector< const xAOD::TruthParticle * > get_all_initial_particles (const std::vector< const xAOD::TruthParticle * > &truth_particles)
std::vector< const xAOD::TruthVertex * > get_matched_primary_vertices (const xAOD::TruthVertex *pv, const std::vector< const xAOD::TruthVertex * > &truth_vertices, float selection_distance=0.001, SG::ConstAccessor< int > acc_uid=SG::ConstAccessor< int >("barcode"))
 Get the matched primary vertex for a given truth vertex.

Function Documentation

◆ childrenRemoved()

void ParticleJetTools::childrenRemoved ( const std::vector< const xAOD::TruthParticle * > & parents,
std::vector< const xAOD::TruthParticle * > & children )

Definition at line 63 of file ParticleJetLabelCommon.cxx.

66 {
67
68 if ( &parents == &children ) {
69 // Same vector provided for both inputs. Extra care needed in
70 // this case...
71 const std::vector<const xAOD::TruthParticle*> copyParents = parents;
72 childrenRemoved(copyParents, children);
73 return;
74 }
75 // We can now safely assume that parents will not be modified
76 // during this loop.
77 for ( const xAOD::TruthParticle* p : parents ) {
78 if (!p) continue;
79 children.erase(std::remove_if(children.begin(),
80 children.end(),
81 [p](const xAOD::TruthParticle* c) { return (c && isChild(p, c)); }),
82 children.end());
83 // auto erased = std::erase_if(children, [p](const xAOD::TruthParticle* c) { return (c && isChild(p, c)); }); // C++20
84 }
85 return;
86 }
ParticleJetTools::childrenRemoved
void childrenRemoved(const std::vector< const xAOD::TruthParticle * > &parents, std::vector< const xAOD::TruthParticle * > &children)
Definition ParticleJetLabelCommon.cxx:64
std::remove_if
DataModel_detail::iterator< DVL > remove_if(typename DataModel_detail::iterator< DVL > beg, typename DataModel_detail::iterator< DVL > end, Predicate pred)
Specialization of remove_if for DataVector/List.
Definition DVL_algorithms.h:70
xAOD::TruthParticle
TruthParticle_v1 TruthParticle
Typedef to implementation.
Definition Event/xAOD/xAODTruth/xAODTruth/TruthParticle.h:15

◆ declareProperties()

template<typename T>
void ParticleJetTools::declareProperties ( T & tool,
LabelNames * n )

Definition at line 109 of file ParticleJetLabelCommon.h.

109 {
110 tool.declareProperty("LabelName", n->singleint="", "Jet label attribute to be added.");
111 tool.declareProperty("DoubleLabelName", n->doubleint="", "Jet label attribute to be added (with the possibility of up to 2 matched hadrons).");
112 tool.declareProperty("LabelPtName", n->pt="", "Attribute for labelling particle pt");
113 tool.declareProperty("LabelLxyName", n->Lxy="", "Attribute for Lxy of labelling particle");
114 tool.declareProperty("LabelDRName", n->dr="", "Attribute for dR(part, jet) for labelling particle");
115 tool.declareProperty("LabelPdgIdName", n->pdgId="", "Attribute for pdgID of labelling particle");
116 tool.declareProperty("LabelPositionDPhiName", n->positionDPhi="", "Attribute for the position dPhi of the labeling particle ");
117 tool.declareProperty("LabelPositionDEtaName", n->positionDEta="", "Attribute for the position dEta of the labeling particle ");
118 tool.declareProperty("LabelBarcodeName", n->uniqueID="", "Attribute for uniqueID of labeling particle");
119 tool.declareProperty("ChildLxyName", n->childLxy="", "Attribute for the labeling particle child Lxy");
120 tool.declareProperty("ChildPtName", n->childPt="", "Attribute for the labeling particle child Pt");
121 tool.declareProperty("ChildPdgIdName", n->childPdgId="", "Attribute for the labeling particle child pdg ID");
122 tool.declareProperty("ChildPositionDPhiName", n->childPositionDPhi="", "Attribute for the position dPhi of the labeling particle child");
123 tool.declareProperty("ChildPositionDEtaName", n->childPositionDEta="", "Attribute for the position dEta of the labeling particle child");
124 // ATLASRECTS-8290: this is for backward compatability, remove eventually
125 tool.declareProperty("useBarcode", n->useBarcode=false, "use barcode instead of uid");
126 }

◆ get_all_initial_particles()

std::vector< const xAOD::TruthParticle * > ParticleJetTools::get_all_initial_particles ( const std::vector< const xAOD::TruthParticle * > & truth_particles)

Definition at line 40 of file TruthVertexDecoratorAlg.cxx.

42 {
43 std::unordered_set<const xAOD::TruthParticle*> pv_parts;
44
45 for ( const auto& part : truth_particles ) {
46 auto initial_part = get_initial_particle(part);
47 if ( initial_part ) {
48 pv_parts.insert(initial_part);
49 }
50 }
51
52 std::vector<const xAOD::TruthParticle*> initial_particles;
53 initial_particles.reserve(pv_parts.size());
54 for ( const auto& part : pv_parts ) {
55 initial_particles.push_back(part);
56 }
57 return initial_particles;
58
59}
ParticleJetTools::get_initial_particle
const xAOD::TruthParticle * get_initial_particle(const xAOD::TruthParticle *part)
Definition TruthVertexDecoratorAlg.cxx:13

◆ get_initial_particle()

const xAOD::TruthParticle * ParticleJetTools::get_initial_particle ( const xAOD::TruthParticle * part)
inline

Definition at line 13 of file TruthVertexDecoratorAlg.cxx.

15 {
16 const xAOD::TruthParticle* parent = part;
17 for ( int i = 0; i < 1000; i++ ) {
18 const xAOD::TruthParticle* next_parent = nullptr;
19
20 if(parent->nParents() > 1){
21 float cur_pt = -1.0;
22 for (size_t j = 0; j < parent->nParents(); j++) {
23 const xAOD::TruthParticle* p = parent->parent(j);
24 if ( !p ) continue;
25 if ( p->pt() > cur_pt ) {
26 cur_pt = p->pt();
27 next_parent = p;
28 }
29 }
30 }else{
31 next_parent = parent->parent(0);
32 }
33 if ( !next_parent ) break;
34 if ( !next_parent->hasDecayVtx() || !next_parent->decayVtx() ) break;
35 parent = next_parent;
36 }
37 return parent;
38}
xAOD::TruthParticle_v1::decayVtx
const TruthVertex_v1 * decayVtx() const
The decay vertex of this particle.
xAOD::TruthParticle_v1::hasDecayVtx
bool hasDecayVtx() const
Check for a decay vertex on this particle.
test_pyathena.parent
parent
Definition test_pyathena.py:15

◆ get_matched_primary_vertices()

std::vector< const xAOD::TruthVertex * > ParticleJetTools::get_matched_primary_vertices ( const xAOD::TruthVertex * pv,
const std::vector< const xAOD::TruthVertex * > & truth_vertices,
float selection_distance = 0.001,
SG::ConstAccessor< int > acc_uid = SG::ConstAccessor<int>("barcode") )

Get the matched primary vertex for a given truth vertex.

The TruthPrimaryVertices container does NOT contain particle links, so we match by position to find the corresponding vertex in TruthVertices.

Definition at line 66 of file TruthVertexDecoratorAlg.cxx.

70 {
71 std::vector<const xAOD::TruthVertex*> matched_vertices;
72
73 float closest_distance = 1e9;
74 const xAOD::TruthVertex* closest_vertex = nullptr;
75 for( const auto& vert : truth_vertices ) {
76 if ( !vert ) continue;
77 float r = FatVertex::vertex_distance(pv, vert);
78 if(r < selection_distance){
79 matched_vertices.push_back(vert);
80 if (r < closest_distance) {
81 closest_distance = r;
82 closest_vertex = vert;
83 }else if (r == closest_distance) {
84 // If we have two vertices at the same distance, we'll take the one with the lowest
85 // barcode as it *should* be the case that this is the actual PV.
86 if ( std::abs(acc_uid(*vert)) < std::abs(acc_uid(*closest_vertex)) ) {
87 closest_vertex = vert;
88 }
89 }
90 }
91 }
92 // Set it such that the first vertex is the closest vertex
93 if ( !matched_vertices.empty() && closest_vertex ) {
94 // remove the closest vertex from the matched vertices
95 matched_vertices.erase(
96 std::remove(matched_vertices.begin(), matched_vertices.end(), closest_vertex),
97 matched_vertices.end()
98 );
99 // Insert into the front of the vector
100 matched_vertices.insert(matched_vertices.begin(), closest_vertex);
101
102 }
103 return matched_vertices;
104
105}
r
int r
Definition globals.cxx:22
ParticleJetTools::FatVertex::vertex_distance
float vertex_distance(const xAOD::TruthVertex *v1, const xAOD::TruthVertex *v2)
Definition FatVertex.cxx:53
std::remove
DataModel_detail::iterator< DVL > remove(typename DataModel_detail::iterator< DVL > beg, typename DataModel_detail::iterator< DVL > end, const T &value)
Specialization of remove for DataVector/List.
Definition DVL_algorithms.h:49
xAOD::TruthVertex
TruthVertex_v1 TruthVertex
Typedef to implementation.
Definition TruthVertex.h:15

◆ isChild()

bool ParticleJetTools::isChild ( const xAOD::TruthParticle * p,
const xAOD::TruthParticle * c )
inline

Definition at line 34 of file ParticleJetLabelCommon.cxx.

34 {
35
36 if ( HepMC::is_same_particle(p,c) ) { return false; }
37
38 for (size_t iC = 0; iC < p->nChildren(); iC++) {
39 const xAOD::TruthParticle* cc = p->child(iC);
40 if (!cc) { continue; }
41
42 if ( HepMC::is_same_particle(cc,c) ) { return true; }
43
44 if (isChild(cc, c)) { return true; }
45 }
46
47 return false;
48 }
HepMC::is_same_particle
bool is_same_particle(const T1 &p1, const T2 &p2)
Method to establish if two particles in the GenEvent actually represent the same particle.
Definition MagicNumbers.h:367
ParticleJetTools::isChild
bool isChild(const xAOD::TruthParticle *p, const xAOD::TruthParticle *c)
Definition ParticleJetLabelCommon.cxx:34

◆ p3() [1/2]

Amg::Vector3D ParticleJetTools::p3 ( const xAOD::Jet & j)

Definition at line 54 of file ParticleJetLabelCommon.cxx.

54 {
55 return {j.px(), j.py(), j.pz()};
56 }

◆ p3() [2/2]

Amg::Vector3D ParticleJetTools::p3 ( const xAOD::TruthVertex * p)

Definition at line 50 of file ParticleJetLabelCommon.cxx.

50 {
51 if (!p) return {NAN, NAN, NAN};
52 return {p->x(), p->y(), p->z()};
53 }

◆ partDR()

float ParticleJetTools::partDR ( const xAOD::TruthParticle * part,
const xAOD::Jet & jet )

Definition at line 298 of file ParticleJetLabelCommon.cxx.

298 {
299 if (!part) return NAN;
300 return part->p4().DeltaR(jet.p4());
301 }

◆ partLxy()

float ParticleJetTools::partLxy ( const xAOD::TruthParticle * part,
const Amg::Vector3D & origin )

Definition at line 293 of file ParticleJetLabelCommon.cxx.

293 {
294 if (!part) return NAN;
295 if (const auto* vx = part->decayVtx() ) return (p3(vx) - origin).perp();
296 return INFINITY;
297 }
ParticleJetTools::p3
Amg::Vector3D p3(const xAOD::TruthVertex *p)
Definition ParticleJetLabelCommon.cxx:50

◆ partPdgId()

int ParticleJetTools::partPdgId ( const xAOD::TruthParticle * part)

Definition at line 302 of file ParticleJetLabelCommon.cxx.

302 {
303 if (!part) return 0;
304 return part->pdgId();
305 }

◆ partPt()

float ParticleJetTools::partPt ( const xAOD::TruthParticle * part)

Definition at line 289 of file ParticleJetLabelCommon.cxx.

289 {
290 if (!part) return NAN;
291 return part->pt();
292 }

◆ positionDEta()

float ParticleJetTools::positionDEta ( const xAOD::TruthParticle * part,
const xAOD::Jet & jet,
const Amg::Vector3D & origin )

Definition at line 316 of file ParticleJetLabelCommon.cxx.

318 {
319 if (!part) return NAN;
320 if (const auto* vx = part->decayVtx() ) {
321 Amg::Vector3D displacement = p3(vx) - origin;
322 return displacement.eta() - jet.eta();
323 }
324 return INFINITY;
325 }
Amg::Vector3D
Eigen::Matrix< double, 3, 1 > Vector3D
Definition GeoPrimitives.h:47

◆ positionDPhi()

float ParticleJetTools::positionDPhi ( const xAOD::TruthParticle * part,
const xAOD::Jet & jet,
const Amg::Vector3D & origin )

Definition at line 306 of file ParticleJetLabelCommon.cxx.

308 {
309 if (!part) return NAN;
310 if (const auto* vx = part->decayVtx() ) {
311 Amg::Vector3D displacement = p3(vx) - origin;
312 return p3(jet).deltaPhi(displacement);
313 }
314 return INFINITY;
315 }

◆ setJetLabels() [1/2]

void ParticleJetTools::setJetLabels ( const xAOD::Jet & jet,
const Particles & particles,
const LabelDecorators & decs )

Definition at line 164 of file ParticleJetLabelCommon.cxx.

166 {
167
168 // we also want to save information about the maximum pt particle of the labeling partons
169 auto getMaxPtPart = [](const auto& container) -> const xAOD::TruthParticle* {
170 if (container.size() == 0) return nullptr;
171 auto itr = std::max_element(container.begin(), container.end(),
172 [](auto* p1, auto* p2) {
173 return p1->pt() < p2->pt();
174 });
175 return *itr;
176 };
177
178 // set truth label for jets above pt threshold
179 // hierarchy: b > c > tau > light
180 int label = 0; // default: light
181 const xAOD::TruthParticle* labelling_particle = nullptr;
182 const xAOD::TruthParticle* child_particle = nullptr;
183 if (particles.b.size()) {
184 label = 5;
185 labelling_particle = getMaxPtPart(particles.b);
186 child_particle = getCharmChild(labelling_particle);
187 } else if (particles.c.size()) {
188 label = 4;
189 labelling_particle = getMaxPtPart(particles.c);
190 } else if (particles.tau.size()) {
191 label = 15;
192 labelling_particle = getMaxPtPart(particles.tau);
193 }
194
195 const Amg::Vector3D& origin = particles.origin;
196
197 // decorate info about the labelling particle
198 decs.singleint(jet) = label;
199 if (label == 0) {
200 decs.pt(jet) = NAN;
201 decs.Lxy(jet) = NAN;
202 decs.dr(jet) = NAN;
203 decs.pdgId(jet) = 0;
204 decs.positionDPhi(jet) = NAN;
205 decs.positionDEta(jet) = NAN;
206 decs.uniqueID(jet) = HepMC::INVALID_PARTICLE_ID;
207 decs.childLxy(jet) = NAN;
208 decs.childPt(jet) = NAN;
209 decs.childPdgId(jet) = 0;
210 decs.childPositionDPhi(jet) = NAN;
211 decs.childPositionDEta(jet) = NAN;
212 } else {
213 decs.pt(jet) = partPt(labelling_particle);
214 decs.Lxy(jet) = partLxy(labelling_particle, origin);
215 decs.dr(jet) = partDR(labelling_particle, jet);
216 decs.pdgId(jet) = partPdgId(labelling_particle);
217 decs.positionDPhi(jet) = positionDPhi(labelling_particle, jet, origin);
218 decs.positionDEta(jet) = positionDEta(labelling_particle, jet, origin);
219 decs.uniqueID(jet) = labelling_particle ?
220 // ATLASRECTS-8290: this should be replaced with ->uid()
221 decs.acc_uid(*labelling_particle) : HepMC::INVALID_PARTICLE_ID;
222 decs.childLxy(jet) = partLxy(child_particle, origin);
223 decs.childPt(jet) = partPt(child_particle);
224 decs.childPdgId(jet) = partPdgId(child_particle);
225 decs.childPositionDPhi(jet) = positionDPhi(child_particle, jet, origin);
226 decs.childPositionDEta(jet) = positionDEta(child_particle, jet, origin);
227 }
228
229 // extended flavour label
230 int double_label = 0;
231 if (particles.b.size()) {
232 if (particles.b.size() >= 2)
233 double_label = 55;
234
235 else if (particles.c.size())
236 double_label = 54;
237
238 else
239 double_label = 5;
240
241 } else if (particles.c.size()) {
242 if (particles.c.size() >= 2)
243 double_label = 44;
244
245 else
246 double_label = 4;
247
248 } else if (particles.tau.size()){
249
250 bool hasElectrondecay = false;
251 bool hasMuondecay = false;
252 bool hasHadronicdecay = false;
253 for (auto itau: particles.tau){
254 for (size_t i = 0; i< itau->nChildren(); i++){ // tau children loop
255 if (itau->child(i)->absPdgId() == 12 || itau->child(i)->absPdgId() == 14 || itau->child(i)->absPdgId() == 16) continue;
256 if (MC::isMuon(itau->child(i))) hasMuondecay = true;
257 else if (MC::isElectron(itau->child(i))) hasElectrondecay = true;
258 else hasHadronicdecay = true;
259 }
260 }
261
262 if (particles.tau.size() >= 2){
263 // check if we have at least one hadronic tau
264 if (hasHadronicdecay){
265 // check if we have also tau->mu decay
266 if (hasMuondecay) double_label = 151513;
267 // check if we have also tau->el decay
268 else if (hasElectrondecay) double_label = 151511;
269 // otherwise fully hadronic di-tau decay
270 else double_label = 1515;
271 }
272 } else {
273 // only consider hadronic tau decay
274 if (hasHadronicdecay) double_label = 15;
275 }
276
277 }
278
279 decs.doubleint(jet) = double_label;
280
281 }
label
std::string label(const std::string &format, int i)
Definition label.h:19
HepMC::INVALID_PARTICLE_ID
constexpr int INVALID_PARTICLE_ID
Definition MagicNumbers.h:58
MC::isElectron
bool isElectron(const int &p)
Definition HepMCHelpers.h:173
MC::isMuon
bool isMuon(const int &p)
Definition HepMCHelpers.h:176
ParticleJetTools::positionDEta
float positionDEta(const xAOD::TruthParticle *part, const xAOD::Jet &jet, const Amg::Vector3D &origin)
Definition ParticleJetLabelCommon.cxx:316
ParticleJetTools::partDR
float partDR(const xAOD::TruthParticle *part, const xAOD::Jet &jet)
Definition ParticleJetLabelCommon.cxx:298
ParticleJetTools::partPt
float partPt(const xAOD::TruthParticle *part)
Definition ParticleJetLabelCommon.cxx:289
ParticleJetTools::partLxy
float partLxy(const xAOD::TruthParticle *part, const Amg::Vector3D &origin)
Definition ParticleJetLabelCommon.cxx:293
ParticleJetTools::positionDPhi
float positionDPhi(const xAOD::TruthParticle *part, const xAOD::Jet &jet, const Amg::Vector3D &origin)
Definition ParticleJetLabelCommon.cxx:306
ParticleJetTools::partPdgId
int partPdgId(const xAOD::TruthParticle *part)
Definition ParticleJetLabelCommon.cxx:302
ParticleJetTools::LabelDecorators::childPositionDEta
SG::AuxElement::Decorator< float > childPositionDEta
Definition ParticleJetLabelCommon.h:57
ParticleJetTools::LabelDecorators::uniqueID
SG::AuxElement::Decorator< int > uniqueID
Definition ParticleJetLabelCommon.h:52
ParticleJetTools::LabelDecorators::pdgId
SG::AuxElement::Decorator< int > pdgId
Definition ParticleJetLabelCommon.h:49
ParticleJetTools::LabelDecorators::pt
SG::AuxElement::Decorator< float > pt
Definition ParticleJetLabelCommon.h:46
ParticleJetTools::LabelDecorators::doubleint
SG::AuxElement::Decorator< int > doubleint
Definition ParticleJetLabelCommon.h:45
ParticleJetTools::LabelDecorators::Lxy
SG::AuxElement::Decorator< float > Lxy
Definition ParticleJetLabelCommon.h:47
ParticleJetTools::LabelDecorators::dr
SG::AuxElement::Decorator< float > dr
Definition ParticleJetLabelCommon.h:48
ParticleJetTools::LabelDecorators::childPdgId
SG::AuxElement::Decorator< int > childPdgId
Definition ParticleJetLabelCommon.h:55
ParticleJetTools::LabelDecorators::positionDEta
SG::AuxElement::Decorator< float > positionDEta
Definition ParticleJetLabelCommon.h:51
ParticleJetTools::LabelDecorators::childPositionDPhi
SG::AuxElement::Decorator< float > childPositionDPhi
Definition ParticleJetLabelCommon.h:56
ParticleJetTools::LabelDecorators::positionDPhi
SG::AuxElement::Decorator< float > positionDPhi
Definition ParticleJetLabelCommon.h:50
ParticleJetTools::LabelDecorators::childLxy
SG::AuxElement::Decorator< float > childLxy
Definition ParticleJetLabelCommon.h:53
ParticleJetTools::LabelDecorators::childPt
SG::AuxElement::Decorator< float > childPt
Definition ParticleJetLabelCommon.h:54
ParticleJetTools::LabelDecorators::singleint
SG::AuxElement::Decorator< int > singleint
Definition ParticleJetLabelCommon.h:44

◆ setJetLabels() [2/2]

void ParticleJetTools::setJetLabels ( const xAOD::Jet & jet,
const Particles & particles,
const LabelNames & names )

Definition at line 283 of file ParticleJetLabelCommon.cxx.

285 {
286 setJetLabels(jet, particles, LabelDecorators(names));
287 }
ParticleJetTools::setJetLabels
void setJetLabels(const xAOD::Jet &jet, const Particles &particles, const LabelNames &names)
Definition ParticleJetLabelCommon.cxx:283

◆ signalProcessP3()

Amg::Vector3D ParticleJetTools::signalProcessP3 ( const xAOD::TruthEventContainer & events)

Definition at line 57 of file ParticleJetLabelCommon.cxx.

57 {
58 if (events.empty()) return {NAN, NAN, NAN};
59 return p3(events.at(0)->signalProcessVertex());
60 }
Generated on for ATLAS Offline Software by doxygen 1.16.1