QIE8Simulator Class Reference

#include <QIE8Simulator.h>

Public Member Functions
double	controlOutput (double t) const
double	getInputAmplitude () const
double	getInputGain () const
double	getInputIntegral () const
const HcalInterpolatedPulse &	getInputSignal () const
double	getInputStartTime () const
double	getOutputGain () const
double	getParameter (const unsigned which) const
double	getPreampOutputCut () const
const AbsElectronicODERHS &	getRHS () const
unsigned long	getRunCount () const
double	lastStopTime () const
unsigned	nParameters () const
double	preampOutput (double t) const
double	preampPeakTime () const
	QIE8Simulator ()
	QIE8Simulator (const AbsElectronicODERHS &model, unsigned chargeNode, bool interpolateCubic=false, double preampOutputCut=-1.0e100, double inputGain=1.0, double outputGain=1.0)
unsigned	run (double dt, double tstop, double tDigitize, double *TS, unsigned lenTS)
void	scaleInputSignal (const double s)
void	setInitialConditions (const double *values, const unsigned len)
void	setInputAmplitude (const double a)
void	setInputGain (const double g)
void	setInputIntegral (const double d)
template<class Real >
void	setInputShape (const Real *values, const unsigned len)
template<class Signal >
void	setInputSignal (const Signal &inputSignal)
void	setInputStartTime (const double newStartTime)
void	setLeadingParameters (const double *values, const unsigned len)
void	setOutputGain (const double g)
void	setParameter (const unsigned which, const double p)
void	setPreampOutputCut (const double p)
void	setRHS (const AbsElectronicODERHS &rhs, unsigned chargeNode, bool interpolateCubic=false)
double	totalIntegratedCharge (double t) const
void	zeroInitialConditions ()

Static Public Member Functions
static double	adcTSWidth ()

Static Public Attributes
static const unsigned	maxlen = HcalInterpolatedPulse::maxlen

Private Member Functions
double	getCharge (const double t) const
AbsElectronicODERHS &	modifiableRHS ()
void	validateGain () const

Private Attributes
unsigned	chargeNode_
std::vector< double >	historyBuffer_
std::vector< double >	initialConditions_
double	inputGain_
bool	integrateToGetCharge_
double	outputGain_
double	preampOutputCut_
unsigned long	runCount_
RK4	solver_
bool	useCubic_

Detailed Description

Definition at line 11 of file QIE8Simulator.h.

Constructor & Destructor Documentation

QIE8Simulator::QIE8Simulator

(

)

Definition at line 6 of file QIE8Simulator.cc.

    : preampOutputCut_(-1.0e100),
      inputGain_(1.0),
      outputGain_(1.0),
      runCount_(0),
      chargeNode_(AbsElectronicODERHS::invalidNode),
      integrateToGetCharge_(false),
      useCubic_(false) {}

QIE8Simulator::QIE8Simulator	(	const AbsElectronicODERHS &	model,
		unsigned	chargeNode,
		bool	interpolateCubic = false,
		double	preampOutputCut = -1.0e100,
		double	inputGain = 1.0,
		double	outputGain = 1.0
	)

Definition at line 15 of file QIE8Simulator.cc.

References Exception, integrateToGetCharge_, AbsElectronicODERHS::invalidNode, AbsElectronicODERHS::outputNode(), validateGain(), and zeroInitialConditions().

    : solver_(model),
      preampOutputCut_(preampOutputCut),
      inputGain_(inputGain),
      outputGain_(outputGain),
      runCount_(0),
      chargeNode_(chargeNode),
      useCubic_(interpolateCubic) {
  if (chargeNode >= AbsElectronicODERHS::invalidNode)
    throw cms::Exception("In QIE8Simulator constructor: invalid charge collection node");
  integrateToGetCharge_ = chargeNode == model.outputNode();
  validateGain();
  zeroInitialConditions();
}

Member Function Documentation

static double QIE8Simulator::adcTSWidth ( )

inlinestatic

Definition at line 135 of file QIE8Simulator.h.

Referenced by run().

{ return 25.0; }

double QIE8Simulator::controlOutput

(

double

t

)

const

Definition at line 121 of file QIE8Simulator.cc.

