Custom class for CDF table in 2 dimensions. More...

#include <JCDFTable2D.hh>

Inheritance diagram for JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >:

Public Types
typedef JArgument_t	argument_type

typedef JResult_t	result_type

typedef JElement2D< argument_type, result_type >	JElement2D_t

typedef JPolintFunction1D< 1, JElement2D_t, JGridCollection >	JFunction1D_t

typedef JMapList< JPolint1FunctionalGridMap >	JMaplist_t

typedef JMultiFunction< JFunction1D_t, JMaplist_t >	JFunction2D_t

typedef JMultiMapTransformer< 2, argument_type >	transformer_type

enum	{ NUMBER_OF_DIMENSIONS = JMapLength<JMaplist_t>::value + JFunction_t::NUMBER_OF_DIMENSIONS }

typedef JMultiMap< typename JFunction_t::argument_type, JFunction_t, JMaplist_t, JDistance_t >	multimap_type

typedef JFunction_t	function_type

typedef JFunction_t::value_type	value_type

typedef JFunction_t::supervisor_type	supervisor_type

typedef multimap_type::abscissa_type	abscissa_type

typedef multimap_type::ordinate_type	ordinate_type

typedef multimap_type::const_iterator	const_iterator

typedef multimap_type::const_reverse_iterator	const_reverse_iterator

typedef multimap_type::iterator	iterator

typedef multimap_type::reverse_iterator	reverse_iterator

typedef multimap_type::super_iterator	super_iterator

typedef multimap_type::super_const_iterator	super_const_iterator

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

template<class JCDF_t , class JCDFMaplist_t , class JCDFDistance_t >
	JCDFTable2D (const JCDFTable< JCDF_t, JCDFMaplist_t, JCDFDistance_t > &cdf, const int number_of_bins, const double safety_factor=2.0)
	Constructor. More...

double	getNPE (const double D, const double cd) const
	Get number of photo-electrons. More...

const JMultiFunction &	getMultiFunction () const
	Get multidimensional function. More...

JMultiFunction &	getMultiFunction ()
	Get multidimensional function. More...

template<class JPDF_t , class JPDFMaplist_t , class JPDFDistance_t >
void	insert (const JMultiFunction< JPDF_t, JPDFMaplist_t, JPDFDistance_t > &input)
	Insert multidimensional input. More...

template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >
void	insert (const JMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > &input)
	Insert multidimensional input. More...

void	compile ()
	Compilation. More...

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

result_type	operator() (const argument_type x,...) const
	Multi-dimensional interpolation method call. More...

Public Attributes
JLANG::JSharedPointer< transformer_type >	transformer

Protected Member Functions
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 > &input)
	Insert multidimensional histogram at multidimensional key. More...

template<class __JValue_t >
void	insert (const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > &key, const __JValue_t &input)
	Convert one-dimensional histogram to PDF and insert result at given multidimensional key. More...

Protected Attributes
va_list	ap

JArray< NUMBER_OF_DIMENSIONS, argument_type >	buffer

Detailed Description

template<class JArgument_t, class JResult_t>
class JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >

Custom class for CDF table in 2 dimensions.

This class provides an upper limit for the average number of photo-electrons as a function of the distance and the cosine of the emission angle.

Definition at line 39 of file JCDFTable2D.hh.

Member Typedef Documentation

◆ argument_type

template<class JArgument_t , class JResult_t >

typedef JArgument_t JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::argument_type

Definition at line 45 of file JCDFTable2D.hh.

◆ result_type

template<class JArgument_t , class JResult_t >

typedef JResult_t JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::result_type

Definition at line 46 of file JCDFTable2D.hh.

◆ JElement2D_t

template<class JArgument_t , class JResult_t >

typedef JElement2D<argument_type, result_type> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JElement2D_t

Definition at line 48 of file JCDFTable2D.hh.

◆ JFunction1D_t

template<class JArgument_t , class JResult_t >

typedef JPolintFunction1D<1, JElement2D_t, JGridCollection> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JFunction1D_t

Definition at line 49 of file JCDFTable2D.hh.

◆ JMaplist_t

template<class JArgument_t , class JResult_t >

typedef JMapList<JPolint1FunctionalGridMap> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JMaplist_t

Definition at line 50 of file JCDFTable2D.hh.

◆ JFunction2D_t

template<class JArgument_t , class JResult_t >

typedef JMultiFunction<JFunction1D_t, JMaplist_t> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JFunction2D_t

Definition at line 51 of file JCDFTable2D.hh.

◆ transformer_type

template<class JArgument_t , class JResult_t >

typedef JMultiMapTransformer<2, argument_type> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::transformer_type

Definition at line 53 of file JCDFTable2D.hh.

◆ multimap_type

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

typedef JMultiMap<typename JFunction_t::argument_type, JFunction_t, JMaplist_t, JDistance_t> JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::multimap_type

inherited

Definition at line 48 of file JMultiFunction.hh.

◆ function_type

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

typedef JFunction_t JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::function_type

inherited

Definition at line 52 of file JMultiFunction.hh.

