This is a class for collecting variables used in continuum suppression. More...

#include <ContinuumSuppression.h>

Inheritance diagram for ContinuumSuppression:

Collaboration diagram for ContinuumSuppression:

[legend]

Public Member Functions
	ContinuumSuppression ()
	Default constructor. More...

void	addThrustB (const TVector3 &thrustB)
	Add ROE thrust axis. More...

void	addThrustO (const TVector3 &thrustO)
	Add ROE thrust axis. More...

void	addThrustBm (float thrustBm)
	Add magnitude of B thrust axis. More...

void	addThrustOm (float thrustOm)
	Add magnitude of ROE thrust axis. More...

void	addCosTBTO (float cosTBTO)
	Add cosine of the angle between the thrust axis of the B and the thrust axis of the ROE. More...

void	addCosTBz (float cosTBz)
	Add cosine of the angle between the thrust axis of the B and the z-axis. More...

void	addR2 (float R2)
	Add reduced Fox-Wolfram moment R2. More...

void	addKsfwFS0 (const std::vector< float > &ksfwFS0)
	Add vector of KSFW moments, Et, and mm2 for final state = 0. More...

void	addKsfwFS1 (const std::vector< float > &ksfwFS1)
	Add vector of KSFW moments, Et, and mm2 for final state = 1. More...

void	addCleoConesALL (const std::vector< float > &cleoConesALL)
	Add vector of Cleo Cones constructed of all final state particles. More...

void	addCleoConesROE (const std::vector< float > &cleoConesROE)
	Add vector of Cleo Cones constructed of only ROE particles. More...

TVector3	getThrustB (void) const
	Get B thrust axis. More...

TVector3	getThrustO (void) const
	Get ROE thrust axis. More...

float	getThrustBm (void) const
	Get magnitude of B thrust axis. More...

float	getThrustOm (void) const
	Get magnitude of ROE thrust axis. More...

float	getCosTBTO (void) const
	Get cosine of the angle between the thrust axis of the B and the thrust axis of the ROE. More...

float	getCosTBz (void) const
	Get cosine of the angle between the thrust axis of the B and the z-axis. More...

float	getR2 (void) const
	Get reduced Fox-Wolfram moment R2. More...

std::vector< float >	getKsfwFS0 (void) const
	Get vector of KSFW moments, Et, and mm2 for final state = 0. More...

std::vector< float >	getKsfwFS1 (void) const
	Get vector of KSFW moments, Et, and mm2 for final state = 1. More...

std::vector< float >	getCleoConesALL (void) const
	Get vector of Cleo Cones constructed of all final state particles. More...

std::vector< float >	getCleoConesROE (void) const
	Get vector of Cleo Cones constructed of only ROE particles. More...

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). More...

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). More...

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

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. More...

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. More...

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. More...

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

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

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. More...

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. More...

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. More...

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. More...

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

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

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

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
TVector3	m_thrustO
	ROE thrust axis.

TVector3	m_thrustB
	B thrust axis.

float	m_thrustBm
	magnitude of B thrust axis

float	m_thrustOm
	magnitude of ROE thrust axis

float	m_cosTBTO
	cosine of the angle between the thrust axis of the B and the thrust axis of the ROE

float	m_cosTBz
	cosine of the angle between the thrust axis of the B and the z-axis

float	m_R2
	reduced Fox-Wolfram moment R2

std::vector< float >	m_ksfwFS0
	vector of KSFW moments, Et, and mm2 for final state = 0

std::vector< float >	m_ksfwFS1
	vector of KSFW moments, Et, and mm2 for final state = 1

std::vector< float >	m_cleoConesALL
	vector of Cleo Cones constructed from all final state particles

std::vector< float >	m_cleoConesROE
	vector of Cleo Cones constructed from only ROE particles

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

This is a class for collecting variables used in continuum suppression.

These variables include: thrust related quantities; the reduced Fox-Wolfram moment R2; and the Super Fox Wolfram (KSFW) moments.

The KSFW moments are stored in separate vectors depending on whether the use_final_state_for_sig==0 (FS0) or ==1 (FS1). For FS0 the moments are calculated using the B primary daughters, while for FS1 they are calculated using the B final state daughters.

