top data objects

Classes
class	TOPAsicMask
	Class to store bit fields of masked ASICs, as reported in raw data. More...
class	TOPAssociatedPDF
	Class to store analytic PDF associated with a photon. More...
class	TOPBarHit
	Class to store track parameters of incoming MC particles relation to MCParticle filled in top/simulation/src/SensitiveBar.cc. More...
class	TOPDigit
	Class to store TOP digitized hits (output of TOPDigitizer or raw data unpacker) relations to TOPSimHits, MCParticles. More...
class	TOPInterimFEInfo
	Class to store debug info of raw data in Interim FE format. More...
class	TOPLikelihood
	Class to store TOP log likelihoods (output of TOPReconstructor). More...
class	TOPLikelihoodScanResult
	Class to store the result of the TOP LL scan (output of TOPLLScanner). More...
class	TOPPDFCollection
	Class to store analytical PDF relation from Tracks filled top/modules/TOPPDFDebugger/src/TOPPDFDebuggerModule.cc. More...
class	TOPPixelLikelihood
	Class to store pixel-by-pixel likelihoods for a track relation from Tracks filled in top/modules/TOPPDFDebugger/src/TOPPDFDebuggerModule.cc. More...
class	TOPProductionEventDebug
	Class to store debugging information about the event headers in the by the TOP production debugging raw data format one of these should be available per boardstack per event. More...
class	TOPProductionHitDebug
	Class to store debugging information about the hit headers in the TOP production debugging raw data format. More...
class	TOPPull
	Class to store photon pull in respect to PDF used in reconstruction. More...
class	TOPRawDigit
	Class to store unpacked raw data (hits in feature-extraction format) It provides also calculation of 50% CFD leading and falling edge times and errors. More...
class	TOPRawWaveform
	Class to store raw data waveforms. More...
class	TOPRecBunch
	Class to store results of TOPBunchFinder. More...
class	TOPSimCalPulse
	Calibration pulse time and amplitude generated by TOPCalPulseGenerator. More...
class	TOPSimHit
	Class to store simulated hits of Cherenkov photons on PMT's input for digitization module (TOPDigitizer). More...
class	TOPSimPhoton
	Class to store Cherenkov photons at emission and at detection relation to TOPSimHit filled in top/simulation/src/SensitivePMT.cc. More...
class	TOPSlowData
	Class to store slow data unpacked from raw data. More...
class	TOPTemplateFitResult
	Class to store template fit result from feature extraction data. More...
class	TOPTimeZero
	Class to store T0 information. More...
class	TOPTriggerDigit
	Class to store trigger time stamps. More...
class	TOPTriggerMCInfo
	Class to store Monte Carlo information useful for trigger studies. More...

Functions
bool	isActive (int moduleID, unsigned channel) const
	Returns true if channel is not explicitely labeled as masked.
const PDFPeak *	getSinglePeak () const
	Returns a PDF peak selected randomly according to weights.
int	getModulo256Sample () const
	Returns sample number modulo 256.
DigitBase::EAppendStatus	addBGDigit (const DigitBase *bg) override
	Implementation of the base class function.
bool	isPedestalJump () const
	Checks if feature extraction finds a pedestal jump.