◆ value_type

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

typedef JFunction_t::value_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::value_type

inherited

Definition at line 54 of file JMultiFunction.hh.

◆ supervisor_type

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

typedef JFunction_t::supervisor_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::supervisor_type

inherited

Definition at line 56 of file JMultiFunction.hh.

◆ abscissa_type

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

typedef multimap_type::abscissa_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::abscissa_type

inherited

Definition at line 58 of file JMultiFunction.hh.

◆ ordinate_type

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

typedef multimap_type::ordinate_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::ordinate_type

inherited

Definition at line 59 of file JMultiFunction.hh.

◆ const_iterator

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

typedef multimap_type::const_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_iterator

inherited

Definition at line 62 of file JMultiFunction.hh.

◆ const_reverse_iterator

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

typedef multimap_type::const_reverse_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_reverse_iterator

inherited

Definition at line 63 of file JMultiFunction.hh.

◆ iterator

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

typedef multimap_type::iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::iterator

inherited

Definition at line 64 of file JMultiFunction.hh.

◆ reverse_iterator

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

typedef multimap_type::reverse_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::reverse_iterator

inherited

Definition at line 65 of file JMultiFunction.hh.

◆ super_iterator

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

typedef multimap_type::super_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::super_iterator

inherited

Definition at line 67 of file JMultiFunction.hh.

◆ super_const_iterator

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

typedef multimap_type::super_const_iterator JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::super_const_iterator

inherited

Definition at line 68 of file JMultiFunction.hh.

Member Enumeration Documentation

◆ anonymous enum

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

anonymous enum

inherited

Enumerator
NUMBER_OF_DIMENSIONS

Definition at line 50 of file JMultiFunction.hh.

50 { NUMBER_OF_DIMENSIONS = JMapLength<JMaplist_t>::value + JFunction_t::NUMBER_OF_DIMENSIONS };

Constructor & Destructor Documentation

◆ JCDFTable2D() [1/2]

template<class JArgument_t , class JResult_t >

JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JCDFTable2D ( )

inline

Default constructor.

Definition at line 59 of file JCDFTable2D.hh.

60 {}

◆ JCDFTable2D() [2/2]

template<class JArgument_t , class JResult_t >

template<class JCDF_t , class JCDFMaplist_t , class JCDFDistance_t >

JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::JCDFTable2D	(	const JCDFTable< JCDF_t, JCDFMaplist_t, JCDFDistance_t > &	cdf,
		const int	number_of_bins,
		const double	safety_factor = `2.0`
	)

inline

Constructor.

Parameters

cdf	CDF (5D table)
number_of_bins	number of bins (2D table)
safety_factor	safety factor

Definition at line 71 of file JCDFTable2D.hh.

                                                   :
       JFunction2D_t()
     { 
       using namespace JTOOLS;
       using namespace JGEOMETRY3D;
  
       // extract the weight function
  
       try {
  
         typedef JPDFTransformer<4, argument_type> JPDFTransformer_t;
  
         const JPDFTransformer_t& object = dynamic_cast<const JPDFTransformer_t&>(*(cdf.transformer));
  
         transformer.reset(object.transformer.clone());
       }
       catch(const std::exception& error) {
         transformer.reset(transformer_type::getClone());
       }
  
  
       // build the 2D table
  
       this->configure(make_grid(number_of_bins, cdf.intensity.begin()->getX(), cdf.intensity.rbegin()->getX()));
  
       const JOmega3D omega(JDirection3D(0,1,0), JAngleRange(0.0,PI/2), 0.07*PI);
  
       for (typename JFunction2D_t::iterator i = this->begin(); i != this->end(); ++i) {
  
         i->getY().configure(make_grid(number_of_bins, -1.0, +1.0));
  
         for (typename JFunction1D_t::iterator j = i->getY().begin(); j != i->getY().end(); ++j) {
  
           const double D  = i->getX(); 
           const double cd = j->getX();
           const double W  = transformer->getWeight(D, cd);
  
           double y = 0.0;
  
           for (JOmega3D::const_iterator dir = omega.begin(); dir != omega.end(); ++dir) {
             y += cdf.getNPE(D, cd, dir->getTheta(), fabs(dir->getPhi()));
           }
  
           y /= omega.size();
  
           j->getY() = safety_factor * y / W;
         }
       }
  
       this->compile();
     }

Member Function Documentation

◆ getNPE()

template<class JArgument_t , class JResult_t >

double JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::getNPE	(	const double	D,
		const double	cd
	)		const

inline

Get number of photo-electrons.

Parameters

D	distance between EM shower and PMT [m]
cd	cosine angle EM shower direction and EM shower - PMT position

Returns: number of photo-electrons

Definition at line 133 of file JCDFTable2D.hh.

     {
       const double buffer[] = { D, cd };
  
       const double y = this->evaluate(buffer);
       const double W = this->transformer->getWeight(D, cd);
  
       return y * W;
     }

◆ getMultiFunction() [1/2]

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

const JMultiFunction& JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getMultiFunction ( ) const

inlineinherited

Get multidimensional function.