References AbsElectronicODERHS::controlNode(), Exception, getRHS(), ConstantStepOdeSolver::interpolateCoordinate(), AbsElectronicODERHS::invalidNode, runCount_, solver_, and useCubic_.

                                                        {
  if (!runCount_)
    throw cms::Exception("In QIE8Simulator::controlOutput: please run the simulation first");
  const unsigned controlNode = getRHS().controlNode();
  if (controlNode >= AbsElectronicODERHS::invalidNode)
    return 0.0;
  else
    return solver_.interpolateCoordinate(controlNode, t, useCubic_);
}

double QIE8Simulator::getCharge ( const double  t ) const

inlineprivate

Definition at line 145 of file QIE8Simulator.h.

References chargeNode_, integrateToGetCharge_, ConstantStepOdeSolver::interpolateCoordinate(), ConstantStepOdeSolver::interpolateIntegrated(), submitPVResolutionJobs::q, solver_, and useCubic_.

Referenced by run(), and totalIntegratedCharge().

                                                {
    double q;
    if (integrateToGetCharge_)
      q = solver_.interpolateIntegrated(chargeNode_, t, useCubic_);
    else
      q = solver_.interpolateCoordinate(chargeNode_, t, useCubic_);
    return q;
  }

double QIE8Simulator::getInputAmplitude ( ) const

inline

Definition at line 91 of file QIE8Simulator.h.

References InterpolatedPulse< MaxLen >::getPeakValue(), getRHS(), inputGain_, and AbsElectronicODERHS::inputPulse().

{ return getRHS().inputPulse().getPeakValue() / inputGain_; }

double QIE8Simulator::getInputGain ( ) const

inline

Definition at line 37 of file QIE8Simulator.h.

References inputGain_.

{ return inputGain_; }

double QIE8Simulator::getInputIntegral ( ) const

inline

Definition at line 96 of file QIE8Simulator.h.

References InterpolatedPulse< MaxLen >::getIntegral(), getRHS(), inputGain_, and AbsElectronicODERHS::inputPulse().

{ return getRHS().inputPulse().getIntegral() / inputGain_; }

const HcalInterpolatedPulse& QIE8Simulator::getInputSignal ( ) const

inline

Definition at line 77 of file QIE8Simulator.h.

References getRHS(), and AbsElectronicODERHS::inputPulse().

{ return getRHS().inputPulse(); }

double QIE8Simulator::getInputStartTime ( ) const

inline

Definition at line 101 of file QIE8Simulator.h.

References getRHS(), InterpolatedPulse< MaxLen >::getStartTime(), and AbsElectronicODERHS::inputPulse().

{ return getRHS().inputPulse().getStartTime(); }

double QIE8Simulator::getOutputGain ( ) const

inline

Definition at line 38 of file QIE8Simulator.h.

References outputGain_.

{ return outputGain_; }

double QIE8Simulator::getParameter ( const unsigned  which ) const

inline

Definition at line 44 of file QIE8Simulator.h.

References AbsElectronicODERHS::getParameter(), and getRHS().

Referenced by Mixins._Parameterizable::hasParameter().

{ return getRHS().getParameter(which); }

double QIE8Simulator::getPreampOutputCut ( ) const

inline

Definition at line 40 of file QIE8Simulator.h.

References preampOutputCut_.

{ return preampOutputCut_; }

const AbsElectronicODERHS& QIE8Simulator::getRHS ( ) const

inline

Definition at line 29 of file QIE8Simulator.h.

References Exception, ConstantStepOdeSolver::getRHS(), and solver_.

Referenced by controlOutput(), getInputAmplitude(), getInputIntegral(), getInputSignal(), getInputStartTime(), getParameter(), nParameters(), preampOutput(), preampPeakTime(), setInitialConditions(), and zeroInitialConditions().

                                                   {
    const AbsODERHS* ptr = solver_.getRHS();
    if (!ptr)
      throw cms::Exception("In QIE8Simulator::getRHS: RHS is not set");
    return *(static_cast<const AbsElectronicODERHS*>(ptr));
  }

unsigned long QIE8Simulator::getRunCount ( ) const

inline

Definition at line 39 of file QIE8Simulator.h.

References runCount_.

{ return runCount_; }

double QIE8Simulator::lastStopTime

