Singleton class for managing gain corrections for the PXD. More...

#include <PXDGainCalibrator.h>

Public Member Functions
void	initialize ()
	Initialize the PXDGainCalibrator.

void	setGains ()
	Set gains from DB.

float	getGainCorrection (VxdID id, unsigned int uid, unsigned int vid) const
	Get gain correction.

float	getADUToEnergy (VxdID id, unsigned int uid, unsigned int vid) const
	Get conversion factor from ADU to energy.

unsigned short	getBinU (VxdID id, unsigned int uid, unsigned int vid) const
	Get gain correction bin along sensor u side.

unsigned short	getBinV (VxdID id, unsigned int vid) const
	Get gain correction bin along sensor v side.

unsigned short	getBinU (VxdID id, unsigned int uid, unsigned int vid, unsigned short nBinsU) const
	Get gain correction bin along sensor u side.

unsigned short	getBinV (VxdID id, unsigned int vid, unsigned short nBinsV) const
	Get gain correction bin along v side.

unsigned short	getGlobalID (VxdID id, unsigned int uid, unsigned int vid) const
	Get global ID for gain correction on a sensor.

const PXDGainMapPar &	getGainMapParameters () const
	Return current gain correction payload.

Static Public Member Functions
static PXDGainCalibrator &	getInstance ()
	Main (and only) way to access the PXDGainCalibrator.

Private Member Functions
	PXDGainCalibrator ()
	Singleton class, hidden constructor.

	PXDGainCalibrator (const PXDGainCalibrator &)=delete
	Singleton class, forbidden copy constructor.

PXDGainCalibrator &	operator= (const PXDGainCalibrator &)=delete
	Singleton class, forbidden assignment operator.

Private Attributes
std::unique_ptr< DBObjPtr< PXDGainMapPar > >	m_gainsFromDB
	Masked pixels retrieved from DB.

PXDGainMapPar	m_gains
	Map of gain corrections.

Detailed Description

Singleton class for managing gain corrections for the PXD.

Definition at line 26 of file PXDGainCalibrator.h.

Constructor & Destructor Documentation

◆ PXDGainCalibrator()

PXDGainCalibrator ( )

inlineprivate

Singleton class, hidden constructor.

Definition at line 101 of file PXDGainCalibrator.h.

101{};

Member Function Documentation

◆ getADUToEnergy()

float getADUToEnergy	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Get conversion factor from ADU to energy.

Parameters

id	unique ID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: ADUToEnergy conversion factor

Definition at line 43 of file PXDGainCalibrator.cc.

{
  // FIXME: These constants are hardcoded as intermediate solution.
  // They should be obtained from GeoCache and ultimately from the condDB.
  float ADCUnit = 130.0;
  float Gq = 0.6;
  return Const::ehEnergy * ADCUnit / Gq / getGainCorrection(id, uid, vid);
}

◆ getBinU() [1/2]

