RawToDigiConverter Class Reference

Collection of code to convert TOTEM raw data into digi. More...

#include <RawToDigiConverter.h>

Classes
struct	Record

Public Member Functions
void	PrintSummaries () const
	Print error summaries. More...
	RawToDigiConverter (const edm::ParameterSet &conf)
void	Run (const VFATFrameCollection &coll, const TotemDAQMapping &mapping, const TotemAnalysisMask &mask, edm::DetSetVector< TotemRPDigi > &digi, edm::DetSetVector< TotemVFATStatus > &status)
	Creates RP digi. More...
void	Run (const VFATFrameCollection &coll, const TotemDAQMapping &mapping, const TotemAnalysisMask &mask, edm::DetSetVector< CTPPSDiamondDigi > &digi, edm::DetSetVector< TotemVFATStatus > &status)
	Creates Diamond digi. More...

Private Types
enum	TestFlag { tfNoTest, tfWarn, tfErr }

Private Member Functions
void	RunCommon (const VFATFrameCollection &input, const TotemDAQMapping &mapping, std::map< TotemFramePosition, Record > &records)
	Common processing for all VFAT based sub-systems. More...

Private Attributes
double	BC_fraction
unsigned int	BC_min
double	EC_fraction
	the minimal required (relative) occupancy of the most frequent counter value to be accepted More...
unsigned int	EC_min
	the minimal required number of frames to determine the most frequent counter value More...
std::map< TotemFramePosition, std::map< TotemVFATStatus, unsigned int > >	errorSummary
	error summaries More...
unsigned int	printErrorSummary
unsigned int	printUnknownFrameSummary
unsigned int	testBCMostFrequent
unsigned int	testCRC
unsigned int	testECDAQ
unsigned int	testECMostFrequent
unsigned int	testECRaw
unsigned int	testFootprint
	flags for which tests to run More...
unsigned int	testID
std::map< TotemFramePosition, unsigned int >	unknownSummary
unsigned char	verbosity

Detailed Description

Collection of code to convert TOTEM raw data into digi.

Definition at line 25 of file RawToDigiConverter.h.

Member Enumeration Documentation

enum RawToDigiConverter::TestFlag

private

Enumerator
tfNoTest
tfWarn
tfErr

Definition at line 54 of file RawToDigiConverter.h.

{ tfNoTest, tfWarn, tfErr };

Constructor & Destructor Documentation

RawToDigiConverter::RawToDigiConverter

(

const edm::ParameterSet &

conf

)

Definition at line 27 of file RawToDigiConverter.cc.

                                                                  :
  verbosity(conf.getUntrackedParameter<unsigned int>("verbosity", 0)),
  printErrorSummary(conf.getUntrackedParameter<unsigned int>("printErrorSummary", 1)),
  printUnknownFrameSummary(conf.getUntrackedParameter<unsigned int>("printUnknownFrameSummary", 1)),

  testFootprint(conf.getParameter<unsigned int>("testFootprint")),
  testCRC(conf.getParameter<unsigned int>("testCRC")),
  testID(conf.getParameter<unsigned int>("testID")),
  testECMostFrequent(conf.getParameter<unsigned int>("testECMostFrequent")),
  testBCMostFrequent(conf.getParameter<unsigned int>("testBCMostFrequent")),

  EC_min(conf.getUntrackedParameter<unsigned int>("EC_min", 10)),
  BC_min(conf.getUntrackedParameter<unsigned int>("BC_min", 10)),

  EC_fraction(conf.getUntrackedParameter<double>("EC_fraction", 0.6)),
  BC_fraction(conf.getUntrackedParameter<double>("BC_fraction", 0.6))
{
}

Member Function Documentation

void RawToDigiConverter::PrintSummaries

(

)

const

Print error summaries.

Definition at line 301 of file RawToDigiConverter.cc.

References errorSummary, printErrorSummary, printUnknownFrameSummary, and unknownSummary.

Referenced by TotemVFATRawToDigi::endStream().

{
  // print error summary
  if (printErrorSummary)
  {
    if (!errorSummary.empty())
    {
      stringstream ees;
      for (const auto &vit : errorSummary)
      {
        ees << vit.first << endl;

        for (const auto &it : vit.second)
          ees << "    " << it.first << " : " << it.second << endl;
      }

      LogWarning("Totem") << "RawToDigiConverter: error summary (error signature : number of such events)\n" << endl << ees.rdbuf();
    } else {
      LogInfo("Totem") << "RawToDigiConverter: no errors to be reported.";
    }
  }

  // print summary of unknown frames (found in data but not in the mapping)
  if (printUnknownFrameSummary)
  {
    if (!unknownSummary.empty())
    {
      stringstream ees;
      for (const auto &it : unknownSummary)
        ees << "  " << it.first << " : " << it.second << endl;

      LogWarning("Totem") << "RawToDigiConverter: frames found in data, but not in the mapping (frame position : number of events)\n"
        << endl << ees.rdbuf();
    } else {
      LogInfo("Totem") << "RawToDigiConverter: no unknown frames to be reported.";
    }
  }
}

