Data class for calibration ADC samples preprocessed by the DSP. More...

#include <LArAccumulatedCalibDigit.h>

Collaboration diagram for LArAccumulatedCalibDigit:

Public Member Functions
	LArAccumulatedCalibDigit (HWIdentifier &channel_value, CaloGain::CaloGain gain_value, const std::vector< uint64_t > &sampleSum_value, const std::vector< uint64_t > &sample2Sum_value, uint32_t nTrigger_value, uint32_t DAC_value=0, uint16_t delay_value=0, uint16_t isPulsed_value=false, uint16_t nStep_value=0, uint16_t iStep_value=0)
	Constructor (initialize everything)
	LArAccumulatedCalibDigit (HWIdentifier &channel_value, CaloGain::CaloGain gain_value, uint32_t nsamples=7, uint32_t DAC_value=0, uint16_t delay_value=0, uint16_t isPulsed_value=false, uint16_t nStep_value=0, uint16_t iStep_value=0)
	Constructor (initialize for later accumulation)
virtual	~LArAccumulatedCalibDigit ()
	Destructor.
	LArAccumulatedCalibDigit ()
	default constructor for persistency
const HWIdentifier &	hardwareID () const
	Return HWIdentifier.
const HWIdentifier &	channelID () const
	Return channel ID.
CaloGain::CaloGain	gain () const
	return gain value
size_t	nsamples () const
	return number of samples
const std::vector< uint64_t > &	sampleSum () const
	return a reference to a stl vector containing the sample-sums
const std::vector< uint64_t > &	sample2Sum () const
	return a reference to a stl vector containing the sum of the squares of the sample
unsigned	nTriggers () const
	return the number of triggers
int	DAC () const
	return the number of samples
int	delay () const
	return the setting of the delay
bool	isPulsed () const
	Tell if this channel was pulsed.
bool	isPulsed (int n) const
	Tell if calib line n was pulsed for this channel (n=1,2,3,4)
uint16_t	getIsPulsedInt () const
	get the four bit int that tells which lines pulsed
std::vector< float >	mean () const
	Calculates and returns the Mean value of each ADC sample.
std::vector< float >	RMS () const
	Calculates and returns the RMS value of each ADC sample.
float	mean (const size_t i) const
	Calculates and returns the Mean value for one ADC sample.
float	RMS (const size_t i) const
	Calculates and returns the RMS value for one ADC sample.
uint16_t	nSteps () const
uint16_t	stepIndex () const
void	setSampleSum (const std::vector< uint64_t > &sampleSum)
	Set the sampleSum.
void	setSample2Sum (const std::vector< uint64_t > &sample2Sum)
	Set the sample2Sum.
bool	setAddDigit (const std::vector< short > &samples)
	Sum up with another (individual) LArCalibDigit.
bool	setAddSubStep (const std::vector< uint64_t > &sampleSum, const std::vector< uint64_t > &sample2Sum, const uint32_t nTriggerPerStep)
	Sum up with another substep.

Private Attributes
HWIdentifier	m_hardwareID
	Online Identifier.
CaloGain::CaloGain	m_gain
	gain
std::vector< uint64_t >	m_sampleSum
	vector of sample sums
std::vector< uint64_t >	m_sample2Sum
	vector of sample square sums
uint32_t	m_nTriggers
	number of samples
uint32_t	m_DAC
	DAC-Value.
uint16_t	m_delayPulsed
	Delay-Value and isPulsed boolean encoded in this variable.
uint16_t	m_nStep
uint16_t	m_iStep

Detailed Description

Data class for calibration ADC samples preprocessed by the DSP.

Author: Sandrine Laplace; Isabelle Wingerter-Seez

Definition at line 42 of file LArAccumulatedCalibDigit.h.

Constructor & Destructor Documentation

◆ LArAccumulatedCalibDigit() [1/3]

