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

#include <GlobalLabel.h>

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.

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

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.

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

int	label ()
	Returns encoded Pede label.

	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.

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

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.

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.

static const gidTYPE	maxTEID = 9999
	max time-dep.

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

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)

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

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.

Member Typedef Documentation

◆ gidTYPE

typedef unsigned int gidTYPE

shortcut for main data type (unsigned int)

Definition at line 45 of file GlobalLabel.h.

Constructor & Destructor Documentation

◆ GlobalLabel() [1/2]

GlobalLabel ( )

inline

Default constuctor. Members initialized in declaration.

Definition at line 62 of file GlobalLabel.h.

62{}

◆ GlobalLabel() [2/2]

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

◆ clearTimeDependentParamaters()

void clearTimeDependentParamaters ( )

static

Forget all previously registered time dependent parameters.

Definition at line 66 of file GlobalLabel.cc.

{
  GlobalLabel::getDictionary().clear();
  GlobalLabel::getTimeIntervals().clear();
}

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

Definition at line 95 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.

    {
      GlobalLabel theLabel;
      theLabel.construct(DBObjType::getGlobalUniqueID(), element, param);
      return theLabel;
    }

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

{
  if (elementId > maxEID || paramId > maxPID)
    return;
  pid = paramId;
  eid = elementId;
 
  gidTYPE eidpid = makeEIDPID(eid, pid);
  gidTYPE teidpid = 0;
  auto& ints = GlobalLabel::getTimeIntervals();
  auto it = ints.find(eidpid);
  if (it != ints.end())
    teidpid = it->second.teidpid();
 
  if (teidpid)
    tif = 1;
  else
    tif = 0;
 
  if (!tif)
    gid = (tif * tifOffset + eid * eidOffest + pid * pidOffset);
  else {
    tid = it->second.get(GlobalLabel::getCurrentTimeIntervalRef());
    gid = (tif * tifOffset + tid * tidOffset + teidpid);
  }
  /*
  if (!teidpid) {
    // time indep.
    tif = 0;
    gid = (tif * tifOffset + eid * eidOffest + pid * pidOffset);
  }
  else {
    tid = it->second.get(GlobalLabel::getCurrentTimeIntervalRef());
    if (tid == 0) {
      // actually the first instance of time dep. parameter -> def with orginal time. indep. label
      //FIXME: code copied from above!
      tif = 0;
      gid = (tif * tifOffset + eid * eidOffest + pid * pidOffset);
    } else {
      tif = 1;
      gid = (tif * tifOffset + tid * tidOffset + teidpid);
    }
  }
  */
}

◆ dump()

void dump ( int level = 0 ) const

Dumps the label to std::cout.

Definition at line 128 of file GlobalLabel.cc.

{
  cout << "GlobalLabel: gid=" << gid << endl;
  cout << "             eid=" << eid << endl;
  cout << "             pid=" << pid << endl;
  cout << "             tid=" << tid << endl;
  cout << "             tif=" << tif << endl;
  if (level == 0)
    return;
  cout << "    Time-dependent map:" <<  endl;
  cout << "    [EIDPID : TEIDPID] (registered time intervals)" << endl;
  for (auto& it : getTimeIntervals()) {
    cout << "     " << it.first << " : " << it.second.teidpid() << endl;
    cout << "     ";
    if (level > 1) {
      for (unsigned int i = 0; i <= GlobalLabel::maxTID; i++) {
        cout << it.second.get(i) << " ";
        if ((i + 1) % 40 == 0)
          cout << endl << "     ";
      }
      cout << endl;
    }
    cout << endl;
  }
  cout << endl;
}

◆ getCurrentTimeInterval()

static gidTYPE getCurrentTimeInterval ( )

inlinestatic

Get current time id.

Definition at line 214 of file GlobalLabel.h.

    {
      return GlobalLabel::getCurrentTimeIntervalRef();
    }

◆ getCurrentTimeIntervalRef()

static unsigned int & getCurrentTimeIntervalRef ( )

inlinestatic

Returns reference to current time id.

Definition at line 199 of file GlobalLabel.h.

    {
      static unsigned int subrun = 0;
      return subrun;
    }

◆ getDictionary()

static std::map< gidTYPE, gidTYPE > & getDictionary ( )

inlinestatic

Reference to dictionary/map TEIDPID -> EIDPID.