void RawToDigiConverter::Run	(	const VFATFrameCollection &	coll,
		const TotemDAQMapping &	mapping,
		const TotemAnalysisMask &	mask,
		edm::DetSetVector< TotemRPDigi > &	digi,
		edm::DetSetVector< TotemVFATStatus > &	status
	)

Creates RP digi.

Definition at line 199 of file RawToDigiConverter.cc.

References TotemAnalysisMask::analysisMask, TotemRPDetId::chip(), edm::DetSetVector< T >::find_or_insert(), RawToDigiConverter::Record::frame, TotemVFATAnalysisMask::fullMask, VFATFrame::getActiveChannels(), TotemRPDetId::getPlaneId(), RawToDigiConverter::Record::info, TotemVFATStatus::isOK(), TotemVFATAnalysisMask::maskedChannels, PFRecoTauDiscriminationByIsolation_cfi::offset, AlCaHLTBitMon_ParallelJobs::p, edm::DetSet< T >::push_back(), record, RunCommon(), TotemVFATStatus::setChipPosition(), TotemVFATStatus::setFullyMaskedOut(), TotemVFATStatus::setPartiallyMaskedOut(), RawToDigiConverter::Record::status, TotemSymbID::symbolicID, and TotemVFATInfo::symbolicID.

Referenced by TotemVFATRawToDigi::run().

{
  // structure merging vfat frame data with the mapping
  map<TotemFramePosition, Record> records;

  // common processing - frame validation
  RunCommon(input, mapping, records);

  // second loop over data
  for (auto &p : records)
  {
    Record &record = p.second;

    // calculate ids
    TotemRPDetId chipId(record.info->symbolicID.symbolicID);
    uint8_t chipPosition = chipId.chip();
    TotemRPDetId detId = chipId.getPlaneId();

    // update chipPosition in status
    record.status.setChipPosition(chipPosition);

    // produce digi only for good frames
    if (record.status.isOK())
    {
      // find analysis mask (needs a default=no mask, if not in present the mapping)
      TotemVFATAnalysisMask anMa;
      anMa.fullMask = false;

      auto analysisIter = analysisMask.analysisMask.find(record.info->symbolicID);
      if (analysisIter != analysisMask.analysisMask.end())
      {
        // if there is some information about masked channels - save it into conversionStatus
        anMa = analysisIter->second;
        if (anMa.fullMask)
          record.status.setFullyMaskedOut();
        else
          record.status.setPartiallyMaskedOut();
      }

      // create the digi
      unsigned short offset = chipPosition * 128;
      const vector<unsigned char> &activeChannels = record.frame->getActiveChannels();

      for (auto ch : activeChannels)
      {
        // skip masked channels
        if (!anMa.fullMask && anMa.maskedChannels.find(ch) == anMa.maskedChannels.end())
        {
          DetSet<TotemRPDigi> &digiDetSet = rpData.find_or_insert(detId);
          digiDetSet.push_back(TotemRPDigi(offset + ch));
        }
      }
    }

    // save status
    DetSet<TotemVFATStatus> &statusDetSet = finalStatus.find_or_insert(detId);
    statusDetSet.push_back(record.status);
  }
}

void RawToDigiConverter::Run	(	const VFATFrameCollection &	coll,
		const TotemDAQMapping &	mapping,
		const TotemAnalysisMask &	mask,
		edm::DetSetVector< CTPPSDiamondDigi > &	digi,
		edm::DetSetVector< TotemVFATStatus > &	status
	)

Creates Diamond digi.

Definition at line 263 of file RawToDigiConverter.cc.

References edm::DetSetVector< T >::find_or_insert(), RawToDigiConverter::Record::frame, VFATFrame::getEC(), DiamondVFATFrame::getHptdcErrorFlag(), DiamondVFATFrame::getLeadingEdgeTime(), DiamondVFATFrame::getMultihit(), DiamondVFATFrame::getThresholdVoltage(), DiamondVFATFrame::getTrailingEdgeTime(), RawToDigiConverter::Record::info, TotemVFATStatus::isOK(), AlCaHLTBitMon_ParallelJobs::p, edm::DetSet< T >::push_back(), record, RunCommon(), TotemVFATStatus::setEC(), RawToDigiConverter::Record::status, TotemSymbID::symbolicID, and TotemVFATInfo::symbolicID.

