#include <FParameter.hh>

Public Member Functions
void	clear ()
	Reset the projection.
bool	before (const Projection &p) const
virtual const std::set< PdgIdPair >	beamPairs () const
virtual std::string	name () const
	Get the name of the projection.
Projection &	addPdgIdPair (PdgId beam1, PdgId beam2)
	Add a colliding beam pair.
Log &	getLog () const
	Get a Log object based on the getName() property of the calling projection object.
void	setName (const std::string &name)
	Used by derived classes to set their name.
void	markAsOwned () const
Constructors etc.
	FParameter (const FinalState &fsp)
	Constructor.
	DEFAULT_RIVET_PROJ_CLONE (FParameter)
	Clone on the heap.
Access the event shapes by name
F-Parametr
double	F () const
Access the linearised transverse momentum tensor eigenvalues
double	lambda1 () const
double	lambda2 () const
Direct methods
Ways to do the calculation directly, without engaging the caching system
void	calc (const FinalState &fs)
	Manually calculate the sphericity, without engaging the caching system.
void	calc (const vector< Particle > &fsparticles)
	Manually calculate the sphericity, without engaging the caching system.
void	calc (const vector< FourMomentum > &fsmomenta)
	Manually calculate the sphericity, without engaging the caching system.
void	calc (const vector< Vector3 > &fsmomenta)
	Manually calculate the sphericity, without engaging the caching system.
Standard constructors and destructors.
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () const
	Get the contained projections, including recursion.
template<typename PROJ >
const PROJ &	getProjection (const std::string &name) const
const Projection &	getProjection (const std::string &name) const
template<typename PROJ >
const PROJ &	get (const std::string &name) const
Projection applying functions
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const Projection &proj) const
	Apply the supplied projection on event evt.
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const PROJ &proj) const
	Apply the supplied projection on event evt.
template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const std::string &name) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const Projection &proj) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const PROJ &proj) const
template<typename PROJ >
const PROJ &	apply (const Event &evt, const std::string &name) const
Protected Member Functions
void	project (const Event &e)
	Perform the projection on the Event.
int	compare (const Projection &p) const
	Compare with other projections.
Cmp< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.
const Projection &	_applyProjection (const Event &evt, const std::string &name) const
const Projection &	_applyProjection (const Event &evt, const Projection &proj) const
Projection registration functions
template<typename PROJ >
const PROJ &	declareProjection (const PROJ &proj, const std::string &name)
	Register a contained projection.
template<typename PROJ >
const PROJ &	declare (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version)
template<typename PROJ >
const PROJ &	addProjection (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version)
const Projection &	_declareProjection (const Projection &proj, const std::string &name)
	Untemplated function to do the work...
Protected Attributes
bool	_allowProjReg
	Flag to forbid projection registration in analyses until the init phase.
Private Member Functions
void	_calcFParameter (const vector< Vector3 > &fsmomenta)
	Actually do the calculation.
Private Attributes
vector< double >	_lambdas
	Eigenvalues.
Friends
class	Event
	Event is a friend.
class	Cmp< Projection >
	The Cmp specialization for Projection is a friend.

Detailed Description

Definition at line 12 of file FParameter.hh.

Constructor & Destructor Documentation

FParameter ( const FinalState & fsp )

Constructor.

Definition at line 6 of file FParameter.cc.

                                              {
    setName("FParameter");
    addProjection(fsp, "FS");
    clear();
  }

Member Function Documentation

const Projection & _applyProjection	(	const Event &	evt,
		const std::string &	name
	)		const `[protected, inherited]`

Non-templated version of string-based applyProjection, to work around header dependency issue.

Definition at line 22 of file ProjectionApplier.cc.

                                                                                  {
    return evt.applyProjection(getProjection(name));
  }

const Projection & _applyProjection	(	const Event &	evt,
		const Projection &	proj
	)		const `[protected, inherited]`

Non-templated version of proj-based applyProjection, to work around header dependency issue.

Definition at line 28 of file ProjectionApplier.cc.

                                                                                      {
    return evt.applyProjection(proj);
  }

void _calcFParameter ( const vector< Vector3 > & fsmomenta ) [private]

Actually do the calculation.

