Jpp
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
JPHYSICS::JCDFTable1D< JArgument_t, JResult_t > Class Template Referenceabstract

Custom class for CDF table in 1 dimension. More...

#include <JCDFTable1D.hh>

Inheritance diagram for JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >:
JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t > JTOOLS::JPolintFunction< N, JElement_t, JCollection_t, JResult_t, JDistance_t > JTOOLS::JFunction1D< JElement_t::abscissa_type, JResult_t > JTOOLS::JFunction< JElement_t::abscissa_type, JResult_t > JTOOLS::JFunctional< JElement_t::abscissa_type, 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 JMultiMapTransformer< 1, argument_type > transformer_type
 
typedef JCollection_t< JElement_t, JDistance_t > 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, JResult_t > function_type
 
typedef function_type::JExceptionHandler exceptionhandler_type
 
enum  
 
typedef JFunctional< JElement_t::abscissa_type, JResult_t > functional_type
 
typedef JSupervisor supervisor_type
 

Public Member Functions

 JCDFTable1D ()
 Default constructor. More...
 
template<class JCDF_t , class JCDFMaplist_t , class JCDFDistance_t >
 JCDFTable1D (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 R) const
 Get number of photo-electrons. 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...
 

Public Attributes

JLANG::JSharedPointer< transformer_type > transformer
 

Protected Attributes

JSupervisor supervisor
 

Detailed Description

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

Custom class for CDF table in 1 dimension.

This class provides an upper limit for the avegare number of photo-electrons as a function of the distance.

Definition at line 38 of file JCDFTable1D.hh.

Member Typedef Documentation

◆ argument_type

template<class JArgument_t , class JResult_t >
typedef JArgument_t JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::argument_type

Definition at line 43 of file JCDFTable1D.hh.

◆ result_type

template<class JArgument_t , class JResult_t >
typedef JResult_t JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::result_type

Definition at line 44 of file JCDFTable1D.hh.

◆ JElement2D_t

template<class JArgument_t , class JResult_t >
typedef JElement2D<argument_type, result_type> JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::JElement2D_t

Definition at line 46 of file JCDFTable1D.hh.

◆ JFunction1D_t

template<class JArgument_t , class JResult_t >
typedef JPolintFunction1D<1, JElement2D_t, JGridCollection> JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::JFunction1D_t

Definition at line 47 of file JCDFTable1D.hh.

◆ transformer_type

template<class JArgument_t , class JResult_t >
typedef JMultiMapTransformer<1, argument_type> JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::transformer_type

Definition at line 49 of file JCDFTable1D.hh.

◆ collection_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JCollection_t<JElement_t, JDistance_t> JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::collection_type
inherited

Definition at line 939 of file JPolint.hh.

◆ abscissa_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::abscissa_type JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::abscissa_type
inherited

Definition at line 941 of file JPolint.hh.

◆ ordinate_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::ordinate_type JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::ordinate_type
inherited

Definition at line 942 of file JPolint.hh.

◆ value_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::value_type JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::value_type
inherited

Definition at line 943 of file JPolint.hh.

◆ distance_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::distance_type JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::distance_type
inherited

Definition at line 944 of file JPolint.hh.

◆ const_iterator

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::const_iterator JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_iterator
inherited

Definition at line 946 of file JPolint.hh.

◆ const_reverse_iterator

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::const_reverse_iterator JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::const_reverse_iterator
inherited

Definition at line 947 of file JPolint.hh.

◆ iterator

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::iterator JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::iterator
inherited

Definition at line 948 of file JPolint.hh.

◆ reverse_iterator

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef collection_type::reverse_iterator JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::reverse_iterator
inherited

Definition at line 949 of file JPolint.hh.

◆ function_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef JFunction1D<abscissa_type, JResult_t> JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::function_type
inherited

Definition at line 951 of file JPolint.hh.

◆ exceptionhandler_type

template<unsigned int N, class JElement_t, template< class, class > class JCollection_t, class JResult_t = typename JElement_t::ordinate_type, class JDistance_t = JDistance<typename JElement_t::abscissa_type>>
typedef function_type::JExceptionHandler JTOOLS::JPolintFunction1D< N, JElement_t, JCollection_t, JResult_t, JDistance_t >::exceptionhandler_type
inherited

