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

#include <JPDFTransformer.hh>

Inheritance diagram for JPHYSICS::JPDFTransformer< 2, JArgument_t >:

Public Types
typedef JTOOLS::JMultiMapTransformer< 2, 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 JMultiMapTransformer< N, JArgument_t >	multimaptransformer_type

typedef JArray< N, argument_type >	array_type

Public Member Functions
	JPDFTransformer ()
	Default constructor. More...

	JPDFTransformer (const double ln, const int alpha, const double kmin, const double kmax, const JGeant &geant, const double bmin)
	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 {D, cd}. More...

virtual argument_type	getXn (const_array_type &buffer, const argument_type xn) const
	Evaluate dt value as a function of {D, cd}. More...

virtual double	getWeight (const_array_type &buffer) const
	Weight function. More...

virtual JReader &	read (JReader &in)
	Read PDF transformer from input. More...

virtual JWriter &	write (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	getDmin ()

static const JMultiMapTransformer &	getDefaultTransformer ()
	Get default transformer. More...

static JMultiMapTransformer *	getClone ()
	Get clone of default transformer. More...

Public Attributes
double	__ln
	Effective attenuation length [m]. More...

int	__alpha
	Distance dependence (power term) More...

double	__kmin
	minimal kappa More...

double	__kmax
	maximal kappa More...

JGeant	getShowerProbability

Private Attributes
va_list	ap

JArray< N, argument_type >	buffer

Detailed Description

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

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

PDFs are evaluated by interpolation for:

distance between EM shower and PMT [m]
cosine angle EM shower direction and EM shower - PMT position
arrival time [ns]

The evaluation of the weights is based on:

effective attenuation length
emission profile of the photons

Definition at line 255 of file JPDFTransformer.hh.

Member Typedef Documentation

◆ JMultiMapTransformer_t

template<class JArgument_t >

typedef JTOOLS::JMultiMapTransformer<2, JArgument_t> JPHYSICS::JPDFTransformer< 2, JArgument_t >::JMultiMapTransformer_t

Definition at line 260 of file JPDFTransformer.hh.

◆ clone_type

template<class JArgument_t >

typedef JMultiMapTransformer_t::clone_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::clone_type

Definition at line 262 of file JPDFTransformer.hh.

◆ argument_type

template<class JArgument_t >

typedef JMultiMapTransformer_t::argument_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::argument_type

Definition at line 263 of file JPDFTransformer.hh.

◆ const_array_type

template<class JArgument_t >

typedef JMultiMapTransformer_t::const_array_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::const_array_type

Definition at line 264 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< 2, JArgument_t >::JPDFTransformer ( )

inline

Default constructor.

Definition at line 274 of file JPDFTransformer.hh.

                       :
       __ln   (0.0),
       __alpha(0),
       __kmin (0.0),
       __kmax (0.0),
       getShowerProbability()
     {}

◆ JPDFTransformer() [2/2]

template<class JArgument_t >

JPHYSICS::JPDFTransformer< 2, JArgument_t >::JPDFTransformer	(	const double	ln,
		const int	alpha,
		const double	kmin,
		const double	kmax,
		const JGeant &	geant,
		const double	bmin
	)

inline

Constructor.

Parameters

ln	Effective attenuation length [m]
alpha	Distance dependence (power term)
kmin	Minimal kappa
kmax	Maximal kappa
geant	Function photon emission from EM-shower
bmin	Baseline photon emission from EM-shower

Definition at line 293 of file JPDFTransformer.hh.

                                         :
       __ln   (ln),
       __alpha(alpha),
       __kmin (kmin),
       __kmax (kmax),
       getShowerProbability(geant)
     {
       getShowerProbability.add(bmin);
       getShowerProbability.compile();
     }

Member Function Documentation

◆ getDmin()

template<class JArgument_t >

static double JPHYSICS::JPDFTransformer< 2, JArgument_t >::getDmin ( )

inlinestatic

Definition at line 268 of file JPDFTransformer.hh.

268 { return 0.01; } // shortest distance [m]

◆ clone()

template<class JArgument_t >

virtual clone_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::clone ( ) const

inlinevirtual

Clone object.

Returns: pointer to newly created JPDFTransformer

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

Definition at line 315 of file JPDFTransformer.hh.

     {
       return new JPDFTransformer(*this);
     }

◆ putXn() [1/2]

template<class JArgument_t >

virtual argument_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::putXn	(	const_array_type &	buffer,
		const argument_type	xn
	)		const

inlinevirtual

Evaluate dt value as a function of {D, cd}.

Parameters

buffer	{D, cd}
xn	old dt value

Returns: new dt value

Definition at line 328 of file JPDFTransformer.hh.

     {
       using namespace JTOOLS;
  
       const double D  = buffer[0];
       //const double cd = buffer[1];
  
       double x = xn;
  
       const double t0 =  D * getIndexOfRefraction() * getInverseSpeedOfLight();
       const double t1 =  D * __kmin * getInverseSpeedOfLight();
  
       x -= t1 - t0;
  
       if (__kmax > __kmin) {
         x /= D * (__kmax - __kmin) * getInverseSpeedOfLight();
       }
  
       return x;
     }

◆ getXn() [1/2]

template<class JArgument_t >

virtual argument_type JPHYSICS::JPDFTransformer< 2, JArgument_t >::getXn	(	const_array_type &	buffer,
		const argument_type	xn
	)		const

inlinevirtual

Evaluate dt value as a function of {D, cd}.

Parameters

buffer	{D, cd}
xn	old dt value

Returns: new dt value

Definition at line 357 of file JPDFTransformer.hh.

     {
       using namespace JTOOLS;
  
       const double D  = buffer[0];
       //const double cd = buffer[1];
  
       double x = xn;
  
       if (__kmax > __kmin) {
         x *= D * (__kmax - __kmin) * getInverseSpeedOfLight();
       }
  
       const double t0 =  D * getIndexOfRefraction() * getInverseSpeedOfLight();
       const double t1 =  D * __kmin * getInverseSpeedOfLight();
  
       x += t1 - t0;
  
       return x;
     }

◆ getWeight() [1/3]

template<class JArgument_t >

virtual double JPHYSICS::JPDFTransformer< 2, JArgument_t >::getWeight ( const_array_type & buffer ) const

inlinevirtual

Weight function.

Parameters

buffer {D, cd}

Returns: weight

Definition at line 385 of file JPDFTransformer.hh.

     {
       using namespace JTOOLS;
  
       const double D  = buffer[0];
       const double cd = buffer[1];
  
       const double d  = sqrt(getDmin()*getDmin() + D*D);
  
       return getShowerProbability(getIndexOfRefractionPhase(), cd) * exp(-d/__ln) / pow(d,__alpha);
     }

◆ read()

template<class JArgument_t >

virtual JReader& JPHYSICS::JPDFTransformer< 2, JArgument_t >::read ( JReader & in )

inlinevirtual

Read PDF transformer from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 404 of file JPDFTransformer.hh.

     {
       in >> __ln;
       in >> __alpha;
       in >> __kmin;
       in >> __kmax;
       in >> getShowerProbability;
  
       return in;
     }

◆ write()

template<class JArgument_t >

virtual JWriter& JPHYSICS::JPDFTransformer< 2, JArgument_t >::write ( JWriter & out ) const

inlinevirtual

Write PDF transformer to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 422 of file JPDFTransformer.hh.

     {
       out << __ln;
       out << __alpha;
       out << __kmin;
       out << __kmax;
       out << getShowerProbability;
  
       return out;
     }

◆ print()

template<class JArgument_t >

std::ostream& JPHYSICS::JPDFTransformer< 2, JArgument_t >::print ( std::ostream & out ) const

inline

Print PDF transformer to output stream.

Parameters

out	output stream

Returns: output stream

Definition at line 440 of file JPDFTransformer.hh.

     {
       using std::endl;
  
       out << "Effective attenuation length [m]   " << __ln    << endl;
       out << "Distance dependence (power term)   " << __alpha << endl;
       out << "Minimal kappa                      " << __kmin  << endl;
       out << "Maximal kappa                      " << __kmax  << endl;
  
       return out;
     }

◆ 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

buffer	x0 - xn-1 values
xn	xn 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

buffer	x0 - xn-1 values
xn	xn 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

buffer x0 - xn-1 values

Returns: weight

◆ getWeight() [3/3]

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

inlineinherited

Weight function.

Parameters

x	comma seperated list of abscissa values

Returns: weight

Definition at line 84 of file JMultiMapTransformer.hh.

     {
       va_start(ap, x);
  
       buffer[0] = x;
  
       for (int i = 1; i != N; ++i) {
         buffer[i] = va_arg(ap, argument_type);
       }
  
       va_end(ap);
  
       return getWeight(buffer);
     }

◆ 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.

     {
       static const JMultiMapDefaultTransformer transformer;
       
       return transformer;
     }

◆ 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.

     {
       return new JMultiMapDefaultTransformer(); 
     }

Member Data Documentation

◆ __ln

template<class JArgument_t >

double JPHYSICS::JPDFTransformer< 2, JArgument_t >::__ln

Effective attenuation length [m].

Definition at line 453 of file JPDFTransformer.hh.

◆ __alpha

template<class JArgument_t >

int JPHYSICS::JPDFTransformer< 2, JArgument_t >::__alpha

Distance dependence (power term)

Definition at line 454 of file JPDFTransformer.hh.

◆ __kmin

template<class JArgument_t >

double JPHYSICS::JPDFTransformer< 2, JArgument_t >::__kmin

minimal kappa

Definition at line 455 of file JPDFTransformer.hh.

◆ __kmax

template<class JArgument_t >

double JPHYSICS::JPDFTransformer< 2, JArgument_t >::__kmax

maximal kappa

Definition at line 456 of file JPDFTransformer.hh.

◆ getShowerProbability

template<class JArgument_t >

JGeant JPHYSICS::JPDFTransformer< 2, JArgument_t >::getShowerProbability

Definition at line 457 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:

JPDFTransformer.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ JMultiMapTransformer_t

◆ clone_type

◆ argument_type

◆ const_array_type

◆ multimaptransformer_type

◆ array_type

Constructor & Destructor Documentation

◆ JPDFTransformer() [1/2]

◆ JPDFTransformer() [2/2]

Member Function Documentation

◆ getDmin()

◆ clone()

◆ putXn() [1/2]

◆ getXn() [1/2]

◆ getWeight() [1/3]

◆ read()

◆ write()

◆ print()

◆ putXn() [2/2]

◆ getXn() [2/2]

◆ getWeight() [2/3]

◆ getWeight() [3/3]

◆ getDefaultTransformer()

◆ getClone()

Member Data Documentation

◆ __ln

◆ __alpha

◆ __kmin

◆ __kmax

◆ getShowerProbability

◆ ap

◆ buffer

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