Belle II Software development

ROIid stores the U and V ids and the sensor id of the Region Of Interest. More...

#include <ROIid.h>

Inheritance diagram for ROIid:
RelationsInterface< BASE >

Public Member Functions

 ROIid ()
 Default constructor.
 
 ROIid (int minUid, int maxUid, int minVid, int maxVid, VxdID sensorID)
 Constructor providing the ROI information.
 
 ROIid (int minUid, int maxUid, int minVid, int maxVid, VxdID::baseType sensorID)
 Constructor providing the ROI information.
 
virtual ~ROIid ()
 Destructor.
 
int getMinUid () const
 return the minimum U id of the ROI
 
int getMaxUid () const
 return the maximum U id of the ROI
 
int getMinVid () const
 return the minimum V id of the ROI
 
int getMaxVid () const
 return the maximum V id of the ROI
 
VxdID getSensorID () const
 return the sensor ID of the ROI
 
void setMinUid (double user_minUid)
 set the minimum U id of the ROI
 
void setMaxUid (double user_maxUid)
 set the maximum U id of the ROI
 
void setMinVid (double user_minVid)
 set the minimum V id of the ROI
 
void setMaxVid (double user_maxVid)
 set the maximum V id of the ROI
 
void setSensorID (VxdID::baseType user_sensorID)
 set the sensor ID of the ROI
 
void setSensorID (VxdID user_sensorID)
 set the sensor ID of the ROI
 
bool Contains (const PXDRawHit &thePXDRawHit) const
 true if the ROI contains the thePXDRawHit
 
bool Contains (const PXDDigit &thePXDDigit) const
 true if the ROI contains the thePXDDigit
 
bool Contains (const Belle2::SVDShaperDigit &theSVDDigit) const
 true if the ROI contains the theSVDDigit
 
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_minUid
 u ID of the bottom left pixel of the ROI
 
int m_maxUid
 u ID of the top right pixel of the ROI
 
int m_minVid
 v ID of the bottom left pixel of the ROI
 
int m_maxVid
 v ID of the top right pixel of the ROI
 
VxdID::baseType m_sensorID
 sensor ID
 
DataStore::StoreEntrym_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

ROIid stores the U and V ids and the sensor id of the Region Of Interest.

Definition at line 25 of file ROIid.h.

Constructor & Destructor Documentation

◆ ROIid() [1/3]

ROIid ( )

Default constructor.

Definition at line 14 of file ROIid.cc.

14 : m_minUid(0), m_maxUid(0), m_minVid(0), m_maxVid(0),
16{
17}
VxdID::baseType m_sensorID
sensor ID
Definition: ROIid.h:67
int m_minVid
v ID of the bottom left pixel of the ROI
Definition: ROIid.h:65
int m_minUid
u ID of the bottom left pixel of the ROI
Definition: ROIid.h:63
int m_maxUid
u ID of the top right pixel of the ROI
Definition: ROIid.h:64
int m_maxVid
v ID of the top right pixel of the ROI
Definition: ROIid.h:66

◆ ROIid() [2/3]

ROIid ( int  minUid,
int  maxUid,
int  minVid,
int  maxVid,
VxdID  sensorID 
)
inline

Constructor providing the ROI information.

Definition at line 33 of file ROIid.h.

33 :
34 m_minUid(minUid), m_maxUid(maxUid), m_minVid(minVid), m_maxVid(maxVid), m_sensorID(sensorID.getID()) {};

◆ ROIid() [3/3]

ROIid ( int  minUid,
int  maxUid,
int  minVid,
int  maxVid,
VxdID::baseType  sensorID 
)
inline

Constructor providing the ROI information.

Definition at line 37 of file ROIid.h.

37 :
38 m_minUid(minUid), m_maxUid(maxUid), m_minVid(minVid), m_maxVid(maxVid), m_sensorID(sensorID) {};

◆ ~ROIid()

~ROIid ( )
virtual

Destructor.

