Regressor function object for JShower3EZ fit using JSimplex minimiser. More...

#include <JShowerEnergyRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JEnergy, JSimplex >:

Public Types
typedef JTOOLS::JSplineFunction1S_t	JFunction1D_t

typedef JTOOLS::JMAPLIST< JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint1FunctionalGridMap >::maplist	JMapList_t

typedef JPHYSICS::JPDFTable< JFunction1D_t, JMapList_t >	JPDF_t

typedef JPHYSICS::JNPETable< double, double, JMapList_t >	JNPE_t

typedef JSimplex< JEnergy >	minimiser_type

typedef JRegressor< JEnergy, JSimplex >	regressor_type

typedef minimiser_type::result_type	result_type

Public Member Functions
	JRegressor (const std::string &fileDescriptor)
	Parameterized constructor.

double	operator() (const JEnergy &x, const JShowerNPEHit &npe) const
	Fit function.

JShowerNPE	getNPE (const JAxis3D &axis, const double R_Hz) const
	Create data structure for handling light yields for PMT.

result_type	operator() (const JEnergy &value, T __begin, T __end)
	Global fit.

double	operator() (const JFunction_t &fit, T __begin, T __end)
	Multi-dimensional fit.

double	operator() (const JFunction_t &fit, T __begin, T __end, const JEnergy &step)
	1D fit.

Static Public Member Functions
static double	getNPE (const std::vector< JNPE_t > &NPE, const double D, const double cd)
	Get number of photo-electrons.

Public Attributes
std::vector< JNPE_t >	Y
	light from EM showers

JLANG::JSharedPointer< JMEstimator >	estimator
	M-Estimator function.

JEnergy	value

std::vector< JEnergy >	step

int	numberOfIterations

Static Public Attributes
static JTimeRange	T_ns
	Time window with respect to Cherenkov hypothesis [ns].

static double	Vmax_npe = std::numeric_limits<double>::max()
	Maximal integral of PDF [npe].

static const int	NUMBER_OF_PDFS = 2

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]

static int	MAXIMUM_ITERATIONS
	maximal number of iterations

static double	EPSILON
	maximal distance to minimum

static int	debug = 0
	debug level (default is off).

Private Member Functions
double	evaluate (const JFunction_t &fit, T __begin, T __end) const
	Evaluate chi2 for given data set.

Private Attributes
JEnergy	p0

JEnergy	p1

JEnergy	wall

Detailed Description

Regressor function object for JShower3EZ fit using JSimplex minimiser.

Definition at line 51 of file JShowerEnergyRegressor.hh.

Member Typedef Documentation

◆ JFunction1D_t

JTOOLS::JSplineFunction1S_t JFIT::JRegressor< JEnergy, JSimplex >::JFunction1D_t

Definition at line 56 of file JShowerEnergyRegressor.hh.

◆ JMapList_t

JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMap,JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressor< JEnergy, JSimplex >::JMapList_t

Definition at line 58 of file JShowerEnergyRegressor.hh.

◆ JPDF_t

JPHYSICS::JPDFTable<JFunction1D_t, JMapList_t> JFIT::JRegressor< JEnergy, JSimplex >::JPDF_t

Definition at line 59 of file JShowerEnergyRegressor.hh.

◆ JNPE_t

JPHYSICS::JNPETable<double, double, JMapList_t> JFIT::JRegressor< JEnergy, JSimplex >::JNPE_t

Definition at line 61 of file JShowerEnergyRegressor.hh.

◆ minimiser_type

JSimplex<JEnergy> JFIT::JAbstractRegressor< JEnergy, JSimplex >::minimiser_type

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

JRegressor<JEnergy, JSimplex> JFIT::JAbstractRegressor< JEnergy, JSimplex >::regressor_type

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

minimiser_type::result_type JFIT::JAbstractRegressor< JEnergy, JSimplex >::result_type

inherited

Definition at line 82 of file JRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor()

JFIT::JRegressor< JEnergy, JSimplex >::JRegressor ( const std::string & fileDescriptor )

inline

Parameterized constructor.