Definition at line 955 of file JPolint.hh.

◆ functional_type

typedef JFunctional<JElement_t::abscissa_type , JResult_t> JTOOLS::JFunction1D< JElement_t::abscissa_type , JResult_t >::functional_type
inherited

Definition at line 322 of file JFunctional.hh.

◆ supervisor_type

typedef JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::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

◆ JCDFTable1D() [1/2]

template<class JArgument_t , class JResult_t >
JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::JCDFTable1D ( )
inline

Default constructor.

Definition at line 55 of file JCDFTable1D.hh.

56  {}

◆ JCDFTable1D() [2/2]

template<class JArgument_t , class JResult_t >
template<class JCDF_t , class JCDFMaplist_t , class JCDFDistance_t >
JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::JCDFTable1D ( const JCDFTable< JCDF_t, JCDFMaplist_t, JCDFDistance_t > &  cdf,
const int  number_of_bins,
const double  safety_factor = 2.0 
)
inline

Constructor.

Parameters
cdfCDF (4D table)
number_of_binsnumber of bins (1D table)
safety_factorsafety factor

Definition at line 67 of file JCDFTable1D.hh.

70  {
71  using namespace JTOOLS;
72  using namespace JGEOMETRY3D;
73 
74  // extract the weight function
75 
76  try {
77 
78  typedef JPDFTransformer<3, argument_type> JPDFTransformer_t;
79 
80  const JPDFTransformer_t& object = dynamic_cast<const JPDFTransformer_t&>(*(cdf.transformer));
81 
82  transformer.reset(object.transformer.clone());
83  }
84  catch(const std::exception& error) {
85  transformer.reset(transformer_type::getClone());
86  }
87 
88 
89  // build the 1D table
90 
91  this->configure(make_grid(number_of_bins, cdf.intensity.begin()->getX(), cdf.intensity.rbegin()->getX()));
92 
93  const JOmega3D omega(JDirection3D(0,1,0), JAngleRange(0.0,PI/2), 0.07*PI);
94 
95  for (typename JFunction1D_t::iterator j = this->begin(); j != this->end(); ++j) {
96 
97  const double R = j->getX();
98  const double W = transformer->getWeight(R);
99 
100  double y = 0.0;
101 
102  for (JOmega3D::const_iterator dir = omega.begin(); dir != omega.end(); ++dir) {
103  y += cdf.getNPE(R, dir->getTheta(), fabs(dir->getPhi()));
104  }
105 
106  y /= omega.size();
107 
108  j->getY() = safety_factor * y / W;
109  }
110 
111  this->compile();
112  }

Member Function Documentation

◆ getNPE()

template<class JArgument_t , class JResult_t >
double JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::getNPE ( const double  R) const
inline

Get number of photo-electrons.

Parameters
Rdistance between muon and PMT [m]
Returns
number of photo-electrons

Definition at line 121 of file JCDFTable1D.hh.

122  {
123  const double buffer[] = { R };
124 
125  const double y = this->evaluate(buffer);
126  const double W = this->transformer->getWeight(R);
127 
128  return y * W;
129  }

◆ operator()()

result_type JTOOLS::JFunction1D< JElement_t::abscissa_type , JResult_t >::operator() ( const argument_type  x) const
inlineinherited

Function value evaluation.

Parameters
xargument value
Returns
function value

Definition at line 333 of file JFunctional.hh.

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

◆ evaluate()

virtual result_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::evaluate ( const argument_type *  pX) const
pure virtualinherited

Recursive function value evaluation.

Parameters
pXpointer to abscissa values
Returns
function value

◆ getValue() [1/2]

static result_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getValue ( const JFunctional< JElement_t::abscissa_type, JResult_t > &  function,
const argument_type *  pX 
)
inlinestaticinherited

Recursive function value evaluation.

Parameters
functionfunction
pXpointer to abscissa values

Definition at line 107 of file JFunctional.hh.

109  {
110  return function.evaluate(pX);
111  }

◆ getValue() [2/2]

static JClass<result_type>::argument_type JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getValue ( typename JClass< result_type >::argument_type  value,
const argument_type *  pX 
)
inlinestaticinherited

Termination of recursive function value evaluation.

Parameters
valueresult
pXpointer to abscissa values