LArAccumulatedCalibDigit::LArAccumulatedCalibDigit	(	HWIdentifier &	channel_value,
		CaloGain::CaloGain	gain_value,
		const std::vector< uint64_t > &	sampleSum_value,
		const std::vector< uint64_t > &	sample2Sum_value,
		uint32_t	nTrigger_value,
		uint32_t	DAC_value = 0,
		uint16_t	delay_value = 0,
		uint16_t	isPulsed_value = false,
		uint16_t	nStep_value = 0,
		uint16_t	iStep_value = 0 )

inline

Constructor (initialize everything)

Definition at line 77 of file LArAccumulatedCalibDigit.h.

                                                                                              : 
    m_hardwareID(channel_value), m_gain(gain_value), m_sampleSum(sampleSum_value), m_sample2Sum(sample2Sum_value),
    m_nTriggers(nTrigger_value), m_DAC(DAC_value), 
    m_delayPulsed((delay_value & 0xFFF) | (isPulsed_value<<12)),  
    m_nStep(nStep_value), m_iStep(iStep_value) 
    {};

◆ LArAccumulatedCalibDigit() [2/3]

LArAccumulatedCalibDigit::LArAccumulatedCalibDigit	(	HWIdentifier &	channel_value,
		CaloGain::CaloGain	gain_value,
		uint32_t	nsamples = 7,
		uint32_t	DAC_value = 0,
		uint16_t	delay_value = 0,
		uint16_t	isPulsed_value = false,
		uint16_t	nStep_value = 0,
		uint16_t	iStep_value = 0 )

inline

Constructor (initialize for later accumulation)

Definition at line 89 of file LArAccumulatedCalibDigit.h.

                                                                                              : 
    m_hardwareID(channel_value), m_gain(gain_value), 
    m_nTriggers(0), m_DAC(DAC_value),
    m_delayPulsed((delay_value & 0xFFF) | (isPulsed_value<<12)),
    m_nStep(nStep_value), m_iStep(iStep_value) 
  {
    m_sampleSum.resize(nsamples);
    m_sample2Sum.resize(nsamples);
  };

◆ ~LArAccumulatedCalibDigit()

LArAccumulatedCalibDigit::~LArAccumulatedCalibDigit ( )

virtualdefault

Destructor.

◆ LArAccumulatedCalibDigit() [3/3]

LArAccumulatedCalibDigit::LArAccumulatedCalibDigit ( )

inline

default constructor for persistency

Definition at line 105 of file LArAccumulatedCalibDigit.h.

                             :
    m_hardwareID(0), m_gain(CaloGain::LARNGAIN), m_nTriggers(0), 
    m_DAC(0), m_delayPulsed(0), m_nStep(0), m_iStep(0) 
    {};

Member Function Documentation

◆ channelID()

const HWIdentifier & LArAccumulatedCalibDigit::channelID ( ) const

inline

Return channel ID.

Definition at line 114 of file LArAccumulatedCalibDigit.h.

114{ return m_hardwareID; }

◆ DAC()

int LArAccumulatedCalibDigit::DAC ( ) const

inline

return the number of samples

return the setting of the DAC

Definition at line 135 of file LArAccumulatedCalibDigit.h.

135{return static_cast<int>(m_DAC);}

◆ delay()

int LArAccumulatedCalibDigit::delay ( ) const

inline

return the setting of the delay

Definition at line 138 of file LArAccumulatedCalibDigit.h.

138{return static_cast<int>(m_delayPulsed & 0xFFF);}

◆ gain()

CaloGain::CaloGain LArAccumulatedCalibDigit::gain ( ) const

inline

return gain value

Definition at line 117 of file LArAccumulatedCalibDigit.h.

117{ return m_gain; }

◆ getIsPulsedInt()

uint16_t LArAccumulatedCalibDigit::getIsPulsedInt ( ) const

inline

get the four bit int that tells which lines pulsed

