InterpolatedPulse< MaxLen > Class Template Reference

#include <InterpolatedPulse.h>

Public Types
enum	{ maxlen = MaxLen }

Public Member Functions
double	derivative (const double t) const
double	getIntegral () const
unsigned	getLength () const
double	getPeakValue () const
const double *	getPulse () const
double	getPulseWidth () const
double	getStartTime () const
double	getStopTime () const
double	getTimeStep () const
	InterpolatedPulse ()
	InterpolatedPulse (const unsigned len)
	InterpolatedPulse (const double tmin, const double tmax, const unsigned len)
template<typename Real >
	InterpolatedPulse (const double tmin, const double tmax, const Real *values, const unsigned len)
	InterpolatedPulse (const InterpolatedPulse &r)
template<unsigned Len2>
	InterpolatedPulse (const InterpolatedPulse< Len2 > &r)
template<unsigned Len2>
bool	operator!= (const InterpolatedPulse< Len2 > &r) const
double	operator() (const double t) const
InterpolatedPulse &	operator*= (const double scale)
template<unsigned Len2>
InterpolatedPulse &	operator+= (const InterpolatedPulse< Len2 > &r)
InterpolatedPulse &	operator= (const InterpolatedPulse &r)
template<unsigned Len2>
InterpolatedPulse &	operator= (const InterpolatedPulse< Len2 > &r)
template<unsigned Len2>
bool	operator== (const InterpolatedPulse< Len2 > &r) const
double	secondDerivative (const double t) const
void	setIntegral (const double newValue)
void	setPeakValue (const double newValue)
void	setPulseWidth (const double newWidth)
template<typename Real >
void	setShape (const Real *values, const unsigned len)
void	setStartTime (const double newStartTime)
void	zeroOut ()

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, unsigned)

Private Attributes
unsigned	length_
double	pulse_ [MaxLen]
double	tmin_
double	width_

Friends
class	boost::serialization::access
template<unsigned Len2>
class	InterpolatedPulse

Detailed Description

template<unsigned MaxLen>
class InterpolatedPulse< MaxLen >

Definition at line 11 of file InterpolatedPulse.h.

Member Enumeration Documentation

anonymous enum

template<unsigned MaxLen>

anonymous enum

Enumerator
maxlen

Definition at line 17 of file InterpolatedPulse.h.

{ maxlen = MaxLen };

Constructor & Destructor Documentation

InterpolatedPulse() [1/6]

template<unsigned MaxLen>

InterpolatedPulse< MaxLen >::InterpolatedPulse ( )

inline

Definition at line 20 of file InterpolatedPulse.h.

: tmin_(0.0), width_(1.0), length_(2U) { zeroOut(); }

InterpolatedPulse() [2/6]

template<unsigned MaxLen>

InterpolatedPulse< MaxLen >::InterpolatedPulse ( const unsigned  len )

inlineexplicit

Definition at line 24 of file InterpolatedPulse.h.

                                                        : tmin_(0.0), width_(1.0), length_(len) {
    if (length_ < 2 || length_ > MaxLen)
      throw cms::Exception("In InterpolatedPulse constructor: invalid length");
    zeroOut();
  }

InterpolatedPulse() [3/6]

template<unsigned MaxLen>

InterpolatedPulse< MaxLen >::InterpolatedPulse ( const double  tmin, const double  tmax, const unsigned  len  )

inline

Definition at line 30 of file InterpolatedPulse.h.

      : tmin_(tmin), width_(tmax - tmin), length_(len) {
    if (length_ < 2 || length_ > MaxLen)
      throw cms::Exception("In InterpolatedPulse constructor: invalid length");
    if (width_ <= 0.0)
      throw cms::Exception("In InterpolatedPulse constructor: invalid pulse width");
    zeroOut();
  }

InterpolatedPulse() [4/6]

template<unsigned MaxLen>

template<typename Real >

InterpolatedPulse< MaxLen >::InterpolatedPulse ( const double  tmin, const double  tmax, const Real *  values, const unsigned  len  )

inline

