JDETECTOR::JK40DefaultSimulator Class Reference

Default implementation of the simulation of K40 background. More...

#include <JK40DefaultSimulator.hh>

Inheritance diagram for JDETECTOR::JK40DefaultSimulator:

Public Member Functions
	JK40DefaultSimulator ()
	Default constructor.
	JK40DefaultSimulator (const JK40Rates &rates)
	Constructor.
	JK40DefaultSimulator (const JK40Rates &rates, const JMixedK40Rates &mixed)
	Constructor.
virtual double	getSinglesRate (const JPMTIdentifier &pmt) const override
	Get singles rate as a function of PMT.
virtual double	getMultiplesRate (const JModuleIdentifier &module, const int M) const override
	Get multiples rate as a function of optical module.
virtual double	getProbability (const double ct) const override
	Get probability of coincidence.
virtual double	getL01Rate () const override
	Get mixed L0 (lower module) and L1 (upper module) rate [Hz].
virtual double	getL10Rate () const override
	Get mixed L1 (lower module) and L0 (upper module) rate [Hz].
virtual void	generateHits (const JModule &module, const JTimeRange &period, JModuleData &output) const override
	Generate hits.
virtual void	generateHits (const module_pair &input, const JTimeRange &period, const module_data &output) const override
	Generate mixed-L1/L0 hits.
double	getSinglesRate () const
	Get singles rate.
const JRateL1_t &	getMultiplesRates () const
	Get multiples rate.
double	getMultiplesRate (const multiplicity_type M) const
	Get multiples rate at given multiplicity.
multiplicity_type	getLowerL1Multiplicity () const
	Get lower multiplicty.
multiplicity_type	getUpperL1Multiplicity () const
	Get upper multiplicty.
void	correct (const double QE)
	Correct rates for global efficiency,.

Static Public Member Functions
static JK40DefaultSimulator &	getInstance ()
	Get reference to unique instance of this class object.
static double	getSigma ()
	Get intrinsic time smearing of K40 coincidences.
static void	setSigma (const double sigma)
	Set intrinsic time smearing of K40 coincidences.

Static Public Attributes
static const multiplicity_type	LOWER_L1_MULTIPLICITY = 2
	Lower L1 multiplicity.

Static Protected Member Functions
static double	p1 ()
	Parameters for probability of coincidence as a function of the cosine of space angle between PMT axes.
static double	p2 ()
static double	p3 ()
static double	p4 ()

Protected Attributes
JRateL0_t	rateL0
	singles rate [Hz]
JRateL1_t	rateL1
	multiples rates [Hz]
double	rateL01
	mixed L0 (lower module) and L1 (upper module) rate [Hz]
double	rateL10
	mixed L1 (lower module) and L0 (upper module) rate [Hz]

Static Private Member Functions
static double &	get_sigma ()
	Get intrinsic time smearing of K40 coincidences.

Friends
std::istream &	operator>> (std::istream &in, JK40DefaultSimulator &object)
	Read K40 simulator from input.
std::ostream &	operator<< (std::ostream &out, const JK40DefaultSimulator &object)
	Write K40 simulator to output.

Detailed Description

Default implementation of the simulation of K40 background.

This class implements the JK40Simulator interface.

Definition at line 31 of file JK40DefaultSimulator.hh.

Constructor & Destructor Documentation

JK40DefaultSimulator() [1/3]

JDETECTOR::JK40DefaultSimulator::JK40DefaultSimulator ( )

inline

Default constructor.

Definition at line 40 of file JK40DefaultSimulator.hh.

                           :
      JK40Rates(),
      JMixedK40Rates()
    {}

JK40DefaultSimulator() [2/3]

JDETECTOR::JK40DefaultSimulator::JK40DefaultSimulator ( const JK40Rates & rates )

inline

Constructor.

Parameters

rates

K40 rates [Hz]

Definition at line 51 of file JK40DefaultSimulator.hh.

                                                 :
      JK40Rates(rates),
      JMixedK40Rates()
    {}

JK40DefaultSimulator() [3/3]

JDETECTOR::JK40DefaultSimulator::JK40DefaultSimulator ( const JK40Rates & rates, const JMixedK40Rates & mixed )

inline

Constructor.

Parameters

rates	K40 rates [Hz]
mixed	mixed K40 rates [Hz]

