Jpp
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
JPHYSICS::JPDFTransformer< 3, JArgument_t > Class Template Referenceabstract

Template specialisation of transformer of the 3D Probability Density Functions of the time response of a PMT. More...

#include <JPDFTransformer.hh>

Inheritance diagram for JPHYSICS::JPDFTransformer< 3, JArgument_t >:
JTOOLS::JMultiMapTransformer< 3, JArgument_t > JLANG::JClonable< JClonable_t, JDerived_t > JIO::JSerialisable

Public Types

typedef JPDFTransformer< 1, JArgument_t > JFunction1DTransformer_t
 
typedef JTOOLS::JMultiMapTransformer< 3, JArgument_t > JMultiMapTransformer_t
 
typedef JMultiMapTransformer_t::clone_type clone_type
 
typedef JMultiMapTransformer_t::argument_type argument_type
 
typedef JMultiMapTransformer_t::const_array_type const_array_type
 
typedef JTOOLS::JGridPolint1Function1D_t JFunction1D_t
 
typedef JMultiMapTransformer< N, JArgument_t > multimaptransformer_type
 
typedef JArray< N, argument_typearray_type
 

Public Member Functions

 JPDFTransformer ()
 Default constructor. More...
 
template<class T >
 JPDFTransformer (const double ln, const int alpha, const double kmin, const double kmax, T pmt, const double amin)
 Constructor. More...
 
virtual clone_type clone () const
 Clone object. More...
 
virtual argument_type putXn (const_array_type &buffer, const argument_type xn) const
 Evaluate dt value as a function of {R, theta, phi}. More...
 
virtual argument_type getXn (const_array_type &buffer, const argument_type xn) const
 Evaluate dt value as a function of {R, theta, phi}. More...
 
virtual double getWeight (const_array_type &buffer) const
 Weight function. More...
 
virtual JReaderread (JReader &in)
 Read PDF transformer from input. More...
 
virtual JWriterwrite (JWriter &out) const
 Write PDF transformer to output. More...
 
std::ostream & print (std::ostream &out) const
 Print PDF transformer to output stream. More...
 
virtual argument_type putXn (const_array_type &buffer, const argument_type xn) const=0
 Evaluate xn value as a function of {x0, ..., xn-1}. More...
 
virtual argument_type getXn (const_array_type &buffer, const argument_type xn) const=0
 Evaluate xn value as a function of {x0, ..., xn-1}. More...
 
virtual double getWeight (const_array_type &buffer) const=0
 Weight function. More...
 
double getWeight (const argument_type x,...) const
 Weight function. More...
 

Static Public Member Functions

static double getRmin ()
 
static const JMultiMapTransformergetDefaultTransformer ()
 Get default transformer. More...
 
static JMultiMapTransformergetClone ()
 Get clone of default transformer. More...
 

Public Attributes

JFunction1DTransformer_t transformer
 
JFunction1D_t getAngularAcceptance
 

Private Attributes

va_list ap
 
JArray< N, argument_typebuffer
 

Detailed Description

template<class JArgument_t>
class JPHYSICS::JPDFTransformer< 3, JArgument_t >

Template specialisation of transformer of the 3D Probability Density Functions of the time response of a PMT.

PDFs are evaluated by interpolation for:

  1. distance of closest approach of the muon to the PMT [m]
  2. zenith angle of the PMT
  3. azimuthal angle of the PMT
  4. arrival time [ns]

The evaluation of the weights is based on:

  1. effective attenuation length
  2. emission profile of the photons
  3. angular acceptance of PMT

Definition at line 476 of file JPDFTransformer.hh.

Member Typedef Documentation

◆ JFunction1DTransformer_t

template<class JArgument_t >
typedef JPDFTransformer<1, JArgument_t> JPHYSICS::JPDFTransformer< 3, JArgument_t >::JFunction1DTransformer_t

Definition at line 481 of file JPDFTransformer.hh.

◆ JMultiMapTransformer_t

template<class JArgument_t >
typedef JTOOLS::JMultiMapTransformer<3, JArgument_t> JPHYSICS::JPDFTransformer< 3, JArgument_t >::JMultiMapTransformer_t

