TotemTimingConversions Class Reference

#include <TotemTimingConversions.h>

Public Member Functions
float	timeOfFirstSample (const TotemTimingDigi &digi) const
float	timePrecision (const TotemTimingDigi &digi) const
std::vector< float >	timeSamples (const TotemTimingDigi &digi) const
	TotemTimingConversions (double sampicSamplingPeriodNs, bool mergeTimePeaks, const PPSTimingCalibration &calibration)
float	triggerTime (const TotemTimingDigi &digi) const
std::vector< float >	voltSamples (const TotemTimingDigi &digi) const

Private Attributes
PPSTimingCalibration	calibration_
reco::FormulaEvaluator	calibrationFunction_
bool	mergeTimePeaks_
double	sampicSamplingPeriodNs_

Static Private Attributes
static constexpr int	ACCEPTED_TIME_RADIUS = 4
static constexpr unsigned long	CELL0_MASK = 0xfffffff000
static constexpr float	SAMPIC_ADC_V = 1. / 256
static constexpr int	SAMPIC_MAX_NUMBER_OF_SAMPLES = 64

Detailed Description

Definition at line 23 of file TotemTimingConversions.h.

Constructor & Destructor Documentation

TotemTimingConversions()

TotemTimingConversions::TotemTimingConversions	(	double	sampicSamplingPeriodNs,
		bool	mergeTimePeaks,
		const PPSTimingCalibration &	calibration
	)

Definition at line 17 of file TotemTimingConversions.cc.

    : calibration_(calibration),
      sampicSamplingPeriodNs_(sampicSamplingPeriodNs),
      mergeTimePeaks_(mergeTimePeaks),
      calibrationFunction_(calibration_.formula()) {}

Member Function Documentation

timeOfFirstSample()

float TotemTimingConversions::timeOfFirstSample

(

const TotemTimingDigi &

digi

)

const

Definition at line 27 of file TotemTimingConversions.cc.

References ACCEPTED_TIME_RADIUS, calibration_, CELL0_MASK, TotemTimingDigi::cellInfo(), EcalCondDB::db, TotemTimingDigi::eventInfo(), TotemTimingDigi::fpgaTimestamp(), TotemTimingDigi::hardwareBoardId(), TotemTimingDigi::hardwareChannelId(), TotemTimingDigi::hardwareSampicId(), TotemTimingEventInfo::l1ALatency(), TotemTimingEventInfo::l1ATimestamp(), mergeTimePeaks_, TotemTimingEventInfo::offsetOfSamples(), SAMPIC_MAX_NUMBER_OF_SAMPLES, sampicSamplingPeriodNs_, submitPVValidationJobs::t, PPSTimingCalibration::timeOffset(), cond::timestamp, TotemTimingDigi::timestampA(), and TotemTimingDigi::timestampB().

Referenced by timeSamples(), and triggerTime().

                                                                                 {
  unsigned int offsetOfSamples = digi.eventInfo().offsetOfSamples();

  unsigned int timestamp =
      (digi.cellInfo() <= SAMPIC_MAX_NUMBER_OF_SAMPLES / 2) ? digi.timestampA() : digi.timestampB();

  int cell0TimeClock = timestamp + ((digi.fpgaTimestamp() - timestamp) & CELL0_MASK) - digi.eventInfo().l1ATimestamp() +
                       digi.eventInfo().l1ALatency();

  // time of first cell
  float cell0TimeInstant = SAMPIC_MAX_NUMBER_OF_SAMPLES * sampicSamplingPeriodNs_ * cell0TimeClock;

  // time of triggered cell
  float firstCellTimeInstant =
      (digi.cellInfo() < offsetOfSamples)
          ? cell0TimeInstant + digi.cellInfo() * sampicSamplingPeriodNs_
          : cell0TimeInstant - (SAMPIC_MAX_NUMBER_OF_SAMPLES - digi.cellInfo()) * sampicSamplingPeriodNs_;

  int db = digi.hardwareBoardId();
  int sampic = digi.hardwareSampicId();
  int channel = digi.hardwareChannelId();
  float t = firstCellTimeInstant + calibration_.timeOffset(db, sampic, channel);
  //NOTE: If no time offset is set, timeOffset returns 0

  if (mergeTimePeaks_) {
    if (t < -ACCEPTED_TIME_RADIUS)
      t += SAMPIC_MAX_NUMBER_OF_SAMPLES * sampicSamplingPeriodNs_;
    if (t > ACCEPTED_TIME_RADIUS)
      t -= SAMPIC_MAX_NUMBER_OF_SAMPLES * sampicSamplingPeriodNs_;
  }

  return t;
}

timePrecision()

float TotemTimingConversions::timePrecision

(

const TotemTimingDigi &

digi

)

const

Definition at line 70 of file TotemTimingConversions.cc.

References calibration_, EcalCondDB::db, TotemTimingDigi::hardwareBoardId(), TotemTimingDigi::hardwareChannelId(), TotemTimingDigi::hardwareSampicId(), and PPSTimingCalibration::timePrecision().

                                                                             {
  int db = digi.hardwareBoardId();
  int sampic = digi.hardwareSampicId();
  int channel = digi.hardwareChannelId();
  return calibration_.timePrecision(db, sampic, channel);
}

