Function object for the probability density function of photon emission from EM-shower as a function of cosine of the emission angle. More...

#include <JGeant.hh>

Inheritance diagram for JPHYSICS::JGeant:

Public Types
typedef JGridCollection< JElement2D< double, double >, JDistance< typename JElement2D< double, double > ::abscissa_type > >	collection_type

typedef collection_type::abscissa_type	abscissa_type

typedef collection_type::ordinate_type	ordinate_type

typedef collection_type::value_type	value_type

typedef collection_type::distance_type	distance_type

typedef collection_type::const_iterator	const_iterator

typedef collection_type::const_reverse_iterator	const_reverse_iterator

typedef collection_type::iterator	iterator

typedef collection_type::reverse_iterator	reverse_iterator

typedef JFunction1D< abscissa_type, double >	function_type

typedef function_type::argument_type	argument_type

typedef function_type::result_type	result_type

typedef function_type::JExceptionHandler	exceptionhandler_type

enum

typedef JFunctional< JElement2D< double, double > ::abscissa_type, double >	functional_type

typedef JSupervisor	supervisor_type

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

	JGeant (const JGeanx &geanx, const double dx=0.0001)
	Constructor. More...

virtual void	compile ()
	Function compilation. More...

double	operator() (const double n, const double ct) const
	Number of photons from EM-shower as a function of emission angle. More...

double	operator() (const double n, const double xmin, const double xmax) const
	Integral number of photons from EM-shower between two emission angles. More...

result_type	operator() (const argument_type x) const
	Function value evaluation. More...

virtual result_type	evaluate (const argument_type *pX) const=0
	Recursive function value evaluation. More...

JSupervisor	getSupervisor () const
	Get supervisor. More...

const JExceptionHandler &	getExceptionHandler () const
	Get exception handler. More...

void	setExceptionHandler (const JSupervisor &supervisor)
	Set the supervisor for handling of exceptions. More...

Static Public Member Functions
static result_type	getValue (const JFunctional &function, const argument_type *pX)
	Recursive function value evaluation. More...

static JClass< result_type >::argument_type	getValue (typename JClass< result_type >::argument_type value, const argument_type *pX)
	Termination of recursive function value evaluation. More...

Protected Attributes
JSupervisor	supervisor

Private Attributes
double	a0
	offset of the normalisation dependence More...

double	a1
	slope of the normalisation dependence More...

JGeantFunction1D_t	buffer

Friends
JReader &	operator>> (JReader &in, JGeant &geant)
	Read geant from input. More...

JWriter &	operator<< (JWriter &out, const JGeant &geant)
	Write geant to output. More...

Detailed Description

Function object for the probability density function of photon emission from EM-shower as a function of cosine of the emission angle.

The implementation of this function is based on a linear interpolation of tabulated values. In this, a linear approximation of the dependence of the normalisation constant on the index of refraction is assumed. This assumption is valid to within 10^-3.

Definition at line 39 of file JGeant.hh.

Member Typedef Documentation

◆ collection_type

typedef JGridCollection <JElement2D< double, double > , JDistance<typename JElement2D< double, double > ::abscissa_type> > JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::collection_type

inherited

Definition at line 939 of file JPolint.hh.

◆ abscissa_type

typedef collection_type::abscissa_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::abscissa_type

inherited

Definition at line 941 of file JPolint.hh.

◆ ordinate_type

typedef collection_type::ordinate_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::ordinate_type

inherited

Definition at line 942 of file JPolint.hh.

◆ value_type

typedef collection_type::value_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::value_type

inherited

Definition at line 943 of file JPolint.hh.

◆ distance_type

typedef collection_type::distance_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::distance_type

inherited

Definition at line 944 of file JPolint.hh.

◆ const_iterator

typedef collection_type::const_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::const_iterator

inherited

Definition at line 946 of file JPolint.hh.

◆ const_reverse_iterator

typedef collection_type::const_reverse_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::const_reverse_iterator

inherited

Definition at line 947 of file JPolint.hh.

◆ iterator

typedef collection_type::iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::iterator

inherited