Definition at line 482 of file JPDFTransformer.hh.

◆ clone_type

template<class JArgument_t >
typedef JMultiMapTransformer_t::clone_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::clone_type

Definition at line 484 of file JPDFTransformer.hh.

◆ argument_type

template<class JArgument_t >
typedef JMultiMapTransformer_t::argument_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::argument_type

Definition at line 485 of file JPDFTransformer.hh.

◆ const_array_type

template<class JArgument_t >
typedef JMultiMapTransformer_t::const_array_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::const_array_type

Definition at line 486 of file JPDFTransformer.hh.

◆ JFunction1D_t

template<class JArgument_t >
typedef JTOOLS::JGridPolint1Function1D_t JPHYSICS::JPDFTransformer< 3, JArgument_t >::JFunction1D_t

Definition at line 488 of file JPDFTransformer.hh.

◆ multimaptransformer_type

typedef JMultiMapTransformer<N, JArgument_t> JTOOLS::JMultiMapTransformer< N, JArgument_t >::multimaptransformer_type
inherited

Definition at line 41 of file JMultiMapTransformer.hh.

◆ array_type

typedef JArray<N, argument_type> JTOOLS::JMultiMapTransformer< N, JArgument_t >::array_type
inherited

Definition at line 45 of file JMultiMapTransformer.hh.

Constructor & Destructor Documentation

◆ JPDFTransformer() [1/2]

template<class JArgument_t >
JPHYSICS::JPDFTransformer< 3, JArgument_t >::JPDFTransformer ( )
inline

Default constructor.

Definition at line 498 of file JPDFTransformer.hh.

498  :
499  transformer(),
501  {}

◆ JPDFTransformer() [2/2]

template<class JArgument_t >
template<class T >
JPHYSICS::JPDFTransformer< 3, JArgument_t >::JPDFTransformer ( const double  ln,
const int  alpha,
const double  kmin,
const double  kmax,
pmt,
const double  amin 
)
inline

Constructor.

Parameters
lnEffective attenuation length [m]
alphaDistance dependence (power term)
kminMinimal kappa
kmaxMaximal kappa
pmtFunction angular acceptance of PMT
aminBaseline angular acceptance of PMT

Definition at line 515 of file JPDFTransformer.hh.

520  :
521  transformer(ln, alpha, kmin, kmax),
523  {
524  getAngularAcceptance.configure(JTOOLS::make_grid(1000, -1.0, +1.0), pmt);
525  getAngularAcceptance.add(amin);
526  getAngularAcceptance.compile();
527  getAngularAcceptance.setExceptionHandler(new JFunction1D_t::JDefaultResult(0.0));
528  }

Member Function Documentation

◆ getRmin()

template<class JArgument_t >
static double JPHYSICS::JPDFTransformer< 3, JArgument_t >::getRmin ( )
inlinestatic

Definition at line 492 of file JPDFTransformer.hh.

492 { return 0.01; } // shortest distance of approach [m]

◆ clone()

template<class JArgument_t >
virtual clone_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::clone ( ) const
inlinevirtual

Clone object.

Returns
pointer to newly created JPDFTransformer

Reimplemented from JLANG::JClonable< JClonable_t, JDerived_t >.

Definition at line 536 of file JPDFTransformer.hh.

537  {
538  return new JPDFTransformer(*this);
539  }

◆ putXn() [1/2]

template<class JArgument_t >
virtual argument_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::putXn ( const_array_type buffer,
const argument_type  xn 
) const
inlinevirtual

Evaluate dt value as a function of {R, theta, phi}.

Parameters
buffer{R, theta, phi}
xnold dt value
Returns
new dt value

Definition at line 549 of file JPDFTransformer.hh.

550  {
551  return transformer.putXn(buffer, xn);
552  }

◆ getXn() [1/2]

template<class JArgument_t >
virtual argument_type JPHYSICS::JPDFTransformer< 3, JArgument_t >::getXn ( const_array_type buffer,
const argument_type  xn 
) const
inlinevirtual

Evaluate dt value as a function of {R, theta, phi}.

Parameters
buffer{R, theta, phi}
xnold dt value
Returns
new dt value

Definition at line 562 of file JPDFTransformer.hh.

