Class to convert to/from global labels for Millepede II to/from detector & parameter identificators. More...

#include <GlobalLabel.h>

Collaboration diagram for GlobalLabel:

Classes
struct	TimeInterval
	Struct to hold intervals of validity. More...

Public Types
typedef unsigned int	gidTYPE
	shortcut for main data type (unsigned int)

Public Member Functions
	GlobalLabel ()
	Default constuctor. Members initialized in declaration.

	GlobalLabel (gidTYPE globalLabel)
	Constructor from Pede label Depends on registered time dependent parameters if the time flag in the label is non-zero. More...

void	construct (gidTYPE dbObjId, gidTYPE element, gidTYPE param)
	Construct label for given DB object id and its element and parameter. More...

void	registerTimeDependent (gidTYPE start, gidTYPE end=maxTID)
	Register this Detector element and parameter as time dependent with instance starting at "start" time index and ending at "end" index. More...

gidTYPE	setParameterId (gidTYPE paramId)
	Usefull setter to quickly change only the parameter id and return back the encoded label (for use in RecoHits) More...

int	label ()
	Returns encoded Pede label. More...

	operator int ()
	Cast to encoded Pede label.

	operator unsigned int ()
	Cast to encoded Pede label.

gidTYPE	getUniqueId () const
	Returns the global id identifing DB object for constantwith this label.

gidTYPE	getElementId () const
	Returns the element id (like VxdID for silicon sensors) to identify sets of parameters in DB objects.

gidTYPE	getParameterId () const
	Get id of alignment/calibration parameter.

gidTYPE	getTimeId () const
	Get time id.

bool	getTimeFlag () const
	Is label time-dependent?

bool	isValid ()
	Is label valid? (non-zero)

void	dump (int level=0) const
	Dumps the label to std::cout.

int	getEndOfValidity ()
	Get the last time id, where this label is valid.

gidTYPE	makeEIDPID (gidTYPE eid_, gidTYPE pid_)
	Helper to compose elemnt id & param id.

gidTYPE	makeTEIDPID (gidTYPE teid_, gidTYPE pid_)
	Helper to compose time elemnt id & param id.

Static Public Member Functions
template<class DBObjType >
static GlobalLabel	construct (gidTYPE element, gidTYPE param)
	Construct label for given DB object (template argument) and its element and parameter. More...

static void	setComponents (const std::set< unsigned short > &components)
	Set which DB objects have non-zero labels (by their id) More...

static void	clearTimeDependentParamaters ()
	Forget all previously registered time dependent parameters.

static unsigned int &	getCurrentTimeIntervalRef ()
	Returns reference to current time id.

static void	setCurrentTimeInterval (gidTYPE time)
	Sets current time id. More...

static gidTYPE	getCurrentTimeInterval ()
	Get current time id.

static std::map< gidTYPE, TimeInterval > &	getTimeIntervals ()
	Reference to map EIDPID -> (TEIDPID, time intervals)

static std::map< gidTYPE, gidTYPE > &	getDictionary ()
	Reference to dictionary/map TEIDPID -> EIDPID.

Static Public Attributes
static const gidTYPE	maxPID = 99
	max 99 parameter types 1..99

static const gidTYPE	maxEID = 9999999
	max 9.999.999 detector elements 1..9999999 (NOT time-dep-)

static const gidTYPE	maxTIF = 1
	time-dep. More...

static const gidTYPE	maxTEID = 9999
	max time-dep. More...

static const gidTYPE	maxTID = 999
	max time slices for a parameter 1..999

static const gidTYPE	pidOffset = 1
	parameter number are the last 2 decimal digits

static const gidTYPE	eidOffest = pidOffset * (maxPID + 1)
	Offset of detector element id = 100.

static const gidTYPE	tifOffset = eidOffest * (maxEID + 1)
	Offset of time flag = 1.000.000.000.

static const gidTYPE	teidOffset = eidOffest
	Offset of time dependent element(detector+parameter) = 100.

static const gidTYPE	tidOffset = eidOffest * (maxTEID + 1)
	Offset of time slice id = 1.000.000.

static const gidTYPE	maxGID
	max internal id = 1.999.999.999 More...

static const gidTYPE	maxLabel
	Label and internal id ("gid") are the same numbers (label is signed but 0 and <0 values are invalid to give to Pede) More...

Private Member Functions
void	construct (gidTYPE elementId, gidTYPE paramId)
	Constructor for any detector. More...

Private Attributes
gidTYPE	gid {0}
	global id

gidTYPE	eid {0}
	element id

gidTYPE	pid {0}
	parameter id

gidTYPE	tid {0}
	time id

gidTYPE	tif {0}
	time identification flag

Static Private Attributes
static std::set< unsigned short >	m_components = {}
	Set of global ids of components for which to return non-zero labels.

Detailed Description

Class to convert to/from global labels for Millepede II to/from detector & parameter identificators.

The labels are in following form (the example shows maximal allowed labels):

|TIF| EID |PID| | 0|9999999 |99 | & TEID=0 & TID=0, or

|TIF|TID|TEID|PID| | 1|999|9999|99 | & (EID,PID)=dictionary(TEID,PID).

where

TIF is time flag (0 or 1) for time-dependent parameters,
EID is id of detector element (numeric VxdID or WireID + offset),
PID is id of alignment/calibration parameter (u/v...),
TEID is time-dependent element index (one per time-dep. parameter)
TID is time interval id

Definition at line 41 of file GlobalLabel.h.

Constructor & Destructor Documentation

◆ GlobalLabel()

GlobalLabel ( GlobalLabel::gidTYPE globalLabel )

explicit

Constructor from Pede label Depends on registered time dependent parameters if the time flag in the label is non-zero.

Parameters

globalLabel The encoded label

