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 >:

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_type >	array_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 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	getRmin ()

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

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

Public Attributes
JFunction1DTransformer_t	transformer

JFunction1D_t	getAngularAcceptance

Private Attributes
va_list	ap

JArray< N, argument_type >	buffer

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:

distance of closest approach of the muon to the PMT [m]
zenith angle of the PMT
azimuthal angle of the PMT
arrival time [ns]

The evaluation of the weights is based on:

effective attenuation length
emission profile of the photons
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.

                       :
       transformer(),
       getAngularAcceptance()
     {}

◆ 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,
		T	pmt,
		const double	amin
	)

inline

Constructor.

Parameters

ln	Effective attenuation length [m]
alpha	Distance dependence (power term)
kmin	Minimal kappa
kmax	Maximal kappa
pmt	Function angular acceptance of PMT
amin	Baseline angular acceptance of PMT

Definition at line 515 of file JPDFTransformer.hh.

                                        :
       transformer(ln, alpha, kmin, kmax),
       getAngularAcceptance()
     {
       getAngularAcceptance.configure(JTOOLS::make_grid(1000, -1.0, +1.0), pmt);
       getAngularAcceptance.add(amin);
       getAngularAcceptance.compile();
       getAngularAcceptance.setExceptionHandler(new JFunction1D_t::JDefaultResult(0.0));
     }

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.

     {
       return new JPDFTransformer(*this);
     }

◆ 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}
xn	old dt value

Returns: new dt value

Definition at line 549 of file JPDFTransformer.hh.

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

◆ 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}
xn	old dt value

Returns: new dt value

Definition at line 562 of file JPDFTransformer.hh.

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

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

     {
       using namespace JTOOLS;
  
       const double theta = buffer[1];
       const double phi   = buffer[2];
  
       const double n   = getIndexOfRefraction();
       const double ct0 = 1.0 / n;
       const double st0 = sqrt((1.0 + ct0)*(1.0 - ct0));
     
       const double px = sin(theta)*cos(phi);
       //const double py = sin(theta)*sin(phi);
       const double pz = cos(theta);
     
       const double ct = st0*px + ct0*pz;
     
       return transformer.getWeight(buffer) * getAngularAcceptance(ct);
     }

◆ read()

template<class JArgument_t >

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

inlinevirtual

Read PDF transformer from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 601 of file JPDFTransformer.hh.

     {
       in >> transformer;
       in >> getAngularAcceptance;
  
       getAngularAcceptance.compile();
  
       return in;
     }

◆ write()

template<class JArgument_t >

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

inlinevirtual

Write PDF transformer to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 618 of file JPDFTransformer.hh.

     {
       out << transformer;
       out << getAngularAcceptance;
  
       return out;
     }

◆ 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

out	output stream

Returns: output stream

Definition at line 633 of file JPDFTransformer.hh.

     {
       return transformer.print(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

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

JPDFTransformer.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ JFunction1DTransformer_t

◆ JMultiMapTransformer_t

◆ clone_type

◆ argument_type

◆ const_array_type

◆ JFunction1D_t

◆ multimaptransformer_type

◆ array_type

Constructor & Destructor Documentation

◆ JPDFTransformer() [1/2]

◆ JPDFTransformer() [2/2]

Member Function Documentation

◆ getRmin()

◆ 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

◆ transformer

◆ getAngularAcceptance

◆ ap

◆ buffer

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