Class to store debugging information about the hit headers in the TOP production debugging raw data format. More...

#include <TOPProductionHitDebug.h>

Inheritance diagram for TOPProductionHitDebug:

Collaboration diagram for TOPProductionHitDebug:

[legend]

Public Member Functions
	TOPProductionHitDebug ()
	Default constructor.

	TOPProductionHitDebug (bool hasWaveform, bool isOnHeap, unsigned short logicWindow, unsigned short physicalWindow, bool isWindowStraddle=false, bool isOnHeapStraddle=false, unsigned short logicWindowStraddle=0, unsigned short physicalWindowStraddle=0)
	Full constructor. More...

bool	hasWaveform () const
	Returns hasWaveform flag. More...

bool	isOnHeap () const
	Returns isOnHeap flag. More...

unsigned short	getLogicWindow () const
	Returns logic window address. More...

unsigned short	getPhysicalWindow () const
	Returns physical window address. More...

bool	isWindowStraddle () const
	Returns isWindowStraddle flag showing if the hit was extracted from a window-straddling waveform. More...

bool	isOnHeapStraddle () const
	Returns isOnHeap flag for straddled window. More...

unsigned short	getLogicWindowStraddle () const
	Returns logic window address for straddled window. More...

unsigned short	getPhysicalWindowStraddle () const
	Returns physical window address for straddled window. More...

void	appendExtraWord (unsigned int extraWord)
	Appends extra word to vector of additional event words.

std::vector< unsigned int >	getExtraWords () const
	Returns additional event words. 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 (TOPProductionHitDebug, 1)
	ClassDef.

Private Attributes
bool	m_hasWaveform = false
	hit header waveform flag

bool	m_isOnHeap = false
	hit header heap flag

unsigned short	m_logicWindow = 0
	hit header logic window

unsigned short	m_physicalWindow = 0
	hit header heap window

bool	m_isWindowStraddle = false
	hit is from window-straddling waveform segment flag

bool	m_isOnHeapStraddle = false
	hit header heap flag for second half of waveform segment in case of straddling window

unsigned short	m_logicWindowStraddle
	hit header logic window for second half of waveform segment in case of straddling window More...

unsigned short	m_physicalWindowStraddle
	hit header heap window for second half of waveform segment in case of straddling window More...

std::vector< unsigned int >	m_extraWords
	additional event words

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 debugging information about the hit headers in the TOP production debugging raw data format.

Access these through their relations to TOPRawDigits, otherwise there is no information which scrod/carrier/asic/channel they belong to.

Definition at line 23 of file TOPProductionHitDebug.h.

Constructor & Destructor Documentation

◆ TOPProductionHitDebug()

TOPProductionHitDebug	(	bool	hasWaveform,
		bool	isOnHeap,
		unsigned short	logicWindow,
		unsigned short	physicalWindow,
		bool	isWindowStraddle = `false`,
		bool	isOnHeapStraddle = `false`,
		unsigned short	logicWindowStraddle = `0`,
		unsigned short	physicalWindowStraddle = `0`
	)

inline

Full constructor.

Parameters

hasWaveform	has waveform or not
isOnHeap	is on heap or not
logicWindow	logic window
physicalWindow	physical window
isWindowStraddle	is window straddle
isOnHeapStraddle	is on heap straddle
logicWindowStraddle	logic window straddle
physicalWindowStraddle	physical window straddle

Definition at line 43 of file TOPProductionHitDebug.h.

                                                                     :
       m_hasWaveform(hasWaveform),
       m_isOnHeap(isOnHeap),
       m_logicWindow(logicWindow),
       m_physicalWindow(physicalWindow),
       m_isWindowStraddle(isWindowStraddle),
       m_isOnHeapStraddle(isOnHeapStraddle),
       m_logicWindowStraddle(logicWindowStraddle),
       m_physicalWindowStraddle(physicalWindowStraddle)
     {
       m_extraWords.clear();
     }

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.

◆ getExtraWords()

std::vector<unsigned int> getExtraWords ( ) const

inline

Returns additional event words.

Returns: extraWords

Definition at line 124 of file TOPProductionHitDebug.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.

◆ getLogicWindow()

unsigned short getLogicWindow ( ) const

inline

Returns logic window address.

Returns: logic window

Definition at line 81 of file TOPProductionHitDebug.h.

◆ getLogicWindowStraddle()

unsigned short getLogicWindowStraddle ( ) const

inline

Returns logic window address for straddled window.

Returns: logicWindowStraddle

Definition at line 107 of file TOPProductionHitDebug.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.

◆ getPhysicalWindow()

unsigned short getPhysicalWindow ( ) const

inline

Returns physical window address.

Returns: physical window

Definition at line 87 of file TOPProductionHitDebug.h.

◆ getPhysicalWindowStraddle()

unsigned short getPhysicalWindowStraddle ( ) const

inline

Returns physical window address for straddled window.

Returns: physical window

Definition at line 113 of file TOPProductionHitDebug.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.

◆ hasWaveform()

bool hasWaveform ( ) const

inline

Returns hasWaveform flag.

Returns: hasWaveform

Definition at line 68 of file TOPProductionHitDebug.h.

◆ isOnHeap()

bool isOnHeap ( ) const

inline

Returns isOnHeap flag.

Returns: isOnHeap

Definition at line 74 of file TOPProductionHitDebug.h.

◆ isOnHeapStraddle()

bool isOnHeapStraddle ( ) const

inline

Returns isOnHeap flag for straddled window.

Returns: isOnHeapStraddle

Definition at line 100 of file TOPProductionHitDebug.h.

◆ isWindowStraddle()

bool isWindowStraddle ( ) const

inline

Returns isWindowStraddle flag showing if the hit was extracted from a window-straddling waveform.

Returns: isWindowStraddle

Definition at line 93 of file TOPProductionHitDebug.h.

Member Data Documentation

◆ m_logicWindowStraddle

unsigned short m_logicWindowStraddle

private

Initial value:

=

0

hit header logic window for second half of waveform segment in case of straddling window

Definition at line 134 of file TOPProductionHitDebug.h.

◆ m_physicalWindowStraddle

unsigned short m_physicalWindowStraddle

private

Initial value:

=

0

hit header heap window for second half of waveform segment in case of straddling window

Definition at line 136 of file TOPProductionHitDebug.h.

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

top/dataobjects/include/TOPProductionHitDebug.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOPProductionHitDebug()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getExtraWords()

◆ getInfo()

◆ getInfoHTML()

◆ getLogicWindow()

◆ getLogicWindowStraddle()

◆ getName()

◆ getPhysicalWindow()

◆ getPhysicalWindowStraddle()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ hasWaveform()

◆ isOnHeap()

◆ isOnHeapStraddle()

◆ isWindowStraddle()

Member Data Documentation

◆ m_logicWindowStraddle

◆ m_physicalWindowStraddle