bool	isAtWindowDiscontinuity (unsigned short storageDepth=508) const
	Checks if feature extraction points are at window discontinuity (e.g.
bool	areWindowsInOrder (unsigned short storageDepth=508) const
	Checks if storage windows come in the consecutive order before the last sample (no gaps before the last sample) Note: returns true if m_windows is empty.
double	correctTime (double time, unsigned short storageDepth=508) const
	Corrects time after window discontinuity by adding missing samples.
double	timeErrorCoefficient (double y1, double y2) const
	Calculate the coefficient of time error.
int	getIntegral (int sampleRise, int samplePeak, int sampleFall) const
	Returns integral of a peak.
int	Integral (int sampleRise, int samplePeak, int sampleFall) const
	Returns integral of a peak.
int	featureExtraction (int threshold, int hysteresis, int thresholdCount) const
	Do feature extraction.
	TOPTemplateFitResult ()
	Default constructor.
	TOPTemplateFitResult (short risingEdge, short backgroundOffset, short amplitude, short chisquare)
	Usefull contructor for data from Zynqs.
	TOPTemplateFitResult (double risingEdge, double risingEdgeTime, double backgroundOffset, double amplitude, double chisquare)
	Usefull contructor for software implementation of template fit in basf2.
void	setRisingEdgeAndConvert (unsigned short risingEdge)
	Sets rising edge from Zynq and converts to double This does not convert from sample to time space.
double	risingEdgeShortToRisingEdgeDouble (unsigned short risingEdgeS) const
	Convert rising edge saved in short to double.

Variables
static float	s_doubleHitResolution = 0
	double hit resolving time in [ns]
static float	s_pileupTime = 0
	pile-up time in [ns]

Detailed Description

Function Documentation

addBGDigit()

DigitBase::EAppendStatus addBGDigit ( const DigitBase *  bg )

overridevirtual

Implementation of the base class function.

Pile-up method.

Parameters

bg

BG digit

Returns

append status

Implements DigitBase.

Definition at line 36 of file TOPDigit.cc.

  {
    const auto* bgDigit = static_cast<const TOPDigit*>(bg);
    double diff = m_time - bgDigit->getTime();
 
    if (fabs(diff) > s_doubleHitResolution) return DigitBase::c_Append; // no pile-up
 
    if (fabs(diff) < s_pileupTime) { // pile-up results in time averaging
      const double time[2] = {m_time, bgDigit->getTime()};
      const double rawTime[2] = {m_rawTime, bgDigit->getRawTime()};
      const int pulseHeight[2] = {m_pulseHeight, bgDigit->getPulseHeight()};
      double sum = pulseHeight[0] + pulseHeight[1];
      if (sum > 0) {
        m_time = (time[0] * pulseHeight[0] + time[1] * pulseHeight[1]) / sum;
        m_rawTime = (rawTime[0] * pulseHeight[0] + rawTime[1] * pulseHeight[1]) / sum;
        // m_timeError =
        // m_pulseWidth =
        // m_integral =
      } else {
        m_time = (time[0] + time[1]) / 2;
        m_rawTime = (rawTime[0] + rawTime[1]) / 2;
        // m_timeError =
        // m_pulseWidth =
        // m_integral =
      }
      m_pulseHeight = int(sum);
      double reweight = sum > 0 ? pulseHeight[0] / sum : 0.5;
      auto relSimHits = this->getRelationsTo<TOPSimHit>();
      for (size_t i = 0; i < relSimHits.size(); ++i) {
        float weight = relSimHits.weight(i) * reweight;
        relSimHits.setWeight(i, weight);
      }
      auto relRawDigits = this->getRelationsTo<TOPRawDigit>();
      for (size_t i = 0; i < relRawDigits.size(); ++i) {
        float weight = relRawDigits.weight(i) * reweight;
        relRawDigits.setWeight(i, weight);
      }
      auto relMCParticles = this->getRelationsTo<MCParticle>();
      for (size_t i = 0; i < relMCParticles.size(); ++i) {
        float weight = relMCParticles.weight(i) * reweight;
        relMCParticles.setWeight(i, weight);
      }
    } else { // pile-up results in discarding the second-in-time hit
      if (diff > 0) {
        // bg digit is the first-in-time hit, therefore replace and remove relations
        *this = *bgDigit;
 
        // remove relations (going from back side!)
        auto relSimHits = this->getRelationsTo<TOPSimHit>();
        for (int i = relSimHits.size() - 1; i >= 0; --i) {
          relSimHits.remove(i);
        }
        auto relRawDigits = this->getRelationsTo<TOPRawDigit>();
        for (int i = relRawDigits.size() - 1; i >= 0; --i) {
          relRawDigits.remove(i);
        }
        auto relMCParticles = this->getRelationsTo<MCParticle>();
        for (int i = relMCParticles.size() - 1; i >= 0; --i) {
          relMCParticles.remove(i);
        }
      }
    }
    return DigitBase::c_DontAppend;
 
  }

areWindowsInOrder()

bool areWindowsInOrder

(

unsigned short

storageDepth = 508

)

const

Checks if storage windows come in the consecutive order before the last sample (no gaps before the last sample) Note: returns true if m_windows is empty.

Parameters

storageDepth

storage depth

Returns

true, if no gaps before the last sample or m_windows is empty

Definition at line 52 of file TOPRawDigit.cc.

  {
    unsigned lastSample = getSampleFall() + 1;
    unsigned last = lastSample / c_WindowSize + 1;
    unsigned size = m_windows.size();
    for (unsigned i = 1; i < std::min(last, size); i++) {
      int diff = m_windows[i] - m_windows[i - 1];
      if (diff < 0) diff += storageDepth;
      if (diff != 1) return false;
    }
    return true;
  }

correctTime()

double correctTime	(	double	time,
		unsigned short	storageDepth = 508
	)		const

Corrects time after window discontinuity by adding missing samples.

Parameters

time	leading or falling edge time [samples]
storageDepth	storage depth

Returns

time corrected for missing samples if any, otherwise returns input value [samples]

Definition at line 66 of file TOPRawDigit.cc.

  {
    if (m_windows.empty()) return time;
 
    unsigned last = int(time) / c_WindowSize + 1;
    unsigned size = m_windows.size();
    int missing = 0;
    for (unsigned i = 1; i < std::min(last, size); i++) {
      int diff = m_windows[i] - m_windows[i - 1];
      if (diff < 0) diff += storageDepth;
      if (diff != 1) missing += diff - 1;
      if (diff == 0) B2ERROR("TOPRawDigit: two consecutive windows with the same number");
    }
 
    return time + missing * c_WindowSize;
  }

featureExtraction()

int featureExtraction	(	int	threshold,
		int	hysteresis,
		int	thresholdCount
	)		const

Do feature extraction.

Parameters

threshold	pulse height threshold [ADC counts]
hysteresis	threshold hysteresis [ADC counts]
thresholdCount	minimal number of samples above threshold

Returns

number of feature extraction data (hits found)

Definition at line 44 of file TOPRawWaveform.cc.

  {
 
    m_features.clear();
 
    int currentThr = threshold;
    bool lastState = false;
    int samplePeak = 0;
    int size = m_data.size();
    int aboveThr = 0;
    for (int i = 0; i < size; i++) {
      const auto& adc = m_data[i];
      if (adc > currentThr and i < size - 1) {
        currentThr = threshold - hysteresis;
        if (!lastState or adc > m_data[samplePeak]) samplePeak = i;
        lastState = true;
        aboveThr++;
      } else {
        currentThr = threshold;
        if (lastState and aboveThr >= thresholdCount) {
          auto halfValue = m_data[samplePeak] / 2;
          auto sampleRise = samplePeak;
          while (sampleRise > 0 and m_data[sampleRise] > halfValue) sampleRise--;
          if (sampleRise == 0 and m_data[sampleRise] > halfValue) continue;
          auto sampleFall = samplePeak;
          while (sampleFall < size - 1 and m_data[sampleFall] > halfValue) sampleFall++;
          if (sampleFall == size - 1 and m_data[sampleFall] > halfValue) continue;
          sampleFall--;
          FeatureExtraction feature;
          feature.sampleRise = sampleRise + m_startSample;
          feature.samplePeak = samplePeak + m_startSample;
          feature.sampleFall = sampleFall + m_startSample;
          feature.vRise0 = m_data[sampleRise];
          feature.vRise1 = m_data[sampleRise + 1];
          feature.vPeak = m_data[samplePeak];
          feature.vFall0 = m_data[sampleFall];
          feature.vFall1 = m_data[sampleFall + 1];
          feature.integral = Integral(sampleRise, samplePeak, sampleFall);
          m_features.push_back(feature);
        }
        lastState = false;
        aboveThr = 0;
      }
    }
 
    return m_features.size();
  }

getIntegral()

int getIntegral	(	int	sampleRise,
		int	samplePeak,
		int	sampleFall
	)		const

Returns integral of a peak.

Parameters

sampleRise	sample number just before 50% CFD crossing at leading edge
samplePeak	sample number at maximum
sampleFall	sample number just before 50% CFD crossing at falling edge

Returns

integral

Definition at line 19 of file TOPRawWaveform.cc.

  {
    sampleRise -= m_startSample;
    samplePeak -= m_startSample;
    sampleFall -= m_startSample;
 
    return Integral(sampleRise, samplePeak, sampleFall);
  }

getModulo256Sample()

int getModulo256Sample

(

)

const

Returns sample number modulo 256.

Returns

sample number modulo 256

Definition at line 26 of file TOPDigit.cc.

  {
    int sample = int(m_rawTime);
    if (m_rawTime < 0) sample--;
    sample += (int) m_firstWindow * 64;
    if (sample < 0) return 256 + sample % 256;
    return sample % 256;
  }

getSinglePeak()

const TOPAssociatedPDF::PDFPeak * getSinglePeak

(

)

const

Returns a PDF peak selected randomly according to weights.

Null ptr is returned if background or delta-ray contribution is selected instead.

Definition at line 20 of file TOPAssociatedPDF.cc.

  {
    if (m_weights.empty()) return 0;
 
    float sum = m_BGWeight + m_deltaRayWeight;
    for (const auto& w : m_weights) sum += w;
    float prob = sum * gRandom->Rndm();
    float cumul = 0;
    for (size_t i = 0; i < m_weights.size(); i++) {
      cumul += m_weights[i];
      if (prob < cumul) return &m_peaks[i];
    }
    return 0;
  }

Integral()

int Integral ( int  sampleRise, int  samplePeak, int  sampleFall  ) const

private

Returns integral of a peak.

Parameters

sampleRise	w.r.t array boundaries
samplePeak	w.r.t array boundaries
sampleFall	w.r.t array boundaries

Returns

integral

Definition at line 28 of file TOPRawWaveform.cc.

  {
    int min = samplePeak - 3 * (samplePeak - sampleRise);
    if (min < 0) min = 0;
    int max = samplePeak + 4 * (sampleFall + 1 - samplePeak);
    int size = m_data.size();
    if (max > size) max = size;
    int integral = 0;
    while (min < max) {
      integral += m_data[min];
      min++;
    }
    return integral;
  }

isActive()

bool isActive	(	int	moduleID,
		unsigned	channel
	)		const

Returns true if channel is not explicitely labeled as masked.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Definition at line 17 of file TOPAsicMask.cc.

  {
    if (m_masks.empty()) return true;
 
    unsigned asic = channel / 8;
    unsigned bs = (moduleID - 1) * 4 + asic / 16;
    if (bs >= m_masks.size()) return true;
 
    unsigned word = m_masks[bs];
    unsigned bit = asic % 16;
    return ((word >> bit) & 0x1) == 0;
  }

isAtWindowDiscontinuity()

bool isAtWindowDiscontinuity

(

unsigned short

storageDepth = 508

)

const

Checks if feature extraction points are at window discontinuity (e.g.

discontinuity happens between sampleRise and sampleFall+1) NOTE: always false if m_windows is empty

Parameters

storageDepth

storage depth

Returns

true if window discontinuity is found between sampleRise and sampleFall+1

Definition at line 34 of file TOPRawDigit.cc.

  {
    if (m_windows.empty()) return false;
 
    unsigned size = m_windows.size();
    unsigned i0 = getSampleRise() / c_WindowSize;
    if (i0 >= size) i0 = size - 1;
    unsigned i1 = (getSampleFall() + 1) / c_WindowSize;
    if (i1 >= size) i1 = size - 1;
    if (i0 == i1) return false;
 
    int diff = m_windows[i1] - m_windows[i0];
    if (diff < 0) diff += storageDepth;
    if (diff != 1) return true;
    return false;
  }

isPedestalJump()

bool isPedestalJump

(

)

const

Checks if feature extraction finds a pedestal jump.

Returns

true if pedestal jump

Definition at line 23 of file TOPRawDigit.cc.

  {
    if (m_sampleRise == 0) {
      if ((m_dSampleFall + 1) % 64 == 0) return true;
    } else if ((m_sampleRise + 1) % 64 == 0) {
      if (m_dSampleFall % 64 == 0) return true;
    }
    return false;
  }

risingEdgeShortToRisingEdgeDouble()

double risingEdgeShortToRisingEdgeDouble ( unsigned short  risingEdgeS ) const

private

Convert rising edge saved in short to double.

Parameters

risingEdgeS

input short

Returns

output double

Definition at line 47 of file TOPTemplateFitResult.cc.

  {
    double risingEdgeD = (risingEdgeS & 0xff00) >> 8;
    int mask = 0x80;
    for (int i = 0; i < 8; i++) {
      int b = (risingEdgeS & mask);
      if (b != 0) risingEdgeD += 1. / (pow(2, i + 1));
      mask = mask >> 1;
    }
    return risingEdgeD;
  }

setRisingEdgeAndConvert()

void setRisingEdgeAndConvert

(

unsigned short

risingEdge

)

Sets rising edge from Zynq and converts to double This does not convert from sample to time space.

Parameters

risingEdge

rising edge

Definition at line 41 of file TOPTemplateFitResult.cc.

  {
    m_risingEdgeRaw = risingEdge;
    m_risingEdge = risingEdgeShortToRisingEdgeDouble(risingEdge);
  }

timeErrorCoefficient()

double timeErrorCoefficient ( double  y1, double  y2  ) const

private

Calculate the coefficient of time error.

Parameters

y1	first value (e.g. VRise0 or VFall0)
y2	second value (e.g. VRise1 or VFall1)

Returns

coefficient of time error

Definition at line 84 of file TOPRawDigit.cc.

  {
    double dy = y2 - y1;
    double ym = m_VPeak / 2.0;
    double a = 1.0 / (2.0 * dy);
    double b = (ym - y2) / (dy * dy);
    double c = (ym - y1) / (dy * dy);
 
    return sqrt(a * a + b * b + c * c);
  }

TOPTemplateFitResult() [1/3]

TOPTemplateFitResult

(

)

Default constructor.

Definition at line 20 of file TOPTemplateFitResult.cc.

{}

TOPTemplateFitResult() [2/3]

TOPTemplateFitResult	(	double	risingEdge,
		double	risingEdgeTime,
		double	backgroundOffset,
		double	amplitude,
		double	chisquare
	)

Usefull contructor for software implementation of template fit in basf2.

Parameters

risingEdge	template fit rising edge in samples
risingEdgeTime	template fit rising edge in ns
backgroundOffset	background offset
amplitude	amplitude
chisquare	chi square

Definition at line 33 of file TOPTemplateFitResult.cc.

    : m_risingEdge(risingEdge), m_risingEdgeTime(risingEdgeTime), m_backgroundOffset(backgroundOffset), m_amplitude(amplitude),
      m_chisquare(chisquare)
  {
    m_risingEdgeRaw = -1;
  }

TOPTemplateFitResult() [3/3]

TOPTemplateFitResult ( short  risingEdge, short  backgroundOffset, short  amplitude, short  chisquare  )

explicit

Usefull contructor for data from Zynqs.

Parameters

risingEdge	template fit rising edge, lower 8 bit are fraction
backgroundOffset	background offset
amplitude	amplitude
chisquare	chi square

Definition at line 22 of file TOPTemplateFitResult.cc.

  {
    m_risingEdgeRaw = risingEdge;
    m_risingEdge = risingEdgeShortToRisingEdgeDouble(risingEdge);
    m_backgroundOffset = backgroundOffset;
    m_amplitude = amplitude;
    m_chisquare = chisquare;
    m_risingEdgeTime = -1.;
  }

Variable Documentation

s_doubleHitResolution

float s_doubleHitResolution = 0

staticprivate

double hit resolving time in [ns]

Definition at line 435 of file TOPDigit.h.

s_pileupTime

float s_pileupTime = 0

staticprivate

pile-up time in [ns]

Definition at line 436 of file TOPDigit.h.