ZDCWaveformSampler Class Reference

#include <ZDCWaveformSampler.h>

Collaboration diagram for ZDCWaveformSampler:

Public Member Functions
	ZDCWaveformSampler (float freqMHz, float timeMin, unsigned int numSamples, unsigned int nBits, unsigned int pedestal, std::shared_ptr< ZDCWaveformBase > waveformPtr)
	ZDCWaveformSampler (float freqMHz, float timeMin, unsigned int numSamples, unsigned int nBits, unsigned int pedestal, const std::vector< std::shared_ptr< ZDCWaveformBase > > &waveformPtrVec)
void	SetDefaultT0 (float T0)
std::vector< unsigned int >	Generate (float amplitude)
std::vector< unsigned int >	Generate (float amplitude, float T0)
std::vector< unsigned int >	Generate (unsigned int channel, float amplitude, float T0)

Private Attributes
float	m_timeMin
unsigned int	m_numSamples
unsigned int	m_pedestal
unsigned int	m_numChannels
float	m_deltaT
float	m_maxADC
bool	m_haveDefaultT0
float	m_defaultT0
std::vector< std::shared_ptr< ZDCWaveformBase > >	m_waveformChanPtrs

Detailed Description

Definition at line 24 of file ZDCWaveformSampler.h.

Constructor & Destructor Documentation

ZDCWaveformSampler() [1/2]

ZDCWaveformSampler::ZDCWaveformSampler ( float  freqMHz, float  timeMin, unsigned int  numSamples, unsigned int  nBits, unsigned int  pedestal, std::shared_ptr< ZDCWaveformBase >  waveformPtr  )

inline

Definition at line 41 of file ZDCWaveformSampler.h.

                                                         :
    m_timeMin(timeMin),
    m_numSamples(numSamples),
    m_pedestal(pedestal),
    m_numChannels(1),
    m_deltaT(1000./freqMHz),
    m_maxADC((1<<nBits) - 1),
    m_haveDefaultT0(false),
    m_defaultT0(0.),
    m_waveformChanPtrs(1, waveformPtr)
  {}

ZDCWaveformSampler() [2/2]

ZDCWaveformSampler::ZDCWaveformSampler ( float  freqMHz, float  timeMin, unsigned int  numSamples, unsigned int  nBits, unsigned int  pedestal, const std::vector< std::shared_ptr< ZDCWaveformBase > > &  waveformPtrVec  )

inline

Definition at line 54 of file ZDCWaveformSampler.h.

                                                                               :
    m_timeMin(timeMin),
    m_numSamples(numSamples),
    m_pedestal(pedestal),
    m_numChannels(waveformPtrVec.size()),
    m_deltaT(1000./freqMHz),
    m_maxADC((1<<nBits) - 1),
    m_haveDefaultT0(false),
    m_defaultT0(0.),
    m_waveformChanPtrs(waveformPtrVec)
  {}

Member Function Documentation

Generate() [1/3]

std::vector<unsigned int> ZDCWaveformSampler::Generate ( float  amplitude )

inline

Definition at line 72 of file ZDCWaveformSampler.h.

  {
    if (m_numChannels != 1) throw std::runtime_error("ZDCWaveformSampler::Generate called with one parameter on an object with multiple channels.");
    if (!m_haveDefaultT0) throw std::runtime_error("ZDCWaveformSampler::Generate called with no default t0.");
    return Generate(amplitude, m_defaultT0);
  }

Generate() [2/3]

std::vector<unsigned int> ZDCWaveformSampler::Generate ( float  amplitude, float  T0  )

inline

Definition at line 79 of file ZDCWaveformSampler.h.

  {
    if (m_numChannels != 1) throw std::runtime_error("ZDCWaveformSampler::Generate called with one parameter on an object with multiple channels.");
    return Generate(0, amplitude, T0);
  }

Generate() [3/3]

std::vector< unsigned int > ZDCWaveformSampler::Generate	(	unsigned int	channel,
		float	amplitude,
		float	T0
	)

Definition at line 8 of file ZDCWaveformSampler.cxx.

{
  std::vector<unsigned int> samples;
  const ZDCWaveformBase* waveformPtr = m_waveformChanPtrs.at(channel).get();
 
  //
  // We loop over the requested number of samples
  //
  float time = m_timeMin;
 
  for (unsigned int isample = 0; isample < m_numSamples; isample++) {
    //
    // The waveform generates a shape with unit amplitude with maximum at t = 0
    //   we shift the evaluation to account for the actual T0
    //
    float valueUnitNorm = waveformPtr->evaluate(time - T0);
 
    // Now we scale up by the amplitue
    //
    float value = std::floor(valueUnitNorm*amplitude);
 
    // We apply the pedestal shift and force value > 0
    //
    value = std::max(value + m_pedestal, float(0.));
    
    // Now we truncate at the maximum ADC value
    //
    unsigned int valueIntTrunc = std::min(value, m_maxADC);
    samples.push_back(valueIntTrunc);
 
    time += m_deltaT;
  }
 
  return samples;
}

SetDefaultT0()

void ZDCWaveformSampler::SetDefaultT0 ( float  T0 )

inline

Definition at line 67 of file ZDCWaveformSampler.h.

                              {
    m_haveDefaultT0 = true;
    m_defaultT0 = T0;
  }

Member Data Documentation

m_defaultT0

float ZDCWaveformSampler::m_defaultT0

private

Definition at line 35 of file ZDCWaveformSampler.h.

m_deltaT

float ZDCWaveformSampler::m_deltaT

private

Definition at line 31 of file ZDCWaveformSampler.h.

m_haveDefaultT0

bool ZDCWaveformSampler::m_haveDefaultT0

private

Definition at line 34 of file ZDCWaveformSampler.h.

m_maxADC

float ZDCWaveformSampler::m_maxADC

private

Definition at line 32 of file ZDCWaveformSampler.h.

m_numChannels

unsigned int ZDCWaveformSampler::m_numChannels

private

Definition at line 29 of file ZDCWaveformSampler.h.

m_numSamples

unsigned int ZDCWaveformSampler::m_numSamples

private

Definition at line 27 of file ZDCWaveformSampler.h.

m_pedestal

unsigned int ZDCWaveformSampler::m_pedestal

private

Definition at line 28 of file ZDCWaveformSampler.h.

m_timeMin

float ZDCWaveformSampler::m_timeMin

private

Definition at line 26 of file ZDCWaveformSampler.h.

m_waveformChanPtrs

std::vector<std::shared_ptr<ZDCWaveformBase> > ZDCWaveformSampler::m_waveformChanPtrs

private

Definition at line 37 of file ZDCWaveformSampler.h.

---

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

• ZDCWaveformSampler.h
• ZDCWaveformSampler.cxx