SiStripRawProcessingAlgorithms Class Reference

#include <SiStripRawProcessingAlgorithms.h>

Public Types
using	digivector_t = SiStripAPVRestorer::digivector_t

Public Member Functions
uint16_t	convertVirginRawToHybrid (uint32_t detId, uint16_t firstAPV, digivector_t &inDigis, edm::DetSet< SiStripDigi > &rawDigis)
uint16_t	convertVirginRawToHybrid (const edm::DetSet< SiStripRawDigi > &rawDigis, edm::DetSet< SiStripDigi > &suppressedDigis)
const std::vector< bool > &	getAPVFlags () const
const SiStripAPVRestorer::medians_t &	getAPVsCM () const
const SiStripAPVRestorer::baselinemap_t &	getBaselineMap () const
const std::map< uint16_t, SiStripAPVRestorer::digimap_t > &	getSmoothedPoints () const
void	initialize (const edm::EventSetup &)
void	initialize (const edm::EventSetup &, const edm::Event &)
uint16_t	suppressHybridData (const edm::DetSet< SiStripDigi > &inDigis, edm::DetSet< SiStripDigi > &suppressedDigis, uint16_t firstAPV=0)
uint16_t	suppressProcessedRawData (uint32_t detId, uint16_t firstAPV, digivector_t &procRawDigis, edm::DetSet< SiStripDigi > &output)
uint16_t	suppressProcessedRawData (const edm::DetSet< SiStripRawDigi > &rawDigis, edm::DetSet< SiStripDigi > &output)
uint16_t	suppressVirginRawData (uint32_t detId, uint16_t firstAPV, digivector_t &procRawDigis, edm::DetSet< SiStripDigi > &output)
uint16_t	suppressVirginRawData (const edm::DetSet< SiStripRawDigi > &rawDigis, edm::DetSet< SiStripDigi > &output)

Public Attributes
const std::unique_ptr< SiStripAPVRestorer >	restorer
const std::unique_ptr< SiStripCommonModeNoiseSubtractor >	subtractorCMN
const std::unique_ptr< SiStripPedestalsSubtractor >	subtractorPed
const std::unique_ptr< SiStripFedZeroSuppression >	suppressor

Private Member Functions
	SiStripRawProcessingAlgorithms (edm::ConsumesCollector iC, std::unique_ptr< SiStripPedestalsSubtractor > ped, std::unique_ptr< SiStripCommonModeNoiseSubtractor > cmn, std::unique_ptr< SiStripFedZeroSuppression > zs, std::unique_ptr< SiStripAPVRestorer > res, bool doAPVRest, bool useCMMap)

Private Attributes
const bool	doAPVRestore
edm::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	tkGeomToken_
const TrackerGeometry *	trGeo
const bool	useCMMeanMap

Friends
class	SiStripRawProcessingFactory

Detailed Description

Definition at line 15 of file SiStripRawProcessingAlgorithms.h.

Member Typedef Documentation

digivector_t

using SiStripRawProcessingAlgorithms::digivector_t = SiStripAPVRestorer::digivector_t

Definition at line 19 of file SiStripRawProcessingAlgorithms.h.

Constructor & Destructor Documentation

SiStripRawProcessingAlgorithms()

SiStripRawProcessingAlgorithms::SiStripRawProcessingAlgorithms ( edm::ConsumesCollector  iC, std::unique_ptr< SiStripPedestalsSubtractor >  ped, std::unique_ptr< SiStripCommonModeNoiseSubtractor >  cmn, std::unique_ptr< SiStripFedZeroSuppression >  zs, std::unique_ptr< SiStripAPVRestorer >  res, bool  doAPVRest, bool  useCMMap  )

private

Definition at line 14 of file SiStripRawProcessingAlgorithms.cc.

    : subtractorPed(std::move(ped)),
      subtractorCMN(std::move(cmn)),
      suppressor(std::move(zs)),
      restorer(std::move(res)),
      doAPVRestore(doAPVRest),
      useCMMeanMap(useCMMap),
      tkGeomToken_(iC.esConsumes<TrackerGeometry, TrackerDigiGeometryRecord>()) {}

Member Function Documentation

convertVirginRawToHybrid() [1/2]

