Jpp  17.3.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Protected Attributes | Friends | List of all members
JDETECTOR::JK40DefaultSimulator Class Reference

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

#include <JK40DefaultSimulator.hh>

Inheritance diagram for JDETECTOR::JK40DefaultSimulator:
JDETECTOR::JK40DefaultSimulatorInterface JPHYSICS::JK40Rates JDETECTOR::JK40Simulator JTRIGGER::JK40RunByRunSimulator

Public Member Functions

 JK40DefaultSimulator ()
 Default constructor. More...
 
 JK40DefaultSimulator (const JK40Rates &rates)
 Constructor. More...
 
virtual double getSinglesRate (const JPMTIdentifier &pmt) const override
 Get singles rate as a function of PMT. More...
 
virtual double getMultiplesRate (const JModuleIdentifier &module, const int M) const override
 Get multiples rate as a function of optical module. More...
 
virtual double getProbability (const double ct) const override
 Get probability of coincidence. More...
 
virtual void generateHits (const JModule &module, const JTimeRange &period, JModuleData &output) const
 Generate hits. More...
 
double getSinglesRate () const
 Get singles rate. More...
 
const JRateL1_t & getMultiplesRates () const
 Get multiples rate. More...
 
double getMultiplesRate (const multiplicity_type M) const
 Get multiples rate at given multiplicity. More...
 
multiplicity_type getLowerL1Multiplicity () const
 Get lower multiplicty. More...
 
multiplicity_type getUpperL1Multiplicity () const
 Get upper multiplicty. More...
 
void correct (const double QE)
 Correct rates for global efficiency,. More...
 

Static Public Member Functions

static JK40DefaultSimulatorgetInstance ()
 Get reference to unique instance of this class object. More...
 
static unsigned int getRandomIndex (const JBuffer1D_t &buffer, const double random)
 Get index based on random value. More...
 
static double getSigma ()
 Get intrinsic time smearing of K40 coincidences. More...
 
static void setSigma (const double sigma)
 Set intrinsic time smearing of K40 coincidences. More...
 

Static Public Attributes

static const multiplicity_type LOWER_L1_MULTIPLICITY = 2
 Lower L1 multiplicity. More...
 

Static Protected Member Functions

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

Protected Attributes

JRateL0_t rateL0
 singles rate [Hz] More...
 
JRateL1_t rateL1
 multiples rates [Hz] More...
 

Friends

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

Detailed Description

Default implementation of the simulation of K40 background.

This class implements the JK40Simulator interface.

Definition at line 30 of file JK40DefaultSimulator.hh.

Constructor & Destructor Documentation

JDETECTOR::JK40DefaultSimulator::JK40DefaultSimulator ( )
inline

Default constructor.

Definition at line 38 of file JK40DefaultSimulator.hh.

38  :
39  JK40Rates()
40  {}
JK40Rates()
Default constructor.
Definition: JK40Rates.hh:45
JDETECTOR::JK40DefaultSimulator::JK40DefaultSimulator ( const JK40Rates rates)
inline

Constructor.

Parameters
ratesK40 rates [Hz]

Definition at line 48 of file JK40DefaultSimulator.hh.

48  :
49  JK40Rates(rates)
50  {}
JK40Rates()
Default constructor.
Definition: JK40Rates.hh:45

Member Function Documentation

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 62 of file JK40DefaultSimulator.hh.

63  {
64  static JK40DefaultSimulator k40Simulator(KM3NET::getK40Rates());
65 
66  return k40Simulator;
67  }
Default implementation of the simulation of K40 background.
const JK40Rates & getK40Rates()
Get K40 rates.
Definition: KM3NeT.hh:36
virtual double JDETECTOR::JK40DefaultSimulator::getSinglesRate ( const JPMTIdentifier pmt) const
inlineoverridevirtual

Get singles rate as a function of PMT.

Parameters
pmtPMT identifier
Returns
rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Reimplemented in JTRIGGER::JK40RunByRunSimulator.

Definition at line 76 of file JK40DefaultSimulator.hh.