563  {
564  return transformer.getXn(buffer, xn);
565  }

◆ getWeight() [1/3]

template<class JArgument_t >
virtual double JPHYSICS::JPDFTransformer< 3, JArgument_t >::getWeight ( const_array_type buffer) const
inlinevirtual

Weight function.

Parameters
buffer{R, theta, phi}
Returns
weight

Definition at line 574 of file JPDFTransformer.hh.

575  {
576  using namespace JTOOLS;
577 
578  const double theta = buffer[1];
579  const double phi = buffer[2];
580 
581  const double n = getIndexOfRefraction();
582  const double ct0 = 1.0 / n;
583  const double st0 = sqrt((1.0 + ct0)*(1.0 - ct0));
584 
585  const double px = sin(theta)*cos(phi);
586  //const double py = sin(theta)*sin(phi);
587  const double pz = cos(theta);
588 
589  const double ct = st0*px + ct0*pz;
590 
592  }

◆ read()

template<class JArgument_t >
virtual JReader& JPHYSICS::JPDFTransformer< 3, JArgument_t >::read ( JReader in)
inlinevirtual

Read PDF transformer from input.

Parameters
inreader
Returns
reader

Implements JIO::JSerialisable.

Definition at line 601 of file JPDFTransformer.hh.

602  {
603  in >> transformer;
604  in >> getAngularAcceptance;
605 
606  getAngularAcceptance.compile();
607 
608  return in;
609  }

◆ write()

template<class JArgument_t >
virtual JWriter& JPHYSICS::JPDFTransformer< 3, JArgument_t >::write ( JWriter out) const
inlinevirtual

Write PDF transformer to output.

Parameters
outwriter
Returns
writer

Implements JIO::JSerialisable.

Definition at line 618 of file JPDFTransformer.hh.

619  {
620  out << transformer;
621  out << getAngularAcceptance;
622 
623  return out;
624  }

◆ print()

template<class JArgument_t >
std::ostream& JPHYSICS::JPDFTransformer< 3, JArgument_t >::print ( std::ostream &  out) const
inline

Print PDF transformer to output stream.

Parameters
outoutput stream
Returns
output stream

Definition at line 633 of file JPDFTransformer.hh.

634  {
635  return transformer.print(out);
636  }

◆ putXn() [2/2]

virtual argument_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::putXn ( const_array_type buffer,
const argument_type  xn 
) const
pure virtualinherited

Evaluate xn value as a function of {x0, ..., xn-1}.

Parameters
bufferx0 - xn-1 values
xnxn value
Returns
xn value

◆ getXn() [2/2]

virtual argument_type JTOOLS::JMultiMapTransformer< N, JArgument_t >::getXn ( const_array_type buffer,
const argument_type  xn 
) const
pure virtualinherited

Evaluate xn value as a function of {x0, ..., xn-1}.

Parameters
bufferx0 - xn-1 values
xnxn value
Returns
xn value

◆ getWeight() [2/3]

virtual double JTOOLS::JMultiMapTransformer< N, JArgument_t >::getWeight ( const_array_type buffer) const
pure virtualinherited

Weight function.

Parameters
bufferx0 - xn-1 values
Returns
weight

◆ getWeight() [3/3]

double JTOOLS::JMultiMapTransformer< N, JArgument_t >::getWeight ( const argument_type  x,
  ... 
) const
inlineinherited

Weight function.

Parameters
xcomma seperated list of abscissa values
Returns
weight

Definition at line 84 of file JMultiMapTransformer.hh.

85  {
86  va_start(ap, x);
87 
88  buffer[0] = x;
89 
90  for (int i = 1; i != N; ++i) {
91  buffer[i] = va_arg(ap, argument_type);
92  }
93 
94  va_end(ap);
95 
96  return getWeight(buffer);
97  }

◆ getDefaultTransformer()

static const JMultiMapTransformer& JTOOLS::JMultiMapTransformer< N, JArgument_t >::getDefaultTransformer ( )
inlinestaticinherited

Get default transformer.

Returns
default transformer

Definition at line 111 of file JMultiMapTransformer.hh.