Definition at line 40 of file InterpolatedPulse.h.

      : tmin_(tmin), width_(tmax - tmin) {
    if (width_ <= 0.0)
      throw cms::Exception("In InterpolatedPulse constructor: invalid pulse width");
    setShape(values, len);
  }

InterpolatedPulse() [5/6]

template<unsigned MaxLen>

InterpolatedPulse< MaxLen >::InterpolatedPulse ( const InterpolatedPulse< MaxLen > &  r )

inline

Definition at line 48 of file InterpolatedPulse.h.

                                                       : tmin_(r.tmin_), width_(r.width_), length_(r.length_) {
    double* buf = &pulse_[0];
    const double* rbuf = &r.pulse_[0];
    for (unsigned i = 0; i < length_; ++i)
      *buf++ = *rbuf++;
  }

InterpolatedPulse() [6/6]

template<unsigned MaxLen>

template<unsigned Len2>

InterpolatedPulse< MaxLen >::InterpolatedPulse ( const InterpolatedPulse< Len2 > &  r )

inline

Definition at line 57 of file InterpolatedPulse.h.

                                                             : tmin_(r.tmin_), width_(r.width_), length_(r.length_) {
    if (length_ > MaxLen)
      throw cms::Exception("In InterpolatedPulse copy constructor: buffer is not long enough");
    double* buf = &pulse_[0];
    const double* rbuf = &r.pulse_[0];
    for (unsigned i = 0; i < length_; ++i)
      *buf++ = *rbuf++;
  }

Member Function Documentation

derivative()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::derivative ( const double  t ) const

inline

Definition at line 147 of file InterpolatedPulse.h.

                                                 {
    const volatile double tmax = tmin_ + width_;
    if (t < tmin_ || t > tmax)
      return 0.0;
    const unsigned lm1 = length_ - 1U;
    const double step = width_ / lm1;
    const double nSteps = (t - tmin_) / step;
    unsigned nbelow = nSteps;
    unsigned nabove = nbelow + 1;
    if (nabove > lm1) {
      nabove = lm1;
      nbelow = nabove - 1U;
    }
    const double delta = nSteps - nbelow;
    if ((nbelow == 0U && delta <= 0.5) || (nabove == lm1 && delta >= 0.5))
      return (pulse_[nabove] - pulse_[nbelow]) / step;
    else if (delta >= 0.5) {
      const double lower = pulse_[nabove] - pulse_[nbelow];
      const double upper = pulse_[nabove + 1U] - pulse_[nabove];
      return (upper * (delta - 0.5) + lower * (1.5 - delta)) / step;
    } else {
      const double lower = pulse_[nbelow] - pulse_[nbelow - 1U];
      const double upper = pulse_[nabove] - pulse_[nbelow];
      return (lower * (0.5 - delta) + upper * (0.5 + delta)) / step;
    }
  }

getIntegral()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getIntegral ( ) const

inline

Definition at line 242 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::getInputIntegral(), and InterpolatedPulse< 1500U >::setIntegral().

                                    {
    const double* buf = &pulse_[0];
    long double sum = buf[0] / 2.0;
    const unsigned nIntervals = length_ - 1U;
    for (unsigned i = 1U; i < nIntervals; ++i)
      sum += buf[i];
    sum += buf[nIntervals] / 2.0;
    return sum * width_ / nIntervals;
  }

getLength()

template<unsigned MaxLen>

unsigned InterpolatedPulse< MaxLen >::getLength ( ) const

inline

Definition at line 114 of file InterpolatedPulse.h.

{ return length_; }

getPeakValue()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getPeakValue ( ) const

inline

Definition at line 259 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::getInputAmplitude(), and InterpolatedPulse< 1500U >::setPeakValue().

                                     {
    const double* buf = &pulse_[0];
    double peak = buf[0];
    for (unsigned i = 1U; i < length_; ++i)
      if (buf[i] > peak)
        peak = buf[i];
    return peak;
  }

getPulse()

template<unsigned MaxLen>

const double* InterpolatedPulse< MaxLen >::getPulse ( ) const

inline

Definition at line 113 of file InterpolatedPulse.h.

{ return &pulse_[0]; }

getPulseWidth()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getPulseWidth ( ) const

inline