{
  // structure merging vfat frame data with the mapping
  map<TotemFramePosition, Record> records;

  // common processing - frame validation
  RunCommon(coll, mapping, records);

  // second loop over data
  for (auto &p : records)
  {
    Record &record = p.second;

    // calculate ids
    CTPPSDiamondDetId detId(record.info->symbolicID.symbolicID);

    if (record.status.isOK())
    {
      const VFATFrame *fr = record.frame;
      const DiamondVFATFrame *diamondframe = static_cast<const DiamondVFATFrame*>(fr);

      // update Event Counter in status
      record.status.setEC(record.frame->getEC() & 0xFF);

      // create the digi
      DetSet<CTPPSDiamondDigi> &digiDetSet = digi.find_or_insert(detId);
      digiDetSet.push_back(CTPPSDiamondDigi(diamondframe->getLeadingEdgeTime(),diamondframe->getTrailingEdgeTime(),diamondframe->getThresholdVoltage(),diamondframe->getMultihit(),diamondframe->getHptdcErrorFlag()));
    }

    // save status
    DetSet<TotemVFATStatus> &statusDetSet = status.find_or_insert(detId);
    statusDetSet.push_back(record.status);
  }
}

void RawToDigiConverter::RunCommon ( const VFATFrameCollection &  input, const TotemDAQMapping &  mapping, std::map< TotemFramePosition, Record > &  records  )

private

Common processing for all VFAT based sub-systems.

Definition at line 48 of file RawToDigiConverter.cc.

References CounterChecker::Analyze(), BC_fraction, BC_min, CounterChecker::BCChecker, VFATFrame::checkCRC(), VFATFrame::checkFootprint(), TauDecayModes::dec, EC_fraction, EC_min, CounterChecker::ECChecker, errorSummary, CounterChecker::Fill(), RawToDigiConverter::Record::frame, VFATFrame::getChipID(), VFATFrame::getNumberOfClusters(), TotemVFATInfo::hwID, RawToDigiConverter::Record::info, VFATFrameCollection::Iterator::IsEnd(), VFATFrame::isIDPresent(), VFATFrame::isNumberOfClustersPresent(), funct::m, python.rootplot.argparse::message, AlCaHLTBitMon_ParallelJobs::p, printErrorSummary, record, TotemVFATStatus::setCRCError(), TotemVFATStatus::setFootprintError(), TotemVFATStatus::setIDMismatch(), TotemVFATStatus::setMissing(), TotemVFATStatus::setNumberOfClusters(), TotemVFATStatus::setNumberOfClustersSpecified(), RawToDigiConverter::Record::status, TotemSymbID::symbolicID, TotemVFATInfo::symbolicID, testBCMostFrequent, testCRC, testECMostFrequent, testFootprint, testID, tfErr, tfNoTest, unknownSummary, verbosity, and TotemDAQMapping::VFATMapping.

Referenced by Run().