77  {
79  }
double getSinglesRate() const
Get singles rate.
Definition: JK40Rates.hh:71
virtual double JDETECTOR::JK40DefaultSimulator::getMultiplesRate ( const JModuleIdentifier module,
const int  M 
) const
inlineoverridevirtual

Get multiples rate as a function of optical module.

Parameters
moduleoptical module identifier
Mmultiplicity (M >= 2)
Returns
rate [Hz]

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 89 of file JK40DefaultSimulator.hh.

90  {
92  }
double getMultiplesRate(const multiplicity_type M) const
Get multiples rate at given multiplicity.
Definition: JK40Rates.hh:94
virtual double JDETECTOR::JK40DefaultSimulator::getProbability ( const double  ct) const
inlineoverridevirtual

Get probability of coincidence.

Parameters
ctcosine space angle between PMT axes
Returns
probability

Implements JDETECTOR::JK40DefaultSimulatorInterface.

Definition at line 101 of file JK40DefaultSimulator.hh.

102  {
103  return exp(ct * (p1() + ct * (p2() + ct * (p3() + ct*p4()))));
104  }
static double p1()
Parameters for probability of coincidence as a function of the cosine of space angle between PMT axes...
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable STRING $argv[2] set_array QUANTILES set_variable FORMULA *[0] exp(-0.5 *(x-[1])*(x-[1])/([2]*[2]))" set_variable MODULE `getModule -a $DETECTOR -L "$STRING 0"` source JAcousticsToolkit.sh typeset -A TRIPODS get_tripods $WORKDIR/tripod.txt TRIPODS XMEAN
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 160 of file JK40DefaultSimulator.hh.

160 { return 3.0767; }
static double JDETECTOR::JK40DefaultSimulator::p2 ( )
inlinestaticprotected

Definition at line 161 of file JK40DefaultSimulator.hh.

161 { return -1.2078; }
static double JDETECTOR::JK40DefaultSimulator::p3 ( )
inlinestaticprotected

Definition at line 162 of file JK40DefaultSimulator.hh.

162 { return 0.9905; }
static double JDETECTOR::JK40DefaultSimulator::p4 ( )
inlinestaticprotected

Definition at line 163 of file JK40DefaultSimulator.hh.

163 { return 0.9379; }
virtual void JDETECTOR::JK40DefaultSimulatorInterface::generateHits ( const JModule module,
const JTimeRange period,
JModuleData output 
) const
inlinevirtualinherited

Generate hits.

Parameters
modulemodule
periodtime window [ns]
outputbackground data

Implements JDETECTOR::JK40Simulator.

Definition at line 112 of file JK40DefaultSimulatorInterface.hh.

