Class for collecting variables related to tau-taubar MC decay process. More...

#include <TauPairDecay.h>

Inheritance diagram for TauPairDecay:

Public Member Functions
	TauPairDecay ()
	Default constructor.

void	addTauPlusIdMode (int pmode)
	Add ID of positive tau decay.

void	addTauMinusIdMode (int mmode)
	Add ID of negative tau decay.

void	addTauPlusMcProng (int pprong)
	Add prong of positive tau decay.

void	addTauMinusMcProng (int mprong)
	Add prong of negative tau decay.

void	addTauMinusEgstar (double megstar)
	Add energy of radiated photon from negative tau decay [in tau- rest frame].

void	addTauPlusEgstar (double pegstar)
	Add energy of radiated photon from positive tau decay [in tau+ rest frame].

int	getTauPlusIdMode (void) const
	Get ID of positive tau decay.

int	getTauMinusIdMode (void) const
	Get ID of negative tau decay.

int	getTauPlusMcProng (void) const
	Get prong of positive tau decay.

int	getTauMinusMcProng (void) const
	Get prong of negative tau decay.

double	getTauMinusEgstar (void) const
	Get energy of radiated photon from negative tau decay [in tau- rest frame].

double	getTauPlusEgstar (void) const
	Get energy of radiated photon from positive tau decay [in tau+ rest frame].

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching).

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow).

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.

template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array.

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array.

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array.