Definition at line 19 of file ROIid.cc.

20{
21}

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
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

143 {
144 if (object)
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }
void addRelation(const TObject *fromObject, StoreEntry *&fromEntry, int &fromIndex, const TObject *toObject, StoreEntry *&toEntry, int &toIndex, float weight, const std::string &namedRelation)
Add a relation from an object in a store array to another object in a store array.
Definition: DataStore.cc:492
static DataStore & Instance()
Instance of singleton Store.
Definition: DataStore.cc:54
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.

◆ 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
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

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

◆ Contains() [1/3]

bool Contains ( const Belle2::SVDShaperDigit theSVDDigit) const

true if the ROI contains the theSVDDigit

Definition at line 47 of file ROIid.cc.

48{
49
50 bool inside = false;
51
52 if (theSVDDigit.isUStrip())
53 inside = (m_minUid <= theSVDDigit.getCellID() && m_maxUid >= theSVDDigit.getCellID());
54 else
55 inside = (m_minVid <= theSVDDigit.getCellID() && m_maxVid >= theSVDDigit.getCellID());
56
57 return (inside && m_sensorID == theSVDDigit.getSensorID().getID());
58
59}
VxdID getSensorID() const
Get the sensor ID.
short int getCellID() const
Get strip ID.
bool isUStrip() const
Get strip direction.
baseType getID() const
Get the unique id.
Definition: VxdID.h:94

◆ Contains() [2/3]

bool Contains ( const PXDDigit thePXDDigit) const

true if the ROI contains the thePXDDigit

Definition at line 37 of file ROIid.cc.

38{
39 return (m_minUid <= thePXDDigit.getUCellID() &&
40 m_maxUid >= thePXDDigit.getUCellID() &&
41 m_minVid <= thePXDDigit.getVCellID() &&
42 m_maxVid >= thePXDDigit.getVCellID() &&
43 m_sensorID == thePXDDigit.getSensorID().getID()
44 );
45}
unsigned short getVCellID() const
Get cell ID in v.
Definition: PXDDigit.h:74
unsigned short getUCellID() const
Get cell ID in u.
Definition: PXDDigit.h:69
VxdID getSensorID() const
Get the sensor ID.
Definition: PXDDigit.h:64

◆ Contains() [3/3]

bool Contains ( const PXDRawHit thePXDRawHit) const

true if the ROI contains the thePXDRawHit

Definition at line 25 of file ROIid.cc.

26{
27 return (m_minUid <= thePXDRawHit.getUCellID() &&
28 m_maxUid >= thePXDRawHit.getUCellID() &&
29 m_minVid <= thePXDRawHit.getVCellID() &&
30 m_maxVid >= thePXDRawHit.getVCellID() &&
31 m_sensorID == thePXDRawHit.getSensorID().getID()
32 );
33}
short getUCellID() const
Get u cell id of hit position.
Definition: PXDRawHit.h:84
VxdID getSensorID() const
Get the sensor ID.
Definition: PXDRawHit.h:52
short getVCellID() const
Get v cell id of hit position.
Definition: PXDRawHit.h:68

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

171 {
172 if (!sourceObj)
173 return;
174 auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
175 for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
176 fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
177 }
178
179 auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
180 for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
181 this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
182 }
183 }
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).

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

386 {
388 return m_cacheArrayIndex;
389 }
bool findStoreEntry(const TObject *object, StoreEntry *&entry, int &index)
Find an object in an array in the data store.
Definition: DataStore.cc:398

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

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

419 {
422 return nullptr;
424 }
TClonesArray * getPtrAsArray() const
Return ptr cast to TClonesArray.
Definition: StoreEntry.cc:83

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

371 {
373 }
virtual std::string getInfoHTML() const
Return a short summary of this object's contents in HTML format.
std::string htmlToPlainText(const std::string &html)
See RelationsObject::getInfo()

◆ 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();
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:24
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 ""; }

◆ getMaxUid()