Definition at line 117 of file InterpolatedPulse.h.

{ return width_; }

getStartTime()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getStartTime ( ) const

inline

Definition at line 115 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::getInputStartTime().

{ return tmin_; }

getStopTime()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getStopTime ( ) const

inline

Definition at line 116 of file InterpolatedPulse.h.

{ return tmin_ + width_; }

getTimeStep()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::getTimeStep ( ) const

inline

Definition at line 118 of file InterpolatedPulse.h.

{ return width_ / (length_ - 1U); }

operator!=()

template<unsigned MaxLen>

template<unsigned Len2>

bool InterpolatedPulse< MaxLen >::operator!= ( const InterpolatedPulse< Len2 > &  r ) const

inline

Definition at line 237 of file InterpolatedPulse.h.

                                                                 {
    return !(*this == r);
  }

operator()()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::operator() ( const double  t ) const

inline

Definition at line 130 of file InterpolatedPulse.h.

                                                 {
    const volatile double tmax = tmin_ + width_;
    if (t < tmin_ || t > tmax)
      return 0.0;
    const unsigned lm1 = length_ - 1U;
    const double step = width_ / lm1;
    const double nSteps = (t - tmin_) / step;
    unsigned nbelow = nSteps;
    unsigned nabove = nbelow + 1;
    if (nabove > lm1) {
      nabove = lm1;
      nbelow = nabove - 1U;
    }
    const double delta = nSteps - nbelow;
    return pulse_[nbelow] * (1.0 - delta) + pulse_[nabove] * delta;
  }

operator*=()

template<unsigned MaxLen>

InterpolatedPulse& InterpolatedPulse< MaxLen >::operator*= ( const double  scale )

inline

Definition at line 204 of file InterpolatedPulse.h.

                                                           {
    if (scale != 1.0) {
      double* buf = &pulse_[0];
      for (unsigned i = 0; i < length_; ++i)
        *buf++ *= scale;
    }
    return *this;
  }

operator+=()

template<unsigned MaxLen>

template<unsigned Len2>

InterpolatedPulse& InterpolatedPulse< MaxLen >::operator+= ( const InterpolatedPulse< Len2 > &  r )

inline

Definition at line 217 of file InterpolatedPulse.h.

                                                                         {
    const double step = width_ / (length_ - 1U);
    for (unsigned i = 0; i < length_; ++i)
      pulse_[i] += r(tmin_ + i * step);
    return *this;
  }

operator=() [1/2]

template<unsigned MaxLen>

InterpolatedPulse& InterpolatedPulse< MaxLen >::operator= ( const InterpolatedPulse< MaxLen > &  r )

inline

Definition at line 67 of file InterpolatedPulse.h.

                                                                  {
    if (this != &r) {
      tmin_ = r.tmin_;
      width_ = r.width_;
      length_ = r.length_;
      double* buf = &pulse_[0];
      const double* rbuf = &r.pulse_[0];
      for (unsigned i = 0; i < length_; ++i)
        *buf++ = *rbuf++;
    }
    return *this;
  }

operator=() [2/2]

template<unsigned MaxLen>

template<unsigned Len2>

InterpolatedPulse& InterpolatedPulse< MaxLen >::operator= ( const InterpolatedPulse< Len2 > &  r )

inline

Definition at line 82 of file InterpolatedPulse.h.

                                                                        {
    if (r.length_ > MaxLen)
      throw cms::Exception("In InterpolatedPulse::operator=: buffer is not long enough");
    tmin_ = r.tmin_;
    width_ = r.width_;
    length_ = r.length_;
    double* buf = &pulse_[0];
    const double* rbuf = &r.pulse_[0];
    for (unsigned i = 0; i < length_; ++i)
      *buf++ = *rbuf++;
    return *this;
  }

operator==()

template<unsigned MaxLen>

template<unsigned Len2>

bool InterpolatedPulse< MaxLen >::operator== ( const InterpolatedPulse< Len2 > &  r ) const

inline