Definition at line 121 of file JFunctional.hh.

123  {
124  return value;
125  }

◆ getSupervisor()

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getSupervisor ( ) const
inlineinherited

Get supervisor.

Returns
supervisor

Definition at line 266 of file JFunctional.hh.

267  {
268  return supervisor;
269  }

◆ getExceptionHandler()

const JExceptionHandler& JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::getExceptionHandler ( ) const
inlineinherited

Get exception handler.

Returns
exception handler

Definition at line 277 of file JFunctional.hh.

278  {
279  return *supervisor;
280  }

◆ setExceptionHandler()

void JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::setExceptionHandler ( const JSupervisor &  supervisor)
inlineinherited

Set the supervisor for handling of exceptions.

Parameters
supervisorsupervisor

Definition at line 288 of file JFunctional.hh.

289  {
290  this->supervisor = supervisor;
291  }

Member Data Documentation

◆ transformer

template<class JArgument_t , class JResult_t >
JLANG::JSharedPointer<transformer_type> JPHYSICS::JCDFTable1D< JArgument_t, JResult_t >::transformer

Definition at line 132 of file JCDFTable1D.hh.

◆ supervisor

JSupervisor JTOOLS::JFunctional< JElement_t::abscissa_type , JResult_t >::supervisor
protectedinherited

Definition at line 295 of file JFunctional.hh.

The documentation for this class was generated from the following file:
JTOOLS::JFunctional< JElement_t::abscissa_type, JResult_t >::supervisor
JSupervisor supervisor
Definition: JFunctional.hh:295
JTOOLS::pX
pX
Definition: JPolint.hh:625
JTOOLS::JAngleRange
JRange< double > JAngleRange
Type definition for angle range.
Definition: JAngleRange.hh:19
JPHYSICS::JCDFTable::getNPE
double getNPE(const argument_type x,...) const
Get number of photo-electrons.
Definition: JCDFTable.hh:156
JPHYSICS::JCDFTable::intensity
JMultiQuantile_t intensity
Definition: JCDFTable.hh:241
JPHYSICS::JCDFTable1D::transformer
JLANG::JSharedPointer< transformer_type > transformer
Definition: JCDFTable1D.hh:132
JTOOLS::JFunction1D< JElement_t::abscissa_type, JResult_t >::NUMBER_OF_DIMENSIONS
Definition: JFunctional.hh:320
JGEOMETRY3D::JDirection3D
Data structure for direction in three dimensions.
Definition: JDirection3D.hh:32
JTOOLS::j
int j
Definition: JPolint.hh:634
JTOOLS::JFunctional< JElement_t::abscissa_type, JResult_t >::evaluate
virtual result_type evaluate(const argument_type *pX) const=0
Recursive function value evaluation.
JTOOLS::JMultiMapTransformer::getClone
static JMultiMapTransformer * getClone()
Get clone of default transformer.
Definition: JMultiMapTransformer.hh:124
JPHYSICS::JPDFTransformer
Template definition of transformer of the Probability Density Functions of the time response of a PMT...
Definition: JPDFTransformer.hh:33
JTOOLS::make_grid
JGrid< JAbscissa_t > make_grid(const int nx, const JAbscissa_t Xmin, const JAbscissa_t Xmax)
Helper method for JGrid.
Definition: JGrid.hh:177
JTOOLS::PI
static const double PI
Constants.
Definition: JConstants.hh:20
JGEOMETRY3D
Auxiliary classes and methods for 3D geometrical objects and operations.
Definition: JAngle3D.hh:18
JPHYSICS::JCDFTable::transformer
JLANG::JSharedPointer< transformer_type > transformer
Definition: JCDFTable.hh:243
JTOOLS
Auxiliary classes and methods for multi-dimensional interpolations and histograms.
Definition: JAbstractCollection.hh:9
JGEOMETRY3D::JOmega3D
Direction set covering (part of) solid angle.
Definition: JOmega3D.hh:64
JTOOLS::configure
void configure(const T &value, const JAbstractCollection< JAbscissa_t > &bounds, JBool< false > option)
Configuration of value.
Definition: JToolsToolkit.hh:285
JTOOLS::JPolintFunction1D::iterator
collection_type::iterator iterator
Definition: JPolint.hh:948
Generated by   doxygen 1.8.16