Rivet: /Users/chrisg/software/rivet/include/Rivet/Projections/Sphericity.hh Source File

| Rivet 3.1.9

Sphericity.hh
1// -*- C++ -*-
2#ifndef RIVET_Sphericity_HH
3#define RIVET_Sphericity_HH
4
5#include "Rivet/Projection.hh"
6#include "Rivet/Projections/AxesDefinition.hh"
7#include "Rivet/Projections/FinalState.hh"
8#include "Rivet/Event.hh"
9#include "Rivet/Jet.fhh"
10
11namespace Rivet {
12
13
14
52 class Sphericity : public AxesDefinition {
53 public:
54
56
57
59 Sphericity(double rparam=2.0): _regparam(rparam){}
60
61 Sphericity(const FinalState& fsp, double rparam=2.0);
62
64 DEFAULT_RIVET_PROJ_CLONE(Sphericity);
65
67
69 using Projection::operator =;
70
71
72 protected:
73
75 void project(const Event& e);
76
78 CmpState compare(const Projection& p) const;
79
80
81 public:
82
84 void clear();
85
87
88
89 double sphericity() const { return 3.0 / 2.0 * (lambda2() + lambda3()); }
91 double transSphericity() const { return 2.0 * lambda2() / ( lambda1() + lambda2() ); }
93 double planarity() const { return 2 * (sphericity() - 2 * aplanarity()) / 3.0; }
95 double aplanarity() const { return 3 / 2.0 * lambda3(); }
97
98
100
101
102 const Vector3& sphericityAxis() const { return _sphAxes[0]; }
104 const Vector3& sphericityMajorAxis() const { return _sphAxes[1]; }
106 const Vector3& sphericityMinorAxis() const { return _sphAxes[2]; }
108
109
111
112 const Vector3& axis1() const { return sphericityAxis(); }
113 const Vector3& axis2() const { return sphericityMajorAxis(); }
114 const Vector3& axis3() const { return sphericityMinorAxis(); }
116
117
119
120 double lambda1() const { return _lambdas[0]; }
121 double lambda2() const { return _lambdas[1]; }
122 double lambda3() const { return _lambdas[2]; }
124
125 Vector3 mkEigenVector(Matrix3 A, const double &lambda);
126
129
130
132 void calc(const FinalState& fs);
133
135 void calc(const Particles& particles);
136
138 void calc(const Jets& jets);
139
141 void calc(const vector<FourMomentum>& momenta);
142
146 void calc(const vector<Vector3>& momenta);
147
149
150
151 protected:
152
154 vector<double> _lambdas;
155
157 vector<Vector3> _sphAxes;
158
160 const double _regparam;
161
162 };
163
164
165}
166
167#endif
Rivet::AxesDefinition
Base class for projections which define a spatial basis.
Definition AxesDefinition.hh:19
Rivet::Event
Representation of a HepMC event, and enabler of Projection caching.
Definition Event.hh:22
Rivet::FinalState
Project out all final-state particles in an event. Probably the most important projection in Rivet!
Definition FinalState.hh:12
Rivet::Jets
Specialised vector of Jet objects.
Definition Jet.hh:23
Rivet::Particles
Specialised vector of Particle objects.
Definition Particle.hh:25
Rivet::Projection
Base class for all Rivet projections.
Definition Projection.hh:29
Rivet::Sphericity
Calculate the sphericity event shape.
Definition Sphericity.hh:52
Rivet::Sphericity::axis3
const Vector3 & axis3() const
The least significant ("minor") axis.
Definition Sphericity.hh:114
Rivet::Sphericity::axis1
const Vector3 & axis1() const
Definition Sphericity.hh:112
Rivet::Sphericity::project
void project(const Event &e)
Perform the projection on the Event.
Rivet::Sphericity::transSphericity
double transSphericity() const
Transverse sphericity.
Definition Sphericity.hh:91
Rivet::Sphericity::calc
void calc(const Particles &particles)
Manually calculate the sphericity, without engaging the caching system.
Rivet::Sphericity::compare
CmpState compare(const Projection &p) const
Compare with other projections.
Rivet::Sphericity::Sphericity
Sphericity(double rparam=2.0)
Constructor.
Definition Sphericity.hh:59
Rivet::Sphericity::planarity
double planarity() const
Planarity.
Definition Sphericity.hh:93
Rivet::Sphericity::calc
void calc(const FinalState &fs)
Manually calculate the sphericity, without engaging the caching system.
Rivet::Sphericity::clear
void clear()
Reset the projection.
Rivet::Sphericity::calc
void calc(const vector< FourMomentum > &momenta)
Manually calculate the sphericity, without engaging the caching system.
Rivet::Sphericity::sphericityAxis
const Vector3 & sphericityAxis() const
Sphericity axis.
Definition Sphericity.hh:102
Rivet::Sphericity::aplanarity
double aplanarity() const
Aplanarity.
Definition Sphericity.hh:95
Rivet::Sphericity::calc
void calc(const Jets &jets)
Manually calculate the sphericity, without engaging the caching system.
Rivet::Sphericity::sphericityMinorAxis
const Vector3 & sphericityMinorAxis() const
Sphericity minor axis.
Definition Sphericity.hh:106
Rivet::Sphericity::axis2
const Vector3 & axis2() const
The 2nd most significant ("major") axis.
Definition Sphericity.hh:113
Rivet::Sphericity::sphericityMajorAxis
const Vector3 & sphericityMajorAxis() const
Sphericity major axis.
Definition Sphericity.hh:104
Rivet::Sphericity::sphericity
double sphericity() const
Sphericity.
Definition Sphericity.hh:89
Rivet::Sphericity::calc
void calc(const vector< Vector3 > &momenta)
Manually calculate the sphericity, without engaging the caching system.
Rivet::Sphericity::DEFAULT_RIVET_PROJ_CLONE
DEFAULT_RIVET_PROJ_CLONE(Sphericity)
Clone on the heap.
Rivet::Vector3
Three-dimensional specialisation of Vector.
Definition Vector3.hh:40
Rivet::Kin::p
double p(const ParticleBase &p)
Unbound function access to p.
Definition ParticleBaseUtils.hh:684
Rivet
Definition MC_Cent_pPb.hh:10