The PDF file descriptor should contain the wild card character JPHYSICS::WILDCARD which will be replaced by the corresponding PDF types listed in JRegressor<JEnergy, JSimplex>::pdf_t.

Parameters

fileDescriptor PDF file descriptor

Definition at line 72 of file JShowerEnergyRegressor.hh.

                                               :
      estimator(new JMEstimatorNull())
    {
      using namespace std;
      using namespace JPP;
      
      
      const JPDF_t::JSupervisor supervisor(new JPDF_t::JDefaultResult(JMATH::zero));
      
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
        
        try {
 
          JPDF_t pdf;
 
          const string file_name = getFilename(fileDescriptor, pdf_t[i]);
          
          NOTICE("loading PDF from file " << file_name << "... " << flush);
 
          pdf.load(file_name.c_str());
 
          NOTICE("OK" << endl);
 
          pdf.setExceptionHandler(supervisor);
                  
          Y.push_back(JNPE_t(pdf));
        }
        catch(const JException& error) {
          FATAL(error.what() << endl);
        }
      }
 
      // Add PDFs
 
      for (int i = 1; i < NUMBER_OF_PDFS; i += 2) {
        Y[i].add(Y[i-1]);
      }    
 
      Y.erase(Y.begin());
    }

Member Function Documentation

◆ operator()() [1/4]

double JFIT::JRegressor< JEnergy, JSimplex >::operator()	(	const JEnergy &	x,
		const JShowerNPEHit &	npe ) const

inline

Fit function.

This method is used to determine the chi2 of given PMT with respect to shower hypothesis.

Parameters

x	energy
npe	number of photoelectrons

Returns: chi2

Definition at line 121 of file JShowerEnergyRegressor.hh.

    {      
      using namespace JPP;
 
      const double E = x.getE();
      const double u = npe.getChi2(E);
 
      return estimator->getRho(u);
    }

◆ getNPE() [1/2]

JShowerNPE JFIT::JRegressor< JEnergy, JSimplex >::getNPE	(	const JAxis3D &	axis,
		const double	R_Hz ) const

inline

Create data structure for handling light yields for PMT.

Parameters

axis	PMT axis
R_Hz	singles rate [Hz]

Returns: light yields

Definition at line 138 of file JShowerEnergyRegressor.hh.

    {
      using namespace JPP;
 
      const JPosition3D  D(axis.getPosition());
      const JDirection3D U(axis.getDirection());      
 
      const double U_length = std::sqrt(U.getDX()*U.getDX() + 
                                        U.getDY()*U.getDY() + 
                                        U.getDZ()*U.getDZ());
 
      const double ct = U.getDot(D) / (D.getLength()*U_length);
      
      const double y = getNPE(Y, D.getLength(), ct);
 
      return JShowerNPE(getN(T_ns, R_Hz * 1.0e-9), y);      
    }

◆ getNPE() [2/2]

static double JFIT::JRegressor< JEnergy, JSimplex >::getNPE	(	const std::vector< JNPE_t > &	NPE,
		const double	D,
		const double	cd )

inlinestatic

Get number of photo-electrons.

Parameters

NPE	NPE tables
D	PMT distance from shower [m]
cd	cosine of the PMT angle wrt the photon direction

Returns: number of photo-electrons

Definition at line 166 of file JShowerEnergyRegressor.hh.

     {
       double npe = 0.0;
       
       for (std::vector<JNPE_t>::const_iterator i = NPE.begin(); i != NPE.end(); ++i) {
         
         if (D <= i->getXmax()) {
           
           try {
             
             const double y = get_value((*i)(std::max(D, i->getXmin()), cd));
             
             if (y > 0.0) {
               npe += y;
             }
           }
           catch(const JLANG::JException& error) {
             ERROR(error << std::endl);
           }
         }
       }
       
       return npe;
     }    

◆ operator()() [2/4]

result_type JFIT::JAbstractRegressor< JEnergy, JSimplex >::operator()	(	const JEnergy &	value,
		T	__begin,
		T	__end )

inlineinherited

Global fit.

Parameters

value	start value
__begin	begin of data set
__end	end of data set

Returns: chi2