Definition at line 225 of file InterpolatedPulse.h.

                                                                 {
    if (!(tmin_ == r.tmin_ && width_ == r.width_ && length_ == r.length_))
      return false;
    const double* buf = &pulse_[0];
    const double* rbuf = &r.pulse_[0];
    for (unsigned i = 0; i < length_; ++i)
      if (*buf++ != *rbuf++)
        return false;
    return true;
  }

secondDerivative()

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::secondDerivative ( const double  t ) const

inline

Definition at line 174 of file InterpolatedPulse.h.

                                                       {
    const volatile double tmax = tmin_ + width_;
    if (t < tmin_ || t > tmax || length_ < 3U)
      return 0.0;
    const unsigned lm1 = length_ - 1U;
    const double step = width_ / lm1;
    const double stepSq = step * step;
    const double nSteps = (t - tmin_) / step;
    unsigned nbelow = nSteps;
    unsigned nabove = nbelow + 1;
    if (nabove > lm1) {
      nabove = lm1;
      nbelow = nabove - 1U;
    }

    if (nbelow == 0U) {
      // The first interval
      return (pulse_[2] - 2.0 * pulse_[1] + pulse_[0]) / stepSq;
    } else if (nabove == lm1) {
      // The last interval
      return (pulse_[lm1] - 2.0 * pulse_[lm1 - 1U] + pulse_[lm1 - 2U]) / stepSq;
    } else {
      // One of the middle intervals
      const double lower = pulse_[nbelow - 1U] - 2.0 * pulse_[nbelow] + pulse_[nabove];
      const double upper = pulse_[nbelow] - 2.0 * pulse_[nabove] + pulse_[nabove + 1U];
      const double delta = nSteps - nbelow;
      return (lower * (1.0 - delta) + upper * delta) / stepSq;
    }
  }

serialize()

template<unsigned MaxLen>

template<class Archive >

void InterpolatedPulse< MaxLen >::serialize ( Archive &  ar, unsigned    )

inlineprivate

Definition at line 284 of file InterpolatedPulse.h.

                                                 {
    ar& tmin_& width_& length_;

    // In case we are reading, it may be useful to verify
    // that the length is reasonable
    if (length_ > MaxLen)
      throw cms::Exception("In InterpolatedPulse::serialize: buffer is not long enough");

    for (unsigned i = 0; i < length_; ++i)
      ar& pulse_[i];
  }

setIntegral()

template<unsigned MaxLen>

void InterpolatedPulse< MaxLen >::setIntegral ( const double  newValue )

inline

Definition at line 252 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::setInputIntegral().

                                                 {
    const double integ = this->getIntegral();
    if (integ == 0.0)
      throw cms::Exception("In InterpolatedPulse::setIntegral division by zero");
    *this *= (newValue / integ);
  }

setPeakValue()

template<unsigned MaxLen>

void InterpolatedPulse< MaxLen >::setPeakValue ( const double  newValue )

inline

Definition at line 268 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::setInputAmplitude().

                                                  {
    const double peak = this->getPeakValue();
    if (peak == 0.0)
      throw cms::Exception("In InterpolatedPulse::setPeakValue: division by zero");
    *this *= (newValue / peak);
  }

setPulseWidth()

template<unsigned MaxLen>

void InterpolatedPulse< MaxLen >::setPulseWidth ( const double  newWidth )

inline

Definition at line 123 of file InterpolatedPulse.h.

                                                   {
    if (newWidth <= 0.0)
      throw cms::Exception("In InterpolatedPulse::setPulseWidth: invalid pulse width");
    width_ = newWidth;
  }

setShape()

template<unsigned MaxLen>

template<typename Real >

void InterpolatedPulse< MaxLen >::setShape ( const Real *  values, const unsigned  len  )

inline

Definition at line 96 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::InterpolatedPulse(), and QIE8Simulator::setInputShape().

                                                               {
    if (len < 2 || len > MaxLen)
      throw cms::Exception("In InterpolatedPulse::setShape: invalid length");
    assert(values);
    length_ = len;
    double* buf = &pulse_[0];
    for (unsigned i = 0; i < len; ++i)
      *buf++ = *values++;
  }

setStartTime()

template<unsigned MaxLen>

void InterpolatedPulse< MaxLen >::setStartTime ( const double  newStartTime )