Definition at line 19 of file GlobalLabel.cc.

                                                        :
   gid(0), eid(0), pid(0), tid(0), tif(0)
 {
   if (globalLabel > maxLabel)
     return;
   gid = globalLabel;
   tif = gid / tifOffset;
   pid = gid % eidOffest / pidOffset;
  
   if (!tif) {
     eid = gid % tifOffset / eidOffest;
   } else {
     // Time-dep label
     gidTYPE teid = gid % tidOffset / teidOffset;
     gidTYPE teidpid = makeTEIDPID(teid, pid);
     gidTYPE eidpid = 0;
     auto& dict = GlobalLabel::getDictionary();
     auto it = dict.find(teidpid);
     if (it != dict.end())
       eidpid = it->second;
  
     eid = eidpid / eidOffest;
     tid = gid % tifOffset / tidOffset;
   }
 }

Member Function Documentation

◆ construct() [1/3]

void construct	(	gidTYPE	dbObjId,
		gidTYPE	element,
		gidTYPE	param
	)

inline

Construct label for given DB object id and its element and parameter.

Parameters

dbObjId	id of the DB object in global calibration
element	Element id in DB object (wire, sensor etc.)
param	Paremetr id of the element (shift, angle, etc.)

Returns: GlobalLabel

Definition at line 96 of file GlobalLabel.h.

     {
       if (m_components.empty() or m_components.find(dbObjId) != m_components.end())
         construct(100000 * dbObjId + element, param);
       else
         construct(0, 0);
     }

◆ construct() [2/3]

static GlobalLabel construct	(	gidTYPE	element,
		gidTYPE	param
	)

inlinestatic

Construct label for given DB object (template argument) and its element and parameter.

Parameters

element	Element id in DB object (wire, sensor etc.)
param	Paremetr id of the element (shift, angle, etc.)

Returns: GlobalLabel

Definition at line 81 of file GlobalLabel.h.

◆ construct() [3/3]

void construct	(	GlobalLabel::gidTYPE	elementId,
		GlobalLabel::gidTYPE	paramId
	)

private

Constructor for any detector.

Parameters

elementId	Unique id of Belle2 detector element (sensor, layer, wire...)
paramId	id of the parameter of the element

Definition at line 81 of file GlobalLabel.cc.

◆ label()

int label ( )

inline

Returns encoded Pede label.

Returns: int

Definition at line 142 of file GlobalLabel.h.

◆ registerTimeDependent()

void registerTimeDependent	(	GlobalLabel::gidTYPE	start,
		GlobalLabel::gidTYPE	end = `maxTID`
	)

Register this Detector element and parameter as time dependent with instance starting at "start" time index and ending at "end" index.

Call this for each time interval, in which the parameter is allowed to have different value (from that at interval 0-0)

Parameters

start	Start time of parameter time-dep. instance (the instance has number "start" from start to end). The instance number before is 0 if not set.
end	End time of parameter instance. The number after "end" is 0 if not set.

Definition at line 45 of file GlobalLabel.cc.

◆ setComponents()

static void setComponents ( const std::set< unsigned short > & components )

inlinestatic

Set which DB objects have non-zero labels (by their id)

Parameters

components set of global ids of DB objects

Definition at line 108 of file GlobalLabel.h.

◆ setCurrentTimeInterval()

static void setCurrentTimeInterval ( gidTYPE time )

inlinestatic

Sets current time id.

Parameters

time time id

Definition at line 208 of file GlobalLabel.h.

◆ setParameterId()

GlobalLabel::gidTYPE setParameterId ( GlobalLabel::gidTYPE paramId )

Usefull setter to quickly change only the parameter id and return back the encoded label (for use in RecoHits)

Parameters

paramId Id of calibration/alignment parameter

Returns: Encoded Pede label with new parameter id

Definition at line 72 of file GlobalLabel.cc.

Member Data Documentation

◆ maxGID

const gidTYPE maxGID

static

Initial value:

= pidOffset * maxPID + eidOffest * maxEID + tifOffset *

maxTIF

Belle2::GlobalLabel::maxEID

static const gidTYPE maxEID

max 9.999.999 detector elements 1..9999999 (NOT time-dep-)

Definition: GlobalLabel.h:47

Belle2::GlobalLabel::maxPID

static const gidTYPE maxPID

max 99 parameter types 1..99

Definition: GlobalLabel.h:46

Belle2::GlobalLabel::maxTIF

static const gidTYPE maxTIF

time-dep.

Definition: GlobalLabel.h:48

max internal id = 1.999.999.999

Definition at line 56 of file GlobalLabel.h.

◆ maxLabel

const gidTYPE maxLabel

static

Initial value:

=

maxGID

Belle2::GlobalLabel::maxGID

static const gidTYPE maxGID

max internal id = 1.999.999.999

Definition: GlobalLabel.h:56

Label and internal id ("gid") are the same numbers (label is signed but 0 and <0 values are invalid to give to Pede)

Definition at line 58 of file GlobalLabel.h.

◆ maxTEID

const gidTYPE maxTEID = 9999

static

max time-dep.

parameters 1..9999

Definition at line 49 of file GlobalLabel.h.

◆ maxTIF

const gidTYPE maxTIF = 1

static

time-dep.

flag

Definition at line 48 of file GlobalLabel.h.

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

alignment/include/GlobalLabel.h
alignment/src/GlobalLabel.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GlobalLabel()

Member Function Documentation

◆ construct() [1/3]

◆ construct() [2/3]

◆ construct() [3/3]

◆ label()

◆ registerTimeDependent()

◆ setComponents()

◆ setCurrentTimeInterval()

◆ setParameterId()

Member Data Documentation

◆ maxGID

◆ maxLabel

◆ maxTEID

◆ maxTIF