Definition at line 282 of file GlobalLabel.h.

    {
      // Map TEIDPID -> EIDPID
      static std::map<gidTYPE, gidTYPE> dictionary;
      return dictionary;
    }

◆ getElementId()

gidTYPE getElementId ( ) const

inline

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

Definition at line 161 of file GlobalLabel.h.

161{return eid % 100000;}

◆ getEndOfValidity()

int getEndOfValidity ( )

inline

Get the last time id, where this label is valid.

Definition at line 179 of file GlobalLabel.h.

    {
      if (!tif)
        return maxTID;
      auto it = GlobalLabel::getTimeIntervals().find(makeEIDPID(eid, pid));
      if (it == GlobalLabel::getTimeIntervals().end())
        return tid;
      for (unsigned int i = tid; i < maxTID; i++) {
        if (it->second.get(i) != tid)
          return i - 1;
      }
      return tid;
    }

◆ getParameterId()

gidTYPE getParameterId ( ) const

inline

Get id of alignment/calibration parameter.

Definition at line 164 of file GlobalLabel.h.

164{return pid;}

◆ getTimeFlag()

bool getTimeFlag ( ) const

inline

Is label time-dependent?

Definition at line 170 of file GlobalLabel.h.

170{return tif;}

◆ getTimeId()

gidTYPE getTimeId ( ) const

inline

Get time id.

Definition at line 167 of file GlobalLabel.h.

167{return tid;}

◆ getTimeIntervals()

static std::map< gidTYPE, TimeInterval > & getTimeIntervals ( )

inlinestatic

Reference to map EIDPID -> (TEIDPID, time intervals)

Definition at line 274 of file GlobalLabel.h.

    {
      // Map EIDPID -> (TEIDPID, time intervals)
      static std::map<gidTYPE, TimeInterval > intervals;
      return intervals;
    }

◆ getUniqueId()

gidTYPE getUniqueId ( ) const

inline

Returns the global id identifing DB object for constantwith this label.

Definition at line 156 of file GlobalLabel.h.

156{return eid / 100000;}

◆ isValid()

bool isValid ( )

inline

Is label valid? (non-zero)

Definition at line 173 of file GlobalLabel.h.

173{return 0 != gid;}

◆ label()

int label ( )

inline

Returns encoded Pede label.

Returns: int

Definition at line 141 of file GlobalLabel.h.

141{return gid;}

◆ makeEIDPID()

gidTYPE makeEIDPID	(	gidTYPE	eid_,
		gidTYPE	pid_
	)

inline

Helper to compose elemnt id & param id.

Definition at line 290 of file GlobalLabel.h.

290{return pid_ * pidOffset + eid_ * eidOffest;}

◆ makeTEIDPID()

gidTYPE makeTEIDPID	(	gidTYPE	teid_,
		gidTYPE	pid_
	)

inline

Helper to compose time elemnt id & param id.

Definition at line 293 of file GlobalLabel.h.

293{return pid_ * pidOffset + teid_ * teidOffset;}

◆ operator int()

operator int ( )

inline

Cast to encoded Pede label.

Definition at line 146 of file GlobalLabel.h.

146{return (int)label();}

Belle2::GlobalLabel::label

int label()

Returns encoded Pede label.

Definition: GlobalLabel.h:141

◆ operator unsigned int()

operator unsigned int ( )

inline

Cast to encoded Pede label.

Definition at line 151 of file GlobalLabel.h.

151{return (unsigned int)label();}

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

{
  auto& dict = GlobalLabel::getDictionary();
  auto& ints = GlobalLabel::getTimeIntervals();
  tif = 1;
  tid = start;
  gidTYPE eidpid  = makeEIDPID(eid, pid);
 
  auto it = ints.find(eidpid);
  if (it == ints.end()) {
    // Not found, insert new record
    gidTYPE teidpid = makeTEIDPID(dict.size() + 1, pid);
    dict.insert(make_pair(teidpid, eidpid));
    ints.insert(make_pair(eidpid, TimeInterval(teidpid, start, end)));
  } else {
    // Found, add time interval
    it->second.set(start, end);
  }
}

◆ 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 107 of file GlobalLabel.h.

    {
      m_components = components;
    }

◆ setCurrentTimeInterval()

static void setCurrentTimeInterval ( gidTYPE time )

