SiStripZeroSuppression Class Reference

#include <SiStripZeroSuppression.h>

Inheritance diagram for SiStripZeroSuppression:

Public Member Functions
void	produce (edm::Event &, const edm::EventSetup &) override
	SiStripZeroSuppression (const edm::ParameterSet &)
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Private Types
using	medians_t = std::vector< std::pair< short, float >>
using	rawtoken_t = edm::EDGetTokenT< edm::DetSetVector< SiStripRawDigi >>
enum	RawType { RawType::Unknown, RawType::VirginRaw, RawType::ProcessedRaw, RawType::ScopeMode }
using	zstoken_t = edm::EDGetTokenT< edm::DetSetVector< SiStripDigi >>

Private Member Functions
void	clearOutputs ()
edm::DetSet< SiStripRawDigi >	formatRawDigis (const edm::DetSet< SiStripRawDigi > &rawDigis)
edm::DetSet< SiStripRawDigi >	formatRawDigis (uint32_t detId, const std::vector< int16_t > &rawDigis)
void	processHybrid (const edm::DetSetVector< SiStripDigi > &input)
void	processRaw (const edm::DetSetVector< SiStripRawDigi > &input, RawType inType)
void	putOutputs (edm::Event &evt, const std::string &tagName)
void	storeBaseline (uint32_t, const medians_t &)
void	storeBaselinePoints (uint32_t)
void	storeCMN (uint32_t, const medians_t &)
void	storeExtraOutput (uint32_t, int16_t)

Private Attributes
std::unique_ptr < SiStripRawProcessingAlgorithms >	algorithms
bool	fixCM
std::vector< std::tuple < std::string, zstoken_t > >	hybridInputs
std::vector< edm::DetSet < SiStripProcessedRawDigi > >	output_apvcm
std::vector< edm::DetSet < SiStripDigi > >	output_base
std::vector< edm::DetSet < SiStripRawDigi > >	output_base_raw
std::vector< edm::DetSet < SiStripProcessedRawDigi > >	output_baseline
std::vector< edm::DetSet < SiStripDigi > >	output_baseline_points
bool	produceBaselinePoints
bool	produceCalculatedBaseline
bool	produceHybridFormat
bool	produceRawDigis
std::vector< std::tuple < std::string, RawType, rawtoken_t > >	rawInputs
bool	storeCM
bool	storeInZScollBadAPV

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
using	CacheTypes = CacheContexts< T...>
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T...>
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

Detailed Description

Definition at line 16 of file SiStripZeroSuppression.h.

Member Typedef Documentation

using SiStripZeroSuppression::medians_t = std::vector<std::pair<short, float>>

private

Definition at line 32 of file SiStripZeroSuppression.h.

using SiStripZeroSuppression::rawtoken_t = edm::EDGetTokenT<edm::DetSetVector<SiStripRawDigi>>

private

Definition at line 47 of file SiStripZeroSuppression.h.

using SiStripZeroSuppression::zstoken_t = edm::EDGetTokenT<edm::DetSetVector<SiStripDigi>>

private

Definition at line 48 of file SiStripZeroSuppression.h.

Member Enumeration Documentation

enum SiStripZeroSuppression::RawType

strongprivate

Enumerator
Unknown
VirginRaw
ProcessedRaw
ScopeMode

Definition at line 22 of file SiStripZeroSuppression.h.

{ Unknown, VirginRaw, ProcessedRaw, ScopeMode };

Constructor & Destructor Documentation

SiStripZeroSuppression::SiStripZeroSuppression ( const edm::ParameterSet &  conf )

explicit

Definition at line 14 of file SiStripZeroSuppression.cc.

