Transformer for the 1D probability density function (PDF) of the time response of a PMT due to a point source. More...

#include <JPDFTransformer.hh>

Inheritance diagram for JPHYSICS::JPD0Transformer_t< JArgument_t >:

Public Types
typedef JMultiMapTransformer< 1, 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
	JPD0Transformer_t ()
	Default constructor.

	JPD0Transformer_t (const double ln, const int alpha, const double kmin, const double kmax)
	Constructor.

virtual clone_type	clone () const override
	Clone object.

virtual argument_type	putXn (const_array_type &buffer, const argument_type xn) const override
	Evaluate arrival time.

virtual argument_type	getXn (const_array_type &buffer, const argument_type xn) const override
	Evaluate arrival time.

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

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

virtual JWriter &	write (JWriter &out) const override
	Write PDF transformer to output.

std::ostream &	print (std::ostream &out) const
	Print PDF transformer to output stream.

template<class ... Args>
double	getWeight (const argument_type x, const Args &...args) const
	Weight function.

Static Public Member Functions
static double	getDmin ()
	Get shortest distance.

static const JMultiMapTransformer &	getDefaultTransformer ()
	Get default transformer.

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

Public Attributes
double	ln
	Effective attenuation length [m].

int	alpha
	Distance dependence (power term)

double	kmin
	minimal kappa

double	kmax
	maximal kappa

Detailed Description

template<class JArgument_t>
class JPHYSICS::JPD0Transformer_t< JArgument_t >

Transformer for the 1D probability density function (PDF) of the time response of a PMT due to a point source.

PDFs are evaluated by interpolation for:

distance between point source and PMT [m]
arrival time [ns]

The evaluation of the weights is based on:

effective attenuation length

Definition at line 254 of file JPDFTransformer.hh.

Member Typedef Documentation

◆ JMultiMapTransformer_t

template<class JArgument_t >

JMultiMapTransformer<1, JArgument_t> JPHYSICS::JPD0Transformer_t< JArgument_t >::JMultiMapTransformer_t

Definition at line 259 of file JPDFTransformer.hh.

◆ clone_type

template<class JArgument_t >

JMultiMapTransformer_t::clone_type JPHYSICS::JPD0Transformer_t< JArgument_t >::clone_type

Definition at line 261 of file JPDFTransformer.hh.

◆ argument_type

template<class JArgument_t >

JMultiMapTransformer_t::argument_type JPHYSICS::JPD0Transformer_t< JArgument_t >::argument_type

Definition at line 262 of file JPDFTransformer.hh.

◆ const_array_type

template<class JArgument_t >

JMultiMapTransformer_t::const_array_type JPHYSICS::JPD0Transformer_t< JArgument_t >::const_array_type

Definition at line 263 of file JPDFTransformer.hh.

◆ multimaptransformer_type

template<unsigned int N, class JArgument_t >

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

inherited

Definition at line 39 of file JMultiMapTransformer.hh.

◆ array_type

template<unsigned int N, class JArgument_t >

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

inherited

Definition at line 43 of file JMultiMapTransformer.hh.

Constructor & Destructor Documentation

◆ JPD0Transformer_t() [1/2]

template<class JArgument_t >

JPHYSICS::JPD0Transformer_t< JArgument_t >::JPD0Transformer_t ( )

inline

Default constructor.

Definition at line 281 of file JPDFTransformer.hh.

                        :
      ln   (0.0),
      alpha(0),
      kmin (0.0),
      kmax (0.0)
    {}

◆ JPD0Transformer_t() [2/2]

template<class JArgument_t >

JPHYSICS::JPD0Transformer_t< JArgument_t >::JPD0Transformer_t	(	const double	ln,
		const int	alpha,
		const double	kmin,
		const double	kmax )

inline

Constructor.

Parameters

ln	Effective attenuation length [m]
alpha	Distance dependence (power term)
kmin	Minimal kappa
kmax	Maximal kappa

Definition at line 297 of file JPDFTransformer.hh.

                                          :
      ln   (ln),
      alpha(alpha),
      kmin (kmin),
      kmax (kmax)
    {}

Member Function Documentation

◆ getDmin()

template<class JArgument_t >

static double JPHYSICS::JPD0Transformer_t< JArgument_t >::getDmin ( )

inlinestatic

Get shortest distance.

Returns: distance [m]

Definition at line 272 of file JPDFTransformer.hh.

    {
      return 0.01;
    }

◆ clone()

template<class JArgument_t >

virtual clone_type JPHYSICS::JPD0Transformer_t< JArgument_t >::clone ( ) const

inlineoverridevirtual

Clone object.

Returns: pointer to newly created transformer

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

Definition at line 313 of file JPDFTransformer.hh.

    {
      return new JPD0Transformer_t(*this);
    }

◆ putXn()