Definition at line 948 of file JPolint.hh.

◆ reverse_iterator

typedef collection_type::reverse_iterator JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::reverse_iterator

inherited

Definition at line 949 of file JPolint.hh.

◆ function_type

typedef JFunction1D<abscissa_type, double > JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::function_type

inherited

Definition at line 951 of file JPolint.hh.

◆ argument_type

typedef function_type::argument_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::argument_type

inherited

Definition at line 953 of file JPolint.hh.

◆ result_type

typedef function_type::result_type JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::result_type

inherited

Definition at line 954 of file JPolint.hh.

◆ exceptionhandler_type

typedef function_type::JExceptionHandler JTOOLS::JPolintFunction1D< N, JElement2D< double, double > , JGridCollection , double , JDistance<typename JElement2D< double, double > ::abscissa_type> >::exceptionhandler_type

inherited

Definition at line 955 of file JPolint.hh.

◆ functional_type

typedef JFunctional<JElement2D< double, double > ::abscissa_type , double > JTOOLS::JFunction1D< JElement2D< double, double > ::abscissa_type , double >::functional_type

inherited

Definition at line 322 of file JFunctional.hh.

◆ supervisor_type

typedef JSupervisor JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Definition at line 320 of file JFunctional.hh.

320 { NUMBER_OF_DIMENSIONS = 1 };

Constructor & Destructor Documentation

◆ JGeant() [1/2]

JPHYSICS::JGeant::JGeant ( )

inline

Default constructor.

Definition at line 46 of file JGeant.hh.

47 {}

◆ JGeant() [2/2]

JPHYSICS::JGeant::JGeant	(	const JGeanx &	geanx,
		const double	dx = `0.0001`
	)

inline

Constructor.

Parameters

geanx	PDF of EM-shower
dx	step size for interpolation of function values

Definition at line 56 of file JGeant.hh.

     {
       using JTOOLS::PI;
  
       const double n0 = geanx.n - 0.02;
       const double n1 = geanx.n + 0.02;
  
       const JGeanx g0(geanx.a, geanx.b, n0);
       const JGeanx g1(geanx.a, geanx.b, n1);
  
       const double y0 = g0.evaluate(-1.0, +1.0);
       const double y1 = g1.evaluate(-1.0, +1.0);
  
       const double c  = 1.0 / (y0 * 2*PI);
  
       // following range corresponds to n = 1 to n = infinity
  
       for (double x = -2.0; x < 1.0; x += dx) {
         (*this)[x] = c * g0.evaluate(x + 1.0/n0);
       }
  
       compile();
  
       // linear approximation of dependence normalisation constant on index of refraction
       
       a1 = (y1 - y0) / y0 / (n1 - n0);
       a0 = 1.0 + a1*n0;
     }

Member Function Documentation

◆ compile()

virtual void JPHYSICS::JGeant::compile ( )

inlinevirtual

Function compilation.

Definition at line 90 of file JGeant.hh.

     {
       JGeantFunction1D_t::compile();
  
       buffer.clear();
  
       JTOOLS::integrate(*this, buffer);
  
       buffer.compile();
     }

◆ operator()() [1/3]

double JPHYSICS::JGeant::operator()	(	const double	n,
		const double	ct
	)		const

inline

Number of photons from EM-shower as a function of emission angle.

The integral over full solid angle is normalised to one.

Parameters

n	index of refraction
ct	cosine angle of emmision

Returns: d^2P/dcos()dphi

Definition at line 110 of file JGeant.hh.

     {
       const double y = JGeantFunction1D_t::operator()(ct - 1.0/n);
  
       return y * (a0 - a1*n);
     }

◆ operator()() [2/3]

double JPHYSICS::JGeant::operator()	(	const double	n,
		const double	xmin,
		const double	xmax
	)		const

inline

Integral number of photons from EM-shower between two emission angles.

The integral over full solid angle is normalised to one.

Parameters

n	index of refraction
xmin	minimal cosine angle of emmision
xmax	maximal cosine angle of emmision

Returns: dnpe/dphi

Definition at line 128 of file JGeant.hh.

     {
       const double x_min = std::max(xmin - 1.0/n, buffer. begin()->getX());
       const double x_max = std::min(xmax - 1.0/n, buffer.rbegin()->getX());
  
       const double y = buffer(x_max) - buffer(x_min);
  
       return y * (a0 - a1*n);
     }

◆ operator()() [3/3]

result_type JTOOLS::JFunction1D< JElement2D< double, double > ::abscissa_type , double >::operator() ( const argument_type x ) const

inlineinherited

Function value evaluation.

Parameters

x	argument value

Returns: function value

Definition at line 333 of file JFunctional.hh.

     {
       return this->evaluate(&x);
     }

◆ evaluate()

virtual result_type JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::evaluate ( const argument_type * pX ) const

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

◆ getValue() [1/2]

static result_type JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::getValue	(	const JFunctional< JElement2D< double, double > ::abscissa_type, double > &	function,
		const argument_type *	pX
	)

inlinestaticinherited

Recursive function value evaluation.

Parameters

function	function
pX	pointer to abscissa values

Definition at line 107 of file JFunctional.hh.

     {
       return function.evaluate(pX);
     }

◆ getValue() [2/2]

static JClass<result_type>::argument_type JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::getValue	(	typename JClass< result_type >::argument_type	value,
		const argument_type *	pX
	)

inlinestaticinherited

Termination of recursive function value evaluation.

Parameters

value	result
pX	pointer to abscissa values

Definition at line 121 of file JFunctional.hh.

     {
       return value;
     }

◆ getSupervisor()

JSupervisor JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 266 of file JFunctional.hh.

     {
       return supervisor;
     }

◆ getExceptionHandler()

const JExceptionHandler& JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::getExceptionHandler ( ) const

inlineinherited

Get exception handler.

Returns: exception handler

Definition at line 277 of file JFunctional.hh.

     {
       return *supervisor;
     }

◆ setExceptionHandler()

void JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::setExceptionHandler ( const JSupervisor & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 288 of file JFunctional.hh.

     {
       this->supervisor = supervisor;
     }

Friends And Related Function Documentation

◆ operator>>

JReader& operator>>	(	JReader &	in,
		JGeant &	geant
	)

friend

Read geant from input.

Parameters

in	reader
geant	geant

Returns: reader

Definition at line 148 of file JGeant.hh.

     {
       in >> geant.a0;
       in >> geant.a1;
       in >> static_cast<JGeantFunction1D_t&>(geant);
  
       geant.compile();
  
       return in;
     }

◆ operator<<

JWriter& operator<<	(	JWriter &	out,
		const JGeant &	geant
	)

friend

Write geant to output.

Parameters

out	writer
geant	geant

Returns: writer

Definition at line 167 of file JGeant.hh.

     {
       out << geant.a0;
       out << geant.a1;
       out << static_cast<const JGeantFunction1D_t&>(geant);
  
       return out;
     }

Member Data Documentation

◆ a0

double JPHYSICS::JGeant::a0

private

offset of the normalisation dependence

Definition at line 178 of file JGeant.hh.

◆ a1

double JPHYSICS::JGeant::a1

private

slope of the normalisation dependence

Definition at line 179 of file JGeant.hh.

◆ buffer

JGeantFunction1D_t JPHYSICS::JGeant::buffer

private

Definition at line 180 of file JGeant.hh.

◆ supervisor

JSupervisor JTOOLS::JFunctional< JElement2D< double, double > ::abscissa_type , double >::supervisor

protectedinherited

Definition at line 295 of file JFunctional.hh.

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

JGeant.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ collection_type

◆ abscissa_type

◆ ordinate_type

◆ value_type

◆ distance_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ function_type

◆ argument_type

◆ result_type

◆ exceptionhandler_type

◆ functional_type

◆ supervisor_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JGeant() [1/2]

◆ JGeant() [2/2]

Member Function Documentation

◆ compile()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ evaluate()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getSupervisor()

◆ getExceptionHandler()

◆ setExceptionHandler()

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ a0

◆ a1

◆ buffer

◆ supervisor