Multi-dimensional CDF table for arrival time of Cherenkov light. More...

#include <JCDFTable.hh>

Inheritance diagram for JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >:

Public Types
enum	{ NUMBER_OF_DIMENSIONS = transformablemultifunction_t::NUMBER_OF_DIMENSIONS }

typedef JFunction1D_t::argument_type	argument_type

typedef JFunction1D_t::result_type	result_type

typedef JFunction1D_t::value_type	value_type

typedef JTransformableMultiFunction < JFunction1D_t, JMaplist_t, JDistance_t >	transformablemultifunction_t

typedef transformablemultifunction_t::multimap_type	multimap_type

typedef transformablemultifunction_t::transformer_type	transformer_type

typedef JMultiKey < NUMBER_OF_DIMENSIONS-1, argument_type >	multikey_type

typedef JTOOLS::JConstantFunction1D < double, argument_type >	JConstantFunction1D_t

typedef JTOOLS::JMultiFunction < JConstantFunction1D_t, JMaplist_t, JDistance_t >	JMultiQuantile_t

typedef JTOOLS::JMultiFunction < JFunction1D_t, JMaplist_t, JDistance_t >	JMultiFunction_t

typedef JFunctional < argument_type, result_type >	functional_type

typedef JSupervisor	supervisor_type

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

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
	JCDFTable (const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input, const typename __JFunction_t::ordinate_type eps=JMATH::zero)
	Constructor. More...

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
	JCDFTable (const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input, const typename JHistogram_t::ordinate_type eps=JMATH::zero)
	Constructor. More...

template<class JFunctionTransformer_t >
void	transform (const JFunctionTransformer_t &transformer)
	Application of weight function. More...

template<class... Args>
double	getNPE (const Args &...args) const
	Get number of photo-electrons. More...

template<class... Args>
double	getTime (const Args &...args) const
	Generate arrival time. More...

virtual JReader &	read (JReader &in) override
	Read CDF from input. More...

virtual JWriter &	write (JWriter &out) const override
	Write CDF to output. More...

void	load (const char *file_name)
	Load from input file. More...

void	store (const char *file_name) const
	Store to output file. 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...

Public Attributes
JMultiQuantile_t	intensity

JMultiFunction_t	function

JLANG::JSharedPointer < transformer_type >	transformer

Protected Member Functions
virtual void	do_compile () override
	Function compilation. More...

template<class JValue_t >
void	insert (const multikey_type &key, const JValue_t &value, const typename JValue_t::ordinate_type eps)
	Insert value at given multidimensional key. More...

template<unsigned int N, class __JAbscissa_t , class __JContents_t , template< class, class, class > class __JMap_t, class __JDistance_t >
void	insert (const JMultiKey< N, argument_type > &key, const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > &value, const __JContents_t eps)
	Insert multi-dimensional histogram at multi-dimensional key. More...

Protected Attributes
JSupervisor	supervisor

Detailed Description

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>
class JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >

Multi-dimensional CDF table for arrival time of Cherenkov light.

This class can be used to determine the number of photo-electrons as a function of the values of the leading parameter values and to generate random photon arrival times.

N.B. The transformation of the PDF is assumed to be linear.

Definition at line 53 of file JCDFTable.hh.

Member Typedef Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JFunction1D_t::argument_type JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::argument_type

Definition at line 60 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JFunction1D_t::result_type JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::result_type

Definition at line 61 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JFunction1D_t::value_type JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::value_type

Definition at line 62 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JTransformableMultiFunction<JFunction1D_t, JMaplist_t, JDistance_t> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transformablemultifunction_t

Definition at line 64 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef transformablemultifunction_t::multimap_type JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::multimap_type

Definition at line 66 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef transformablemultifunction_t::transformer_type JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transformer_type

Definition at line 67 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JMultiKey<NUMBER_OF_DIMENSIONS - 1, argument_type> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::multikey_type

Definition at line 71 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JTOOLS::JConstantFunction1D<double, argument_type> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JConstantFunction1D_t

Definition at line 73 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JTOOLS::JMultiFunction<JConstantFunction1D_t, JMaplist_t, JDistance_t> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JMultiQuantile_t

Definition at line 74 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

typedef JTOOLS::JMultiFunction<JFunction1D_t, JMaplist_t, JDistance_t> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JMultiFunction_t

Definition at line 75 of file JCDFTable.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JFunctional<argument_type, result_type> JTOOLS::JFunctional< JArgument_t, JResult_t >::functional_type

inherited

Definition at line 88 of file JFunctional.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

typedef JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor_type

inherited

Definition at line 89 of file JFunctional.hh.

Member Enumeration Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