timeSamples()

std::vector< float > TotemTimingConversions::timeSamples

(

const TotemTimingDigi &

digi

)

const

Definition at line 79 of file TotemTimingConversions.cc.

References mps_fire::i, TotemTimingDigi::numberOfSamples(), sampicSamplingPeriodNs_, hcalRecHitTable_cff::time, and timeOfFirstSample().

                                                                                      {
  std::vector<float> time(digi.numberOfSamples());
  for (unsigned int i = 0; i < time.size(); ++i)
    time.at(i) = timeOfFirstSample(digi) + i * sampicSamplingPeriodNs_;
  return time;
}

triggerTime()

float TotemTimingConversions::triggerTime

(

const TotemTimingDigi &

digi

)

const

Definition at line 63 of file TotemTimingConversions.cc.

References TotemTimingDigi::eventInfo(), TotemTimingEventInfo::offsetOfSamples(), SAMPIC_MAX_NUMBER_OF_SAMPLES, sampicSamplingPeriodNs_, and timeOfFirstSample().

                                                                           {
  unsigned int offsetOfSamples = digi.eventInfo().offsetOfSamples();
  return timeOfFirstSample(digi) + (SAMPIC_MAX_NUMBER_OF_SAMPLES - offsetOfSamples) * sampicSamplingPeriodNs_;
}

voltSamples()

std::vector< float > TotemTimingConversions::voltSamples

(

const TotemTimingDigi &

digi

)

const

Definition at line 89 of file TotemTimingConversions.cc.

References calibration_, calibrationFunction_, TotemTimingDigi::cellInfo(), data, EcalCondDB::db, reco::FormulaEvaluator::evaluate(), TotemTimingDigi::hardwareBoardId(), TotemTimingDigi::hardwareChannelId(), TotemTimingDigi::hardwareSampicId(), reco::FormulaEvaluator::numberOfParameters(), reco::FormulaEvaluator::numberOfVariables(), PPSTimingCalibration::parameters(), SAMPIC_ADC_V, SAMPIC_MAX_NUMBER_OF_SAMPLES, ecalGpuTask_cfi::sample, and TotemTimingDigi::samples().

                                                                                      {
  std::vector<float> data;
  if (calibrationFunction_.numberOfVariables() != 1)
    for (const auto& sample : digi.samples())
      data.emplace_back(SAMPIC_ADC_V * sample);
  else {
    unsigned int db = digi.hardwareBoardId();
    unsigned int sampic = digi.hardwareSampicId();
    unsigned int channel = digi.hardwareChannelId();
    unsigned int cell = digi.cellInfo();
    for (const auto& sample : digi.samples()) {
      // ring buffer on Sampic, so accounting for samples register boundary
      const unsigned short sample_cell = (cell++) % SAMPIC_MAX_NUMBER_OF_SAMPLES;
      auto parameters = calibration_.parameters(db, sampic, channel, sample_cell);
      if (parameters.empty() || parameters.size() != calibrationFunction_.numberOfParameters())
        throw cms::Exception("TotemTimingConversions:voltSamples")
            << "Invalid calibrations retrieved for Sampic digi"
            << " (" << db << ", " << sampic << ", " << channel << ", " << sample_cell << ")!";
      data.emplace_back(calibrationFunction_.evaluate(std::vector<double>{(double)sample}, parameters));
    }
  }
  return data;
}

Member Data Documentation

ACCEPTED_TIME_RADIUS

constexpr int TotemTimingConversions::ACCEPTED_TIME_RADIUS = 4

staticprivate

Definition at line 36 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample().

calibration_

PPSTimingCalibration TotemTimingConversions::calibration_

private

Definition at line 39 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample(), timePrecision(), and voltSamples().

calibrationFunction_

reco::FormulaEvaluator TotemTimingConversions::calibrationFunction_

private

Definition at line 42 of file TotemTimingConversions.h.

Referenced by voltSamples().

CELL0_MASK

constexpr unsigned long TotemTimingConversions::CELL0_MASK = 0xfffffff000

staticprivate

Definition at line 37 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample().

mergeTimePeaks_

bool TotemTimingConversions::mergeTimePeaks_

private

Definition at line 41 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample().

SAMPIC_ADC_V

constexpr float TotemTimingConversions::SAMPIC_ADC_V = 1. / 256

staticprivate

Definition at line 34 of file TotemTimingConversions.h.

Referenced by voltSamples().

SAMPIC_MAX_NUMBER_OF_SAMPLES

constexpr int TotemTimingConversions::SAMPIC_MAX_NUMBER_OF_SAMPLES = 64

staticprivate

Definition at line 35 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample(), triggerTime(), and voltSamples().

sampicSamplingPeriodNs_

double TotemTimingConversions::sampicSamplingPeriodNs_

private

Definition at line 40 of file TotemTimingConversions.h.

Referenced by timeOfFirstSample(), timeSamples(), and triggerTime().