template<class JArgument_t >

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

inlineoverridevirtual

Evaluate arrival time.

Parameters

buffer	{D_m}
xn	old t_ns

Returns: new t_ns

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 326 of file JPDFTransformer.hh.

    {
      using namespace JTOOLS;
 
      const double D  = buffer[0];
 
      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()

template<class JArgument_t >

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

inlineoverridevirtual

Evaluate arrival time.

Parameters

buffer	{D_m}
xn	old t_ns

Returns: new t_ns

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 354 of file JPDFTransformer.hh.

    {
      using namespace JTOOLS;
 
      const double D  = buffer[0];
 
      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/2]

template<class JArgument_t >

virtual double JPHYSICS::JPD0Transformer_t< JArgument_t >::getWeight ( const_array_type & buffer ) const

inlineoverridevirtual

Weight function.

Parameters

buffer {D_m}

Returns: weight

Implements JTOOLS::JMultiMapTransformer< N, JArgument_t >.

Definition at line 381 of file JPDFTransformer.hh.

    {
      using namespace JTOOLS;
 
      const double D  = buffer[0];
 
      const double d  = sqrt(getDmin()*getDmin() + D*D);
 
      return exp(-d/ln) / pow(d,alpha);
    }

◆ read()

template<class JArgument_t >

virtual JReader & JPHYSICS::JPD0Transformer_t< JArgument_t >::read ( JReader & in )

inlineoverridevirtual

Read PDF transformer from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 399 of file JPDFTransformer.hh.

    {
      in >> ln;
      in >> alpha;
      in >> kmin;
      in >> kmax;
 
      return in;
    }

◆ write()

template<class JArgument_t >

virtual JWriter & JPHYSICS::JPD0Transformer_t< JArgument_t >::write ( JWriter & out ) const

inlineoverridevirtual

Write PDF transformer to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 416 of file JPDFTransformer.hh.

    {
      out << ln;
      out << alpha;
      out << kmin;
      out << kmax;
 
      return out;
    }

◆ print()

template<class JArgument_t >

std::ostream & JPHYSICS::JPD0Transformer_t< JArgument_t >::print ( std::ostream & out ) const

inline

Print PDF transformer to output stream.

Parameters

out	output stream

Returns: output stream

Definition at line 433 of file JPDFTransformer.hh.

    {
      using namespace std;
 
      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;
    }

◆ getWeight() [2/2]

template<class JArgument_t >

template<class ... Args>

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

inline

Weight function.

Parameters

x	first abscissa values
args	comma seperated list of remaining abscissa values

Returns: weight

Definition at line 84 of file JMultiMapTransformer.hh.

    {
      return getWeight(array_type(x, args...));
    }

◆ getDefaultTransformer()

template<unsigned int N, class JArgument_t >

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

inlinestaticinherited

Get default transformer.

Returns: default transformer

Definition at line 101 of file JMultiMapTransformer.hh.

    {
      static const JMultiMapDefaultTransformer transformer;
      
      return transformer;
    }

◆ getClone()

template<unsigned int N, class JArgument_t >

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

inlinestaticinherited

Get clone of default transformer.

Returns: pointer to newly created transformer

Definition at line 114 of file JMultiMapTransformer.hh.

    {
      return new JMultiMapDefaultTransformer(); 
    }

Member Data Documentation

◆ ln

template<class JArgument_t >

double JPHYSICS::JPD0Transformer_t< JArgument_t >::ln

Effective attenuation length [m].

Definition at line 446 of file JPDFTransformer.hh.

◆ alpha

template<class JArgument_t >

int JPHYSICS::JPD0Transformer_t< JArgument_t >::alpha

Distance dependence (power term)

Definition at line 447 of file JPDFTransformer.hh.

◆ kmin

template<class JArgument_t >

double JPHYSICS::JPD0Transformer_t< JArgument_t >::kmin

minimal kappa

Definition at line 448 of file JPDFTransformer.hh.

◆ kmax

template<class JArgument_t >

double JPHYSICS::JPD0Transformer_t< JArgument_t >::kmax

maximal kappa

Definition at line 449 of file JPDFTransformer.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

Detailed Description

Member Typedef Documentation

◆ JMultiMapTransformer_t

◆ clone_type

◆ argument_type

◆ const_array_type

◆ multimaptransformer_type

◆ array_type

Constructor & Destructor Documentation

◆ JPD0Transformer_t() [1/2]

◆ JPD0Transformer_t() [2/2]

Member Function Documentation

◆ getDmin()

◆ clone()

◆ putXn()

◆ getXn()

◆ getWeight() [1/2]

◆ read()

◆ write()

◆ print()

◆ getWeight() [2/2]

◆ getDefaultTransformer()

◆ getClone()

Member Data Documentation

◆ ln

◆ alpha

◆ kmin

◆ kmax