uint16_t SiStripRawProcessingAlgorithms::convertVirginRawToHybrid	(	uint32_t	id,
		uint16_t	firstAPV,
		digivector_t &	procRawDigis,
		edm::DetSet< SiStripDigi > &	output
	)

Zero-suppress virgin raw data in "hybrid" mode

Subtracts pedestals (in 11bit mode, x->(x+1024-ped)/2) and common-mode noise, and inspects the digis then. If not flagged by the hybrid APV inspector, the zero-suppression is performed as usual (evaluation and subtraction of the baseline, truncation). Otherwise, the pedestal-subtracted digis (as above) are saved in one 128-strip cluster. Note: the APV restorer is used, it must be configured with APVInspectMode='HybridEmulation' if this method is called.

Parameters

id	module DetId
firstAPV	index of the first APV considered
procRawDigis	input (virgin raw) ADCs. Output: the ADCs after all subtractions, but before zero-suppression
output	zero-suppressed digis (or pedestal-subtracted digis, see above)

Returns

number of restored APVs

Definition at line 203 of file SiStripRawProcessingAlgorithms.cc.

References getAPVFlags(), mps_fire::i, restorer, subtractorCMN, subtractorPed, suppressor, and HLT_2024v13_cff::truncate.

Referenced by convertVirginRawToHybrid().

                                                                                                  {
  digivector_t procRawDigisPedSubtracted;

  for (auto& digi : procRawDigis) {
    digi += 1024;
  }  // adding one MSB

  subtractorPed->subtract(id, firstAPV * 128, procRawDigis);  // all strips are pedestals subtracted

  for (auto& digi : procRawDigis) {
    digi /= 2;
  }

  procRawDigisPedSubtracted.assign(procRawDigis.begin(), procRawDigis.end());

  subtractorCMN->subtract(id, firstAPV, procRawDigis);

  const auto nAPVFlagged = restorer->inspect(id, firstAPV, procRawDigis, subtractorCMN->getAPVsCM());

  for (auto& digi : procRawDigis) {
    digi *= 2;
  }

  const std::vector<bool>& apvf = getAPVFlags();
  const std::size_t nAPVs = procRawDigis.size() / 128;
  for (uint16_t iAPV = firstAPV; iAPV < nAPVs + firstAPV; ++iAPV) {
    if (apvf[iAPV]) {
      //GB 23/6/08: truncation should be done at the very beginning
      for (uint16_t i = 0; i < 128; ++i) {
        const int16_t digi = procRawDigisPedSubtracted[128 * (iAPV - firstAPV) + i];
        output.push_back(SiStripDigi(128 * iAPV + i, (digi < 0 ? 0 : suppressor->truncate(digi))));
      }
    } else {
      const auto firstDigiIt = std::begin(procRawDigis) + 128 * (iAPV - firstAPV);
      std::vector<int16_t> singleAPVdigi(firstDigiIt, firstDigiIt + 128);
      suppressor->suppress(singleAPVdigi, iAPV, output);
    }
  }

  return nAPVFlagged;
}

convertVirginRawToHybrid() [2/2]

uint16_t SiStripRawProcessingAlgorithms::convertVirginRawToHybrid	(	const edm::DetSet< SiStripRawDigi > &	rawDigis,
		edm::DetSet< SiStripDigi > &	suppressedDigis
	)

Zero-suppress virgin raw data in "hybrid" mode

Subtracts pedestals (in 11bit mode, x->(x+1024-ped)/2) and common-mode noise, and inspects the digis then. If flagged by the hybrid APV inspector, the zero-suppression is performed as usual (evaluation and subtraction of the baseline, truncation). Otherwise, the pedestal-subtracted digis are saved in one 128-strip cluster.

Parameters

rawDigis	input (virgin) raw digis
output	zero-suppressed digis (or pedestal-subtracted digis, see above)

Returns

number of restored APVs

Definition at line 260 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), convertVirginRawToHybrid(), edm::DetSet< T >::id, edm::DetSet< T >::size(), and HcalDetIdTransform::transform().

                                                                                                           {
  digivector_t rawdigis;
  rawdigis.reserve(rawDigis.size());
  std::transform(std::begin(rawDigis), std::end(rawDigis), std::back_inserter(rawdigis), [](SiStripRawDigi digi) {
    return digi.adc();
  });
  return convertVirginRawToHybrid(rawDigis.id, 0, rawdigis, suppressedDigis);
}