Definition at line 153 of file LArAccumulatedCalibDigit.h.

153{ return (m_delayPulsed >> 12);}

◆ hardwareID()

const HWIdentifier & LArAccumulatedCalibDigit::hardwareID ( ) const

inline

Return HWIdentifier.

Definition at line 111 of file LArAccumulatedCalibDigit.h.

111{return m_hardwareID; }

◆ isPulsed() [1/2]

bool LArAccumulatedCalibDigit::isPulsed ( ) const

inline

Tell if this channel was pulsed.

Definition at line 141 of file LArAccumulatedCalibDigit.h.

141{return static_cast<bool>(m_delayPulsed & 0xF000);}

◆ isPulsed() [2/2]

bool LArAccumulatedCalibDigit::isPulsed ( int n ) const

inline

Tell if calib line n was pulsed for this channel (n=1,2,3,4)

Definition at line 144 of file LArAccumulatedCalibDigit.h.

                             {
    if(n==1) return static_cast<bool>(m_delayPulsed & 0x1000);
    if(n==2) return static_cast<bool>(m_delayPulsed & 0x2000);
    if(n==3) return static_cast<bool>(m_delayPulsed & 0x4000);
    if(n==4) return static_cast<bool>(m_delayPulsed & 0x8000);
    return false;//WRITE ERROR MESSAGE
  }

◆ mean() [1/2]

std::vector< float > LArAccumulatedCalibDigit::mean ( ) const

Calculates and returns the Mean value of each ADC sample.

Definition at line 36 of file LArAccumulatedCalibDigit.cxx.

                                                      {
 
  const size_t nS=m_sampleSum.size();
  std::vector<float> mean;
  if (m_nTriggers==0)
    return mean;
  else {
    mean.resize(nS,0.0);
    for (size_t i=0;i<nS;++i)
      mean[i]=((double)m_sampleSum[i])/((double)m_nTriggers);
    return mean;
  }
}

◆ mean() [2/2]

float LArAccumulatedCalibDigit::mean ( const size_t i ) const

Calculates and returns the Mean value for one ADC sample.

Definition at line 15 of file LArAccumulatedCalibDigit.cxx.

                                                         {
 
  if (i<m_sampleSum.size() && i<m_sample2Sum.size() && m_nTriggers>0)
    return ((double)m_sampleSum[i])/((double)m_nTriggers);
  else
    return 0.0;
}

◆ nsamples()

size_t LArAccumulatedCalibDigit::nsamples ( ) const

inline

return number of samples

Definition at line 120 of file LArAccumulatedCalibDigit.h.

120{ return m_sampleSum.size(); }

◆ nSteps()

uint16_t LArAccumulatedCalibDigit::nSteps ( ) const

inline

Definition at line 168 of file LArAccumulatedCalibDigit.h.

168{ return m_nStep;}

◆ nTriggers()

unsigned LArAccumulatedCalibDigit::nTriggers ( ) const

inline

return the number of triggers

Definition at line 129 of file LArAccumulatedCalibDigit.h.

129{return m_nTriggers;}

◆ RMS() [1/2]

std::vector< float > LArAccumulatedCalibDigit::RMS ( ) const

Calculates and returns the RMS value of each ADC sample.

Definition at line 50 of file LArAccumulatedCalibDigit.cxx.

                                                     {
  std::vector<float> rms;  
  const size_t nS=m_sampleSum.size();
  if (m_sample2Sum.size()!=nS || m_nTriggers==0) 
    return rms;// ERROR, return emtpy vector
  
  double mean=0;
  double rms2=0;
  rms.resize(nS,0.0);
  
  for (size_t i=0;i<nS;++i) {
      mean=((double)m_sampleSum[i])/((double)m_nTriggers);
      rms2=((double)m_sample2Sum[i])/((double)m_nTriggers)-mean*mean;
      if (rms2<=0.0) //W.L 2010-12-07 protect against FPE due to rounding error
    rms[i]=0.0;
      else
    rms[i]=sqrt(rms2);
  }
  return rms;
}