References Exception, edm::ParameterSet::getParameter(), hybridInputs, beam_dqm_sourceclient-live_cfg::inputTag, output_apvcm, output_base, output_base_raw, output_baseline, output_baseline_points, ProcessedRaw, produceBaselinePoints, produceCalculatedBaseline, produceHybridFormat, produceRawDigis, rawInputs, ScopeMode, storeCM, AlCaHLTBitMon_QueryRunRegistry::string, Unknown, and VirginRaw.

    : algorithms(
          SiStripRawProcessingFactory::create(conf.getParameter<edm::ParameterSet>("Algorithms"), consumesCollector())),
      produceRawDigis(conf.getParameter<bool>("produceRawDigis")),
      storeCM(conf.getParameter<bool>("storeCM")),
      fixCM(conf.getParameter<bool>("fixCM")),
      produceCalculatedBaseline(conf.getParameter<bool>("produceCalculatedBaseline")),
      produceBaselinePoints(conf.getParameter<bool>("produceBaselinePoints")),
      storeInZScollBadAPV(conf.getParameter<bool>("storeInZScollBadAPV")),
      produceHybridFormat(conf.getParameter<bool>("produceHybridFormat")) {
  for (const auto& inputTag : conf.getParameter<std::vector<edm::InputTag>>("RawDigiProducersList")) {
    const auto& tagName = inputTag.instance();
    produces<edm::DetSetVector<SiStripDigi>>(tagName);
    if (produceRawDigis)
      produces<edm::DetSetVector<SiStripRawDigi>>(tagName);
    if (storeCM)
      produces<edm::DetSetVector<SiStripProcessedRawDigi>>("APVCM" + tagName);
    if (produceCalculatedBaseline)
      produces<edm::DetSetVector<SiStripProcessedRawDigi>>("BADAPVBASELINE" + tagName);
    if (produceBaselinePoints)
      produces<edm::DetSetVector<SiStripDigi>>("BADAPVBASELINEPOINTS" + tagName);

    RawType inputType = RawType::Unknown;
    if (tagName == "ProcessedRaw") {
      inputType = RawType::ProcessedRaw;
      if (produceHybridFormat)
        throw cms::Exception("Processed Raw Cannot be converted in hybrid Format");
    } else if (tagName == "VirginRaw") {
      inputType = RawType::VirginRaw;
    } else if (tagName == "ScopeMode") {
      inputType = RawType::ScopeMode;
      if (produceHybridFormat)
        throw cms::Exception("Scope Mode cannot be converted in hybrid Format");
    }
    if (RawType::Unknown != inputType) {
      rawInputs.emplace_back(tagName, inputType, consumes<edm::DetSetVector<SiStripRawDigi>>(inputTag));
    } else if (tagName == "ZeroSuppressed") {
      hybridInputs.emplace_back(tagName, consumes<edm::DetSetVector<SiStripDigi>>(inputTag));
    } else {
      throw cms::Exception("Unknown input type")
          << tagName << " unknown.  "
          << "SiStripZeroZuppression can only process types \"VirginRaw\", \"ProcessedRaw\" and \"ZeroSuppressed\"";
    }
  }

  if (produceHybridFormat &&
      ("HybridEmulation" !=
       conf.getParameter<edm::ParameterSet>("Algorithms").getParameter<std::string>("APVInspectMode")))
    throw cms::Exception("Invalid option") << "When producing data in the hybrid format, the APV restorer must be "
                                              "configured with APVInspectMode='HybridEmulation'";

  if ((!hybridInputs.empty()) && produceRawDigis) {
    edm::LogInfo("SiStripZeroSuppression") << "Raw digis will not be saved for hybrid inputs";
  }

  if (!(rawInputs.empty() && hybridInputs.empty())) {
    output_base.reserve(16000);
    if (produceRawDigis && !rawInputs.empty())
      output_base_raw.reserve(16000);
    if (storeCM)
      output_apvcm.reserve(16000);
    if (produceCalculatedBaseline)
      output_baseline.reserve(16000);
    if (produceBaselinePoints)
      output_baseline_points.reserve(16000);
  }
}

Member Function Documentation

void SiStripZeroSuppression::clearOutputs ( )

inlineprivate

Definition at line 104 of file SiStripZeroSuppression.cc.

References output_apvcm, output_base, output_base_raw, output_baseline, and output_baseline_points.

Referenced by produce().

                                                 {
  output_base.clear();
  output_base_raw.clear();
  output_baseline.clear();
  output_baseline_points.clear();
  output_apvcm.clear();
}

edm::DetSet< SiStripRawDigi > SiStripZeroSuppression::formatRawDigis ( const edm::DetSet< SiStripRawDigi > &  rawDigis )

inlineprivate

Definition at line 163 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::id, edm::DetSet< T >::push_back(), edm::DetSet< T >::reserve(), edm::DetSet< T >::size(), and digitizers_cfi::strip.

Referenced by processRaw().

                                                                                                                 {
  edm::DetSet<SiStripRawDigi> outRawDigis(rawDigis.id);
  outRawDigis.reserve(rawDigis.size());
  const std::vector<bool>& apvf = algorithms->getAPVFlags();
  uint32_t strip = 0;
  for (const auto rawDigi : rawDigis) {
    int16_t apvN = strip / 128;
    if (apvf[apvN])
      outRawDigis.push_back(rawDigi);
    else
      outRawDigis.push_back(SiStripRawDigi(0));
    ++strip;
  }
  return outRawDigis;
}