Definition at line 94 of file JRegressor.hh.

    {
      static_cast<minimiser_type&>(*this).value = value;
 
      return static_cast<minimiser_type&>(*this)(static_cast<regressor_type&>(*this), __begin, __end);
    }

◆ operator()() [3/4]

double JFIT::JSimplex< JEnergy >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end )

inlineinherited

Multi-dimensional fit.

The given fit function should return the equivalent of chi2 for the current value of the given model and a given data point.

Parameters

fit	fit function
__begin	begin of data
__end	end of data

Returns: chi2

Definition at line 71 of file JSimplex.hh.

    {
      using namespace std;
      using namespace JPP;
 
      double chi2_old = evaluate(fit, __begin, __end);
 
      const int N = step.size();
 
      if (N != 0) {
 
        p0   = value;
        p1   = value;
        wall = value;
 
        double chi2[N];
 
        numberOfIterations = 0;
 
        while (numberOfIterations != MAXIMUM_ITERATIONS) {
 
          DEBUG("old: " << FIXED(12,5) << chi2_old << endl);
 
          p0 = value;
 
          for (int i = 0; i != N; ++i) {
 
            DEBUG("step: " << i << ' ' << setw(5) << numberOfIterations << endl);
 
            chi2[i] = (*this)(fit, __begin, __end, step[i]);
          }
 
          // overall step direction of last iteration
 
          wall  = value;
          wall -= p0;
 
          const double chi2_new = (*this)(fit, __begin, __end, wall);
 
          DEBUG("new: " << FIXED(12,5) << chi2_new << endl);
 
 
          if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
            return chi2_new;
          }
 
          // double overall step
 
          wall   = value;
          wall  -= p0;
          value += wall;
 
          const double fe = evaluate(fit, __begin, __end);
 
          value -= wall;
 
 
          for (int i = N-1; i != 0; --i) {
            chi2[i] = chi2[i-1] - chi2[i];
          }
 
          chi2[0] = chi2_old - chi2[0];
 
 
          double df = 0.0;
 
          for (int i = 0; i != N; ++i) {
            if (chi2[i] > df) {
              df = chi2[i];
            }
          }
 
          const double fn = chi2_new;
          const double f0 = chi2_old;
          const double ff = f0 - fn - df;
 
          // shift step directions
 
          if (fe < f0 && 2.0*(f0 - 2.0*fn + fe)*ff*ff < (f0-fe)*(f0-fe)*df) {
 
            for (int i = 0; i != N - 1; ++i) {
              step[i] = step[i+1];
            }
 
            step[N-1] = wall;
          }
 
          chi2_old = chi2_new;
        }
      }
 
      return chi2_old;
    }

◆ operator()() [4/4]

double JFIT::JSimplex< JEnergy >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end,
		const JEnergy &	step )

inlineinherited

1D fit.

The given fit function should return the equivalent of chi2 for the current value of the given model and a given data point.

Parameters

fit	fit function
__begin	begin of data
__end	end of data
step	step direction

Definition at line 178 of file JSimplex.hh.

    {
      using namespace std;
      using namespace JPP;
 
      double lambda = 0.5;                                     // control parameter
      double factor = 1.0;                                     // multiplication factor
 
      double chi2_old = evaluate(fit, __begin, __end);
 
      for (int i = 0; numberOfIterations != MAXIMUM_ITERATIONS; ++numberOfIterations, ++i) {
 
        p1      = step;
        p1     *= lambda;
        value  += p1;
 
        const double chi2_new = evaluate(fit, __begin, __end);
 
        DEBUG("step: " << setw(3) << i << ' ' << FIXED(12,5) << chi2_old << ' ' << FIXED(12,5) << chi2_new << ' ' << FIXED(5,2) << lambda << endl);
 
        if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
 
          if (chi2_new > chi2_old) {
 
            p1      = step;
            p1     *= lambda;
            value  -= p1;                                      // undo last step
 
            return chi2_old;
 
          } else {
 
            return chi2_new;
          }
        }
 
        if (chi2_new < chi2_old) {
 
          chi2_old = chi2_new;
 
        } else {
            
          p1      = step;
          p1     *= lambda;
          value  -=  p1;                                       // step back
          lambda  = -lambda;                                   // change direction
          
          if (i != 0) {
            factor = 0.5;                                      // reduce step size
          }
        }
        
        lambda = factor * lambda;
      }
 
      return chi2_old;
    }