The CleoCones are stored in separate vectors depending on whether they are calculated using all final state particles (default method), or whether they are calculated using only particles from the ROE.

The ContinuumSuppression object is created for given existing Particle object by the ContinuumSuppressionBuilder module and are related between each other with a BASF2 relation.

Internally, the ContinuumSuppression class holds only floats and vectors of floats.

Definition at line 52 of file ContinuumSuppression.h.

Constructor & Destructor Documentation

◆ ContinuumSuppression()

ContinuumSuppression ( )

inline

Default constructor.

All private members are set to 0 (all vectors are empty).

Definition at line 60 of file ContinuumSuppression.h.

Member Function Documentation

◆ addCleoConesALL()

void addCleoConesALL ( const std::vector< float > & cleoConesALL )

Add vector of Cleo Cones constructed of all final state particles.

Parameters

cleoConesALL vector of Cleo Cones constructed of all final state particles

Definition at line 60 of file ContinuumSuppression.cc.

 {
   m_cleoConesALL = CleoConesALL;
 }

◆ addCleoConesROE()

void addCleoConesROE ( const std::vector< float > & cleoConesROE )

Add vector of Cleo Cones constructed of only ROE particles.

Parameters

cleoConesROE vector of Cleo Cones constructed of only ROE particles

Definition at line 65 of file ContinuumSuppression.cc.

◆ addCosTBTO()

void addCosTBTO ( float cosTBTO )

Add cosine of the angle between the thrust axis of the B and the thrust axis of the ROE.

Parameters

cosTBTO cosine of the angle between the thrust axis of the B and the thrust axis of the ROE

Definition at line 35 of file ContinuumSuppression.cc.

◆ addCosTBz()

void addCosTBz ( float cosTBz )

Add cosine of the angle between the thrust axis of the B and the z-axis.

Parameters

cosTBz cosine of the angle between the thrust axis of the B and the z-axis

Definition at line 40 of file ContinuumSuppression.cc.

◆ addKsfwFS0()

void addKsfwFS0 ( const std::vector< float > & ksfwFS0 )

Add vector of KSFW moments, Et, and mm2 for final state = 0.

Parameters

ksfwFS0 vector of KSFW moments, Et, and mm2 for final state = 0

Definition at line 50 of file ContinuumSuppression.cc.

◆ addKsfwFS1()

void addKsfwFS1 ( const std::vector< float > & ksfwFS1 )

Add vector of KSFW moments, Et, and mm2 for final state = 1.

Parameters

ksfwFS1 vector of KSFW moments, Et, and mm2 for final state = 1

Definition at line 55 of file ContinuumSuppression.cc.

◆ addR2()

void addR2 ( float R2 )

Add reduced Fox-Wolfram moment R2.

Parameters

R2	reduced Fox-Wolfram moment

Definition at line 45 of file ContinuumSuppression.cc.

◆ 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 144 of file RelationsObject.h.

◆ 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 157 of file RelationsObject.h.

◆ addThrustB()

void addThrustB ( const TVector3 & thrustB )

Add ROE thrust axis.

Parameters

thrustB B thrust axis

Definition at line 15 of file ContinuumSuppression.cc.

◆ addThrustBm()

void addThrustBm ( float thrustBm )

Add magnitude of B thrust axis.

Parameters

thrustBm magnitude of B thrust axis

Definition at line 25 of file ContinuumSuppression.cc.

◆ addThrustO()

void addThrustO ( const TVector3 & thrustO )

Add ROE thrust axis.

Parameters

thrustO ROE thrust axis

Definition at line 20 of file ContinuumSuppression.cc.

◆ addThrustOm()

void addThrustOm ( float thrustOm )

Add magnitude of ROE thrust axis.

Parameters

thrustOm magnitude of ROE thrust axis

Definition at line 30 of file ContinuumSuppression.cc.

◆ 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 172 of file RelationsObject.h.

◆ getCleoConesALL()

std::vector<float> getCleoConesALL ( void ) const

inline

Get vector of Cleo Cones constructed of all final state particles.

Returns: vector of Cleo Cones constructed of all final state particles