getAPVFlags()

const std::vector<bool>& SiStripRawProcessingAlgorithms::getAPVFlags ( ) const

inline

Definition at line 47 of file SiStripRawProcessingAlgorithms.h.

References restorer.

Referenced by convertVirginRawToHybrid(), and suppressHybridData().

{ return restorer->getAPVFlags(); }

getAPVsCM()

const SiStripAPVRestorer::medians_t& SiStripRawProcessingAlgorithms::getAPVsCM ( ) const

inline

Definition at line 52 of file SiStripRawProcessingAlgorithms.h.

References subtractorCMN.

{ return subtractorCMN->getAPVsCM(); }

getBaselineMap()

const SiStripAPVRestorer::baselinemap_t& SiStripRawProcessingAlgorithms::getBaselineMap ( ) const

inline

Definition at line 48 of file SiStripRawProcessingAlgorithms.h.

References restorer.

{ return restorer->getBaselineMap(); }

getSmoothedPoints()

const std::map<uint16_t, SiStripAPVRestorer::digimap_t>& SiStripRawProcessingAlgorithms::getSmoothedPoints ( ) const

inline

Definition at line 49 of file SiStripRawProcessingAlgorithms.h.

References restorer.

                                                                                        {
    return restorer->getSmoothedPoints();
  }

initialize() [1/2]

void SiStripRawProcessingAlgorithms::initialize

(

const edm::EventSetup &

es

)

Definition at line 29 of file SiStripRawProcessingAlgorithms.cc.

References edm::EventSetup::getData(), restorer, subtractorCMN, subtractorPed, suppressor, tkGeomToken_, and trGeo.

Referenced by initialize().

                                                                       {
  subtractorPed->init(es);
  subtractorCMN->init(es);
  suppressor->init(es);
  if (restorer.get())
    restorer->init(es);

  trGeo = &es.getData(tkGeomToken_);
}

initialize() [2/2]

void SiStripRawProcessingAlgorithms::initialize	(	const edm::EventSetup &	es,
		const edm::Event &	e
	)

Definition at line 39 of file SiStripRawProcessingAlgorithms.cc.

References doAPVRestore, MillePedeFileConverter_cfg::e, initialize(), restorer, and useCMMeanMap.

                                                                                          {
  initialize(es);
  if (restorer.get() && doAPVRestore && useCMMeanMap)
    restorer->loadMeanCMMap(e);
}

suppressHybridData()

uint16_t SiStripRawProcessingAlgorithms::suppressHybridData	(	const edm::DetSet< SiStripDigi > &	hybridDigis,
		edm::DetSet< SiStripDigi > &	suppressedDigis,
		uint16_t	firstAPV = 0
	)

Zero-suppress "hybrid" raw data

Subtracts common-mode noise, and inspects the digis then. If flagged by the APV inspector, the zero-suppression is performed as usual. Otherwise, the positive inputs are copied.

Parameters

hybridDigis	input ADCs in ZS format (regular ZS or "hybrid", i.e. processed as x->(x+1024-ped)/2)
suppressedDigis	zero-suppressed digis
firstAPV	(optional) number of the first APV for which digis are should be handled (otherwise all present)

Returns

number of restored APVs

Definition at line 58 of file SiStripRawProcessingAlgorithms.cc.

References SiStripDigi::adc(), edm::DetSet< T >::begin(), HLT_2024v13_cff::distance, edm::DetSet< T >::end(), getAPVFlags(), mps_fire::i, edm::DetSet< T >::id, ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, edm::DetSet< T >::push_back(), restorer, SiStripDigi::strip(), subtractorCMN, suppressor, and HcalDetIdTransform::transform().

                                                                               {
  uint16_t nAPVFlagged = 0;
  auto beginAPV = hybridDigis.begin();
  const auto indigis_end = hybridDigis.end();
  auto iAPV = firstAPV;
  while (beginAPV != indigis_end) {
    const auto endAPV = std::lower_bound(beginAPV, indigis_end, SiStripDigi((iAPV + 1) * 128, 0));
    const auto nDigisInAPV = std::distance(beginAPV, endAPV);
    if (nDigisInAPV > 64) {
      digivector_t workDigis(128, -1024);
      for (auto it = beginAPV; it != endAPV; ++it) {
        workDigis[it->strip() - 128 * iAPV] = it->adc() * 2 - 1024;
      }
      digivector_t workDigisPedSubtracted(workDigis);
      subtractorCMN->subtract(hybridDigis.id, iAPV, workDigis);
      const auto apvFlagged = restorer->inspectAndRestore(
          hybridDigis.id, iAPV, workDigisPedSubtracted, workDigis, subtractorCMN->getAPVsCM());
      nAPVFlagged += apvFlagged;
      if (getAPVFlags()[iAPV]) {
        suppressor->suppress(workDigis, iAPV, suppressedDigis);
      } else {  // bad APV: more than 64 but not flagged
        for (uint16_t i = 0; i != 128; ++i) {
          const auto digi = workDigisPedSubtracted[i];
          if (digi > 0) {
            suppressedDigis.push_back(SiStripDigi(iAPV * 128 + i, suppressor->truncate(digi)));
          }
        }
      }
    } else {  // already zero-suppressed, copy and truncate
      std::transform(beginAPV, endAPV, std::back_inserter(suppressedDigis), [this](const SiStripDigi inDigi) {
        return SiStripDigi(inDigi.strip(), suppressor->truncate(inDigi.adc()));
      });
    }
    beginAPV = endAPV;
    ++iAPV;
  }
  return nAPVFlagged;
}

suppressProcessedRawData() [1/2]

uint16_t SiStripRawProcessingAlgorithms::suppressProcessedRawData	(	uint32_t	id,
		uint16_t	firstAPV,
		digivector_t &	procRawDigis,
		edm::DetSet< SiStripDigi > &	output
	)

Zero-suppress processed (pedestals-subtracted) raw data.

Subtracts common-mode noise and (optionally, if doAPVRestore) re-evaluates and subtracts the baseline.

Parameters

id	module DetId
firstAPV	index of the first APV to consider
procRawDigis	input (processed raw) ADCs. Output: the ADCs after all subtractions, but before zero-suppression
output	zero-suppressed digis

Returns

number of restored APVs

Definition at line 151 of file SiStripRawProcessingAlgorithms.cc.

References doAPVRestore, restorer, subtractorCMN, and suppressor.

Referenced by suppressProcessedRawData(), and suppressVirginRawData().

                                                                                                  {
  digivector_t procRawDigisPedSubtracted;

  int16_t nAPVFlagged = 0;
  if (doAPVRestore)
    procRawDigisPedSubtracted.assign(procRawDigis.begin(), procRawDigis.end());
  subtractorCMN->subtract(id, firstAPV, procRawDigis);
  if (doAPVRestore)
    nAPVFlagged =
        restorer->inspectAndRestore(id, firstAPV, procRawDigisPedSubtracted, procRawDigis, subtractorCMN->getAPVsCM());
  suppressor->suppress(procRawDigis, firstAPV, output);
  return nAPVFlagged;
}

suppressProcessedRawData() [2/2]

uint16_t SiStripRawProcessingAlgorithms::suppressProcessedRawData	(	const edm::DetSet< SiStripRawDigi > &	rawDigis,
		edm::DetSet< SiStripDigi > &	output
	)

Zero-suppress processed (pedestals-subtracted) raw data.

Subtracts common-mode noise and (optionally, if doAPVRestore) re-evaluates and subtracts the baseline.

Parameters

rawDigis	input (processed) raw digis
output	zero-suppressed digis

Returns

number of restored APVs

Definition at line 178 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), edm::DetSet< T >::id, edm::DetSet< T >::size(), suppressProcessedRawData(), and HcalDetIdTransform::transform().

                                                                                                  {
  digivector_t rawdigis;
  rawdigis.reserve(rawDigis.size());
  std::transform(std::begin(rawDigis), std::end(rawDigis), std::back_inserter(rawdigis), [](SiStripRawDigi digi) {
    return digi.adc();
  });
  return suppressProcessedRawData(rawDigis.id, 0, rawdigis, output);
}

suppressVirginRawData() [1/2]