112  {
113  static const JMultiMapDefaultTransformer transformer;
114 
115  return transformer;
116  }

◆ getClone()

static JMultiMapTransformer* JTOOLS::JMultiMapTransformer< N, JArgument_t >::getClone ( )
inlinestaticinherited

Get clone of default transformer.

Returns
pointer to newly created transformer

Definition at line 124 of file JMultiMapTransformer.hh.

125  {
126  return new JMultiMapDefaultTransformer();
127  }

Member Data Documentation

◆ transformer

template<class JArgument_t >
JFunction1DTransformer_t JPHYSICS::JPDFTransformer< 3, JArgument_t >::transformer

Definition at line 639 of file JPDFTransformer.hh.

◆ getAngularAcceptance

template<class JArgument_t >
JFunction1D_t JPHYSICS::JPDFTransformer< 3, JArgument_t >::getAngularAcceptance

Definition at line 640 of file JPDFTransformer.hh.

◆ ap

va_list JTOOLS::JMultiMapTransformer< N, JArgument_t >::ap
mutableprivateinherited

Definition at line 131 of file JMultiMapTransformer.hh.

◆ buffer

JArray<N, argument_type> JTOOLS::JMultiMapTransformer< N, JArgument_t >::buffer
mutableprivateinherited

Definition at line 132 of file JMultiMapTransformer.hh.


The documentation for this class was generated from the following file:
JTOOLS::JMultiMapTransformer< 3, JArgument_t >::ap
va_list ap
Definition: JMultiMapTransformer.hh:131
JTOOLS::JMultiMapTransformer< 3, JArgument_t >::buffer
JArray< N, argument_type > buffer
Definition: JMultiMapTransformer.hh:132
JPHYSICS::JPDFTransformer< 1, JArgument_t >::putXn
virtual argument_type putXn(const_array_type &buffer, const argument_type xn) const
Evaluate dt value as a function of {R}.
Definition: JPDFTransformer.hh:111
JPHYSICS::JPDFTransformer< 3, JArgument_t >::getAngularAcceptance
JFunction1D_t getAngularAcceptance
Definition: JPDFTransformer.hh:640
JTOOLS::n
const int n
Definition: JPolint.hh:628
JPHYSICS::JPDFTransformer< 1, JArgument_t >::print
std::ostream & print(std::ostream &out) const
Print PDF transformer to output stream.
Definition: JPDFTransformer.hh:222
JTOOLS::getIndexOfRefraction
double getIndexOfRefraction()
Get average index of refraction of water.
Definition: JConstants.hh:111
JPHYSICS::JPDFTransformer< 1, JArgument_t >::getXn
virtual argument_type getXn(const_array_type &buffer, const argument_type xn) const
Evaluate dt value as a function of {R}.
Definition: JPDFTransformer.hh:139
JTOOLS::JMultiMapTransformer< 3, JArgument_t >::getWeight
virtual double getWeight(const_array_type &buffer) const=0
Weight function.
JTOOLS::make_grid
JGrid< JAbscissa_t > make_grid(const int nx, const JAbscissa_t Xmin, const JAbscissa_t Xmax)
Helper method for JGrid.
Definition: JGrid.hh:177
JTOOLS::JMultiMapTransformer< 3, JArgument_t >::argument_type
JArgument_t argument_type
Definition: JMultiMapTransformer.hh:44
JPHYSICS::JPDFTransformer< 1, JArgument_t >::getWeight
virtual double getWeight(const_array_type &buffer) const
Weight function.
Definition: JPDFTransformer.hh:166
JPHYSICS::JPDFTransformer< 3, JArgument_t >::transformer
JFunction1DTransformer_t transformer
Definition: JPDFTransformer.hh:639
JTOOLS
Auxiliary classes and methods for multi-dimensional interpolations and histograms.
Definition: JAbstractCollection.hh:9
JTOOLS::JFunctional::setExceptionHandler
void setExceptionHandler(const JSupervisor &supervisor)
Set the supervisor for handling of exceptions.
Definition: JFunctional.hh:288
JPHYSICS::JPDFTransformer< 3, JArgument_t >::JPDFTransformer
JPDFTransformer()
Default constructor.
Definition: JPDFTransformer.hh:498