Returns: this multidimensional function

Definition at line 99 of file JMultiFunction.hh.

     {
       return static_cast<const JMultiFunction&>(*this);
     }

◆ getMultiFunction() [2/2]

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

JMultiFunction& JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getMultiFunction ( )

inlineinherited

Get multidimensional function.

Returns: this multidimensional function

Definition at line 110 of file JMultiFunction.hh.

     {
       return static_cast<JMultiFunction&>(*this);
     }

◆ insert() [1/4]

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

template<class JPDF_t , class JPDFMaplist_t , class JPDFDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiFunction< JPDF_t, JPDFMaplist_t, JPDFDistance_t > & input )

inlineinherited

Insert multidimensional input.

Parameters

input multidimensional function

Definition at line 122 of file JMultiFunction.hh.

     {
       copy(input, *this);
     }

◆ insert() [2/4]

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

template<class JHistogram_t , class JHistogramMaplist_t , class JHistogramDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiHistogram< JHistogram_t, JHistogramMaplist_t, JHistogramDistance_t > & input )

inlineinherited

Insert multidimensional input.

Parameters

input multidimensional histogram

Definition at line 134 of file JMultiFunction.hh.

     {
       this->insert(JMultiKey<0, argument_type>(), input);
     }

◆ insert() [3/4]

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

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

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert	(	const JMultiKey< N, argument_type > &	key,
		const JHistogramMap< __JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t > &	input
	)

inlineprotectedinherited

Insert multidimensional histogram at multidimensional key.

Parameters

key	multidimensional key
input	multidimensional histogram

Definition at line 202 of file JMultiFunction.hh.

     {
       if (input.size() > 1) {
  
         for (typename JHistogramMap<__JAbscissa_t, __JContents_t, __JMap_t, __JDistance_t>::const_iterator j = input.begin(), i = j++; j != input.end(); ++i, ++j) {
           
           const argument_type x = 0.5 * (i->getX() + j->getX());
  
           insert(JMultiKey<N+1, argument_type>(key, x), i->getY());
         }
       }
     }

◆ insert() [4/4]

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

template<class __JValue_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert	(	const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > &	key,
		const __JValue_t &	input
	)

inlineprotectedinherited

Convert one-dimensional histogram to PDF and insert result at given multidimensional key.

Parameters

key	multidimensional key
input	histogram

Definition at line 224 of file JMultiFunction.hh.

     {
       JFunction_t buffer;
       
       makePDF(input, buffer);
       
       multimap_type::insert(key, buffer);
     }    

◆ compile()

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

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::compile ( )

inlineinherited

Compilation.

Definition at line 143 of file JMultiFunction.hh.

     {
       this->for_each(compiler);
  
       for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
         (*i).getValue().compile();
       }
     }

◆ setExceptionHandler()

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

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::setExceptionHandler ( const supervisor_type & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 158 of file JMultiFunction.hh.

     {
       this->for_each(supervisor);
  
       for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
         (*i).getValue().setExceptionHandler(supervisor);
       }
     }

◆ operator()()

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

result_type JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::operator()	(	const argument_type	x,
			...
	)		const

inlineinherited

Multi-dimensional interpolation method call.

Parameters

x	comma seperated list of abscissa values

Returns: function value

Definition at line 174 of file JMultiFunction.hh.

     {
       va_start(ap, x);
  
       buffer[0] = x;
  
       for (int i = 1; i != NUMBER_OF_DIMENSIONS; ++i) {
         buffer[i] = va_arg(ap, argument_type);
       }
  
       va_end(ap);
  
       return this->evaluate(buffer.data());
     }

Member Data Documentation

◆ transformer

template<class JArgument_t , class JResult_t >

JLANG::JSharedPointer<transformer_type> JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >::transformer

Definition at line 145 of file JCDFTable2D.hh.

◆ ap

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

va_list JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::ap

mutableprotectedinherited

Definition at line 235 of file JMultiFunction.hh.

◆ buffer

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

JArray<NUMBER_OF_DIMENSIONS, argument_type> JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::buffer

mutableprotectedinherited

Definition at line 236 of file JMultiFunction.hh.

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

JCDFTable2D.hh

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class JArgument_t, class JResult_t> class JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >

Member Typedef Documentation

◆ argument_type

◆ result_type

◆ JElement2D_t

◆ JFunction1D_t

◆ JMaplist_t

◆ JFunction2D_t

◆ transformer_type

◆ multimap_type

◆ function_type

◆ value_type

◆ supervisor_type

◆ abscissa_type

◆ ordinate_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ super_iterator

◆ super_const_iterator

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ JCDFTable2D() [1/2]

◆ JCDFTable2D() [2/2]

Member Function Documentation

◆ getNPE()

◆ getMultiFunction() [1/2]

◆ getMultiFunction() [2/2]

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ compile()

◆ setExceptionHandler()

◆ operator()()

Member Data Documentation

◆ transformer

◆ ap

◆ buffer

template<class JArgument_t, class JResult_t>
class JPHYSICS::JCDFTable2D< JArgument_t, JResult_t >