edm::DetSet< SiStripRawDigi > SiStripZeroSuppression::formatRawDigis ( uint32_t  detId, const std::vector< int16_t > &  rawDigis  )

inlineprivate

Definition at line 179 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::push_back(), edm::DetSet< T >::reserve(), and digitizers_cfi::strip.

                                                                                                              {
  edm::DetSet<SiStripRawDigi> outRawDigis(detId);
  outRawDigis.reserve(rawDigis.size());
  const std::vector<bool>& apvf = algorithms->getAPVFlags();
  uint32_t strip = 0;
  for (const auto rawDigi : rawDigis) {
    int16_t apvN = strip / 128;
    if (apvf[apvN])
      outRawDigis.push_back(SiStripRawDigi(rawDigi));
    else
      outRawDigis.push_back(SiStripRawDigi(0));
    ++strip;
  }
  return outRawDigis;
}

void SiStripZeroSuppression::processHybrid ( const edm::DetSetVector< SiStripDigi > &  input )

inlineprivate

Definition at line 150 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::empty(), eostools::move(), output_base, and storeExtraOutput().

Referenced by produce().

                                                                                           {
  for (const auto& inDigis : input) {
    edm::DetSet<SiStripDigi> suppressedDigis(inDigis.id);

    uint16_t nAPVflagged = 0;
    nAPVflagged = algorithms->suppressHybridData(inDigis, suppressedDigis);

    storeExtraOutput(inDigis.id, nAPVflagged);
    if (!suppressedDigis.empty())
      output_base.push_back(std::move(suppressedDigis));
  }
}

void SiStripZeroSuppression::processRaw ( const edm::DetSetVector< SiStripRawDigi > &  input, RawType  inType  )

inlineprivate

Definition at line 123 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::empty(), formatRawDigis(), eostools::move(), output_base, output_base_raw, ProcessedRaw, produceHybridFormat, produceRawDigis, ScopeMode, storeExtraOutput(), storeInZScollBadAPV, and VirginRaw.

Referenced by produce().

                                                                                                           {
  for (const auto& rawDigis : input) {
    edm::DetSet<SiStripDigi> suppressedDigis(rawDigis.id);

    int16_t nAPVflagged = 0;
    if (RawType::ProcessedRaw == inType) {
      nAPVflagged = algorithms->suppressProcessedRawData(rawDigis, suppressedDigis);
    } else if (RawType::ScopeMode == inType) {
      nAPVflagged = algorithms->suppressVirginRawData(rawDigis, suppressedDigis);
    } else if (RawType::VirginRaw == inType) {
      if (produceHybridFormat) {
        nAPVflagged = algorithms->convertVirginRawToHybrid(rawDigis, suppressedDigis);
      } else {
        nAPVflagged = algorithms->suppressVirginRawData(rawDigis, suppressedDigis);
      }
    }

    storeExtraOutput(rawDigis.id, nAPVflagged);
    if (!suppressedDigis.empty() && (storeInZScollBadAPV || nAPVflagged == 0))
      output_base.push_back(std::move(suppressedDigis));

    if (produceRawDigis && nAPVflagged > 0) {
      output_base_raw.push_back(formatRawDigis(rawDigis));
    }
  }
}

void SiStripZeroSuppression::produce ( edm::Event &  e, const edm::EventSetup &  es  )

override

Definition at line 82 of file SiStripZeroSuppression.cc.

References algorithms, clearOutputs(), edm::Event::getByToken(), hybridInputs, input, processHybrid(), processRaw(), putOutputs(), and rawInputs.

                                                                         {
  algorithms->initialize(es, e);

  for (const auto& input : rawInputs) {
    clearOutputs();
    edm::Handle<edm::DetSetVector<SiStripRawDigi>> inDigis;
    e.getByToken(std::get<rawtoken_t>(input), inDigis);
    if (!inDigis->empty())
      processRaw(*inDigis, std::get<RawType>(input));
    putOutputs(e, std::get<std::string>(input));
  }
  for (const auto& input : hybridInputs) {
    clearOutputs();
    edm::Handle<edm::DetSetVector<SiStripDigi>> inDigis;
    e.getByToken(std::get<zstoken_t>(input), inDigis);
    if (!inDigis->empty()) {
      processHybrid(*inDigis);
    }
    putOutputs(e, std::get<std::string>(input));
  }
}

void SiStripZeroSuppression::putOutputs ( edm::Event &  evt, const std::string &  tagName  )

inlineprivate

Definition at line 111 of file SiStripZeroSuppression.cc.