◆ RMS() [2/2]

float LArAccumulatedCalibDigit::RMS ( const size_t i ) const

Calculates and returns the RMS value for one ADC sample.

Definition at line 23 of file LArAccumulatedCalibDigit.cxx.

                                                        {
 
  if (i<m_sampleSum.size() && i<m_sample2Sum.size() && m_nTriggers>0) {
    const double mean=((double)m_sampleSum[i])/((double)m_nTriggers);
    const double rms2=((double)m_sample2Sum[i])/((double)m_nTriggers)-mean*mean;
    if (rms2<=0.0) return 0.0; //W.L 2010-12-07 protect against FPE due to rounding error
    return sqrt(rms2);
  }
  else
    return 0.0;
}

◆ sample2Sum()

const std::vector< uint64_t > & LArAccumulatedCalibDigit::sample2Sum ( ) const

inline

return a reference to a stl vector containing the sum of the squares of the sample

Definition at line 126 of file LArAccumulatedCalibDigit.h.

126{ return m_sample2Sum; }

◆ sampleSum()

const std::vector< uint64_t > & LArAccumulatedCalibDigit::sampleSum ( ) const

inline

return a reference to a stl vector containing the sample-sums

Definition at line 123 of file LArAccumulatedCalibDigit.h.

123{ return m_sampleSum; }

◆ setAddDigit()

bool LArAccumulatedCalibDigit::setAddDigit ( const std::vector< short > & samples )

Sum up with another (individual) LArCalibDigit.

Definition at line 82 of file LArAccumulatedCalibDigit.cxx.

                                                                          {
   const size_t nS=samples.size();
   if (m_sampleSum.empty() && m_sample2Sum.empty()) {
     m_sampleSum.resize(nS,0);
     m_sample2Sum.resize(nS,0);
   }
   else 
     if (m_sampleSum.size() != nS || m_sample2Sum.size() != nS) {
       return false; //ERROR, number of samples doesn't match!
     }
 
   for(size_t i=0;i<nS;++i) {
     const uint64_t s2=samples[i]*samples[i];
     if (m_sampleSum[i]>=std::numeric_limits<uint64_t>::max()-samples[i]) {
       return false; //ERROR, overflow! 
     }
     if (m_sample2Sum[i]>=std::numeric_limits<uint64_t>::max()-s2) {
       return false; //ERROR, overflow! 
     }
 
     m_sampleSum[i]+=samples[i];
     m_sample2Sum[i]+=s2;
     ++m_nTriggers;
   }
   return true;
}

◆ setAddSubStep()

bool LArAccumulatedCalibDigit::setAddSubStep	(	const std::vector< uint64_t > &	sampleSum,
		const std::vector< uint64_t > &	sample2Sum,
		const uint32_t	nTriggerPerStep )

Sum up with another substep.

Definition at line 112 of file LArAccumulatedCalibDigit.cxx.

                                                                                                   {
 
 
  const size_t nS=sampleSum.size();
 
  if (m_sampleSum.empty() && m_sample2Sum.empty()) {
      m_sampleSum.resize(nS,0);
      m_sample2Sum.resize(nS,0);
  }
  else 
    if (m_sampleSum.size() != nS || m_sample2Sum.size() != nS || sample2Sum.size() != nS) {
      return false; //ERROR, number of samples doesn't match!
    }
 
  for(size_t is=0; is<nS; is++) {
    if (m_sampleSum[is]>=std::numeric_limits<uint64_t>::max()-sampleSum[is]) {
      return false; //ERROR, overflow! 
    }
    if (m_sample2Sum[is]>=std::numeric_limits<uint64_t>::max()-sample2Sum[is]) {
      return false; //ERROR, overflow! 
    }
 
    m_sampleSum[is] += sampleSum[is];
    m_sample2Sum[is] += sample2Sum[is];
  }
 
  m_nTriggers += nTriggerPerStep;
  return true;
}