(

)

const

Definition at line 182 of file QIE8Simulator.cc.

References Exception, ConstantStepOdeSolver::lastMaxT(), runCount_, and solver_.

                                         {
  if (!runCount_)
    throw cms::Exception("In QIE8Simulator::lastStopTime: please run the simulation first");
  return solver_.lastMaxT();
}

AbsElectronicODERHS& QIE8Simulator::modifiableRHS ( )

inlineprivate

Definition at line 138 of file QIE8Simulator.h.

References Exception, ConstantStepOdeSolver::getRHS(), and solver_.

Referenced by run(), scaleInputSignal(), setInputAmplitude(), setInputIntegral(), setInputShape(), setInputSignal(), setInputStartTime(), setLeadingParameters(), and setParameter().

                                              {
    AbsODERHS* ptr = solver_.getRHS();
    if (!ptr)
      throw cms::Exception("In QIE8Simulator::modifiableRHS: no RHS");
    return *(static_cast<AbsElectronicODERHS*>(ptr));
  }

unsigned QIE8Simulator::nParameters ( ) const

inline

Definition at line 43 of file QIE8Simulator.h.

References getRHS(), and AbsElectronicODERHS::nParameters().

{ return getRHS().nParameters(); }

double QIE8Simulator::preampOutput

(

double

t

)

const

Definition at line 111 of file QIE8Simulator.cc.

References Exception, getRHS(), ConstantStepOdeSolver::interpolateCoordinate(), AbsElectronicODERHS::invalidNode, outputGain_, AbsElectronicODERHS::outputNode(), runCount_, solver_, and useCubic_.

                                                       {
  if (!runCount_)
    throw cms::Exception("In QIE8Simulator::preampOutput: please run the simulation first");
  const unsigned preampNode = getRHS().outputNode();
  if (preampNode >= AbsElectronicODERHS::invalidNode)
    return 0.0;
  else
    return outputGain_ * solver_.interpolateCoordinate(preampNode, t, useCubic_);
}

double QIE8Simulator::preampPeakTime

(

)

const

Definition at line 131 of file QIE8Simulator.cc.

References Exception, ConstantStepOdeSolver::getPeakTime(), getRHS(), AbsElectronicODERHS::invalidNode, AbsElectronicODERHS::outputNode(), runCount_, and solver_.

                                           {
  if (!runCount_)
    throw cms::Exception("In QIE8Simulator::preampPeakTime: please run the simulation first");
  const unsigned preampNode = getRHS().outputNode();
  if (preampNode >= AbsElectronicODERHS::invalidNode)
    throw cms::Exception("In QIE8Simulator::preampPeakTime: no preamp node in the circuit");
  return solver_.getPeakTime(preampNode);
}

unsigned QIE8Simulator::run	(	double	dt,
		double	tstop,
		double	tDigitize,
		double *	TS,
		unsigned	lenTS
	)

Definition at line 35 of file QIE8Simulator.cc.

References adcTSWidth(), cms::cuda::assert(), AbsODERHS::calc(), chargeNode_, dt, Exception, getCharge(), historyBuffer_, initialConditions_, integrateToGetCharge_, AbsElectronicODERHS::invalidNode, relval_steps::istep, ConstantStepOdeSolver::lastMaxT(), maxlen, modifiableRHS(), dqmiodumpmetadata::n, AbsElectronicODERHS::numberOfNodes(), outputGain_, preampOutputCut_, submitPVResolutionJobs::q, ConstantStepOdeSolver::run(), runCount_, ConstantStepOdeSolver::setHistory(), solver_, FrontierCondition_GT_autoExpress_cfi::t0, and ConstantStepOdeSolver::truncateCoordinate().