115  {
116 
117  // resize internal buffers
118 
119  const int N = module.size();
120 
122  probability1D.resize(N);
123  probabilityND.resize(N);
124 
125  rateL1_Hz.resize(N);
126 
127 
128  // generate singles
129 
130  for (int pmt = 0; pmt != N; ++pmt) {
131 
132  const double rateL0_Hz = getSinglesRate(JPMTIdentifier(module.getID(), pmt));
133 
134  if (rateL0_Hz > 0.0) {
135 
136  const double t_ns = 1.0e9 / rateL0_Hz; // [ns]
137 
138  for (double t1 = period.getLowerLimit() + gRandom->Exp(t_ns); t1 < period.getUpperLimit(); t1 += gRandom->Exp(t_ns)) {
139  output[pmt].push_back(JPMTSignal(t1, 1));
140  }
141  }
142  }
143 
144 
145  // generate coincidences
146 
147  double totalRateL1_Hz = 0.0;
148 
149  for (int i = 0; i != N; ++i) {
150  totalRateL1_Hz += rateL1_Hz[i] = getMultiplesRate(module.getID(), i + 2);
151  }
152 
153  if (totalRateL1_Hz > 0.0) {
154 
155  const double t_ns = 1.0e9 / totalRateL1_Hz; // [ns]
156 
157  double t1 = period.getLowerLimit() + gRandom->Exp(t_ns);
158 
159  if (t1 < period.getUpperLimit()) {
160 
161 
162  // configure correlation matrix
163 
164  for (int i = 0; i != N; ++i) {
165 
166  probability2D[i][i] = 0.0;
167 
168  for (int j = i + 1; j != N; ++j) {
169 
170  const double ct = JMATH::getDot(module[i], module[j]);
171  const double p = getProbability(ct);
172 
173  probability2D[i][j] = p;
174  probability2D[j][i] = p;
175  }
176  }
177 
178 
179  // determine probability of a coincidence as a function of the PMT number
180 
181  for (int i = 0; i != N; ++i) {
182 
183  probability1D[i] = 0.0;
184 
185  for (int j = 0; j != N; ++j) {
186  probability1D[i] += probability2D[i][j];
187  }
188  }
189 
190 
191  for ( ; t1 < period.getUpperLimit(); t1 += gRandom->Exp(t_ns)) {
192 
193 
194  // generate two-fold coincidence
195 
196  const unsigned int pmt1 = getRandomIndex(probability1D, gRandom->Rndm());
197  const unsigned int pmt2 = getRandomIndex(probability2D[pmt1], gRandom->Rndm());
198 
199  output[pmt1].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
200  output[pmt2].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
201 
202 
203  try {
204 
205  // generate larger than two-fold coincidences, if any
206 
207  unsigned int M = getRandomIndex(rateL1_Hz, gRandom->Rndm());
208 
209  if (M != 0) {
210 
212 
213  for (unsigned int pmtN = pmt2; M != 0; --M) {
214 
215  for (int i = 0; i != N; ++i) {
216  probabilityND[i] *= probability2D[pmtN][i];
217  }
218 
219  probabilityND[pmtN] = 0.0;
220 
221  pmtN = getRandomIndex(probabilityND, gRandom->Rndm());
222 
223  output[pmtN].insert(JPMTSignal(gRandom->Gaus(t1, getSigma()), 1));
224  }
225  }
226  }
227  catch (const JNumericalPrecision&) {}
228  }
229  }
230  }
231  }
static double getSigma()
Get intrinsic time smearing of K40 coincidences.
Data structure for PMT analogue signal.
T getLowerLimit() const
Get lower limit.
Definition: JRange.hh:202
then JShowerPostfit f $INPUT_FILE o $OUTPUT_FILE N
JBuffer1D_t probabilityND
This probability vector is a one-dimensional array in which element [i] corresponds to the probabilit...
static unsigned int getRandomIndex(const JBuffer1D_t &buffer, const double random)
Get index based on random value.
virtual double getSinglesRate(const JPMTIdentifier &pmt) const =0
Get singles rate as a function of PMT.
int getID() const
Get identifier.
Definition: JObjectID.hh:50
JBuffer2D_t probability2D
This correlation matrix is a two-dimensional array in which element [i][j] corresponds to the probabi...
JBuffer1D_t rateL1_Hz
Multiples rate as a function of the multiplicity.
T getUpperLimit() const
Get upper limit.
Definition: JRange.hh:213
double getDot(const JFirst_t &first, const JSecond_t &second)
Get dot product of objects.
virtual double getMultiplesRate(const JModuleIdentifier &module, const int M) const =0
Get multiples rate as a function of optical module.
JBuffer1D_t probability1D
This probability vector is a one-dimensional array in which element [i] corresponds to the probabilit...
int j
Definition: JPolint.hh:703
virtual double getProbability(const double ct) const =0
Get probability of coincidence.
static unsigned int JDETECTOR::JK40DefaultSimulatorInterface::getRandomIndex ( const JBuffer1D_t buffer,
const double  random 
)
inlinestaticinherited

Get index based on random value.

It is assumed that the values of the input buffer monotonously decrease or increase. This method throws an exception when the summed values in the input buffer is zero.

Parameters
bufferinput values
randomrandom value <0,1]
Returns
index

Definition at line 244 of file JK40DefaultSimulatorInterface.hh.