References output_apvcm, output_base, output_base_raw, output_baseline, output_baseline_points, produceBaselinePoints, produceCalculatedBaseline, produceRawDigis, edm::Event::put(), rawInputs, and storeCM.

Referenced by produce().

                                                                                      {
  evt.put(std::make_unique<edm::DetSetVector<SiStripDigi>>(output_base), tagName);
  if (produceRawDigis && !rawInputs.empty())
    evt.put(std::make_unique<edm::DetSetVector<SiStripRawDigi>>(output_base_raw), tagName);
  if (produceCalculatedBaseline)
    evt.put(std::make_unique<edm::DetSetVector<SiStripProcessedRawDigi>>(output_baseline), "BADAPVBASELINE" + tagName);
  if (produceBaselinePoints)
    evt.put(std::make_unique<edm::DetSetVector<SiStripDigi>>(output_baseline_points), "BADAPVBASELINEPOINTS" + tagName);
  if (storeCM)
    evt.put(std::make_unique<edm::DetSetVector<SiStripProcessedRawDigi>>(output_apvcm), "APVCM" + tagName);
}

void SiStripZeroSuppression::storeBaseline ( uint32_t  id, const medians_t &  vmedians  )

inlineprivate

Definition at line 208 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::empty(), median(), output_baseline, edm::DetSet< T >::push_back(), edm::DetSet< T >::reserve(), and digitizers_cfi::strip.

Referenced by storeExtraOutput().

                                                                                        {
  const auto& baselinemap = algorithms->getBaselineMap();

  edm::DetSet<SiStripProcessedRawDigi> baselineDetSet(id);
  baselineDetSet.reserve(vmedians.size() * 128);
  for (const auto& vmed : vmedians) {
    const uint16_t apvN = vmed.first;
    const float median = vmed.second;
    auto itBaselineMap = baselinemap.find(apvN);
    if (baselinemap.end() == itBaselineMap) {
      for (size_t strip = 0; strip < 128; ++strip)
        baselineDetSet.push_back(SiStripProcessedRawDigi(median));
    } else {
      for (size_t strip = 0; strip < 128; ++strip)
        baselineDetSet.push_back(SiStripProcessedRawDigi((itBaselineMap->second)[strip]));
    }
  }

  if (!baselineDetSet.empty())
    output_baseline.push_back(baselineDetSet);
}

void SiStripZeroSuppression::storeBaselinePoints ( uint32_t  id )

inlineprivate

Definition at line 230 of file SiStripZeroSuppression.cc.

References algorithms, edm::DetSet< T >::empty(), eostools::move(), output_baseline_points, and edm::DetSet< T >::push_back().

Referenced by storeExtraOutput().

                                                                   {
  edm::DetSet<SiStripDigi> baspointDetSet(id);
  for (const auto& itBaselinePointVect : algorithms->getSmoothedPoints()) {
    const uint16_t apvN = itBaselinePointVect.first;
    for (const auto& itBaselinePointMap : itBaselinePointVect.second) {
      const uint16_t bpstrip = itBaselinePointMap.first + apvN * 128;
      const int16_t bp = itBaselinePointMap.second;
      baspointDetSet.push_back(SiStripDigi(bpstrip, bp + 128));
    }
  }

  if (!baspointDetSet.empty())
    output_baseline_points.push_back(std::move(baspointDetSet));
}

void SiStripZeroSuppression::storeCMN ( uint32_t  id, const medians_t &  vmedians  )

inlineprivate

Definition at line 245 of file SiStripZeroSuppression.cc.

References algorithms, SplitLinear::begin, filterCSVwithJSON::copy, edm::DetSet< T >::empty(), dataset::end, fixCM, mps_fire::i, eostools::move(), output_apvcm, and edm::DetSet< T >::push_back().

Referenced by storeExtraOutput().

                                                                                   {
  std::vector<bool> apvf(6, false);
  if (fixCM) {
    const auto& apvFlagged = algorithms->getAPVFlags();
    std::copy(std::begin(apvFlagged), std::end(apvFlagged), std::begin(apvf));
  }

  edm::DetSet<SiStripProcessedRawDigi> apvDetSet(id);
  short apvNb = 0;
  for (const auto& vmed : vmedians) {
    if (vmed.first > apvNb) {
      for (int i{0}; i < vmed.first - apvNb; ++i) {
        apvDetSet.push_back(SiStripProcessedRawDigi(-999.));
        apvNb++;
      }
    }

    if (fixCM && apvf[vmed.first]) {
      apvDetSet.push_back(SiStripProcessedRawDigi(-999.));
    } else {
      apvDetSet.push_back(SiStripProcessedRawDigi(vmed.second));
    }
    apvNb++;
  }

  if (!apvDetSet.empty())
    output_apvcm.push_back(std::move(apvDetSet));
}