Definition at line 236 of file ContinuumSuppression.h.

◆ getCleoConesROE()

std::vector<float> getCleoConesROE ( void ) const

inline

Get vector of Cleo Cones constructed of only ROE particles.

Returns: vector of Cleo Cones constructed of only ROE particles

Definition at line 246 of file ContinuumSuppression.h.

◆ getCosTBTO()

float getCosTBTO ( void ) const

inline

Get cosine of the angle between the thrust axis of the B and the thrust axis of the ROE.

Returns: Float cosine of the angle between the thrust axis of the B and the thrust axis of the ROE

Definition at line 186 of file ContinuumSuppression.h.

◆ getCosTBz()

float getCosTBz ( void ) const

inline

Get cosine of the angle between the thrust axis of the B and the z-axis.

Returns: Float cosine of the angle between the thrust axis of the B and the z-axis

Definition at line 196 of file ContinuumSuppression.h.

◆ 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 372 of file RelationsObject.h.

◆ 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 TrackFitResult, TRGSummary, Track, SoftwareTriggerResult, Particle, RecoTrack, MCParticle, Cluster, and PIDLikelihood.

Definition at line 364 of file RelationsObject.h.

◆ getKsfwFS0()

std::vector<float> getKsfwFS0 ( void ) const

inline

Get vector of KSFW moments, Et, and mm2 for final state = 0.

Returns: vector of KSFW moments, Et, and mm2 for final state = 0

Definition at line 216 of file ContinuumSuppression.h.

◆ getKsfwFS1()

std::vector<float> getKsfwFS1 ( void ) const

inline

Get vector of KSFW moments, Et, and mm2 for final state = 1.

Returns: vector of KSFW moments, Et, and mm2 for final state = 1

Definition at line 226 of file ContinuumSuppression.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, Particle, and MCParticle.

Definition at line 346 of file RelationsObject.h.

◆ getR2()

float getR2 ( void ) const

inline

Get reduced Fox-Wolfram moment R2.

Returns: Float reduced Fox-Wolfram moment R2

Definition at line 206 of file ContinuumSuppression.h.

◆ 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 280 of file RelationsObject.h.

◆ 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 265 of file RelationsObject.h.

◆ 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 316 of file RelationsObject.h.

◆ 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 250 of file RelationsObject.h.

◆ 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 299 of file RelationsObject.h.

◆ 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 333 of file RelationsObject.h.

◆ 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 214 of file RelationsObject.h.

◆ 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 199 of file RelationsObject.h.

◆ 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 232 of file RelationsObject.h.

◆ getThrustB()

TVector3 getThrustB ( void ) const

inline

Get B thrust axis.

Returns: TVector3 ROE thrust axis

Definition at line 146 of file ContinuumSuppression.h.

◆ getThrustBm()

float getThrustBm ( void ) const

inline

Get magnitude of B thrust axis.

Returns: Float magnitude of B thrust axis

Definition at line 166 of file ContinuumSuppression.h.

◆ getThrustO()

TVector3 getThrustO ( void ) const

inline

Get ROE thrust axis.

Returns: TVector3 ROE thrust axis

Definition at line 156 of file ContinuumSuppression.h.

◆ getThrustOm()

float getThrustOm ( void ) const

inline

Get magnitude of ROE thrust axis.

Returns: Float magnitude of ROE thrust axis

Definition at line 176 of file ContinuumSuppression.h.

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ContinuumSuppression()

Member Function Documentation

◆ addCleoConesALL()

◆ addCleoConesROE()

◆ addCosTBTO()

◆ addCosTBz()

◆ addKsfwFS0()

◆ addKsfwFS1()

◆ addR2()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ addThrustB()

◆ addThrustBm()

◆ addThrustO()

◆ addThrustOm()

◆ copyRelations()

◆ getCleoConesALL()

◆ getCleoConesROE()

◆ getCosTBTO()

◆ getCosTBz()

◆ getInfo()

◆ getInfoHTML()

◆ getKsfwFS0()

◆ getKsfwFS1()

◆ getName()

◆ getR2()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getThrustB()

◆ getThrustBm()

◆ getThrustO()

◆ getThrustOm()