Class to store T0 information. More...

#include <TOPTimeZero.h>

Inheritance diagram for TOPTimeZero:

Collaboration diagram for TOPTimeZero:

[legend]

Public Member Functions
	TOPTimeZero ()
	Default constructor.

	TOPTimeZero (int moduleID, double t0, double err, int numPhotons)
	Usefull constructor. More...

void	setHistograms (const TH1F &chi2, const TH1F &pdf, const TH1F &hits)
	Sets histograms. More...

void	setAssumedMass (double mass)
	Sets particle mass used in reconstruction. More...

void	setInvalid ()
	Sets time zero to invalid. More...

void	setMinChi2 (double minChi2)
	Sets chi2 value at minimum. More...

unsigned	getModuleID () const
	Returns slot number used to determine t0. More...

double	getTime () const
	Returns time zero. More...

double	getError () const
	Returns time zero uncertainty. More...

double	getMinChi2 () const
	Returns chi2 value at minimum. More...

int	getNumPhotons () const
	Returns number of photons used to find minimum. More...

const TH1F &	getChi2 () const
	Returns histogram of chi^2 versus t0 that was used to find minimum. More...

const TH1F &	getPDF () const
	Returns histogram of PDF projected to time axis. More...

const TH1F &	getHits () const
	Returns histogram of time distribution of hits. More...

double	getAssumedMass () const
	Returns particle mass used in time zero reconstruction. More...

bool	isValid () const
	Returns the status of time zero reconstruction. 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 (TOPTimeZero, 4)
	ClassDef.

Private Attributes
int	m_moduleID = 0
	slot number (1-based)

float	m_t0 = 0
	time zero in [ns]

float	m_err = 0
	error on time zero [ns]

int	m_numPhotons = 0
	number of photons

TH1F	m_chi2
	chi^2 versus t0 used to find minimum

TH1F	m_pdf
	PDF projected to time.

TH1F	m_hits
	time distribution of hits

float	m_assumedMass = 0
	particle mass used in reconstruction

bool	m_valid = false
	status: true if time zero is successfully determined

float	m_minChi2 = 0
	chi2 value at minimum

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 to store T0 information.

Definition at line 24 of file TOPTimeZero.h.

Constructor & Destructor Documentation

◆ TOPTimeZero()

TOPTimeZero	(	int	moduleID,
		double	t0,
		double	err,
		int	numPhotons
	)

inline

Usefull constructor.

Parameters

moduleID	slot number, photon hits from this slot used to determine t0
t0	value of t0
err	estimated error on t0
numPhotons	number of photon hits used to find minimum

Definition at line 40 of file TOPTimeZero.h.

                                                                     :
       m_moduleID(moduleID), m_t0(t0), m_err(err), m_numPhotons(numPhotons), m_valid(true)
     {}

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.

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

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

◆ getAssumedMass()

double getAssumedMass ( ) const

inline

Returns particle mass used in time zero reconstruction.

Returns: particle mass

Definition at line 126 of file TOPTimeZero.h.

◆ getChi2()

const TH1F& getChi2 ( ) const

inline

Returns histogram of chi^2 versus t0 that was used to find minimum.

Returns: 1D histogram

Definition at line 108 of file TOPTimeZero.h.

◆ getError()

double getError ( ) const

inline

Returns time zero uncertainty.

Returns: uncertainty [ns]

Definition at line 90 of file TOPTimeZero.h.

◆ getHits()

const TH1F& getHits ( ) const

inline

Returns histogram of time distribution of hits.

Returns: 1D histogram

Definition at line 120 of file TOPTimeZero.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 370 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 RecoTrack, TRGSummary, TrackFitResult, Track, SoftwareTriggerResult, PIDLikelihood, MCParticle, Cluster, and Particle.

Definition at line 362 of file RelationsObject.h.

◆ getMinChi2()

double getMinChi2 ( ) const

inline

Returns chi2 value at minimum.

Returns: chi2 at minimum

Definition at line 96 of file TOPTimeZero.h.

◆ getModuleID()

unsigned getModuleID ( ) const

inline

Returns slot number used to determine t0.

Returns: slot number (1-based)

Definition at line 78 of file TOPTimeZero.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, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ getNumPhotons()

int getNumPhotons ( ) const

inline

Returns number of photons used to find minimum.

Returns: number of photons

Definition at line 102 of file TOPTimeZero.h.

◆ getPDF()

const TH1F& getPDF ( ) const

inline

Returns histogram of PDF projected to time axis.

Returns: 1D histogram

Definition at line 114 of file TOPTimeZero.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 278 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 263 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 314 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 248 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 297 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 331 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 212 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 197 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 230 of file RelationsObject.h.

◆ getTime()

double getTime ( ) const

inline

Returns time zero.

Returns: time zero [ns]

Definition at line 84 of file TOPTimeZero.h.

◆ isValid()

bool isValid ( ) const

inline

Returns the status of time zero reconstruction.

Returns: true if successfully determined

Definition at line 132 of file TOPTimeZero.h.

◆ setAssumedMass()

void setAssumedMass ( double mass )

inline

Sets particle mass used in reconstruction.

Parameters

mass	particle mass

Definition at line 61 of file TOPTimeZero.h.

◆ setHistograms()

void setHistograms	(	const TH1F &	chi2,
		const TH1F &	pdf,
		const TH1F &	hits
	)

inline

Sets histograms.

Parameters

chi2	chi^2 versus t0 used to find minimum
pdf	PDF projected to time axis
hits	time distribution of hits

Definition at line 50 of file TOPTimeZero.h.

◆ setInvalid()

void setInvalid ( )

inline

Sets time zero to invalid.

Usefull when time zero not successfully determined.

Definition at line 66 of file TOPTimeZero.h.

◆ setMinChi2()

void setMinChi2 ( double minChi2 )

inline

Sets chi2 value at minimum.

Parameters

minChi2 value at minimum

Definition at line 72 of file TOPTimeZero.h.

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

top/dataobjects/include/TOPTimeZero.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOPTimeZero()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getAssumedMass()

◆ getChi2()

◆ getError()

◆ getHits()

◆ getInfo()

◆ getInfoHTML()

◆ getMinChi2()

◆ getModuleID()

◆ getName()

◆ getNumPhotons()

◆ getPDF()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTime()

◆ isValid()

◆ setAssumedMass()

◆ setHistograms()

◆ setInvalid()

◆ setMinChi2()