Definition at line 52 of file FParameter.cc.

                                                                   {

    // Return (with "safe nonsense" sphericity params) if there are no final state particles.
    if (fsmomenta.empty()) {
      MSG_DEBUG("No particles in final state...");
      clear();
      return;
    }

    // A small iteration over full momenta but set z-coord. to 0.0 to get transverse momenta
    vector <Vector3> fsperpmomenta;
    foreach (const Vector3& p, fsmomenta) {
      fsperpmomenta.push_back(Vector3(p.x(), p.y(), 0.0));
    }

    // Iterate over all the final state particles.
    Matrix<2> mMom;
    MSG_DEBUG("Number of particles = " << fsperpmomenta.size());
    foreach (const Vector3& p3, fsperpmomenta) {

      double prefactor = 1.0/p3.mod();

      Matrix<2> mMomPart;
      for (size_t i = 0; i < 2; ++i) {
        for (size_t j = 0; j < 2; ++j) {
          mMomPart.set(i,j, p3[i]*p3[j]);
        }
      }
      mMom += prefactor * mMomPart;
    }

    MSG_DEBUG("Linearised transverse momentum tensor = " << mMom);

    // Check that the matrix is symmetric.
    const bool isSymm = mMom.isSymm();
    if (!isSymm) {
      MSG_ERROR("Error: momentum tensor not symmetric:");
      MSG_ERROR("[0,1] vs. [1,0]: " << mMom.get(0,1) << ", " << mMom.get(1,0));
      MSG_ERROR("[0,2] vs. [2,0]: " << mMom.get(0,2) << ", " << mMom.get(2,0));
      MSG_ERROR("[1,2] vs. [2,1]: " << mMom.get(1,2) << ", " << mMom.get(2,1));
    }
    // If not symmetric, something's wrong (we made sure the error msg appeared first).
    assert(isSymm);

    // Diagonalize momentum matrix.
    const EigenSystem<2> eigen2 = diagonalize(mMom);
    MSG_DEBUG("Diag momentum tensor = " << eigen2.getDiagMatrix());

    // Reset and set eigenvalue parameters.
    _lambdas.clear();
    const EigenSystem<2>::EigenPairs epairs = eigen2.getEigenPairs();
    assert(epairs.size() == 2);
    for (size_t i = 0; i < 2; ++i) {
      _lambdas.push_back(epairs[i].first);
    }

    // Debug output.
    MSG_DEBUG("Lambdas = ("
             << lambda1() << ", " << lambda2() << ")");
    MSG_DEBUG("Sum of lambdas = " << lambda1() + lambda2());
  }

const Projection & _declareProjection	(	const Projection &	proj,
		const std::string &	name
	)		`[protected, inherited]`

Untemplated function to do the work...

Definition at line 34 of file ProjectionApplier.cc.

                                                                             {
    if (!_allowProjReg) {
      cerr << "Trying to register projection '"
           << proj.name() << "' before init phase in '" << this->name() << "'." << endl;
      exit(2);
    }
    const Projection& reg = getProjHandler().registerProjection(*this, proj, name);
    return reg;
  }

Projection& addPdgIdPair	(	PdgId	beam1,
		PdgId	beam2
	)		`[inline, inherited]`

Add a colliding beam pair.

Definition at line 108 of file Projection.hh.

                                                       {
      _beamPairs.insert(PdgIdPair(beam1, beam2));
      return *this;
    }

const PROJ& addProjection	(	const PROJ &	proj,
		const std::string &	name
	)		`[inline, protected, inherited]`

Register a contained projection (user-facing version)

Deprecated:: Use declareProjection() or declare()

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 157 of file ProjectionApplier.hh.

{ return declareProjection(proj, name); }

const PROJ& apply	(	const Event &	evt,
		const Projection &	proj
	)		const `[inline, inherited]`

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 80 of file ProjectionApplier.hh.

{ return applyProjection<PROJ>(evt, proj); }

const PROJ& apply	(	const Event &	evt,
		const PROJ &	proj
	)		const `[inline, inherited]`

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 92 of file ProjectionApplier.hh.

{ return applyProjection<PROJ>(evt, proj); }

const PROJ& apply	(	const Event &	evt,
		const std::string &	name
	)		const `[inline, inherited]`