Definition at line 63 of file JK40DefaultSimulator.hh.

                                                                              :
      JK40Rates(rates),
      JMixedK40Rates(mixed)
    {}

Member Function Documentation

getInstance()

static JK40DefaultSimulator & JDETECTOR::JK40DefaultSimulator::getInstance ( )

inlinestatic

Get reference to unique instance of this class object.

This method returns an object with default values. The singles and multiples rates are taken from KM3NeT internal note "Detector simulations for KM3NeT".

Returns

reference to this class object

Definition at line 78 of file JK40DefaultSimulator.hh.

    {
      static JK40DefaultSimulator k40Simulator(KM3NET::getK40Rates());
 
      return k40Simulator;
    }

getSinglesRate() [1/2]

virtual double JDETECTOR::JK40DefaultSimulator::getSinglesRate ( const JPMTIdentifier & pmt ) const

inlineoverridevirtual

Get singles rate as a function of PMT.

Parameters

pmt	PMT identifier

Returns

rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Reimplemented in JTRIGGER::JK40RunByRunSimulator.

Definition at line 92 of file JK40DefaultSimulator.hh.

    {
      return JK40Rates::getSinglesRate();
    }

getMultiplesRate() [1/2]

virtual double JDETECTOR::JK40DefaultSimulator::getMultiplesRate ( const JModuleIdentifier & module, const int M ) const

inlineoverridevirtual

Get multiples rate as a function of optical module.

Parameters

module	optical module identifier
M	multiplicity (M >= 2)

Returns

rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 105 of file JK40DefaultSimulator.hh.

    {
      return JK40Rates::getMultiplesRate(M);
    }

getProbability()

virtual double JDETECTOR::JK40DefaultSimulator::getProbability ( const double ct ) const

inlineoverridevirtual

Get probability of coincidence.

Parameters

ct	cosine space angle between PMT axes

Returns

probability

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 117 of file JK40DefaultSimulator.hh.

    {
      return exp(ct * (p1() + ct * (p2() + ct * (p3() + ct*p4()))));
    }

getL01Rate()

virtual double JDETECTOR::JK40DefaultSimulator::getL01Rate ( ) const

inlineoverridevirtual

Get mixed L0 (lower module) and L1 (upper module) rate [Hz].

Returns

rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 128 of file JK40DefaultSimulator.hh.

    {
      return JMixedK40Rates::getL01Rate();
    }

getL10Rate()

virtual double JDETECTOR::JK40DefaultSimulator::getL10Rate ( ) const

inlineoverridevirtual

Get mixed L1 (lower module) and L0 (upper module) rate [Hz].

Returns

rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 139 of file JK40DefaultSimulator.hh.

    {
      return JMixedK40Rates::getL10Rate();
    }

p1()

static double JDETECTOR::JK40DefaultSimulator::p1 ( )

inlinestaticprotected

Parameters for probability of coincidence as a function of the cosine of space angle between PMT axes.

Values are provided by V.Kulikovski.

Definition at line 200 of file JK40DefaultSimulator.hh.

{ return  3.0767; }

p2()

static double JDETECTOR::JK40DefaultSimulator::p2 ( )

inlinestaticprotected

Definition at line 201 of file JK40DefaultSimulator.hh.

{ return -1.2078; }

p3()

static double JDETECTOR::JK40DefaultSimulator::p3 ( )

inlinestaticprotected

Definition at line 202 of file JK40DefaultSimulator.hh.

{ return  0.9905; }

p4()

static double JDETECTOR::JK40DefaultSimulator::p4 ( )

inlinestaticprotected

Definition at line 203 of file JK40DefaultSimulator.hh.

{ return  0.9379; }

generateHits() [1/2]

virtual void JDETECTOR::JK40DefaultSimulatorInterface::generateHits ( const JModule & module, const JTimeRange & period, JModuleData & output ) const

inlineoverridevirtualinherited

Generate hits.

Parameters

module	module
period	time window [ns]
output	background data

Implements JDETECTOR::JK40Simulator.