inline

Definition at line 121 of file InterpolatedPulse.h.

Referenced by QIE8Simulator::setInputStartTime().

{ tmin_ = newStartTime; }

zeroOut()

template<unsigned MaxLen>

void InterpolatedPulse< MaxLen >::zeroOut ( )

inline

Definition at line 107 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::InterpolatedPulse().

                        {
    for (unsigned i = 0; i < length_; ++i)
      pulse_[i] = 0.0;
  }

Friends And Related Function Documentation

boost::serialization::access

template<unsigned MaxLen>

friend class boost::serialization::access

friend

Definition at line 281 of file InterpolatedPulse.h.

InterpolatedPulse

template<unsigned MaxLen>

template<unsigned Len2>

friend class InterpolatedPulse

friend

Definition at line 13 of file InterpolatedPulse.h.

Member Data Documentation

length_

template<unsigned MaxLen>

unsigned InterpolatedPulse< MaxLen >::length_

private

Definition at line 279 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::derivative(), InterpolatedPulse< 1500U >::getIntegral(), InterpolatedPulse< 1500U >::getLength(), InterpolatedPulse< 1500U >::getPeakValue(), InterpolatedPulse< 1500U >::getTimeStep(), InterpolatedPulse< 1500U >::InterpolatedPulse(), InterpolatedPulse< 1500U >::operator()(), InterpolatedPulse< 1500U >::operator*=(), InterpolatedPulse< 1500U >::operator+=(), InterpolatedPulse< 1500U >::operator=(), InterpolatedPulse< 1500U >::operator==(), InterpolatedPulse< 1500U >::secondDerivative(), InterpolatedPulse< 1500U >::serialize(), InterpolatedPulse< 1500U >::setShape(), and InterpolatedPulse< 1500U >::zeroOut().

pulse_

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::pulse_[MaxLen]

private

Definition at line 276 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::derivative(), InterpolatedPulse< 1500U >::getIntegral(), InterpolatedPulse< 1500U >::getPeakValue(), InterpolatedPulse< 1500U >::getPulse(), InterpolatedPulse< 1500U >::InterpolatedPulse(), InterpolatedPulse< 1500U >::operator()(), InterpolatedPulse< 1500U >::operator*=(), InterpolatedPulse< 1500U >::operator+=(), InterpolatedPulse< 1500U >::operator=(), InterpolatedPulse< 1500U >::operator==(), InterpolatedPulse< 1500U >::secondDerivative(), InterpolatedPulse< 1500U >::serialize(), InterpolatedPulse< 1500U >::setShape(), and InterpolatedPulse< 1500U >::zeroOut().

tmin_

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::tmin_

private

Definition at line 277 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::derivative(), InterpolatedPulse< 1500U >::getStartTime(), InterpolatedPulse< 1500U >::getStopTime(), InterpolatedPulse< 1500U >::operator()(), InterpolatedPulse< 1500U >::operator+=(), InterpolatedPulse< 1500U >::operator=(), InterpolatedPulse< 1500U >::operator==(), InterpolatedPulse< 1500U >::secondDerivative(), InterpolatedPulse< 1500U >::serialize(), and InterpolatedPulse< 1500U >::setStartTime().

width_

template<unsigned MaxLen>

double InterpolatedPulse< MaxLen >::width_

private

Definition at line 278 of file InterpolatedPulse.h.

Referenced by InterpolatedPulse< 1500U >::derivative(), InterpolatedPulse< 1500U >::getIntegral(), InterpolatedPulse< 1500U >::getPulseWidth(), InterpolatedPulse< 1500U >::getStopTime(), InterpolatedPulse< 1500U >::getTimeStep(), InterpolatedPulse< 1500U >::InterpolatedPulse(), InterpolatedPulse< 1500U >::operator()(), InterpolatedPulse< 1500U >::operator+=(), InterpolatedPulse< 1500U >::operator=(), InterpolatedPulse< 1500U >::operator==(), InterpolatedPulse< 1500U >::secondDerivative(), InterpolatedPulse< 1500U >::serialize(), and InterpolatedPulse< 1500U >::setPulseWidth().