Datastore class to keep ARICH event infomation e.g. trigger type. More...

#include <ARICHInfo.h>

Inheritance diagram for ARICHInfo:

Public Member Functions
	ARICHInfo ()
	Empty constructor.

	ARICHInfo (int trgtype)
	Useful Constructor.

void	settrgtype (int trgtype)
	Set the trigger type.

void	setpciedata (bool pciedata)
	Set the readout type.

void	setthscan_mode (bool mode)
	Set the threshold scan mode flag.

void	setvth_thscan (double vth_thscan)
	Set vth for thscan mode.

void	setntrack (double n_track)
	Set number of tracks of this event.

void	setnexthit (double n_exthit)
	Set number of eligible ExtHits of this event.

void	setnhit (double n_hit)
	Set number of ARICHHits of this event.

int	gettrgtype () const
	Get the trigger type.

bool	getpciedata () const
	Get the readout type.

bool	getthscan_mode () const
	Get the threshold scan mode flag.

double	getvth_thscan () const
	Get vth for thscan.

int	getntrack () const
	Get number of tracks of this event.

int	getnexthit () const
	Get number of eligible ExtHits of this event.

int	getnhit () const
	Get number of ARICHHits of this event.

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 (ARICHInfo, 4)
	the class title

Private Attributes
int	m_trgtype = 0
	trigger type

bool	m_pciedata = false
	PCIe40 readout data (true), or Copper data (false)

bool	m_thscan_mode = false
	Flag of threshold scan run

double	m_vth_thscan = 0
	vth value for thscan mode

int	m_n_track = 0
	number of tracks of this event

int	m_n_exthit = 0
	number of eligible ExtHits of this event

int	m_n_hit = 0
	number of ARICHHits of this event

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

Datastore class to keep ARICH event infomation e.g. trigger type.

Definition at line 22 of file ARICHInfo.h.

Constructor & Destructor Documentation

◆ ARICHInfo() [1/2]

ARICHInfo ( )

inline

Empty constructor.

Recommended for ROOT IO

does nothing

Definition at line 27 of file ARICHInfo.h.

               :
      m_trgtype(0),
      m_pciedata(false),
      m_thscan_mode(0),
      m_vth_thscan(0.0)
    {
    }

◆ ARICHInfo() [2/2]

ARICHInfo ( int trgtype )

inlineexplicit

Useful Constructor.

Parameters

trgtype obtained from B2L data

Definition at line 40 of file ARICHInfo.h.

    {
      m_trgtype = trgtype;
    }

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);
    }

◆ 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 ""; }

◆ getnexthit()

int getnexthit ( ) const

inline

Get number of eligible ExtHits of this event.

Definition at line 82 of file ARICHInfo.h.

82{ return m_n_exthit; }

Belle2::ARICHInfo::m_n_exthit

int m_n_exthit

number of eligible ExtHits of this event

Definition: ARICHInfo.h:94

◆ getnhit()

int getnhit ( ) const

inline

Get number of ARICHHits of this event.

Definition at line 85 of file ARICHInfo.h.

85{ return m_n_hit; }

Belle2::ARICHInfo::m_n_hit

int m_n_hit

number of ARICHHits of this event

Definition: ARICHInfo.h:95

◆ getntrack()

int getntrack ( ) const

inline

Get number of tracks of this event.

Definition at line 79 of file ARICHInfo.h.

79{ return m_n_track; }

Belle2::ARICHInfo::m_n_track

int m_n_track

number of tracks of this event

Definition: ARICHInfo.h:93

◆ getpciedata()

bool getpciedata ( ) const

inline

Get the readout type.

Definition at line 70 of file ARICHInfo.h.

70{ return m_pciedata; }

◆ 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));
    }

◆ getthscan_mode()

bool getthscan_mode ( ) const

inline

Get the threshold scan mode flag.

Definition at line 73 of file ARICHInfo.h.

73{ return m_thscan_mode; }

◆ gettrgtype()

int gettrgtype ( ) const

inline

Get the trigger type.

Definition at line 67 of file ARICHInfo.h.

67{ return m_trgtype; }

◆ getvth_thscan()

double getvth_thscan ( ) const

inline

Get vth for thscan.

Definition at line 76 of file ARICHInfo.h.

76{ return m_vth_thscan; }

◆ setnexthit()

void setnexthit ( double n_exthit )

inline

Set number of eligible ExtHits of this event.

Definition at line 61 of file ARICHInfo.h.

61{ m_n_exthit = n_exthit; }

◆ setnhit()

void setnhit ( double n_hit )

inline

Set number of ARICHHits of this event.

Definition at line 64 of file ARICHInfo.h.

64{ m_n_hit = n_hit; }

◆ setntrack()

void setntrack ( double n_track )

inline

Set number of tracks of this event.

Definition at line 58 of file ARICHInfo.h.

58{ m_n_track = n_track; }

◆ setpciedata()

void setpciedata ( bool pciedata )

inline

Set the readout type.

Definition at line 49 of file ARICHInfo.h.

49{ m_pciedata = pciedata; }

◆ setthscan_mode()

void setthscan_mode ( bool mode )

inline

Set the threshold scan mode flag.

Definition at line 52 of file ARICHInfo.h.

52{ m_thscan_mode = mode; }

◆ settrgtype()

void settrgtype ( int trgtype )

inline

Set the trigger type.

Definition at line 46 of file ARICHInfo.h.

46{ m_trgtype = trgtype; }

◆ setvth_thscan()

void setvth_thscan ( double vth_thscan )

inline

Set vth for thscan mode.

Definition at line 55 of file ARICHInfo.h.

55{ m_vth_thscan = vth_thscan; }

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_n_exthit

int m_n_exthit = 0

private

number of eligible ExtHits of this event

Definition at line 94 of file ARICHInfo.h.

◆ m_n_hit

int m_n_hit = 0

private

number of ARICHHits of this event

Definition at line 95 of file ARICHInfo.h.

◆ m_n_track

int m_n_track = 0

private

number of tracks of this event

Definition at line 93 of file ARICHInfo.h.

◆ m_pciedata

bool m_pciedata = false

private

PCIe40 readout data (true), or Copper data (false)

Definition at line 90 of file ARICHInfo.h.

◆ m_thscan_mode

bool m_thscan_mode = false

private

Flag of threshold scan run

Definition at line 91 of file ARICHInfo.h.

◆ m_trgtype

int m_trgtype = 0

private

trigger type

Definition at line 89 of file ARICHInfo.h.

◆ m_vth_thscan

double m_vth_thscan = 0

private

vth value for thscan mode

Definition at line 92 of file ARICHInfo.h.

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

arich/dataobjects/include/ARICHInfo.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ARICHInfo() [1/2]

◆ ARICHInfo() [2/2]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getnexthit()

◆ getnhit()

◆ getntrack()

◆ getpciedata()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getthscan_mode()

◆ gettrgtype()

◆ getvth_thscan()

◆ setnexthit()

◆ setnhit()

◆ setntrack()

◆ setpciedata()

◆ setthscan_mode()

◆ settrgtype()

◆ setvth_thscan()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_n_exthit

◆ m_n_hit

◆ m_n_track

◆ m_pciedata

◆ m_thscan_mode

◆ m_trgtype

◆ m_vth_thscan