Referenced by DTWorkflow.DTWorkflow::all(), Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), and o2olib.O2OTool::execute().

                                                                                                   {
  if (chargeNode_ >= AbsElectronicODERHS::invalidNode)
    throw cms::Exception("In QIE8Simulator::run: preamp model is not set");

  // Check arguments for validity
  if (dt <= 0.0)
    throw cms::Exception("In QIE8Simulator::run: invalid time step");

  if (tstop < dt)
    throw cms::Exception("In QIE8Simulator::run: invalid stopping time");

  if (lenTS && tDigitize < 0.0)
    throw cms::Exception("In QIE8Simulator::run: can't digitize at t < 0");

  // Determine the number of time steps
  const double dsteps = tstop / dt;
  unsigned n = dsteps;
  if (dsteps != static_cast<double>(n))
    ++n;
  if (n >= maxlen)
    n = maxlen - 1;

  // Run the simulation
  AbsElectronicODERHS& rhs = modifiableRHS();
  const unsigned numNodes = rhs.numberOfNodes();
  if (numNodes) {
    assert(initialConditions_.size() == numNodes);
    solver_.run(&initialConditions_[0], numNodes, dt, n);
  } else {
    // Special situation: the simulation does not
    // need to solve any ODE. Instead, it will fill
    // out the output directly.
    if (!(integrateToGetCharge_ && chargeNode_ == 0U))
      throw cms::Exception(
          "In QIE8Simulator::run: "
          "invalid mode of operation");
    const unsigned runLen = n + 1U;
    if (historyBuffer_.size() < runLen)
      historyBuffer_.resize(runLen);
    double* hbuf = &historyBuffer_[0];
    for (unsigned istep = 0; istep < runLen; ++istep, ++hbuf)
      rhs.calc(istep * dt, nullptr, 0U, hbuf);
    solver_.setHistory(dt, &historyBuffer_[0], 1U, runLen);
  }

  // Truncate the preamp output if this will affect subsequent results
  if (integrateToGetCharge_ && preampOutputCut_ > -0.9e100)
    solver_.truncateCoordinate(chargeNode_, preampOutputCut_, DBL_MAX);

  // Digitize the accumulated charge
  unsigned filled = 0;
  if (lenTS) {
    assert(TS);
    const double lastTStop = solver_.lastMaxT();
    const double tsWidth = this->adcTSWidth();
    double oldCharge = getCharge(tDigitize);
    for (unsigned its = 0; its < lenTS; ++its) {
      const double t0 = tDigitize + its * tsWidth;
      if (t0 < lastTStop) {
        double t1 = t0 + tsWidth;
        if (t1 > lastTStop)
          t1 = lastTStop;
        else
          ++filled;
        const double q = getCharge(t1);
        TS[its] = (q - oldCharge) * outputGain_;
        oldCharge = q;
      } else
        TS[its] = 0.0;
    }
  }
  ++runCount_;
  return filled;
}

void QIE8Simulator::scaleInputSignal ( const double  s )

inline

Definition at line 88 of file QIE8Simulator.h.

References AbsElectronicODERHS::inputPulse(), modifiableRHS(), and alignCSCRings::s.

{ modifiableRHS().inputPulse() *= s; }

void QIE8Simulator::setInitialConditions	(	const double *	values,
		const unsigned	len
	)

Definition at line 140 of file QIE8Simulator.cc.

References cms::cuda::assert(), c, Exception, getRHS(), mps_fire::i, initialConditions_, and AbsElectronicODERHS::numberOfNodes().

                                                                                {
  const unsigned nExpected = getRHS().numberOfNodes();
  if (sz != nExpected)
    throw cms::Exception(
        "In QIE8Simulator::setInitialConditions: unexpected number "
        "of initial conditions");
  assert(sz == initialConditions_.size());
  if (sz) {
    double* c = &initialConditions_[0];
    for (unsigned i = 0; i < sz; ++i)
      *c++ = *values++;
  }
}

void QIE8Simulator::setInputAmplitude ( const double  a )

inline

Definition at line 93 of file QIE8Simulator.h.

References inputGain_, AbsElectronicODERHS::inputPulse(), modifiableRHS(), and InterpolatedPulse< MaxLen >::setPeakValue().

{ modifiableRHS().inputPulse().setPeakValue(a * inputGain_); }

void QIE8Simulator::setInputGain ( const double  g )

inline

Definition at line 47 of file QIE8Simulator.h.

References g, inputGain_, and validateGain().

                                           {
    inputGain_ = g;
    validateGain();
  }

void QIE8Simulator::setInputIntegral ( const double  d )

inline

Definition at line 98 of file QIE8Simulator.h.