◆ setSample2Sum()

void LArAccumulatedCalibDigit::setSample2Sum ( const std::vector< uint64_t > & sample2Sum )

Set the sample2Sum.

Definition at line 77 of file LArAccumulatedCalibDigit.cxx.

                                                                                     {
  m_sample2Sum = sample2Sum;
}

◆ setSampleSum()

void LArAccumulatedCalibDigit::setSampleSum ( const std::vector< uint64_t > & sampleSum )

Set the sampleSum.

Definition at line 73 of file LArAccumulatedCalibDigit.cxx.

                                                                                   {
  m_sampleSum = sampleSum;
}

◆ stepIndex()

uint16_t LArAccumulatedCalibDigit::stepIndex ( ) const

inline

Definition at line 170 of file LArAccumulatedCalibDigit.h.

170{return m_iStep;}

Member Data Documentation

◆ m_DAC

uint32_t LArAccumulatedCalibDigit::m_DAC

private

DAC-Value.

Definition at line 65 of file LArAccumulatedCalibDigit.h.

◆ m_delayPulsed

uint16_t LArAccumulatedCalibDigit::m_delayPulsed

private

Delay-Value and isPulsed boolean encoded in this variable.

Definition at line 68 of file LArAccumulatedCalibDigit.h.

◆ m_gain

CaloGain::CaloGain LArAccumulatedCalibDigit::m_gain

private

gain

Definition at line 50 of file LArAccumulatedCalibDigit.h.

◆ m_hardwareID

HWIdentifier LArAccumulatedCalibDigit::m_hardwareID

private

Online Identifier.

Definition at line 47 of file LArAccumulatedCalibDigit.h.

◆ m_iStep

uint16_t LArAccumulatedCalibDigit::m_iStep

private

Definition at line 72 of file LArAccumulatedCalibDigit.h.

◆ m_nStep

uint16_t LArAccumulatedCalibDigit::m_nStep

private

Definition at line 70 of file LArAccumulatedCalibDigit.h.

◆ m_nTriggers

uint32_t LArAccumulatedCalibDigit::m_nTriggers

private

number of samples

number of trigger step

Definition at line 62 of file LArAccumulatedCalibDigit.h.

◆ m_sample2Sum

std::vector< uint64_t > LArAccumulatedCalibDigit::m_sample2Sum

private

vector of sample square sums

Definition at line 56 of file LArAccumulatedCalibDigit.h.

◆ m_sampleSum

std::vector< uint64_t > LArAccumulatedCalibDigit::m_sampleSum

private

vector of sample sums

Definition at line 53 of file LArAccumulatedCalibDigit.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LArAccumulatedCalibDigit() [1/3]

◆ LArAccumulatedCalibDigit() [2/3]

◆ ~LArAccumulatedCalibDigit()

◆ LArAccumulatedCalibDigit() [3/3]

Member Function Documentation

◆ channelID()

◆ DAC()

◆ delay()

◆ gain()

◆ getIsPulsedInt()

◆ hardwareID()

◆ isPulsed() [1/2]

◆ isPulsed() [2/2]

◆ mean() [1/2]

◆ mean() [2/2]

◆ nsamples()

◆ nSteps()

◆ nTriggers()

◆ RMS() [1/2]

◆ RMS() [2/2]

◆ sample2Sum()

◆ sampleSum()

◆ setAddDigit()

◆ setAddSubStep()

◆ setSample2Sum()

◆ setSampleSum()

◆ stepIndex()

Member Data Documentation

◆ m_DAC

◆ m_delayPulsed

◆ m_gain

◆ m_hardwareID

◆ m_iStep

◆ m_nStep

◆ m_nTriggers

◆ m_sample2Sum

◆ m_sampleSum