unsigned short getBinU	(	VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Get gain correction bin along sensor u side.

Parameters

id	unique ID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: uBin correction bin along u side of sensor

Definition at line 60 of file PXDGainCalibrator.cc.

61{

62 return getBinU(id, uid, vid, m_gains.getBinsU());

63}

Belle2::PXD::getBinU

unsigned short getBinU(VxdID id, unsigned int uid, unsigned int vid, unsigned short nBinsU)

Function to return a bin number for equal sized binning in U.

Definition PXDUtilities.h:161

◆ getBinU() [2/2]

unsigned short getBinU	(	VxdID	id,
		unsigned int	uid,
		unsigned int	vid,
		unsigned short	nBinsU ) const

Get gain correction bin along sensor u side.

Parameters

id	unique ID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel
nBinsU	number of gain bins along u side

Returns: uBin correction bin along u side of sensor

Definition at line 54 of file PXDGainCalibrator.cc.

55{

56 unsigned int drainsPerBin = 4 * Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getUCells() / nBinsU;

57 return (uid * 4 + vid % 4) / drainsPerBin;

58}

Belle2::VXD::GeoCache::getSensorInfo

const SensorInfoBase & getSensorInfo(Belle2::VxdID id) const

Return a reference to the SensorInfo of a given SensorID.

Definition GeoCache.cc:67

Belle2::VXD::GeoCache::getInstance

static GeoCache & getInstance()

Return a reference to the singleton instance.

Definition GeoCache.cc:214

Belle2::VXD::SensorInfoBase::getUCells

int getUCells() const

Return number of pixel/strips in u direction.

Definition SensorInfoBase.h:214

◆ getBinV() [1/2]

unsigned short getBinV	(	VxdID	id,
		unsigned int	vid ) const

Get gain correction bin along sensor v side.

Parameters

id	unique ID of the sensor
vid	vCell of single pixel

Returns: vBin correction bin along v side of sensor

Definition at line 71 of file PXDGainCalibrator.cc.

72{

73 return getBinV(id, vid, m_gains.getBinsV());

74}

Belle2::PXD::getBinV

unsigned short getBinV(VxdID id, unsigned int vid, unsigned short nBinsV)

Function to return a bin number for equal sized binning in V.

Definition PXDUtilities.h:171

◆ getBinV() [2/2]

unsigned short getBinV	(	VxdID	id,
		unsigned int	vid,
		unsigned short	nBinsV ) const

Get gain correction bin along v side.

Parameters

id	unique ID of the sensor
vid	vCell of single pixel
nBinsV	number of gain bins along v side

Returns: vBin correction bin along v side of sensor

Definition at line 65 of file PXDGainCalibrator.cc.

66{

67 unsigned int rowsPerBin = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells() / nBinsV;

68 return vid / rowsPerBin;

69}

Belle2::VXD::SensorInfoBase::getVCells

int getVCells() const

Return number of pixel/strips in v direction.

Definition SensorInfoBase.h:216

◆ getGainCorrection()

float getGainCorrection	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Get gain correction.

Parameters

id	unique ID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: gain correction

Definition at line 34 of file PXDGainCalibrator.cc.

{
  unsigned int rowsPerBin = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells() / m_gains.getBinsV();
  unsigned int drainsPerBin = 4 * Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getUCells() / m_gains.getBinsU();
  unsigned int uBin = (uid * 4 + vid % 4) / drainsPerBin;
  unsigned int vBin = vid / rowsPerBin;
  return m_gains.getContent(id.getID(), uBin, vBin);
}

◆ getGainMapParameters()

const PXDGainMapPar & getGainMapParameters ( ) const

inline

Return current gain correction payload.

Definition at line 96 of file PXDGainCalibrator.h.

96{return m_gains;}

◆ getGlobalID()

unsigned short getGlobalID	(	VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Get global ID for gain correction on a sensor.

Parameters

id	unique ID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: globalID Unique ID for gain correction

Definition at line 76 of file PXDGainCalibrator.cc.

{
  auto uBin = getBinU(id, uid, vid);
  auto vBin = getBinV(id, vid);
  return m_gains.getGlobalID(uBin, vBin);
}

◆ getInstance()

Belle2::PXD::PXDGainCalibrator & getInstance ( )

static

Main (and only) way to access the PXDGainCalibrator.

Definition at line 27 of file PXDGainCalibrator.cc.

28{

29 static std::unique_ptr<Belle2::PXD::PXDGainCalibrator> instance(new Belle2::PXD::PXDGainCalibrator());

30 return *instance;

31}

◆ initialize()

void initialize ( )

Initialize the PXDGainCalibrator.

Definition at line 16 of file PXDGainCalibrator.cc.

{
  m_gainsFromDB = unique_ptr<Belle2::DBObjPtr<Belle2::PXDGainMapPar>>(new Belle2::DBObjPtr<Belle2::PXDGainMapPar>());
 
  if ((*m_gainsFromDB).isValid()) {
    setGains();
    (*m_gainsFromDB).addCallback(this, &Belle2::PXD::PXDGainCalibrator::setGains);
  }
}

◆ setGains()

void setGains ( )

Set gains from DB.

Definition at line 84 of file PXDGainCalibrator.cc.

85{

86 m_gains = **m_gainsFromDB;

87}

Member Data Documentation

◆ m_gains

PXDGainMapPar m_gains

private

Map of gain corrections.

Definition at line 111 of file PXDGainCalibrator.h.

◆ m_gainsFromDB

std::unique_ptr<DBObjPtr<PXDGainMapPar> > m_gainsFromDB

private

Masked pixels retrieved from DB.

Definition at line 108 of file PXDGainCalibrator.h.

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

pxd/reconstruction/include/PXDGainCalibrator.h
pxd/reconstruction/src/PXDGainCalibrator.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PXDGainCalibrator()

Member Function Documentation

◆ getADUToEnergy()

◆ getBinU() [1/2]

◆ getBinU() [2/2]

◆ getBinV() [1/2]

◆ getBinV() [2/2]

◆ getGainCorrection()

◆ getGainMapParameters()

◆ getGlobalID()

◆ getInstance()

◆ initialize()

◆ setGains()

Member Data Documentation

◆ m_gains

◆ m_gainsFromDB