◆ evaluate()

double JFIT::JSimplex< JEnergy >::evaluate	(	const JFunction_t &	fit,
		T	__begin,
		T	__end ) const

inlineprivateinherited

Evaluate chi2 for given data set.

Parameters

fit	fit function
__begin	begin of data
__end	end of data

Definition at line 253 of file JSimplex.hh.

    {
      double chi2 = 0.0;
 
      for (T hit = __begin; hit != __end; ++hit) {
        chi2 += fit(value, *hit);
      }
 
      return chi2;
    }

Member Data Documentation

◆ T_ns

JTimeRange JFIT::JRegressor< JEnergy, JSimplex >::T_ns

static

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 194 of file JShowerEnergyRegressor.hh.

◆ Vmax_npe

double JFIT::JRegressor< JEnergy, JSimplex >::Vmax_npe = std::numeric_limits<double>::max()

static

Maximal integral of PDF [npe].

Definition at line 195 of file JShowerEnergyRegressor.hh.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressor< JEnergy, JSimplex >::NUMBER_OF_PDFS = 2

static

Definition at line 197 of file JShowerEnergyRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressor< JEnergy, JSimplex >::pdf_t[NUMBER_OF_PDFS]

static

Definition at line 199 of file JShowerEnergyRegressor.hh.

◆ Y

std::vector<JNPE_t> JFIT::JRegressor< JEnergy, JSimplex >::Y

light from EM showers

Definition at line 201 of file JShowerEnergyRegressor.hh.

◆ estimator

JLANG::JSharedPointer<JMEstimator> JFIT::JRegressor< JEnergy, JSimplex >::estimator

M-Estimator function.

Definition at line 203 of file JShowerEnergyRegressor.hh.

◆ MAXIMUM_ITERATIONS

int JFIT::JSimplex< JEnergy >::MAXIMUM_ITERATIONS

staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 237 of file JSimplex.hh.

◆ EPSILON

double JFIT::JSimplex< JEnergy >::EPSILON

staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 238 of file JSimplex.hh.

◆ value

JEnergy JFIT::JSimplex< JEnergy >::value

inherited

Definition at line 240 of file JSimplex.hh.

◆ step

std::vector<JEnergy> JFIT::JSimplex< JEnergy >::step

inherited

Definition at line 241 of file JSimplex.hh.

◆ numberOfIterations

int JFIT::JSimplex< JEnergy >::numberOfIterations

inherited

Definition at line 242 of file JSimplex.hh.

◆ p0

JEnergy JFIT::JSimplex< JEnergy >::p0

mutableprivateinherited

Definition at line 264 of file JSimplex.hh.

◆ p1

JEnergy JFIT::JSimplex< JEnergy >::p1

mutableprivateinherited

Definition at line 265 of file JSimplex.hh.

◆ wall

JEnergy JFIT::JSimplex< JEnergy >::wall

mutableprivateinherited

Definition at line 266 of file JSimplex.hh.

◆ debug

template<class T >

int JEEP::JMessage< T >::debug = 0

staticinherited

debug level (default is off).

Definition at line 45 of file JMessage.hh.

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

JShowerEnergyRegressor.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JFunction1D_t

◆ JMapList_t

◆ JPDF_t

◆ JNPE_t

◆ minimiser_type

◆ regressor_type

◆ result_type

Constructor & Destructor Documentation

◆ JRegressor()

Member Function Documentation

◆ operator()() [1/4]

◆ getNPE() [1/2]

◆ getNPE() [2/2]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ evaluate()

Member Data Documentation

◆ T_ns

◆ Vmax_npe

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ Y

◆ estimator

◆ MAXIMUM_ITERATIONS

◆ EPSILON

◆ value

◆ step

◆ numberOfIterations

◆ p0

◆ p1

◆ wall

◆ debug