245  {
246  double x = 0.0;
247 
248  for (JBuffer1D_t::const_iterator i = buffer.begin(); i != buffer.end(); ++i) {
249  x += *i;
250  }
251 
252  if (x > 0.0) {
253 
254  x *= random;
255 
256  unsigned int index = 0;
257 
258  for (JBuffer1D_t::const_iterator i = buffer.begin(); i != buffer.end() && (x -= *i) > 0.0; ++i, ++index) {}
259 
260  if (index == buffer.size()) {
261  --index;
262  }
263 
264  return index;
265 
266  } else {
267 
268  THROW(JNumericalPrecision, "getRandomIndex(): zero or negative probability.");
269  }
270  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
static double JDETECTOR::JK40DefaultSimulatorInterface::getSigma ( )
inlinestaticinherited

Get intrinsic time smearing of K40 coincidences.

Returns
sigma [ns]

Definition at line 278 of file JK40DefaultSimulatorInterface.hh.

279  {
280  return get_sigma();
281  }
static double & get_sigma()
Get intrinsic time smearing of K40 coincidences.
static void JDETECTOR::JK40DefaultSimulatorInterface::setSigma ( const double  sigma)
inlinestaticinherited

Set intrinsic time smearing of K40 coincidences.

Parameters
sigmasigma [ns]

Definition at line 289 of file JK40DefaultSimulatorInterface.hh.

290  {
291  get_sigma() = sigma;
292  }
const double sigma[]
Definition: JQuadrature.cc:74
static double & get_sigma()
Get intrinsic time smearing of K40 coincidences.
double JPHYSICS::JK40Rates::getSinglesRate ( ) const
inlineinherited

Get singles rate.

Returns
rate [Hz]

Definition at line 71 of file JK40Rates.hh.

72  {
73  return rateL0;
74  }
JRateL0_t rateL0
singles rate [Hz]
Definition: JK40Rates.hh:221
const JRateL1_t& JPHYSICS::JK40Rates::getMultiplesRates ( ) const
inlineinherited

Get multiples rate.

Returns
rate [Hz]

Definition at line 82 of file JK40Rates.hh.

83  {
84  return rateL1;
85  }
JRateL1_t rateL1
multiples rates [Hz]
Definition: JK40Rates.hh:222
double JPHYSICS::JK40Rates::getMultiplesRate ( const multiplicity_type  M) const
inlineinherited

Get multiples rate at given multiplicity.

Parameters
Mmultiplicity (M >= JK40Rates::LOWER_L1_MULTIPLICITY)
Returns
rate [Hz]

Definition at line 94 of file JK40Rates.hh.

95  {
97  return rateL1[M - LOWER_L1_MULTIPLICITY];
98  else
99  return 0.0;
100  }
static const multiplicity_type LOWER_L1_MULTIPLICITY
Lower L1 multiplicity.
Definition: JK40Rates.hh:217
JRateL1_t rateL1
multiples rates [Hz]
Definition: JK40Rates.hh:222
size_t multiplicity_type
Type definition of multiplicity.
Definition: JK40Rates.hh:33
multiplicity_type JPHYSICS::JK40Rates::getLowerL1Multiplicity ( ) const
inlineinherited

Get lower multiplicty.

Returns
lower multiplicity

Definition at line 108 of file JK40Rates.hh.

109  {
110  return LOWER_L1_MULTIPLICITY;
111  }
static const multiplicity_type LOWER_L1_MULTIPLICITY
Lower L1 multiplicity.
Definition: JK40Rates.hh:217
multiplicity_type JPHYSICS::JK40Rates::getUpperL1Multiplicity ( ) const
inlineinherited

Get upper multiplicty.

Returns
upper multiplicity

Definition at line 119 of file JK40Rates.hh.

120  {
121  return rateL1.size() + 1;
122  }
JRateL1_t rateL1
multiples rates [Hz]
Definition: JK40Rates.hh:222
void JPHYSICS::JK40Rates::correct ( const double  QE)
inlineinherited

Correct rates for global efficiency,.

Parameters
QEglobal efficiency

Definition at line 130 of file JK40Rates.hh.

131  {
132  if (QE > 0.0) {
133 
134  rateL0 /= QE;
135 
136  JRateL1_t buffer = rateL1;
137 
139 
140  // determine contribution from higher multiplicities
141 
142  double R = 0.0;
143 
144  for (multiplicity_type i = M + 1; i <= getUpperL1Multiplicity(); ++i) {
145  R += buffer[i - LOWER_L1_MULTIPLICITY] * JMATH::binomial(i, M) * pow(QE, M) * pow(1.0 - QE, i - M);
146  }
147 
148  if (getMultiplesRate(M) > R)
149  buffer[M - LOWER_L1_MULTIPLICITY] = (getMultiplesRate(M) - R) / pow(QE, M);
150  else
151  buffer[M - LOWER_L1_MULTIPLICITY] = 0.0;
152  }
153 
154  rateL1 = buffer;
155 
156  } else {
157 
158  rateL0 = 0.0;
159 
160  for (JRateL1_t::iterator i = rateL1.begin(); i != rateL1.end(); ++i) {
161  *i = 0.0;
162  }
163  }
164  }
static const multiplicity_type LOWER_L1_MULTIPLICITY
Lower L1 multiplicity.
Definition: JK40Rates.hh:217
multiplicity_type getLowerL1Multiplicity() const
Get lower multiplicty.
Definition: JK40Rates.hh:108
JRateL1_t rateL1
multiples rates [Hz]
Definition: JK40Rates.hh:222
T pow(const T &x, const double y)
Power .
Definition: JMath.hh:97
double getMultiplesRate(const multiplicity_type M) const
Get multiples rate at given multiplicity.
Definition: JK40Rates.hh:94
size_t multiplicity_type
Type definition of multiplicity.
Definition: JK40Rates.hh:33
then JCookie sh JDataQuality D $DETECTOR_ID R
Definition: JDataQuality.sh:41
multiplicity_type getUpperL1Multiplicity() const
Get upper multiplicty.
Definition: JK40Rates.hh:119
double binomial(const size_t n, const size_t k)
Binomial function.
JRateL0_t rateL0
singles rate [Hz]
Definition: JK40Rates.hh:221