Definition at line 169 of file JK40DefaultSimulatorInterface.hh.

    {
      using namespace std;
      using namespace JPP;
      
      const size_t N = module.size();
 
 
      // generate singles
 
      for (size_t pmt = 0; pmt != N; ++pmt) {
 
        const double rateL0_Hz = getSinglesRate(JPMTIdentifier(module.getID(), pmt));
 
        if (rateL0_Hz > 0.0) {
 
          const bool   asap = (output[pmt].size() != 0);  // sort as soon as possible
 
          const double t_ns = 1.0e9 / rateL0_Hz;          // interval period [ns]
              
          for (double t1 = period.getLowerLimit() + gRandom->Exp(t_ns); t1 < period.getUpperLimit(); t1 += gRandom->Exp(t_ns)) {
            output[pmt].push_back(JPMTSignal(t1, -1));    // see JPMTSignalProcessorInterface::operator()
          }
 
          if (asap) {
            output[pmt].sort();
          }
        }
      }
 
 
      // generate coincidences
 
      double totalRateL1_Hz = 0.0;
 
      // multiples rate as a function of the multiplicity - index i corresponds to multiplicity M = i + 2
 
      vector<double> rateL1_Hz(N, 0.0);      
 
      for (size_t i = 0; i != N; ++i) {
        totalRateL1_Hz += rateL1_Hz[i] = getMultiplesRate(module.getID(), i + 2);
      }
 
      if (totalRateL1_Hz > 0.0) {
 
        typedef pair<size_t,size_t>  pair_type;
      
        cdf_type<pair_type> probablityL1;
 
        const double t_ns = 1.0e9 / totalRateL1_Hz;       // interval period [ns]
 
        double t1 = period.getLowerLimit() + gRandom->Exp(t_ns);
 
        if (t1 < period.getUpperLimit()) {
 
          // configure pair-wise propabilities
 
          for (size_t pmt1 = 0; pmt1 != N; ++pmt1) {
            for (size_t pmt2 = 0; pmt2 != pmt1; ++pmt2) {
 
              const double ct = getDot(module[pmt1].getDirection(), module[pmt2].getDirection());
              const double p  = getProbability(ct);
 
              probablityL1.put({pmt1, pmt2}, p);
            }
          }
          
          for ( ; t1 < period.getUpperLimit(); t1 += gRandom->Exp(t_ns)) {
 
            try {
 
              // generate two-fold coincidence
 
              const pair_type& pair = probablityL1(gRandom->Rndm());
 
              output[pair.first ].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
              output[pair.second].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
              
              // generate larger than two-fold coincidences, if any
 
              size_t M = 0;
 
              for (double R = totalRateL1_Hz * gRandom->Rndm(); M != N && (R -= rateL1_Hz[M]) > 0.0; ++M) {}
 
              if (M != 0) {
 
                set<size_t> buffer = { pair.first , pair.second };   // hit PMTs
 
                for ( ; M != 0; --M) {
 
                  vector<double> probability1D(N, 1.0);
 
                  double P = 0.0;
                  
                  for (size_t i = 0; i != N; ++i) {
                    
                    if (buffer.count(i) == 0) {
 
                      for (set<size_t>::const_iterator pmt = buffer.begin(); pmt != buffer.end(); ++pmt) {
 
                        const double ct = getDot(module[i].getDirection(), module[*pmt].getDirection());
 
                        probability1D[i] *= getProbability(ct);
                      }
 
                      P += probability1D[i];
 
                    } else {
 
                      probability1D[i] = 0.0;
                    }
                  }
 
                  if (P > 0.0) {
 
                    size_t pmt = 0;
 
                    for (P *= gRandom->Rndm(); pmt != N && (P -= probability1D[pmt]) > 0.0; ++pmt) {}
 
                    if (pmt != N) {
 
                      output[pmt].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
 
                      buffer.insert(pmt);
                    }
 
                  } else {
 
                    break;
                  }
                }
              }
            }
            catch (const JNumericalPrecision&) {}
          }
        }
      }
    }

generateHits() [2/2]

virtual void JDETECTOR::JK40DefaultSimulatorInterface::generateHits ( const module_pair & input, const JTimeRange & period, const module_data & output ) const

inlineoverridevirtualinherited

Generate mixed-L1/L0 hits.

Parameters

input	module pair
period	time window [ns]
output	background data

Implements JDETECTOR::JK40Simulator.