int getMaxUid ( ) const
inline

return the maximum U id of the ROI

Definition at line 45 of file ROIid.h.

◆ getMaxVid()

int getMaxVid ( ) const
inline

return the maximum V id of the ROI

Definition at line 47 of file ROIid.h.

◆ getMinUid()

int getMinUid ( ) const
inline

return the minimum U id of the ROI

Definition at line 44 of file ROIid.h.

◆ getMinVid()

int getMinVid ( ) const
inline

return the minimum V id of the ROI

Definition at line 46 of file ROIid.h.

◆ 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
TThe class of objects to or from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

279 {
281 T::Class(), name, namedRelation).object);
282 }
@ c_BothSides
Combination of c_FromSide and c_ToSide.
Definition: DataStore.h:79
Belle2::RelationEntry getRelationWith(ESearchSide searchSide, const TObject *object, StoreEntry *&entry, int &index, const TClass *withClass, const std::string &withName, const std::string &namedRelation)
Get the first relation between an object and another object in a store array.
Definition: DataStore.cc:597
TObject * object
Pointer to the object.
Definition: RelationEntry.h:32

◆ 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
FROMThe class of objects from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

264 {
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }
@ c_FromSide
Return relations/objects pointed from (to a given object).
Definition: DataStore.h:77

◆ 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
FROMThe class of objects from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

316 {
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

◆ 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
TOThe class of objects to which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

249 {
251 TO::Class(), name, namedRelation).object);
252 }
@ c_ToSide
Return relations/objects pointed to (from a given object).
Definition: DataStore.h:78

◆ 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
TOThe class of objects to which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

299 {
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

◆ 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
TThe class of objects to or from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

333 {
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

◆ 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
FROMThe class of objects from which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 212 of file RelationsObject.h.

214 {
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }
RelationVector< T > getRelationsWith(const std::string &name="", const std::string &namedRelation="") const
Get the relations between this object and another store array.

◆ 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
TOThe class of objects to which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 197 of file RelationsObject.h.

198 {
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

◆ 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
TThe class of objects to or from which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 230 of file RelationsObject.h.

231 {
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ getSensorID()

VxdID getSensorID ( ) const
inline

return the sensor ID of the ROI

Definition at line 48 of file ROIid.h.

◆ setMaxUid()

void setMaxUid ( double  user_maxUid)
inline

set the maximum U id of the ROI

Definition at line 51 of file ROIid.h.

◆ setMaxVid()

void setMaxVid ( double  user_maxVid)
inline

set the maximum V id of the ROI

Definition at line 53 of file ROIid.h.

◆ setMinUid()

void setMinUid ( double  user_minUid)
inline

set the minimum U id of the ROI

Definition at line 50 of file ROIid.h.

◆ setMinVid()

void setMinVid ( double  user_minVid)
inline

set the minimum V id of the ROI

Definition at line 52 of file ROIid.h.

◆ setSensorID() [1/2]

void setSensorID ( VxdID  user_sensorID)
inline

set the sensor ID of the ROI

Definition at line 55 of file ROIid.h.

◆ setSensorID() [2/2]

void setSensorID ( VxdID::baseType  user_sensorID)
inline

set the sensor ID of the ROI

Definition at line 54 of file ROIid.h.

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_maxUid

int m_maxUid
private

u ID of the top right pixel of the ROI

Definition at line 64 of file ROIid.h.

◆ m_maxVid

int m_maxVid
private

v ID of the top right pixel of the ROI

Definition at line 66 of file ROIid.h.

◆ m_minUid

int m_minUid
private

u ID of the bottom left pixel of the ROI

Definition at line 63 of file ROIid.h.

◆ m_minVid

int m_minVid
private

v ID of the bottom left pixel of the ROI

Definition at line 65 of file ROIid.h.

◆ m_sensorID

VxdID::baseType m_sensorID
private

sensor ID

Definition at line 67 of file ROIid.h.


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