Friends And Related Function Documentation

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

Read K40 simulator from input.

Parameters
ininput stream
objectK40 simulator
Returns
input stream

Definition at line 114 of file JK40DefaultSimulator.hh.

115  {
116  const double rateL0 = object.rateL0;
117 
118  if (in >> object.rateL0) {
119 
120  object.rateL1.clear();
121 
122  for (double x; in >> x; ) {
123  object.rateL1.push_back(x);
124  }
125 
126  } else {
127 
128  object.rateL0 = rateL0;
129  }
130 
131  return in;
132  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
Definition: JCanberra.sh:46
JRateL0_t rateL0
singles rate [Hz]
Definition: JK40Rates.hh:221
std::ostream& operator<< ( std::ostream &  out,
const JK40DefaultSimulator object 
)
friend

Write K40 simulator to output.

Parameters
outoutput stream
objectK40 simulator
Returns
output stream

Definition at line 142 of file JK40DefaultSimulator.hh.

143  {
144  out << object.rateL0;
145 
146  for (JRateL1_t::const_iterator i = object.rateL1.begin(); i != object.rateL1.end(); ++i) {
147  out << ' ' << *i;
148  }
149 
150  return out;
151  }
JRateL1_t rateL1
multiples rates [Hz]
Definition: JK40Rates.hh:222

Member Data Documentation

const multiplicity_type JPHYSICS::JK40Rates::LOWER_L1_MULTIPLICITY = 2
staticinherited

Lower L1 multiplicity.

Definition at line 217 of file JK40Rates.hh.

JRateL0_t JPHYSICS::JK40Rates::rateL0
protectedinherited

singles rate [Hz]

Definition at line 221 of file JK40Rates.hh.

JRateL1_t JPHYSICS::JK40Rates::rateL1
protectedinherited

multiples rates [Hz]

Definition at line 222 of file JK40Rates.hh.


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