Definition at line 318 of file JK40DefaultSimulatorInterface.hh.

    {
      using namespace JPP;
 
      const double rate_Hz = getL01Rate() + getL10Rate();
 
      if (rate_Hz > 0.0) {
 
        if (!input.first.empty() && !input.second.empty()) {
 
          if (neighbours(input.first, input.second)) {
 
            // locate decay in between modules
 
            const double ts = 0.8 * fabs(input.first.getZ() - input.second.getZ()) * getInverseSpeedOfLight() * getIndexOfRefraction();
 
            const JModule&   input_lower  = (input.first.getFloor() == input.second.getFloor() - 1 ? input.first  : input.second);
            const JModule&   input_upper  = (input.first.getFloor() == input.second.getFloor() + 1 ? input.first  : input.second);
 
            JModuleData&     output_lower = (input.first.getFloor() == input.second.getFloor() - 1 ? output.first : output.second);
            JModuleData&     output_upper = (input.first.getFloor() == input.second.getFloor() + 1 ? output.first : output.second);
 
            cdf_type<size_t> probability_lower;
            cdf_type<size_t> probability_upper;
 
            // use angular dependence of coincidence rate with respect to z-axis
 
            for (size_t i = 0; i != input_lower.size(); ++i) { probability_lower.put(i, this->getProbability(+1.0 * input_lower[i].getDZ())); }
            for (size_t i = 0; i != input_upper.size(); ++i) { probability_upper.put(i, this->getProbability(-1.0 * input_upper[i].getDZ())); }
              
            const double t_ns = 1.0e9 / rate_Hz;          // interval period [ns]
 
            for (double t1 = period.getLowerLimit() + gRandom->Exp(t_ns); t1 < period.getUpperLimit(); t1 += gRandom->Exp(t_ns)) {
 
              const bool L01 = gRandom->Uniform(0.0, rate_Hz) < getL01Rate();
 
              JModuleData&      output_L1      = (L01 ? output_upper      : output_lower);
              JModuleData&      output_L0      = (L01 ? output_lower      : output_upper);
 
              cdf_type<size_t>& probability_L1 = (L01 ? probability_upper : probability_lower);
              cdf_type<size_t>& probability_L0 = (L01 ? probability_lower : probability_upper);
 
              output_L1[probability_L1(gRandom->Rndm())].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
              output_L1[probability_L1(gRandom->Rndm())].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
 
              output_L0[probability_L0(gRandom->Rndm())].insert(JPMTSignal(gRandom->Gaus(t1 + ts, getSigma()), 1));
            }
          }
        }
      }
    }

getSigma()

static double JDETECTOR::JK40DefaultSimulatorInterface::getSigma ( )

inlinestaticinherited

Get intrinsic time smearing of K40 coincidences.

Returns

sigma [ns]

Definition at line 378 of file JK40DefaultSimulatorInterface.hh.

    {
      return get_sigma();
    }

setSigma()

static void JDETECTOR::JK40DefaultSimulatorInterface::setSigma ( const double sigma )

inlinestaticinherited

Set intrinsic time smearing of K40 coincidences.

Parameters

sigma

sigma [ns]

Definition at line 389 of file JK40DefaultSimulatorInterface.hh.

    {
      get_sigma() = sigma;
    }

get_sigma()

static double & JDETECTOR::JK40DefaultSimulatorInterface::get_sigma ( )

inlinestaticprivateinherited

Get intrinsic time smearing of K40 coincidences.

Returns

sigma [ns]

Definition at line 400 of file JK40DefaultSimulatorInterface.hh.

    {
      static double sigma = 0.5;
 
      return sigma;
    }

getSinglesRate() [2/2]

double JPHYSICS::JK40Rates::getSinglesRate ( ) const

inlineinherited

Get singles rate.

Returns

rate [Hz]

Definition at line 71 of file JK40Rates.hh.

    {
      return rateL0;
    }

getMultiplesRates()

const JRateL1_t & JPHYSICS::JK40Rates::getMultiplesRates ( ) const

inlineinherited

Get multiples rate.

Returns

rate [Hz]

Definition at line 82 of file JK40Rates.hh.

    {
      return rateL1;
    }

getMultiplesRate() [2/2]

double JPHYSICS::JK40Rates::getMultiplesRate ( const multiplicity_type M ) const

inlineinherited

Get multiples rate at given multiplicity.

Parameters

M	multiplicity (M >= JK40Rates::LOWER_L1_MULTIPLICITY)

Returns

rate [Hz]