virtual std::string	getName () const
	Return a short name that describes this object, e.g.

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Protected Member Functions
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Private Member Functions
	ClassDef (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
int	m_pmode
	Decay ID of positive tau lepton decay.

int	m_mmode
	Decay ID of negative tau lepton decay.

int	m_pprong
	Prong of positive tau lepton decay.

int	m_mprong
	Prong of negative tau lepton decay.

double	m_megstar
	Energy of photon from negative tau decay.

double	m_pegstar
	Energy of photon from positive tau decay.

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Detailed Description

Class for collecting variables related to tau-taubar MC decay process.

Definition at line 25 of file TauPairDecay.h.

Constructor & Destructor Documentation

◆ TauPairDecay()

TauPairDecay ( )

inline

Default constructor.

All private members are set to 0.

Definition at line 33 of file TauPairDecay.h.

33: m_pmode(0.0), m_mmode(0.0), m_pprong(0.0), m_mprong(0.0), m_megstar(0), m_pegstar(0) {};

Belle2::TauPairDecay::m_mprong

int m_mprong

Prong of negative tau lepton decay.

Definition: TauPairDecay.h:144

Belle2::TauPairDecay::m_pprong

int m_pprong

Prong of positive tau lepton decay.

Definition: TauPairDecay.h:143

Belle2::TauPairDecay::m_pegstar

double m_pegstar

Energy of photon from positive tau decay.

Definition: TauPairDecay.h:146

Belle2::TauPairDecay::m_pmode

int m_pmode

Decay ID of positive tau lepton decay.

Definition: TauPairDecay.h:141

Belle2::TauPairDecay::m_mmode

int m_mmode

Decay ID of negative tau lepton decay.

Definition: TauPairDecay.h:142

Belle2::TauPairDecay::m_megstar

double m_megstar

Energy of photon from negative tau decay.

Definition: TauPairDecay.h:145

Member Function Documentation

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

◆ addTauMinusEgstar()

void addTauMinusEgstar ( double megstar )

Add energy of radiated photon from negative tau decay [in tau- rest frame].

Parameters

megstar egstar of generated tau- decay.

Definition at line 33 of file TauPairDecay.cc.

{
  m_megstar = megstar;
}

◆ addTauMinusIdMode()

void addTauMinusIdMode ( int mmode )

Add ID of negative tau decay.

Parameters

mmode ID of generated decay.

Definition at line 18 of file TauPairDecay.cc.

{
  m_mmode = mmode;
}

◆ addTauMinusMcProng()

void addTauMinusMcProng ( int mprong )

Add prong of negative tau decay.

Parameters

mprong prong of generated tau decay.

Definition at line 28 of file TauPairDecay.cc.

{
  m_mprong = mprong;
}

◆ addTauPlusEgstar()

void addTauPlusEgstar ( double pegstar )

Add energy of radiated photon from positive tau decay [in tau+ rest frame].

Parameters

pegstar egstar of generated tau+ decay.

Definition at line 38 of file TauPairDecay.cc.

{
  m_pegstar = pegstar;
}

◆ addTauPlusIdMode()

void addTauPlusIdMode ( int pmode )

Add ID of positive tau decay.

Parameters

pmode ID of generated decay.

Definition at line 13 of file TauPairDecay.cc.

{
  m_pmode = pmode;
}

◆ addTauPlusMcProng()

void addTauPlusMcProng ( int pprong )

Add prong of positive tau decay.

Parameters

pprong prong of generated tau decay.

Definition at line 23 of file TauPairDecay.cc.

{
  m_pprong = pprong;
}

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ getArrayIndex()

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also: Particle::getInfoHTML() for a more complex example.; HTML for some utility functions.; Use getInfo() to get a raw text version of this output.

Reimplemented in Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getRelated()

T * getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

◆ getRelatedFrom()

FROM * getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

◆ getRelatedFromWithWeight()

std::pair< FROM *, float > getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

◆ getRelatedTo()

TO * getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

◆ getRelatedToWithWeight()

std::pair< TO *, float > getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

◆ getRelatedWithWeight()

std::pair< T *, float > getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

◆ getRelationsFrom()

RelationVector< FROM > getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

◆ getRelationsTo()

RelationVector< TO > getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

◆ getRelationsWith()

RelationVector< T > getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ getTauMinusEgstar()

double getTauMinusEgstar ( void ) const

inline

Get energy of radiated photon from negative tau decay [in tau- rest frame].

Returns: Energy of radiated photon from generated tau- decay

Definition at line 123 of file TauPairDecay.h.

    {
      return m_megstar;
    }

◆ getTauMinusIdMode()

int getTauMinusIdMode ( void ) const

inline

Get ID of negative tau decay.

Returns: Id of generated decay

Definition at line 93 of file TauPairDecay.h.

    {
      return m_mmode;
    }

◆ getTauMinusMcProng()

int getTauMinusMcProng ( void ) const

inline

Get prong of negative tau decay.

Returns: Prong of generated tau decay

Definition at line 113 of file TauPairDecay.h.

    {
      return m_mprong;
    }

◆ getTauPlusEgstar()

double getTauPlusEgstar ( void ) const

inline

Get energy of radiated photon from positive tau decay [in tau+ rest frame].

Returns: Energy of radiated photon from generated tau+ decay

Definition at line 133 of file TauPairDecay.h.

    {
      return m_pegstar;
    }

◆ getTauPlusIdMode()

int getTauPlusIdMode ( void ) const

inline

Get ID of positive tau decay.

Returns: Id of generated decay

Definition at line 83 of file TauPairDecay.h.

    {
      return m_pmode;
    }

◆ getTauPlusMcProng()

int getTauPlusMcProng ( void ) const

inline

Get prong of positive tau decay.

Returns: Prong of generated tau decay

Definition at line 103 of file TauPairDecay.h.

    {
      return m_pprong;
    }

Member Data Documentation

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_megstar

double m_megstar

private

Energy of photon from negative tau decay.

Definition at line 145 of file TauPairDecay.h.

◆ m_mmode

int m_mmode

private

Decay ID of negative tau lepton decay.

Definition at line 142 of file TauPairDecay.h.

◆ m_mprong

int m_mprong

private

Prong of negative tau lepton decay.

Definition at line 144 of file TauPairDecay.h.

◆ m_pegstar

double m_pegstar

private

Energy of photon from positive tau decay.

Definition at line 146 of file TauPairDecay.h.

◆ m_pmode

int m_pmode

private

Decay ID of positive tau lepton decay.

Definition at line 141 of file TauPairDecay.h.

◆ m_pprong

int m_pprong

private

Prong of positive tau lepton decay.

Definition at line 143 of file TauPairDecay.h.

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

analysis/dataobjects/include/TauPairDecay.h
analysis/dataobjects/src/TauPairDecay.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TauPairDecay()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ addTauMinusEgstar()

◆ addTauMinusIdMode()

◆ addTauMinusMcProng()

◆ addTauPlusEgstar()

◆ addTauPlusIdMode()

◆ addTauPlusMcProng()

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTauMinusEgstar()

◆ getTauMinusIdMode()

◆ getTauMinusMcProng()

◆ getTauPlusEgstar()

◆ getTauPlusIdMode()

◆ getTauPlusMcProng()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_megstar

◆ m_mmode

◆ m_mprong

◆ m_pegstar

◆ m_pmode

◆ m_pprong