void SiStripZeroSuppression::storeExtraOutput ( uint32_t  id, int16_t  nAPVflagged  )

inlineprivate

Definition at line 196 of file SiStripZeroSuppression.cc.

References algorithms, produceBaselinePoints, produceCalculatedBaseline, storeBaseline(), storeBaselinePoints(), storeCM, and storeCMN().

Referenced by processHybrid(), and processRaw().

                                                                                     {
  const auto& vmedians = algorithms->getAPVsCM();
  if (storeCM)
    storeCMN(id, vmedians);
  if (nAPVflagged > 0) {
    if (produceCalculatedBaseline)
      storeBaseline(id, vmedians);
    if (produceBaselinePoints)
      storeBaselinePoints(id);
  }
}

Member Data Documentation

std::unique_ptr<SiStripRawProcessingAlgorithms> SiStripZeroSuppression::algorithms

private

Definition at line 37 of file SiStripZeroSuppression.h.

Referenced by formatRawDigis(), processHybrid(), processRaw(), produce(), storeBaseline(), storeBaselinePoints(), storeCMN(), and storeExtraOutput().

bool SiStripZeroSuppression::fixCM

private

Definition at line 41 of file SiStripZeroSuppression.h.

Referenced by storeCMN().

std::vector<std::tuple<std::string, zstoken_t> > SiStripZeroSuppression::hybridInputs

private

Definition at line 50 of file SiStripZeroSuppression.h.

Referenced by produce(), and SiStripZeroSuppression().

std::vector<edm::DetSet<SiStripProcessedRawDigi> > SiStripZeroSuppression::output_apvcm

private

Definition at line 54 of file SiStripZeroSuppression.h.

Referenced by clearOutputs(), putOutputs(), SiStripZeroSuppression(), and storeCMN().

std::vector<edm::DetSet<SiStripDigi> > SiStripZeroSuppression::output_base

private

Definition at line 52 of file SiStripZeroSuppression.h.

Referenced by clearOutputs(), processHybrid(), processRaw(), putOutputs(), and SiStripZeroSuppression().

std::vector<edm::DetSet<SiStripRawDigi> > SiStripZeroSuppression::output_base_raw

private

Definition at line 53 of file SiStripZeroSuppression.h.

Referenced by clearOutputs(), processRaw(), putOutputs(), and SiStripZeroSuppression().

std::vector<edm::DetSet<SiStripProcessedRawDigi> > SiStripZeroSuppression::output_baseline

private

Definition at line 55 of file SiStripZeroSuppression.h.

Referenced by clearOutputs(), putOutputs(), SiStripZeroSuppression(), and storeBaseline().

std::vector<edm::DetSet<SiStripDigi> > SiStripZeroSuppression::output_baseline_points

private

Definition at line 56 of file SiStripZeroSuppression.h.

Referenced by clearOutputs(), putOutputs(), SiStripZeroSuppression(), and storeBaselinePoints().

bool SiStripZeroSuppression::produceBaselinePoints

private

Definition at line 43 of file SiStripZeroSuppression.h.

Referenced by putOutputs(), SiStripZeroSuppression(), and storeExtraOutput().

bool SiStripZeroSuppression::produceCalculatedBaseline

private

Definition at line 42 of file SiStripZeroSuppression.h.

Referenced by putOutputs(), SiStripZeroSuppression(), and storeExtraOutput().

bool SiStripZeroSuppression::produceHybridFormat

private

Definition at line 45 of file SiStripZeroSuppression.h.

Referenced by processRaw(), and SiStripZeroSuppression().

bool SiStripZeroSuppression::produceRawDigis

private

Definition at line 39 of file SiStripZeroSuppression.h.

Referenced by processRaw(), putOutputs(), and SiStripZeroSuppression().

std::vector<std::tuple<std::string, RawType, rawtoken_t> > SiStripZeroSuppression::rawInputs

private

Definition at line 49 of file SiStripZeroSuppression.h.

Referenced by produce(), putOutputs(), and SiStripZeroSuppression().

bool SiStripZeroSuppression::storeCM

private

Definition at line 40 of file SiStripZeroSuppression.h.

Referenced by putOutputs(), SiStripZeroSuppression(), and storeExtraOutput().

bool SiStripZeroSuppression::storeInZScollBadAPV

private

Definition at line 44 of file SiStripZeroSuppression.h.

Referenced by processRaw().