SiStripRawProcessingAlgorithms Class Reference

#include <SiStripRawProcessingAlgorithms.h>

Public Types
using	digivector_t = SiStripAPVRestorer::digivector_t

Public Member Functions
void	convertHybridDigiToRawDigiVector (const edm::DetSet< SiStripDigi > &inDigis, digivector_t &rawDigis)
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, digivector_t &rawDigis)
uint16_t	suppressHybridData (uint32_t detId, uint16_t firstAPV, digivector_t &processedRawDigis, edm::DetSet< SiStripDigi > &suppressedDigis)
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 (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
const TrackerGeometry *	trGeo
const bool	useCMMeanMap

Friends
class	SiStripRawProcessingFactory

Detailed Description

Definition at line 15 of file SiStripRawProcessingAlgorithms.h.

Member Typedef Documentation

using SiStripRawProcessingAlgorithms::digivector_t = SiStripAPVRestorer::digivector_t

Definition at line 19 of file SiStripRawProcessingAlgorithms.h.

Constructor & Destructor Documentation

SiStripRawProcessingAlgorithms::SiStripRawProcessingAlgorithms ( 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) {}

Member Function Documentation

void SiStripRawProcessingAlgorithms::convertHybridDigiToRawDigiVector	(	const edm::DetSet< SiStripDigi > &	inDigis,
		digivector_t &	rawDigis
	)

Convert hybrid digis to a list of processed raw ADCs

Non-zero-suppressed APVs are identified by the number of ADCs found (above 64), and the ADCs converted into normal processed format (x->x*2-1024). For zero-supppressed APVs the absent strips are set to zero ADC.

Parameters

inDigis	input (non-ZS hybrid or ZS) data
RawDigis	processed raw (or zero-filled ZS) ADCs

Definition at line 121 of file SiStripRawProcessingAlgorithms.cc.

References edm::DetSet< T >::id, TrackerGeometry::idToDetUnit(), me0TriggerPseudoDigis_cff::nStrips, digitizers_cfi::strip, and trGeo.

Referenced by suppressHybridData().

                                                                                              {
  const auto stripModuleGeom = dynamic_cast<const StripGeomDetUnit*>(trGeo->idToDetUnit(inDigis.id));
  const std::size_t nStrips = stripModuleGeom->specificTopology().nstrips();
  const std::size_t nAPVs = nStrips / 128;

  rawDigis.assign(nStrips, 0);
  std::vector<uint16_t> stripsPerAPV(nAPVs, 0);

  for (SiStripDigi digi : inDigis) {
    rawDigis[digi.strip()] = digi.adc();
    ++stripsPerAPV[digi.strip() / 128];
  }

  for (uint16_t iAPV = 0; iAPV < nAPVs; ++iAPV) {
    if (stripsPerAPV[iAPV] > 64) {
      for (uint16_t strip = iAPV * 128; strip < (iAPV + 1) * 128; ++strip)
        rawDigis[strip] = rawDigis[strip] * 2 - 1024;
    }
  }
}

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 247 of file SiStripRawProcessingAlgorithms.cc.

References begin, getAPVFlags(), mps_fire::i, edm::DetSet< T >::push_back(), restorer, subtractorCMN, subtractorPed, and suppressor.

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;
}

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 304 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), begin, convertVirginRawToHybrid(), end, 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);
}

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

inline

Definition at line 53 of file SiStripRawProcessingAlgorithms.h.

References restorer.

Referenced by convertVirginRawToHybrid(), and suppressHybridData().

{ return restorer->getAPVFlags(); }

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

inline

Definition at line 58 of file SiStripRawProcessingAlgorithms.h.

References subtractorCMN.

{ return subtractorCMN->getAPVsCM(); }

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

inline

Definition at line 54 of file SiStripRawProcessingAlgorithms.h.

References restorer.

{ return restorer->getBaselineMap(); }

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

inline

Definition at line 55 of file SiStripRawProcessingAlgorithms.h.

References restorer.

                                                                                        {
    return restorer->getSmoothedPoints();
  }

void SiStripRawProcessingAlgorithms::initialize

(

const edm::EventSetup &

es

)

Definition at line 27 of file SiStripRawProcessingAlgorithms.cc.

References edm::EventSetup::get(), edm::ESHandle< T >::product(), restorer, subtractorCMN, subtractorPed, suppressor, PbPb_ZMuSkimMuonDPG_cff::tracker, and trGeo.

Referenced by initialize().

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

  edm::ESHandle<TrackerGeometry> tracker;
  es.get<TrackerDigiGeometryRecord>().get(tracker);
  trGeo = tracker.product();
}

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

Definition at line 39 of file SiStripRawProcessingAlgorithms.cc.

References doAPVRestore, initialize(), restorer, and useCMMeanMap.

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

uint16_t SiStripRawProcessingAlgorithms::suppressHybridData	(	const edm::DetSet< SiStripDigi > &	hybridDigis,
		edm::DetSet< SiStripDigi > &	suppressedDigis,
		digivector_t &	rawDigis
	)

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)
output	zero-suppressed digis
RawDigis	processed ADCs

Returns

number of restored APVs

Definition at line 104 of file SiStripRawProcessingAlgorithms.cc.

References convertHybridDigiToRawDigiVector(), and edm::DetSet< T >::id.

                                                                                    {
  convertHybridDigiToRawDigiVector(hybridDigis, rawDigis);
  return suppressHybridData(hybridDigis.id, 0, rawDigis, suppressedDigis);
}

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

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

id	module DetId
firstAPV	index of the first APV considered
procRawDigis	input (processed raw) ADCs. Note that this means that ADCs for all strips are expected, so zero-suppressed data should be filled with zeros for the suppressed strips. Output: the ADCs after all subtractions, but before zero-suppression.
output	zero-suppressed digis

Returns

number of restored APVs

Definition at line 61 of file SiStripRawProcessingAlgorithms.cc.

References begin, getAPVFlags(), mps_fire::i, edm::DetSet< T >::push_back(), restorer, subtractorCMN, and suppressor.

                                                                                                     {
  digivector_t procRawDigisPedSubtracted(procRawDigis);

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

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

  const std::vector<bool>& apvf = getAPVFlags();
  const std::size_t nAPVs = procRawDigis.size() / 128;
  for (uint16_t iAPV = firstAPV; iAPV < firstAPV + nAPVs; ++iAPV) {
    if (apvf[iAPV]) {
      const auto firstDigiIt = std::begin(procRawDigis) + 128 * (iAPV - firstAPV);
      std::vector<int16_t> singleAPVdigi(firstDigiIt, firstDigiIt + 128);
      suppressor->suppress(singleAPVdigi, iAPV, suppressedDigis);
    } else {
      for (uint16_t i = 0; i < 128; ++i) {
        const int16_t digi = procRawDigisPedSubtracted[128 * (iAPV - firstAPV) + i];
        if (digi > 0) {
          suppressedDigis.push_back(SiStripDigi(iAPV * 128 + i, suppressor->truncate(digi)));
        }
      }
    }
  }

  return nAPVFlagged;
}

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 195 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;
}

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 222 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), begin, end, 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);
}

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 155 of file SiStripRawProcessingAlgorithms.cc.

References subtractorPed, and suppressProcessedRawData().

Referenced by suppressVirginRawData().

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

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 173 of file SiStripRawProcessingAlgorithms.cc.

References SiStripRawDigi::adc(), begin, end, 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

friend class SiStripRawProcessingFactory

friend

Definition at line 16 of file SiStripRawProcessingAlgorithms.h.

Member Data Documentation

const bool SiStripRawProcessingAlgorithms::doAPVRestore

private

Definition at line 66 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize(), and suppressProcessedRawData().

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

Definition at line 63 of file SiStripRawProcessingAlgorithms.h.

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

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

Definition at line 61 of file SiStripRawProcessingAlgorithms.h.

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

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

Definition at line 60 of file SiStripRawProcessingAlgorithms.h.

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

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

Definition at line 62 of file SiStripRawProcessingAlgorithms.h.

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

const TrackerGeometry* SiStripRawProcessingAlgorithms::trGeo

private

Definition at line 69 of file SiStripRawProcessingAlgorithms.h.

Referenced by convertHybridDigiToRawDigiVector(), and initialize().

const bool SiStripRawProcessingAlgorithms::useCMMeanMap

private

Definition at line 67 of file SiStripRawProcessingAlgorithms.h.

Referenced by initialize().