References inputGain_, AbsElectronicODERHS::inputPulse(), modifiableRHS(), and InterpolatedPulse< MaxLen >::setIntegral().

{ modifiableRHS().inputPulse().setIntegral(d * inputGain_); }

template<class Real >

void QIE8Simulator::setInputShape ( const Real *  values, const unsigned  len  )

inline

Definition at line 82 of file QIE8Simulator.h.

References inputGain_, AbsElectronicODERHS::inputPulse(), modifiableRHS(), and InterpolatedPulse< MaxLen >::setShape().

                                                                    {
    modifiableRHS().inputPulse().setShape(values, len);
    modifiableRHS().inputPulse() *= inputGain_;
  }

template<class Signal >

void QIE8Simulator::setInputSignal ( const Signal &  inputSignal )

inline

Definition at line 71 of file QIE8Simulator.h.

References inputGain_, AbsElectronicODERHS::inputPulse(), modifiableRHS(), and AbsElectronicODERHS::setInputPulse().

                                                        {
    modifiableRHS().setInputPulse(inputSignal);
    modifiableRHS().inputPulse() *= inputGain_;
  }

void QIE8Simulator::setInputStartTime ( const double  newStartTime )

inline

Definition at line 103 of file QIE8Simulator.h.

References AbsElectronicODERHS::inputPulse(), modifiableRHS(), and InterpolatedPulse< MaxLen >::setStartTime().

{ modifiableRHS().inputPulse().setStartTime(newStartTime); }

void QIE8Simulator::setLeadingParameters ( const double *  values, const unsigned  len  )

inline

Definition at line 62 of file QIE8Simulator.h.

References modifiableRHS(), and AbsElectronicODERHS::setLeadingParameters().

                                                                             {
    modifiableRHS().setLeadingParameters(values, len);
  }

void QIE8Simulator::setOutputGain ( const double  g )

inline

Definition at line 51 of file QIE8Simulator.h.

References g, outputGain_, and validateGain().

                                            {
    outputGain_ = g;
    validateGain();
  }

void QIE8Simulator::setParameter ( const unsigned  which, const double  p  )

inline

Definition at line 61 of file QIE8Simulator.h.

References modifiableRHS(), and AbsElectronicODERHS::setParameter().

Referenced by coreTools.RunOnData::__call__(), trackTools.MakeAODTrackCandidates::__call__(), runJetUncertainties.RunJetUncertainties::__call__(), metTools.AddMETCollection::__call__(), cmsswVersionTools.PickRelValInputFiles::__call__(), coreTools.RemoveMCMatching::__call__(), trackTools.MakePATTrackCandidates::__call__(), trigTools.SwitchOnTrigger::__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties::__call__(), trigTools.SwitchOnTriggerStandAlone::__call__(), tauTools.AddTauCollection::__call__(), trackTools.MakeTrackCandidates::__call__(), trigTools.SwitchOnTriggerMatching::__call__(), trigTools.SwitchOnTriggerMatchingStandAlone::__call__(), trigTools.SwitchOnTriggerMatchEmbedding::__call__(), jetTools.AddJetCollection::__call__(), jetTools.SwitchJetCollection::__call__(), jetTools.UpdateJetCollection::__call__(), jetTools.AddJetID::__call__(), jetTools.SetTagInfos::__call__(), and runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties::jetConfiguration().

{ modifiableRHS().setParameter(which, p); }

void QIE8Simulator::setPreampOutputCut ( const double  p )

inline

Definition at line 67 of file QIE8Simulator.h.

References AlCaHLTBitMon_ParallelJobs::p, and preampOutputCut_.

{ preampOutputCut_ = p; }

void QIE8Simulator::setRHS	(	const AbsElectronicODERHS &	rhs,
		unsigned	chargeNode,
		bool	interpolateCubic = false
	)

Definition at line 154 of file QIE8Simulator.cc.

References chargeNode_, Exception, integrateToGetCharge_, AbsElectronicODERHS::invalidNode, AbsElectronicODERHS::outputNode(), ConstantStepOdeSolver::setRHS(), solver_, useCubic_, and zeroInitialConditions().

                                                             {
  if (chargeNode >= AbsElectronicODERHS::invalidNode)
    throw cms::Exception("In QIE8Simulator::setRHS invalid charge collection node");
  solver_.setRHS(rhs);
  chargeNode_ = chargeNode;
  integrateToGetCharge_ = chargeNode == rhs.outputNode();
  useCubic_ = useCubicInterpolation;
  zeroInitialConditions();
}