Apply the supplied projection on event evt (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 104 of file ProjectionApplier.hh.

{ return applyProjection<PROJ>(evt, name); }

const PROJ& applyProjection	(	const Event &	evt,
		const Projection &	proj
	)		const `[inline, inherited]`

Apply the supplied projection on event evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 74 of file ProjectionApplier.hh.

                                                                                {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }

const PROJ& applyProjection	(	const Event &	evt,
		const PROJ &	proj
	)		const `[inline, inherited]`

Apply the supplied projection on event evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 86 of file ProjectionApplier.hh.

                                                                          {
      return pcast<PROJ>(_applyProjection(evt, proj));
    }

const PROJ& applyProjection	(	const Event &	evt,
		const std::string &	name
	)		const `[inline, inherited]`

Apply the named projection on event evt.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 98 of file ProjectionApplier.hh.

                                                                               {
      return pcast<PROJ>(_applyProjection(evt, name));
    }

const set< PdgIdPair > beamPairs ( ) const [virtual, inherited]

Return the allowed beam pairs on which this projection can operate, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Todo:: Remove the beam constraints system from projections.

Definition at line 35 of file Projection.cc.

                                                   {
    set<PdgIdPair> ret = _beamPairs;
    set<ConstProjectionPtr> projs = getProjections();
    for (set<ConstProjectionPtr>::const_iterator ip = projs.begin(); ip != projs.end(); ++ip) {
      ConstProjectionPtr p = *ip;
      getLog() << Log::TRACE << "Proj addr = " << p << endl;
      if (p) ret = intersection(ret, p->beamPairs());
    }
    return ret;
  }

bool before ( const Projection & p ) const [inherited]

Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned.

Definition at line 24 of file Projection.cc.

                                                   {
    const std::type_info& thisid = typeid(*this);
    const std::type_info& otherid = typeid(p);
    if (thisid == otherid) {
      return compare(p) < 0;
    } else {
      return thisid.before(otherid);
    }
  }

void calc ( const FinalState & fs )

Manually calculate the sphericity, without engaging the caching system.

Definition at line 24 of file FParameter.cc.

                                            {
    calc(fs.particles());
  }

void calc ( const vector< Particle > & fsparticles )

Manually calculate the sphericity, without engaging the caching system.

Definition at line 28 of file FParameter.cc.

                                                           {
    vector<Vector3> threeMomenta;
    threeMomenta.reserve(fsparticles.size());
    foreach (const Particle& p, fsparticles) {
      const Vector3 p3 = p.momentum().vector3();
      threeMomenta.push_back(p3);
    }
    _calcFParameter(threeMomenta);
  }

void calc ( const vector< FourMomentum > & fsmomenta )

Manually calculate the sphericity, without engaging the caching system.

Definition at line 38 of file FParameter.cc.

                                                             {
    vector<Vector3> threeMomenta;
    threeMomenta.reserve(fsmomenta.size());
    foreach (const FourMomentum& v, fsmomenta) {
      threeMomenta.push_back(v.vector3());
    }
    _calcFParameter(threeMomenta);
  }

void calc ( const vector< Vector3 > & fsmomenta )

Manually calculate the sphericity, without engaging the caching system.

Definition at line 47 of file FParameter.cc.

                                                        {
    _calcFParameter(fsmomenta);
  }

void clear ( )

Reset the projection.

Definition at line 13 of file FParameter.cc.

                         {
    _lambdas = vector<double>(2, 0);
  }

virtual unique_ptr<Projection> clone ( ) const [pure virtual, inherited]

Clone on the heap.

Implemented in JetAlg, AxesDefinition, and ParticleFinder.

int compare ( const Projection & p ) const [inline, protected, virtual]

Compare with other projections.

Implements Projection.

Definition at line 35 of file FParameter.hh.

                                           {
      return mkNamedPCmp(p, "FS");
    }

const PROJ& declare	(	const PROJ &	proj,
		const std::string &	name
	)		`[inline, protected, inherited]`

Register a contained projection (user-facing version)

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 151 of file ProjectionApplier.hh.

{ return declareProjection(proj, name); }

const PROJ& declareProjection	(	const PROJ &	proj,
		const std::string &	name
	)		`[inline, protected, inherited]`

Register a contained projection.

The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 142 of file ProjectionApplier.hh.

                                                                           {
      const Projection& reg = _declareProjection(proj, name);
      const PROJ& rtn = dynamic_cast<const PROJ&>(reg);
      return rtn;
    }

DEFAULT_RIVET_PROJ_CLONE ( FParameter )

Clone on the heap.

double F ( ) const [inline]

Definition at line 46 of file FParameter.hh.

{ return lambda1() >= lambda2() ? lambda2()/lambda1() : lambda1()/lambda2(); }

const PROJ& get ( const std::string & name ) const [inline, inherited]

Get the named projection, specifying return type via a template argument (user-facing alias).

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 57 of file ProjectionApplier.hh.

{ return getProjection<PROJ>(name); }

Log& getLog ( ) const [inline, inherited]

Get a Log object based on the getName() property of the calling projection object.

Reimplemented from ProjectionApplier.

Definition at line 115 of file Projection.hh.

                        {
      string logname = "Rivet.Projection." + name();
      return Log::getLog(logname);
    }

const PROJ& getProjection ( const std::string & name ) const [inline, inherited]

Get the named projection, specifying return type via a template argument.

Todo:: Add SFINAE to require that PROJ inherit from Projection

Definition at line 50 of file ProjectionApplier.hh.

                                                           {
      const Projection& p = getProjHandler().getProjection(*this, name);
      return pcast<PROJ>(p);
    }

const Projection& getProjection ( const std::string & name ) const [inline, inherited]

Get the named projection (non-templated, so returns as a reference to a Projection base class).

Definition at line 61 of file ProjectionApplier.hh.

                                                                 {
      return getProjHandler().getProjection(*this, name);
    }

std::set<ConstProjectionPtr> getProjections ( ) const [inline, inherited]

Get the contained projections, including recursion.

Definition at line 43 of file ProjectionApplier.hh.

                                                      {
      return getProjHandler().getChildProjections(*this, ProjectionHandler::DEEP);
    }

ProjectionHandler& getProjHandler ( ) const [inline, protected, inherited]

Get a reference to the ProjectionHandler for this thread.

Definition at line 122 of file ProjectionApplier.hh.

                                              {
      return _projhandler;
    }

double lambda1 ( ) const [inline]

Definition at line 51 of file FParameter.hh.

{ return _lambdas[0]; }

double lambda2 ( ) const [inline]

Definition at line 52 of file FParameter.hh.

{ return _lambdas[1]; }

void markAsOwned ( ) const [inline, inherited]

Mark object as owned by the _projhandler

Todo:: Huh? What's this for?

Definition at line 111 of file ProjectionApplier.hh.

{ _owned = true; }

Cmp< Projection > mkNamedPCmp	(	const Projection &	otherparent,
		const std::string &	pname
	)		const `[protected, inherited]`

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Definition at line 47 of file Projection.cc.

                                                                                                  {
    return pcmp(*this, otherparent, pname);
  }

Cmp< Projection > mkPCmp	(	const Projection &	otherparent,
		const std::string &	pname
	)		const `[protected, inherited]`

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Note:: Alias for mkNamedPCmp

Definition at line 51 of file Projection.cc.

                                                                                             {
    return pcmp(*this, otherparent, pname);
  }

virtual std::string name ( ) const [inline, virtual, inherited]

Get the name of the projection.

Implements ProjectionApplier.

Definition at line 102 of file Projection.hh.

                                   {
      return _name;
    }

void project ( const Event & e ) [protected, virtual]

Perform the projection on the Event.

Implements Projection.

Definition at line 18 of file FParameter.cc.

                                         {
    const Particles prts = applyProjection<FinalState>(e, "FS").particles();
    calc(prts);
  }

void setName ( const std::string & name ) [inline, inherited]

Used by derived classes to set their name.

Definition at line 121 of file Projection.hh.

                                        {
      _name = name;
    }

Friends And Related Function Documentation

friend class Cmp< Projection > [friend, inherited]

The Cmp specialization for Projection is a friend.

Definition at line 36 of file Projection.hh.

friend class Event [friend, inherited]

Event is a friend.

Definition at line 33 of file Projection.hh.

Member Data Documentation

bool _allowProjReg [protected, inherited]

Flag to forbid projection registration in analyses until the init phase.

Definition at line 176 of file ProjectionApplier.hh.

vector<double> _lambdas [private]

Eigenvalues.

Definition at line 75 of file FParameter.hh.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation