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

#include <JPDFTable.hh>

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

Public Types
enum	{ NUMBER_OF_DIMENSIONS = transformablemultifunction_type::NUMBER_OF_DIMENSIONS }

typedef JTransformableMultiFunction< JFunction1D_t, JMaplist_t, JDistance_t >	transformablemultifunction_type

typedef transformablemultifunction_type::argument_type	argument_type

typedef transformablemultifunction_type::result_type	result_type

typedef transformablemultifunction_type::value_type	value_type

typedef transformablemultifunction_type::multimap_type	multimap_type

typedef transformablemultifunction_type::transformer_type	transformer_type

typedef transformablemultifunction_type::super_const_iterator	super_const_iterator

typedef transformablemultifunction_type::super_iterator	super_iterator

typedef transformablemultifunction_type::function_type	function_type

enum	{ NUMBER_OF_DIMENSIONS = multifunction_type::NUMBER_OF_DIMENSIONS }

typedef JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >	multifunction_type

typedef multifunction_type::supervisor_type	supervisor_type

typedef multifunction_type::abscissa_type	abscissa_type

typedef multifunction_type::ordinate_type	ordinate_type

typedef multifunction_type::const_iterator	const_iterator

typedef multifunction_type::const_reverse_iterator	const_reverse_iterator

typedef multifunction_type::iterator	iterator

typedef multifunction_type::reverse_iterator	reverse_iterator

typedef transformer_type::array_type	array_type

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

Public Member Functions
	JPDFTable ()
	Default constructor.

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
	JPDFTable (const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input)
	Constructor.

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
	JPDFTable (const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Constructor.

void	blur (const double TTS, const int numberOfPoints=25, const double epsilon=1.0e-10, const double quantile=0.99)
	Blur PDF.

void	compress (const double Xmax, const JRange< typename function_type::abscissa_type > &range)
	Compresses PDF to given abscissa range.

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

virtual JWriter &	write (JWriter &out) const override
	Write from input.

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.

const JTransformableMultiFunction &	getTransformableMultiFunction () const
	Get transformable multidimensional function.

JTransformableMultiFunction &	getTransformableMultiFunction ()
	Get transformable multidimensional function.

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Insert multidimensional input.

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.

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

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >
void	insert (const JMultiKey< JMapLength< JMaplist_t >::value, argument_type > &key, const JMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > &input)
	Convert multidimensional histogram to PDF and insert result at given multidimensional key.

template<class JMultiFunction_t >
void	add (const JMultiFunction_t &input)
	Add function.

template<class ... Args>
result_type	operator() (const Args &...args) const
	Multidimensional interpolation method call.

virtual result_type	evaluate (const argument_type *pX) const override
	Recursive function value evaluation.

virtual void	transform (const transformer_type &transformer) override
	Application of weight function and coordinate transformation.

virtual void	transform (const transformer_type &transformer)=0
	Application of transformation.

const JMultiFunction &	getMultiFunction () const
	Get multidimensional function.

JMultiFunction &	getMultiFunction ()
	Get multidimensional function.

void	compile ()
	Compilation.

void	setExceptionHandler (const typename function_type::supervisor_type &supervisor)
	Set the supervisor for handling of exceptions.

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

void	store (const char *file_name) const
	Store to output file.

Public Attributes
std::shared_ptr< transformer_type >	transformer

Detailed Description

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

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

Definition at line 40 of file JPDFTable.hh.

Member Typedef Documentation

◆ transformablemultifunction_type

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

JTransformableMultiFunction<JFunction1D_t, JMaplist_t, JDistance_t> JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transformablemultifunction_type

Definition at line 47 of file JPDFTable.hh.

◆ argument_type

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

transformablemultifunction_type::argument_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::argument_type

Definition at line 49 of file JPDFTable.hh.

◆ result_type

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

transformablemultifunction_type::result_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::result_type

Definition at line 50 of file JPDFTable.hh.

◆ value_type

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

transformablemultifunction_type::value_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::value_type

Definition at line 51 of file JPDFTable.hh.

◆ multimap_type

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

transformablemultifunction_type::multimap_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::multimap_type

Definition at line 53 of file JPDFTable.hh.

◆ transformer_type

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

transformablemultifunction_type::transformer_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::transformer_type

Definition at line 54 of file JPDFTable.hh.

◆ super_const_iterator

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

transformablemultifunction_type::super_const_iterator JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::super_const_iterator

Definition at line 58 of file JPDFTable.hh.

◆ super_iterator

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

transformablemultifunction_type::super_iterator JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::super_iterator

Definition at line 59 of file JPDFTable.hh.

◆ function_type

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

transformablemultifunction_type::function_type JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::function_type

Definition at line 60 of file JPDFTable.hh.

◆ multifunction_type

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

JMultiFunction<JFunction_t, JMaplist_t, JDistance_t> JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::multifunction_type

inherited

Definition at line 48 of file JTransformableMultiFunction.hh.

◆ supervisor_type

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

multifunction_type::supervisor_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::supervisor_type

inherited

Definition at line 56 of file JTransformableMultiFunction.hh.

◆ abscissa_type

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

multifunction_type::abscissa_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::abscissa_type

inherited

Definition at line 58 of file JTransformableMultiFunction.hh.

◆ ordinate_type

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

multifunction_type::ordinate_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::ordinate_type

inherited

Definition at line 59 of file JTransformableMultiFunction.hh.

◆ const_iterator

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

multifunction_type::const_iterator JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_iterator

inherited

Definition at line 62 of file JTransformableMultiFunction.hh.

◆ const_reverse_iterator

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

multifunction_type::const_reverse_iterator JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::const_reverse_iterator

inherited

Definition at line 63 of file JTransformableMultiFunction.hh.

◆ iterator

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

multifunction_type::iterator JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::iterator

inherited

Definition at line 64 of file JTransformableMultiFunction.hh.

◆ reverse_iterator

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

multifunction_type::reverse_iterator JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::reverse_iterator

inherited

Definition at line 65 of file JTransformableMultiFunction.hh.

◆ array_type

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

transformer_type::array_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::array_type

inherited

Definition at line 71 of file JTransformableMultiFunction.hh.

Member Enumeration Documentation

◆ anonymous enum

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 56 of file JPDFTable.hh.

56{ NUMBER_OF_DIMENSIONS = transformablemultifunction_type::NUMBER_OF_DIMENSIONS };

JPHYSICS::JPDFTable::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JPDFTable.hh:56

JTOOLS::JTransformableMultiFunction::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JTransformableMultiFunction.hh:50

◆ 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 JTransformableMultiFunction.hh.

50{ NUMBER_OF_DIMENSIONS = multifunction_type::NUMBER_OF_DIMENSIONS };

JTOOLS::JMultiFunction::NUMBER_OF_DIMENSIONS

@ NUMBER_OF_DIMENSIONS

Definition JMultiFunction.hh:49

◆ 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 49 of file JMultiFunction.hh.

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

Constructor & Destructor Documentation

◆ JPDFTable() [1/3]

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

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

inline

Default constructor.

Definition at line 68 of file JPDFTable.hh.

                :
      transformablemultifunction_type()
    {}

◆ JPDFTable() [2/3]

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::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JPDFTable ( const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > & input )

inline

Constructor.

Parameters

input multi-dimensional function

Definition at line 79 of file JPDFTable.hh.

                                                                                                    :
      transformablemultifunction_type(input)
    {}

◆ JPDFTable() [3/3]

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::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::JPDFTable ( const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > & input )

inline

Constructor.

Parameters

input multi-dimensional histogram

Definition at line 90 of file JPDFTable.hh.

                                                                                                    :
      transformablemultifunction_type(input)
    {}

Member Function Documentation

◆ blur()

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

void JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::blur	(	const double	TTS,
		const int	numberOfPoints = 25,
		const double	epsilon = 1.0e-10,
		const double	quantile = 0.99 )

inline

Blur PDF.

The arrival times of Cherenkov light are smeared according to a Gaussian distribution with the specified width (i.e. TTS) using Gauss-Hermite integration. An exception is made when the time range according the specified quantile is smaller than the specified width (TTS) of the Gaussian distribution. In that case, the resulting PDF is a Gaussian distribution with the specified width (TTS) and normalisation according to the integral value of the input PDF. A smooth transition is imposed between the normal regime and this exeption.

Parameters

TTS	TTS [ns]
numberOfPoints	number of points for Gauss-Hermite integration
epsilon	precision
quantile	quantile

Definition at line 111 of file JPDFTable.hh.

    {
      using namespace std;
      using namespace JPP;
 
      typedef typename transformer_type::array_type  array_type;
 
      const JGaussHermite engine(numberOfPoints, epsilon);
 
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
        
        const array_type array = (*i).getKey();
        function_type&   f1    = (*i).getValue();
 
        if (!f1.empty()) {
 
          const typename function_type::supervisor_type supervisor = f1.getSupervisor();  // copy
 
          const JMultiMapGetTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> get(*(this->transformer), array);
          const JMultiMapPutTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> put(*(this->transformer), array);
 
          f1.transform(get);
          f1.compile();
 
          const JQuantiles Q(f1, quantile);
 
          // abscissa 
 
          JSet<double> X;
 
          for (JGaussHermite::const_iterator j = engine.begin(); j != engine.end(); ++j) {
            X.insert(Q.getX() + TTS*sqrt(2.0)*j->getX());
          }
 
          for (typename function_type::const_iterator j = f1.begin(); j != f1.end(); ++j) {
 
            if (j->getX() - TTS < X.getXmin()) {
              X.insert(j->getX() - TTS);
            }
            
            if (j->getX() + TTS > X.getXmax()) {
              X.insert(j->getX() + TTS);
            }
          }
 
 
          const double W = gauss(Q.getUpperLimit() - Q.getLowerLimit(), TTS);
 
          function_type buffer;
 
          for (JSet<double>::const_iterator x = X.begin(); x != X.end(); ++x) {
 
            double y = 0.0;
 
            for (JGaussHermite::const_iterator j = engine.begin(); j != engine.end(); ++j) {
 
              const double u = j->getX();
              const double v = j->getY() / sqrt(PI);
              const double w = get_value(f1(*x + u*TTS*sqrt(2.0)));
        
              y += v * w;
            }
 
            buffer[*x]  =  W * Q.getIntegral() * Gauss(*x - Q.getX(), TTS)  +  (1.0 - W) * y;
          }
 
          buffer.transform(put);
          buffer.compile();
 
          f1 = buffer;
 
          f1.setExceptionHandler(supervisor);
        }
      }
    }

◆ compress()

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

void JPHYSICS::JPDFTable< JFunction1D_t, JMaplist_t, JDistance_t >::compress	(	const double	Xmax,
		const JRange< typename function_type::abscissa_type > &	range )

inline

Compresses PDF to given abscissa range.

Parameters

Xmax	maximal value first abscissa
range	accepted range final abscissa

Definition at line 197 of file JPDFTable.hh.

    {
      static_cast<typename transformablemultifunction_type::container_type*>(this)->erase(this->lower_bound(Xmax), this->end());
      
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
 
        function_type& f1 = i.getValue();
        function_type  f2;
        
        typename function_type::iterator p = f1.lower_bound(range.getLowerLimit());
        typename function_type::iterator q = f1.lower_bound(range.getUpperLimit());
        
        for (++q; p != q; ++p) {
          f2.insert(*p);
        }
 
        f2.swap(f1);
      }
 
      this->compile();
    }

◆ read()

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

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

inlineoverridevirtual

Read from input.

Parameters

in reader

Returns: reader

Implements JIO::JSerialisable.

Definition at line 226 of file JPDFTable.hh.

    {
      if (in >> static_cast<transformablemultifunction_type&>(*this)) {
 
        // read optional transformer
 
        JPDFTransformer<NUMBER_OF_DIMENSIONS - 1, argument_type> buffer;
 
        if (buffer.read(in)) {
 
          this->transformer.reset(buffer.clone());
 
        } else {
 
          in.clear();
          
          this->transformer.reset(transformer_type::getClone());
        }
      }
      
      this->compile();
      
      return in;
    }

◆ write()

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

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

inlineoverridevirtual

Write from input.

Parameters

out writer

Returns: writer

Implements JIO::JSerialisable.

Definition at line 258 of file JPDFTable.hh.

    {
      out << static_cast<const transformablemultifunction_type&>(*this);
 
      this->transformer->write(out);
 
      return out;
    }

◆ insert() [1/7]

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 >

void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JTransformableMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input multidimensional function

Definition at line 126 of file JTransformableMultiFunction.hh.

    {
      this->transformer.reset(input.transformer->clone());
 
      multifunction_type::insert(input);
    }

◆ insert() [2/7]

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 >

void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JTransformableMultiHistogram< JHistogram_t, __JMaplist_t, __JDistance_t > & input )

inline

Insert multidimensional input.

Parameters

input multidimensional histogram

Definition at line 140 of file JTransformableMultiFunction.hh.

    {
      this->transformer.reset(input.transformer->clone());
 
      multifunction_type::insert(input);
    }

◆ getTransformableMultiFunction() [1/2]

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

const JTransformableMultiFunction & JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getTransformableMultiFunction ( ) const

inlineinherited

Get transformable multidimensional function.

Returns: this transformable multidimensional function

Definition at line 103 of file JTransformableMultiFunction.hh.

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

◆ getTransformableMultiFunction() [2/2]

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

JTransformableMultiFunction & JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::getTransformableMultiFunction ( )

inlineinherited

Get transformable multidimensional function.

Returns: this transformable multidimensional function

Definition at line 114 of file JTransformableMultiFunction.hh.

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

◆ insert() [3/7]

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

template<class __JFunction_t , class __JMaplist_t , class __JDistance_t >

void JTOOLS::JMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::insert ( const JMultiFunction< __JFunction_t, __JMaplist_t, __JDistance_t > & input )

inlineinherited

Insert multidimensional input.

Parameters

input multidimensional function

Definition at line 121 of file JMultiFunction.hh.

    {
      copy(input, *this);
    }

◆ insert() [4/7]

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

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >

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

inlineinherited

Insert multidimensional input.

Parameters

input multidimensional histogram

Definition at line 133 of file JMultiFunction.hh.

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

◆ insert() [5/7]

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 )

inlineinherited

Insert multidimensional histogram at multidimensional key.

Parameters

key	multidimensional key
input	multidimensional histogram

Definition at line 194 of file JMultiFunction.hh.

    {
      if (input.size() > 1) {
 
        for (auto 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() [6/7]

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

template<class __JElement_t , template< class, class > class __JContainer_t, class __JDistance_t >

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

inlineinherited

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

Parameters

key	multidimensional key
input	histogram

Definition at line 216 of file JMultiFunction.hh.

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

◆ insert() [7/7]

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

template<class JHistogram_t , class __JMaplist_t , class __JDistance_t >

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

inlineinherited

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

Parameters

key	multidimensional key
input	multidimensional histogram

Definition at line 235 of file JMultiFunction.hh.

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

◆ add()

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

template<class JMultiFunction_t >

void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::add ( const JMultiFunction_t & input )

inlineinherited

Add function.

Note that the summation is made via iteration of the elements in this multidimensional function.

Parameters

input multidimensional function

Definition at line 156 of file JTransformableMultiFunction.hh.

    {
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
        
        const array_type array = (*i).getKey();
        function_type&   f1    = (*i).getValue();
 
        if (!f1.empty()) {
 
          const JMultiMapGetTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> get(*(this->transformer), array);
          const JMultiMapPutTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> put(*(this->transformer), array);
 
          f1.transform(get);
 
          for (typename function_type::iterator j = f1.begin(); j != f1.end(); ++j) {
 
            const JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer(array, j->getX());
 
            j->getY() += get_value(input.evaluate(buffer.data()));
          }
 
          f1.transform(put);
          f1.compile();
        }
      }
    }

◆ operator()()

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

template<class ... Args>

result_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::operator() ( const Args &... args ) const

inlineinherited

Multidimensional interpolation method call.

Parameters

args	comma seperated list of abscissa values

Returns: function value

Definition at line 191 of file JTransformableMultiFunction.hh.

    {
      const JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer(args...);
 
      return this->evaluate(buffer.data());
    }

◆ evaluate()

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

virtual result_type JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::evaluate ( const argument_type * pX ) const

inlineoverridevirtualinherited

Recursive function value evaluation.

Parameters

pX	pointer to abscissa values

Returns: function value

Definition at line 205 of file JTransformableMultiFunction.hh.

    {
      JArray<NUMBER_OF_DIMENSIONS, argument_type> buffer;
 
      for (int i = 0; i != NUMBER_OF_DIMENSIONS; ++i) {
        buffer[i] = pX[i];
      }
 
      buffer[NUMBER_OF_DIMENSIONS - 1] = transformer->putXn(buffer, buffer[NUMBER_OF_DIMENSIONS - 1]);
 
      const result_type y = multifunction_type::evaluate(buffer.data());
      const double      W = transformer->getWeight(buffer);
 
      return JResultTransformer<result_type>::transform(*transformer, buffer, y) * W;      
    }

◆ transform() [1/2]

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

virtual void JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::transform ( const transformer_type & transformer )

inlineoverridevirtualinherited

Application of weight function and coordinate transformation.

Parameters

transformer function transformer

Definition at line 227 of file JTransformableMultiFunction.hh.

    {
      for (super_iterator i = this->super_begin(); i != this->super_end(); ++i) {
 
        const array_type  array    = (*i).getKey();
        function_type&    function = (*i).getValue();
 
        const JMultiMapGetTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> get(*(this->transformer), array);
        const JMultiMapPutTransformer<NUMBER_OF_DIMENSIONS - 1, value_type> put(        transformer,  array);
        
        function.transform(get);
        function.transform(put);
      }
 
      this->transformer.reset(transformer.clone());
      this->compile();
    }

◆ transform() [2/2]

virtual void JTOOLS::JTransformable< N, JFunction_t::argument_type >::transform ( const transformer_type & transformer )

pure virtualinherited

Application of transformation.

Parameters

transformer function transformer

◆ 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 98 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 109 of file JMultiFunction.hh.

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

◆ 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 142 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 typename function_type::supervisor_type & supervisor )

inlineinherited

Set the supervisor for handling of exceptions.

Parameters

supervisor supervisor

Definition at line 157 of file JMultiFunction.hh.

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

◆ load()

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));
    }

◆ store()

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));
    }

Member Data Documentation

◆ transformer

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

std::shared_ptr<transformer_type> JTOOLS::JTransformableMultiFunction< JFunction_t, JMaplist_t, JDistance_t >::transformer

inherited

Definition at line 276 of file JTransformableMultiFunction.hh.

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

JPDFTable.hh

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ transformablemultifunction_type

◆ argument_type

◆ result_type

◆ value_type

◆ multimap_type

◆ transformer_type

◆ super_const_iterator

◆ super_iterator

◆ function_type

◆ multifunction_type

◆ supervisor_type

◆ abscissa_type

◆ ordinate_type

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ array_type

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ JPDFTable() [1/3]

◆ JPDFTable() [2/3]

◆ JPDFTable() [3/3]

Member Function Documentation

◆ blur()

◆ compress()

◆ read()

◆ write()

◆ insert() [1/7]

◆ insert() [2/7]

◆ getTransformableMultiFunction() [1/2]

◆ getTransformableMultiFunction() [2/2]

◆ insert() [3/7]

◆ insert() [4/7]

◆ insert() [5/7]

◆ insert() [6/7]

◆ insert() [7/7]

◆ add()

◆ operator()()

◆ evaluate()

◆ transform() [1/2]

◆ transform() [2/2]

◆ getMultiFunction() [1/2]

◆ getMultiFunction() [2/2]

◆ compile()

◆ setExceptionHandler()

◆ load()

◆ store()

Member Data Documentation

◆ transformer