uint16_t SiStripRawProcessingAlgorithms::suppressVirginRawData	(	uint32_t	id,
		uint16_t	firstAPV,
		digivector_t &	procRawDigis,
		edm::DetSet< SiStripDigi > &	output
	)

Zero-suppress virgin raw data.

Subtracts pedestals and common-mode noise, and (optionally, if doAPVRestore) re-evaluates and subtracts the baseline.

Parameters

id	module DetId
firstAPV	index of the first APV to consider
procRawDigis	input (virgin raw) ADCs. Output: the ADCs after all subtractions, but before zero-suppression
output	zero-suppressed digis

Returns

number of restored APVs

Definition at line 111 of file SiStripRawProcessingAlgorithms.cc.

References subtractorPed, and suppressProcessedRawData().

Referenced by suppressVirginRawData().

                                                                                               {
  subtractorPed->subtract(id, firstAPV * 128, procRawDigis);
  return suppressProcessedRawData(id, firstAPV, procRawDigis, output);
}

suppressVirginRawData() [2/2]

uint16_t SiStripRawProcessingAlgorithms::suppressVirginRawData	(	const edm::DetSet< SiStripRawDigi > &	rawDigis,
		edm::DetSet< SiStripDigi > &	output
	)

Zero-suppress virgin raw data.

Subtracts pedestals and common-mode noise, and (optionally, if doAPVRestore) re-evaluates and subtracts the baseline.

Parameters

rawDigis	input (virgin) raw digis
output	zero-suppressed digis

Returns

number of restored APVs

Definition at line 129 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), edm::DetSet< T >::id, edm::DetSet< T >::size(), suppressVirginRawData(), and HcalDetIdTransform::transform().

                                                                                               {
  digivector_t rawdigis;
  rawdigis.reserve(rawDigis.size());
  std::transform(std::begin(rawDigis), std::end(rawDigis), std::back_inserter(rawdigis), [](SiStripRawDigi digi) {
    return digi.adc();
  });
  return suppressVirginRawData(rawDigis.id, 0, rawdigis, output);
}

Friends And Related Function Documentation

SiStripRawProcessingFactory

friend class SiStripRawProcessingFactory

friend

Definition at line 16 of file SiStripRawProcessingAlgorithms.h.

Member Data Documentation

doAPVRestore

const bool SiStripRawProcessingAlgorithms::doAPVRestore

private

Definition at line 60 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize(), and suppressProcessedRawData().

restorer

const std::unique_ptr<SiStripAPVRestorer> SiStripRawProcessingAlgorithms::restorer

Definition at line 57 of file SiStripRawProcessingAlgorithms.h.

Referenced by convertVirginRawToHybrid(), getAPVFlags(), getBaselineMap(), getSmoothedPoints(), initialize(), suppressHybridData(), and suppressProcessedRawData().

subtractorCMN

const std::unique_ptr<SiStripCommonModeNoiseSubtractor> SiStripRawProcessingAlgorithms::subtractorCMN

Definition at line 55 of file SiStripRawProcessingAlgorithms.h.

Referenced by convertVirginRawToHybrid(), getAPVsCM(), initialize(), suppressHybridData(), and suppressProcessedRawData().

subtractorPed

const std::unique_ptr<SiStripPedestalsSubtractor> SiStripRawProcessingAlgorithms::subtractorPed

Definition at line 54 of file SiStripRawProcessingAlgorithms.h.

Referenced by convertVirginRawToHybrid(), initialize(), and suppressVirginRawData().

suppressor

const std::unique_ptr<SiStripFedZeroSuppression> SiStripRawProcessingAlgorithms::suppressor

Definition at line 56 of file SiStripRawProcessingAlgorithms.h.

Referenced by convertVirginRawToHybrid(), initialize(), suppressHybridData(), and suppressProcessedRawData().

tkGeomToken_

edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> SiStripRawProcessingAlgorithms::tkGeomToken_

private

Definition at line 63 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize().

trGeo

const TrackerGeometry* SiStripRawProcessingAlgorithms::trGeo

private

Definition at line 64 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize().

useCMMeanMap

const bool SiStripRawProcessingAlgorithms::useCMMeanMap

private

Definition at line 61 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize().