Singleton class for managing pixel masking for the PXD. More...

#include <PXDPixelMasker.h>

Public Member Functions
void	initialize ()
	Initialize the PXDPixelMasker.

void	setPixelThresholds ()
	Set pixel threshold from DB.

void	setPixelThresholds (PXDMaskedPixelPar maskedPixels)
	Set pixel threshold from masked pixels from DB.

void	setMaskedPixels ()
	Set masked pixels from DB.

void	setDeadPixels ()
	Set dead pixels from DB.

void	setSinglePixelThreshold (VxdID id, unsigned int uid, unsigned int vid, unsigned short pixThr)
	Set threshold for single pixel.

void	maskSinglePixel (VxdID id, unsigned int uid, unsigned int vid)
	Mask single pixel.

unsigned short	getPixelThreshold (VxdID id, unsigned int uid, unsigned int vid) const
	Check whether a pixel on a given sensor is OK or not and get threshold.

bool	pixelOK (VxdID id, unsigned int uid, unsigned int vid) const
	Check whether a pixel on a given sensor is OK or not.

bool	pixelDead (VxdID id, unsigned int uid, unsigned int vid) const
	Check whether a pixel on a given sensor is dead or not.

const PXDPixelThresholdPar &	getPixelThresholdParameters () const
	Return masked pixel payload.

const PXDMaskedPixelPar &	getMaskedPixelParameters () const
	Return masked pixel payload.

const PXDDeadPixelPar &	getDeadPixelParameters () const
	Return dead pixel payload.

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

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

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

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

Private Attributes
DBObjPtr< PXDPixelThresholdPar >	m_pixelThresholdsFromDB
	Pixel thresholds from DB.

DBObjPtr< PXDMaskedPixelPar >	m_maskedPixelsFromDB
	Masked pixels retrieved from DB.

DBObjPtr< PXDDeadPixelPar >	m_deadPixelsFromDB
	Dead pixels retrieved from DB.

PXDPixelThresholdPar	m_pixelThresholds
	List of pixel threshold.

PXDMaskedPixelPar	m_maskedPixels
	List of masked pixels.

PXDDeadPixelPar	m_deadPixels
	List of masked pixels.

Detailed Description

Singleton class for managing pixel masking for the PXD.

Definition at line 28 of file PXDPixelMasker.h.

Constructor & Destructor Documentation

◆ PXDPixelMasker()

PXDPixelMasker ( )

inlineprivate

Singleton class, hidden constructor.

Definition at line 103 of file PXDPixelMasker.h.

103{};

Member Function Documentation

◆ getDeadPixelParameters()

const PXDDeadPixelPar & getDeadPixelParameters ( ) const

inline

Return dead pixel payload.

Definition at line 98 of file PXDPixelMasker.h.

98{return m_deadPixels;}

◆ getInstance()

Belle2::PXD::PXDPixelMasker & getInstance ( )

static

Main (and only) way to access the PXDPixelMasker.

Definition at line 41 of file PXDPixelMasker.cc.

{
  static std::unique_ptr<Belle2::PXD::PXDPixelMasker> instance(new Belle2::PXD::PXDPixelMasker());
  return *instance;
}

◆ getMaskedPixelParameters()

const PXDMaskedPixelPar & getMaskedPixelParameters ( ) const

inline

Return masked pixel payload.

Definition at line 95 of file PXDPixelMasker.h.

95{return m_maskedPixels;}

◆ getPixelThreshold()

unsigned short getPixelThreshold	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Check whether a pixel on a given sensor is OK or not and get threshold.

Parameters

id	VxdID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: charge threshold of the single pixel.

Definition at line 60 of file PXDPixelMasker.cc.

{
  auto vCells = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells();
  return m_pixelThresholds.getPixelThreshold(id.getID(), uid * vCells + vid);
}

◆ getPixelThresholdParameters()

const PXDPixelThresholdPar & getPixelThresholdParameters ( ) const

inline

Return masked pixel payload.

Definition at line 92 of file PXDPixelMasker.h.

92{return m_pixelThresholds;}

◆ initialize()

void initialize ( )

Initialize the PXDPixelMasker.

Definition at line 17 of file PXDPixelMasker.cc.

{
 
  if ((m_pixelThresholdsFromDB).isValid()) {
    setPixelThresholds();
    (m_pixelThresholdsFromDB).addCallback(this, &Belle2::PXD::PXDPixelMasker::setPixelThresholds);
  }
 
  if ((m_maskedPixelsFromDB).isValid()) {
    setMaskedPixels();
    (m_maskedPixelsFromDB).addCallback(this, &Belle2::PXD::PXDPixelMasker::setMaskedPixels);
    if (!(m_pixelThresholdsFromDB).isValid() or !(m_pixelThresholdsFromDB)->getPixelThresholdMap().size()) {
      setPixelThresholds(m_maskedPixels);
      (m_pixelThresholdsFromDB).addCallback(this, &Belle2::PXD::PXDPixelMasker::setPixelThresholds);
    }
  }
 
  if ((m_deadPixelsFromDB).isValid()) {
    setDeadPixels();
    (m_deadPixelsFromDB).addCallback(this, &Belle2::PXD::PXDPixelMasker::setDeadPixels);
  }
}

◆ maskSinglePixel()

void maskSinglePixel	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid )

Mask single pixel.

Parameters

id	VxdID of the required sensor
uid	uCell of single pixel to mask
vid	vCell of single pixel to mask

Definition at line 54 of file PXDPixelMasker.cc.

{
  auto vCells = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells();
  m_maskedPixels.maskSinglePixel(id.getID(), uid * vCells + vid);
}

◆ pixelDead()

bool pixelDead	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Check whether a pixel on a given sensor is dead or not.

Parameters

id	VxdID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: true if pixel DEAD, otherwise false.

Definition at line 72 of file PXDPixelMasker.cc.

{
  auto sensorID = id.getID();
  if (m_deadPixels.isDeadSensor(sensorID))
    return true;
 
  if (m_deadPixels.isDeadRow(sensorID, vid))
    return true;
 
  if (m_deadPixels.isDeadDrain(sensorID, uid * 4 + vid % 4))
    return true;
 
  auto vCells = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells();
  if (m_deadPixels.isDeadSinglePixel(sensorID, uid * vCells + vid))
    return true;
 
  return false;
}

◆ pixelOK()

bool pixelOK	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid ) const

Check whether a pixel on a given sensor is OK or not.

Parameters

id	VxdID of the sensor
uid	uCell of single pixel
vid	vCell of single pixel

Returns: true if pixel is OK, otherwise false.

Definition at line 66 of file PXDPixelMasker.cc.

{
  auto vCells = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells();
  return (m_pixelThresholds.getPixelThreshold(id.getID(), uid * vCells + vid) < 255);
}

◆ setDeadPixels()

void setDeadPixels ( )

Set dead pixels from DB.

Definition at line 113 of file PXDPixelMasker.cc.

{
  m_deadPixels = *m_deadPixelsFromDB;
}

◆ setMaskedPixels()

void setMaskedPixels ( )

Set masked pixels from DB.

Definition at line 108 of file PXDPixelMasker.cc.

{
  m_maskedPixels = *m_maskedPixelsFromDB;
}

◆ setPixelThresholds() [1/2]

void setPixelThresholds ( )

Set pixel threshold from DB.

Definition at line 103 of file PXDPixelMasker.cc.

{
  m_pixelThresholds = *m_pixelThresholdsFromDB;
}

◆ setPixelThresholds() [2/2]

void setPixelThresholds ( PXDMaskedPixelPar maskedPixels )

Set pixel threshold from masked pixels from DB.

Definition at line 91 of file PXDPixelMasker.cc.

{
  auto maskedPixelMap = maskedPixels.getMaskedPixelMap();
  for (auto maskedSingles = maskedPixelMap.begin(); maskedSingles != maskedPixelMap.end(); maskedSingles++) {
    const auto& sensorID = maskedSingles->first;
    const auto& singles = maskedSingles->second;
    for (const auto& single : singles) {
      m_pixelThresholds.setSinglePixelThreshold(sensorID, single, 255);
    }
  }
}

◆ setSinglePixelThreshold()

void setSinglePixelThreshold	(	Belle2::VxdID	id,
		unsigned int	uid,
		unsigned int	vid,
		unsigned short	pixThr )

Set threshold for single pixel.

Parameters

id	VxdID of the required sensor
uid	uCell of single pixel to mask
vid	vCell of single pixel to mask
pixThr	charge threshold of the single pixel

Definition at line 47 of file PXDPixelMasker.cc.

{
  auto vCells = Belle2::VXD::GeoCache::getInstance().getSensorInfo(id).getVCells();
  m_pixelThresholds.setSinglePixelThreshold(id.getID(), uid * vCells + vid, pixThr);
}

Member Data Documentation

◆ m_deadPixels

PXDDeadPixelPar m_deadPixels

private

List of masked pixels.

Definition at line 125 of file PXDPixelMasker.h.

◆ m_deadPixelsFromDB

DBObjPtr<PXDDeadPixelPar> m_deadPixelsFromDB

private

Dead pixels retrieved from DB.

Definition at line 116 of file PXDPixelMasker.h.

◆ m_maskedPixels

PXDMaskedPixelPar m_maskedPixels

private

List of masked pixels.

Definition at line 122 of file PXDPixelMasker.h.

◆ m_maskedPixelsFromDB

DBObjPtr<PXDMaskedPixelPar> m_maskedPixelsFromDB

private

Masked pixels retrieved from DB.

Definition at line 113 of file PXDPixelMasker.h.

◆ m_pixelThresholds

PXDPixelThresholdPar m_pixelThresholds

private

List of pixel threshold.

Definition at line 119 of file PXDPixelMasker.h.

◆ m_pixelThresholdsFromDB

DBObjPtr<PXDPixelThresholdPar> m_pixelThresholdsFromDB

private

Pixel thresholds from DB.

Definition at line 110 of file PXDPixelMasker.h.

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PXDPixelMasker()

Member Function Documentation

◆ getDeadPixelParameters()

◆ getInstance()

◆ getMaskedPixelParameters()

◆ getPixelThreshold()

◆ getPixelThresholdParameters()

◆ initialize()

◆ maskSinglePixel()

◆ pixelDead()

◆ pixelOK()

◆ setDeadPixels()

◆ setMaskedPixels()

◆ setPixelThresholds() [1/2]

◆ setPixelThresholds() [2/2]

◆ setSinglePixelThreshold()

Member Data Documentation

◆ m_deadPixels

◆ m_deadPixelsFromDB

◆ m_maskedPixels

◆ m_maskedPixelsFromDB

◆ m_pixelThresholds

◆ m_pixelThresholdsFromDB