anonymous enum

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 69 of file JCDFTable.hh.

69 { NUMBER_OF_DIMENSIONS = transformablemultifunction_t::NUMBER_OF_DIMENSIONS };

JPHYSICS::JCDFTable::NUMBER_OF_DIMENSIONS

Definition: JCDFTable.hh:69

JTOOLS::JTransformableMultiFunction::NUMBER_OF_DIMENSIONS

Definition: JTransformableMultiFunction.hh:49

Constructor & Destructor Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JCDFTable ( )

inline

Default constructor.

Definition at line 81 of file JCDFTable.hh.

                 :
       transformer(transformer_type::getClone())
     {}

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >

JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JCDFTable	(	const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &	input,
		const typename __JFunction_t::ordinate_type	eps = `JMATH::zero`
	)

inline

Constructor.

Parameters

input	multi-dimensional PDF
eps	minimal step size for CDF

Definition at line 93 of file JCDFTable.hh.

                                                                                                             :
       transformer(transformer_type::getClone())
     {
       this->transformer.reset(input.transformer->clone());
 
       for (auto i = input.super_begin(); i != input.super_end(); ++i) {
         this->insert((*i).getKey(), (*i).getValue(), eps);
       }
 
       this->compile();
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >

JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JCDFTable	(	const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &	input,
		const typename JHistogram_t::ordinate_type	eps = `JMATH::zero`
	)

inline

Constructor.

Parameters

input	multi-dimensional histogram
eps	minimal step size for CDF

Definition at line 114 of file JCDFTable.hh.

                                                                                                             :
       transformer(transformer_type::getClone())
     {
       this->transformer.reset(input.transformer->clone());
       
       this->insert(JMultiKey<0, typename JHistogram_t::abscissa_type>(), input, eps);
       
       this->compile();
     }

Member Function Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class JFunctionTransformer_t >

void JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transform ( const JFunctionTransformer_t & transformer )

inline

Application of weight function.

Parameters

transformer function transformer

Definition at line 132 of file JCDFTable.hh.

     {
       for (typename JMultiQuantile_t::super_iterator i = intensity.super_begin(); i != intensity.super_end(); ++i) {
 
         const typename transformer_type::array_type array    = (*i).getKey();
         JConstantFunction1D_t&                      function = (*i).getValue();
 
         const double W1 = this->transformer->getWeight(array);
         const double W2 =       transformer .getWeight(array);
 
         const result_type y  = function(JMATH::zero);
 
         function = JConstantFunction1D_t(y * W1 / W2);
       }
 
       this->transformer.reset(transformer.clone());
       this->compile();
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class... Args>

double JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::getNPE ( const Args &... args ) const

inline

Get number of photo-electrons.

Parameters

args	comma separated argument list

Returns: number of photo-electrons

Definition at line 159 of file JCDFTable.hh.

     {
       const JArray<NUMBER_OF_DIMENSIONS - 1, argument_type> buffer(args...);
 
       const double W   = transformer->getWeight(buffer);
       const double npe = intensity.evaluate(buffer.data());
 
       return W * npe;
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class... Args>

double JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::getTime ( const Args &... args ) const

inline

Generate arrival time.

Parameters

args	comma seperated argument list (last value is random number between 0 and 1)

Returns: arrival time

Definition at line 177 of file JCDFTable.hh.

     {
       const JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer(args...);
 
       const argument_type y = function.evaluate(buffer.data());
 
       return transformer->getXn(buffer, y);
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

virtual JReader& JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::read ( JReader & in )

inlineoverridevirtual

Read CDF from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 193 of file JCDFTable.hh.

     {
       in >> intensity;
       in >> function;
 
       JPDFTransformer<NUMBER_OF_DIMENSIONS - 1, argument_type> buffer;
 
       if (buffer.read(in))
         transformer.reset(buffer.clone());
       else
         transformer.reset(transformer_type::getClone());
 
       compile();
 
       intensity.setExceptionHandler(new typename JMultiQuantile_t::function_type::JDefaultResult(JMATH::zero));
       function .setExceptionHandler(new typename JMultiFunction_t::function_type::JDefaultResult(JMATH::zero));
 
       return in;
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

virtual JWriter& JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::write ( JWriter & out ) const

inlineoverridevirtual

Write CDF to output.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 220 of file JCDFTable.hh.

     {
       out << intensity;
       out << function;
 
       return transformer->write(out);
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

virtual void JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::do_compile ( )

inlineoverrideprotectedvirtual

Function compilation.

Definition at line 238 of file JCDFTable.hh.

     {
       intensity.compile();
       function .compile();
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<class JValue_t >

void JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::insert	(	const multikey_type &	key,
		const JValue_t &	value,
		const typename JValue_t::ordinate_type	eps
	)

inlineprotected

Insert value at given multidimensional key.

Parameters

key	multi-dimensional key
value	function or histogram
eps	minimal step size for method JTOOLS::makeCDF

Definition at line 253 of file JCDFTable.hh.

     {
       using namespace JPP;
 
       try {
 
         const typename transformer_type::array_type array(key);
         
         JFunction1D_t buffer;
         
         const argument_type z = transformer->getXn(array, 1.0) - transformer->getXn(array, 0.0);
         const result_type   V = makeCDF(value, buffer, eps);
         
         intensity.insert(key, JConstantFunction1D_t(z*V));
         function .insert(key, buffer);
       } 
       catch(const JException& error) {
         intensity.insert(key, JMATH::zero);
       }
     }

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

template<unsigned int N, class __JAbscissa_t , class __JContents_t , template< class, class, class > class __JMap_t, class __JDistance_t >

void JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::insert	(	const JMultiKey< N, argument_type > &	key,
		const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > &	value,
		const __JContents_t	eps
	)

inlineprotected

Insert multi-dimensional histogram at multi-dimensional key.

Parameters

key	multidimensional key
value	multidimensional histogram
eps	minimal step size for CDF

Definition at line 289 of file JCDFTable.hh.

     {
       if (value.getSize() > 1) {
 
         for (auto j = value.begin(), i = j++; j != value.end(); ++i, ++j) {
           
           const __JAbscissa_t x = 0.5 * (i->first + j->first);
           
           insert(JMultiKey<N+1, __JAbscissa_t>(key, x), i->second, eps);
         } 
       }
     }

template<class T>

void JIO::JObjectBinaryIO< T >::load ( const char * file_name )

inlineinherited

Load from input file.

Parameters

file_name file name

Definition at line 29 of file JObjectBinaryIO.hh.

     {
       JLANG::load<JFileStreamReader>(file_name, static_cast<T&>(*this));
     }

template<class T>

void JIO::JObjectBinaryIO< T >::store ( const char * file_name ) const

inlineinherited

Store to output file.

Parameters

file_name file name

Definition at line 40 of file JObjectBinaryIO.hh.

     {
       JLANG::store<JFileStreamWriter>(file_name, static_cast<const T&>(*this));
     }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

virtual result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::evaluate ( const argument_type * pX ) const

pure virtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

Implemented in JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultType< JValue_t >::result_type, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JMap, JResultType< JValue_t >::result_type, JDistance_t >, JTOOLS::JSplineMap< JKey_t, JValue_t, JGridMap, JResultDerivative< JResultType< JValue_t >::result_type >, JDistance_t >, JTOOLS::JConstantFunction1D< JArgument_t, JResult_t >, JTOOLS::JFunctionObject1D< JArgument_t, JResult_t >, and JTOOLS::JExternalFunction1D< JArgument_t, JResult_t >.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

static result_type JTOOLS::JFunctional< JArgument_t, JResult_t >::getValue	(	const JFunctional< JArgument_t, JResult_t > &	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);
     }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

static JClass<result_type>::argument_type JTOOLS::JFunctional< JArgument_t, JResult_t >::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;
     }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::getSupervisor ( ) const

inlineinherited

Get supervisor.

Returns: supervisor

Definition at line 266 of file JFunctional.hh.

     {
       return supervisor;
     }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

const JExceptionHandler& JTOOLS::JFunctional< JArgument_t, JResult_t >::getExceptionHandler ( ) const

inlineinherited

Get exception handler.

Returns: exception handler

Definition at line 277 of file JFunctional.hh.

     {
       return *supervisor;
     }

template<class JArgument_t = JNullType, class JResult_t = JNullType>

void JTOOLS::JFunctional< JArgument_t, JResult_t >::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;
     }

Member Data Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

JMultiQuantile_t JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::intensity

Definition at line 229 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

JMultiFunction_t JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::function

Definition at line 230 of file JCDFTable.hh.

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>

JLANG::JSharedPointer<transformer_type> JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transformer

Definition at line 231 of file JCDFTable.hh.

template<class JArgument_t = JNullType, class JResult_t = JNullType>

JSupervisor JTOOLS::JFunctional< JArgument_t, JResult_t >::supervisor

protectedinherited

Definition at line 295 of file JFunctional.hh.

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

JCDFTable.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>> class JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class JFunction1D_t, class JMaplist_t, class JDistance_t = JTOOLS::JDistance<typename JFunction1D_t::argument_type>>
class JPHYSICS::JCDFTable< JFunction1D_t, JMaplist_t, JDistance_t >