Definition at line 94 of file JK40Rates.hh.

    {
      if (M >= LOWER_L1_MULTIPLICITY && M - LOWER_L1_MULTIPLICITY < (multiplicity_type) rateL1.size())
        return rateL1[M - LOWER_L1_MULTIPLICITY];
      else
        return 0.0;
    }

getLowerL1Multiplicity()

multiplicity_type JPHYSICS::JK40Rates::getLowerL1Multiplicity ( ) const

inlineinherited

Get lower multiplicty.

Returns

lower multiplicity

Definition at line 108 of file JK40Rates.hh.

    {
      return LOWER_L1_MULTIPLICITY;
    }

getUpperL1Multiplicity()

multiplicity_type JPHYSICS::JK40Rates::getUpperL1Multiplicity ( ) const

inlineinherited

Get upper multiplicty.

Returns

upper multiplicity

Definition at line 119 of file JK40Rates.hh.

    {
      return rateL1.size() + 1;
    }

correct()

void JPHYSICS::JK40Rates::correct ( const double QE )

inlineinherited

Correct rates for global efficiency,.

Parameters

QE	global efficiency

Definition at line 130 of file JK40Rates.hh.

    {
      if (QE > 0.0) {
      
        rateL0 /= QE;
 
        JRateL1_t buffer = rateL1;
        
        for (multiplicity_type M = getUpperL1Multiplicity(); M >= getLowerL1Multiplicity(); --M) {
 
          // determine contribution from higher multiplicities
          
          double R = 0.0;
          
          for (multiplicity_type i = M + 1; i <= getUpperL1Multiplicity(); ++i) {
            R += buffer[i - LOWER_L1_MULTIPLICITY] * JMATH::binomial(i, M) * pow(QE, M) * pow(1.0 - QE, i - M);
          }
 
          if (getMultiplesRate(M) > R)
            buffer[M - LOWER_L1_MULTIPLICITY] = (getMultiplesRate(M) - R) / pow(QE, M);
          else
            buffer[M - LOWER_L1_MULTIPLICITY] =  0.0;
        }
 
        rateL1 = buffer;
        
      } else {
 
        rateL0 = 0.0;
 
        for (JRateL1_t::iterator i = rateL1.begin(); i != rateL1.end(); ++i) {
          *i = 0.0;
        }
      }
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JK40DefaultSimulator & object )

friend

Read K40 simulator from input.

Parameters

in	input stream
object	K40 simulator

Returns

input stream

Definition at line 152 of file JK40DefaultSimulator.hh.

    {
      const double rateL0 = object.rateL0;
 
      if (in >> object.rateL0) {
 
        object.rateL1.clear();
 
        for (double x; in >> x; ) {
          object.rateL1.push_back(x);
        }
 
      } else {
 
        object.rateL0 = rateL0;
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JK40DefaultSimulator & object )

friend

Write K40 simulator to output.

Parameters

out	output stream
object	K40 simulator

Returns

output stream

Definition at line 180 of file JK40DefaultSimulator.hh.

    {
      out << object.rateL0;
 
      for (JRateL1_t::const_iterator i = object.rateL1.begin(); i != object.rateL1.end(); ++i) {
        out << ' ' << *i;
      }
 
      out << " X " << object.rateL01 << ' ' << object.rateL10;
 
      return out;
    }

Member Data Documentation

LOWER_L1_MULTIPLICITY

const multiplicity_type JPHYSICS::JK40Rates::LOWER_L1_MULTIPLICITY = 2

staticinherited

Lower L1 multiplicity.

Definition at line 217 of file JK40Rates.hh.

rateL0

JRateL0_t JPHYSICS::JK40Rates::rateL0

protectedinherited

singles rate [Hz]

Definition at line 221 of file JK40Rates.hh.

rateL1

JRateL1_t JPHYSICS::JK40Rates::rateL1

protectedinherited

multiples rates [Hz]

Definition at line 222 of file JK40Rates.hh.

rateL01

double JPHYSICS::JMixedK40Rates::rateL01

protectedinherited

mixed L0 (lower module) and L1 (upper module) rate [Hz]

Definition at line 300 of file JK40Rates.hh.

rateL10

double JPHYSICS::JMixedK40Rates::rateL10

protectedinherited

mixed L1 (lower module) and L0 (upper module) rate [Hz]

Definition at line 301 of file JK40Rates.hh.

---

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

• JK40DefaultSimulator.hh