double QIE8Simulator::totalIntegratedCharge

(

double

t

)

const

Definition at line 188 of file QIE8Simulator.cc.

References Exception, getCharge(), outputGain_, and runCount_.

                                                                {
  if (!runCount_)
    throw cms::Exception(
        "In QIE8Simulator::totalIntegratedCharge: "
        "please run the simulation first");
  return outputGain_ * getCharge(t);
}

void QIE8Simulator::validateGain ( ) const

private

Definition at line 177 of file QIE8Simulator.cc.

References Exception, and inputGain_.

Referenced by QIE8Simulator(), setInputGain(), and setOutputGain().

                                       {
  if (inputGain_ <= 0.0)
    throw cms::Exception("In QIE8Simulator::validateGain: invalid input gain");
}

void QIE8Simulator::zeroInitialConditions

(

)

Definition at line 166 of file QIE8Simulator.cc.

References c, getRHS(), mps_fire::i, initialConditions_, and AbsElectronicODERHS::numberOfNodes().

Referenced by QIE8Simulator(), and setRHS().

                                          {
  const unsigned sz = getRHS().numberOfNodes();
  if (initialConditions_.size() != sz)
    initialConditions_.resize(sz);
  if (sz) {
    double* c = &initialConditions_[0];
    for (unsigned i = 0; i < sz; ++i)
      *c++ = 0.0;
  }
}

Member Data Documentation

unsigned QIE8Simulator::chargeNode_

private

Definition at line 163 of file QIE8Simulator.h.

Referenced by getCharge(), run(), and setRHS().

std::vector<double> QIE8Simulator::historyBuffer_

private

Definition at line 158 of file QIE8Simulator.h.

Referenced by run().

std::vector<double> QIE8Simulator::initialConditions_

private

Definition at line 157 of file QIE8Simulator.h.

Referenced by run(), setInitialConditions(), and zeroInitialConditions().

double QIE8Simulator::inputGain_

private

Definition at line 160 of file QIE8Simulator.h.

Referenced by getInputAmplitude(), getInputGain(), getInputIntegral(), setInputAmplitude(), setInputGain(), setInputIntegral(), setInputShape(), setInputSignal(), and validateGain().

bool QIE8Simulator::integrateToGetCharge_

private

Definition at line 164 of file QIE8Simulator.h.

Referenced by getCharge(), QIE8Simulator(), run(), and setRHS().

const unsigned QIE8Simulator::maxlen = HcalInterpolatedPulse::maxlen

static

Definition at line 13 of file QIE8Simulator.h.

Referenced by core.autovars.NTupleCollection::fillBranchesScalar(), core.autovars.NTupleCollection::fillBranchesVector(), core.autovars.NTupleCollection::get_cpp_declaration(), core.autovars.NTupleCollection::makeBranchesScalar(), core.autovars.NTupleCollection::makeBranchesVector(), and run().

double QIE8Simulator::outputGain_

private

Definition at line 161 of file QIE8Simulator.h.

Referenced by getOutputGain(), preampOutput(), run(), setOutputGain(), and totalIntegratedCharge().

double QIE8Simulator::preampOutputCut_

private

Definition at line 159 of file QIE8Simulator.h.

Referenced by getPreampOutputCut(), run(), and setPreampOutputCut().

unsigned long QIE8Simulator::runCount_

private

Definition at line 162 of file QIE8Simulator.h.

Referenced by controlOutput(), getRunCount(), lastStopTime(), preampOutput(), preampPeakTime(), run(), and totalIntegratedCharge().

RK4 QIE8Simulator::solver_

private

Definition at line 156 of file QIE8Simulator.h.

Referenced by controlOutput(), getCharge(), getRHS(), lastStopTime(), modifiableRHS(), preampOutput(), preampPeakTime(), run(), and setRHS().

bool QIE8Simulator::useCubic_

private

Definition at line 165 of file QIE8Simulator.h.

Referenced by controlOutput(), getCharge(), preampOutput(), and setRHS().