{
  // EC and BC checks (wrt. the most frequent value), BC checks per subsystem
  CounterChecker ECChecker(CounterChecker::ECChecker, "EC", EC_min, EC_fraction, verbosity);
  CounterChecker BCChecker(CounterChecker::BCChecker, "BC", BC_min, BC_fraction, verbosity);

  // initialise structure merging vfat frame data with the mapping
  for (auto &p : mapping.VFATMapping)
  {
    TotemVFATStatus st;
    st.setMissing(true);
    records[p.first] = { &p.second, nullptr,  st };
  }

  // event error message buffer
  stringstream ees;

  // associate data frames with records
  for (VFATFrameCollection::Iterator fr(&input); !fr.IsEnd(); fr.Next())
  {
    // frame error message buffer
    stringstream fes;

    bool problemsPresent = false;
    bool stopProcessing = false;

    // skip data frames not listed in the DAQ mapping
    auto records_it = records.find(fr.Position());
    if (records_it == records.end())
    {
      unknownSummary[fr.Position()]++;
      continue;
    }

    // update record
    Record &record = records_it->second;
    record.frame = fr.Data();
    record.status.setMissing(false);
    record.status.setNumberOfClustersSpecified(record.frame->isNumberOfClustersPresent());
    record.status.setNumberOfClusters(record.frame->getNumberOfClusters());

    // check footprint
    if (testFootprint != tfNoTest && !record.frame->checkFootprint())
    {
      problemsPresent = true;

      if (verbosity > 0)
        fes << "    invalid footprint" << endl;

      if (testFootprint == tfErr)
      {
        record.status.setFootprintError();
        stopProcessing = true;
      }
    }

    // check CRC
    if (testCRC != tfNoTest && !record.frame->checkCRC())
    {
      problemsPresent = true;

      if (verbosity > 0)
        fes << "    CRC failure" << endl;

      if (testCRC == tfErr)
      {
        record.status.setCRCError();
        stopProcessing = true;
      }
    }
    // check the id mismatch
    if (testID != tfNoTest && record.frame->isIDPresent() && (record.frame->getChipID() & 0xFFF) != (record.info->hwID & 0xFFF))
    {
      if (verbosity > 0)
        fes << "    ID mismatch (data: 0x" << hex << record.frame->getChipID()
          << ", mapping: 0x" << record.info->hwID  << dec << ", symbId: " << record.info->symbolicID.symbolicID << ")" << endl;

      if (testID == tfErr)
      {
        record.status.setIDMismatch();
        stopProcessing = true;
      }
    }

    // if there were errors, put the information to ees buffer
    if (verbosity > 0 && problemsPresent)
    {
      string message = (stopProcessing) ? "(and will be dropped)" : "(but will be used though)";
      if (verbosity > 2)
      {
        ees << "  Frame at " << fr.Position() << " seems corrupted " << message << ":" << endl;
        ees << fes.rdbuf();
      } else
        ees << "  Frame at " << fr.Position() << " seems corrupted " << message << "." << endl;
    }

    // if there were serious errors, do not process this frame
    if (stopProcessing)
      continue;

    // fill EC and BC values to the statistics
    if (fr.Data()->isECPresent())
      ECChecker.Fill(fr.Data()->getEC(), fr.Position());

    if (fr.Data()->isBCPresent())
      BCChecker.Fill(fr.Data()->getBC(), fr.Position());
  }

  // analyze EC and BC statistics
  if (testECMostFrequent != tfNoTest)
    ECChecker.Analyze(records, (testECMostFrequent == tfErr), ees);

  if (testBCMostFrequent != tfNoTest)
    BCChecker.Analyze(records, (testBCMostFrequent == tfErr), ees);

  // add error message for missing frames
  if (verbosity > 1)
  {
    for (const auto &p : records)
    {
      if (p.second.status.isMissing())
        ees << "Frame for VFAT " << p.first << " is not present in the data." << endl;
    }
  }

  // print error message
  if (verbosity > 0 && !ees.rdbuf()->str().empty())
  {
    if (verbosity > 1)
      LogWarning("Totem") << "Error in RawToDigiConverter::RunCommon > " << "event contains the following problems:" << endl << ees.rdbuf() << endl;
    else
      LogWarning("Totem") << "Error in RawToDigiConverter::RunCommon > " << "event contains problems." << endl;
  }

  // increase error counters
  if (printErrorSummary)
  {
    for (const auto &it : records)
    {
      if (!it.second.status.isOK())
      {
        auto &m = errorSummary[it.first];
        m[it.second.status]++;
      }
    }
  }
}

Member Data Documentation

double RawToDigiConverter::BC_fraction

private

Definition at line 69 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::BC_min

private

Definition at line 66 of file RawToDigiConverter.h.

Referenced by RunCommon().

double RawToDigiConverter::EC_fraction

private

the minimal required (relative) occupancy of the most frequent counter value to be accepted

Definition at line 69 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::EC_min

private

the minimal required number of frames to determine the most frequent counter value

Definition at line 66 of file RawToDigiConverter.h.

Referenced by RunCommon().

std::map<TotemFramePosition, std::map<TotemVFATStatus, unsigned int> > RawToDigiConverter::errorSummary

private

error summaries

Definition at line 72 of file RawToDigiConverter.h.

Referenced by PrintSummaries(), and RunCommon().

unsigned int RawToDigiConverter::printErrorSummary

private

Definition at line 51 of file RawToDigiConverter.h.

Referenced by PrintSummaries(), and RunCommon().

unsigned int RawToDigiConverter::printUnknownFrameSummary

private

Definition at line 52 of file RawToDigiConverter.h.

Referenced by PrintSummaries().

unsigned int RawToDigiConverter::testBCMostFrequent

private

Definition at line 63 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::testCRC

private

Definition at line 58 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::testECDAQ

private

Definition at line 61 of file RawToDigiConverter.h.

unsigned int RawToDigiConverter::testECMostFrequent

private

Definition at line 62 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::testECRaw

private

Definition at line 60 of file RawToDigiConverter.h.

unsigned int RawToDigiConverter::testFootprint

private

flags for which tests to run

Definition at line 57 of file RawToDigiConverter.h.

Referenced by RunCommon().

unsigned int RawToDigiConverter::testID

private

Definition at line 59 of file RawToDigiConverter.h.

Referenced by RunCommon().

std::map<TotemFramePosition, unsigned int> RawToDigiConverter::unknownSummary

private

Definition at line 73 of file RawToDigiConverter.h.

Referenced by PrintSummaries(), and RunCommon().

unsigned char RawToDigiConverter::verbosity

private

Definition at line 49 of file RawToDigiConverter.h.

Referenced by RunCommon().