inlinestatic

Sets current time id.

Parameters

time time id

Definition at line 207 of file GlobalLabel.h.

    {
      gidTYPE& timeref = GlobalLabel::getCurrentTimeIntervalRef();
      timeref = time;
    }

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

{
  if (!getUniqueId() or paramId > maxPID) {
    return label();
  }
  construct(getUniqueId(), getElementId(), paramId);
  return label();
}

Member Data Documentation

◆ eid

gidTYPE eid {0}

private

element id

Definition at line 299 of file GlobalLabel.h.

◆ eidOffest

const gidTYPE eidOffest = pidOffset * (maxPID + 1)

static

Offset of detector element id = 100.

Definition at line 52 of file GlobalLabel.h.

◆ gid

gidTYPE gid {0}

private

global id

Definition at line 296 of file GlobalLabel.h.

◆ m_components

std::set< unsigned short > m_components = {}

staticprivate

Set of global ids of components for which to return non-zero labels.

Definition at line 221 of file GlobalLabel.h.

◆ maxEID

const gidTYPE maxEID = 9999999

static

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

Definition at line 47 of file GlobalLabel.h.

◆ maxGID

const gidTYPE maxGID

static

Initial value:

= pidOffset * maxPID + eidOffest * maxEID + tifOffset *

maxTIF

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.

◆ maxPID

const gidTYPE maxPID = 99

static

max 99 parameter types 1..99

Definition at line 46 of file GlobalLabel.h.

◆ maxTEID

const gidTYPE maxTEID = 9999

static

max time-dep.

parameters 1..9999

Definition at line 49 of file GlobalLabel.h.

◆ maxTID

const gidTYPE maxTID = 999

static

max time slices for a parameter 1..999

Definition at line 50 of file GlobalLabel.h.

◆ maxTIF

const gidTYPE maxTIF = 1

static

time-dep.

flag

Definition at line 48 of file GlobalLabel.h.

◆ pid

gidTYPE pid {0}

private

parameter id

Definition at line 302 of file GlobalLabel.h.

◆ pidOffset

const gidTYPE pidOffset = 1

static

parameter number are the last 2 decimal digits

Definition at line 51 of file GlobalLabel.h.

◆ teidOffset

const gidTYPE teidOffset = eidOffest

static

Offset of time dependent element(detector+parameter) = 100.

Definition at line 54 of file GlobalLabel.h.

◆ tid

gidTYPE tid {0}

private

time id

Definition at line 305 of file GlobalLabel.h.

◆ tidOffset

const gidTYPE tidOffset = eidOffest * (maxTEID + 1)

static

Offset of time slice id = 1.000.000.

Definition at line 55 of file GlobalLabel.h.

◆ tif

gidTYPE tif {0}

private

time identification flag

Definition at line 308 of file GlobalLabel.h.

◆ tifOffset

const gidTYPE tifOffset = eidOffest * (maxEID + 1)

static

Offset of time flag = 1.000.000.000.

Definition at line 53 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

Member Typedef Documentation

◆ gidTYPE

Constructor & Destructor Documentation

◆ GlobalLabel() [1/2]

◆ GlobalLabel() [2/2]

Member Function Documentation

◆ clearTimeDependentParamaters()

◆ construct() [1/3]

◆ construct() [2/3]

◆ construct() [3/3]

◆ dump()

◆ getCurrentTimeInterval()

◆ getCurrentTimeIntervalRef()

◆ getDictionary()

◆ getElementId()

◆ getEndOfValidity()

◆ getParameterId()

◆ getTimeFlag()

◆ getTimeId()

◆ getTimeIntervals()

◆ getUniqueId()

◆ isValid()

◆ label()

◆ makeEIDPID()

◆ makeTEIDPID()

◆ operator int()

◆ operator unsigned int()

◆ registerTimeDependent()

◆ setComponents()

◆ setCurrentTimeInterval()

◆ setParameterId()

Member Data Documentation

◆ eid

◆ eidOffest

◆ gid

◆ m_components

◆ maxEID

◆ maxGID

◆ maxLabel

◆ maxPID

◆ maxTEID

◆ maxTID

◆ maxTIF

◆ pid

◆ pidOffset

◆ teidOffset

◆ tid

◆ tidOffset

◆ tif

◆ tifOffset