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

#include <JShower3EZRegressor.hh>

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

Public Types
typedef JRegressorStorage< JShower3EZ, JSimplex >	storage_type

typedef JSimplex< JShower3EZ >	minimiser_type

typedef JRegressor< JShower3EZ, JSimplex >	regressor_type

typedef minimiser_type::result_type	result_type

typedef JTOOLS::JPolint1Function1D_t	JFunction1D_t

typedef JTOOLS::JMAPLIST< JTOOLS::JPolint0FunctionalMap, JTOOLS::JPolint0FunctionalMap, JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JPolint0FunctionalGridMap >::maplist	JPDFMaplist_t

typedef JPHYSICS::JPDFTable< JFunction1D_t, JPDFMaplist_t >	JPDF_t

typedef JTOOLS::JMAPLIST< JTOOLS::JPolint0FunctionalMap, JTOOLS::JPolint0FunctionalMap, JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JPolint0FunctionalGridMap >::maplist	JNPEMaplist_t

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

typedef std::array< JNPE_t, NUMBER_OF_PDFS >	JNPEs_t
	NPEs.

Public Member Functions
	JRegressor ()
	Default constructor.

	JRegressor (const std::string &fileDescriptor, const JTimeRange &T_ns)
	Constructor.

	JRegressor (const storage_type &storage)
	Constructor.

double	operator() (const JShower3EZ &shower, const JPMTW0 &pmt) const
	Fit function.

JNPE_t::result_type	getH0 (const double R_Hz) const
	Get background hypothesis value for time integrated PDF.

JNPE_t::result_type	getH1 (const double D, const double cd, const double theta, const double phi, const double E) const
	Get signal hypothesis value for time integrated PDF.

result_type	operator() (const JShower3EZ &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 JShower3EZ &step)
	1D fit.

const JNPEs_t &	getNPE () const
	Get NPEs.

Public Attributes
const JNPEs_t &	npe

std::shared_ptr< JMEstimator >	estimator
	M-Estimator function.

JShower3EZ	value

std::vector< JShower3EZ >	step

int	numberOfIterations

JTimeRange	T_ns
	Time window with respect to Cherenkov hypothesis [ns].

Static Public Attributes
static double	Vmax_npe
	Maximal integral of PDF [npe].

static int	MAXIMUM_ITERATIONS
	maximal number of iterations

static double	EPSILON
	maximal distance to minimum

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

static const int	NUMBER_OF_PDFS = 2

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types.

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

Private Attributes
JShower3EZ	p0

JShower3EZ	p1

JShower3EZ	wall

JNPEs_t	_npe
	PDFs.

Detailed Description

Regressor function object for JShower3EZ fit using JGandalf minimiser.

Definition at line 197 of file JShower3EZRegressor.hh.

Member Typedef Documentation

◆ storage_type

JRegressorStorage<JShower3EZ, JSimplex> JFIT::JRegressor< JShower3EZ, JSimplex >::storage_type

Definition at line 203 of file JShower3EZRegressor.hh.

◆ minimiser_type

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

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

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

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

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

inherited

Definition at line 82 of file JRegressor.hh.

◆ JFunction1D_t

JTOOLS::JPolint1Function1D_t JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JFunction1D_t

inherited

Definition at line 99 of file JShower3EZRegressor.hh.

◆ JPDFMaplist_t

JTOOLS::JMAPLIST<JTOOLS::JPolint0FunctionalMap,JTOOLS::JPolint0FunctionalMap,JTOOLS::JPolint0FunctionalGridMap,JTOOLS::JPolint0FunctionalGridMap>::maplist JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JPDFMaplist_t

inherited

Definition at line 103 of file JShower3EZRegressor.hh.

◆ JPDF_t

JPHYSICS::JPDFTable<JFunction1D_t, JPDFMaplist_t> JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JPDF_t

inherited

Definition at line 104 of file JShower3EZRegressor.hh.

◆ JNPEMaplist_t

JTOOLS::JMAPLIST<JTOOLS::JPolint0FunctionalMap,JTOOLS::JPolint0FunctionalMap,JTOOLS::JPolint0FunctionalGridMap,JTOOLS::JPolint0FunctionalGridMap>::maplist JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JNPEMaplist_t

inherited

Definition at line 109 of file JShower3EZRegressor.hh.

◆ JNPE_t

JPHYSICS::JNPETable<double, double, JNPEMaplist_t> JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JNPE_t

inherited

Definition at line 110 of file JShower3EZRegressor.hh.

◆ JNPEs_t

std::array<JNPE_t, NUMBER_OF_PDFS> JFIT::JRegressorStorage< JShower3EZ, JSimplex >::JNPEs_t

inherited

NPEs.

Definition at line 115 of file JShower3EZRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

JFIT::JRegressor< JShower3EZ, JSimplex >::JRegressor ( )

inline

Default constructor.

Definition at line 208 of file JShower3EZRegressor.hh.

                 :
      storage_type(),
      npe(getNPE()),
      estimator() 
    {}

◆ JRegressor() [2/3]

JFIT::JRegressor< JShower3EZ, JSimplex >::JRegressor	(	const std::string &	fileDescriptor,
		const JTimeRange &	T_ns )

inline

Constructor.

The PDF file descriptor should contain the wild card character JEEP::FILENAME_WILDCARD which will be replaced by the PDF types listed in JRegressorStorage<JShower3EZ, JSimplex>::pdf_t.

Parameters

fileDescriptor	PDF file descriptor
T_ns	time range [ns]

Definition at line 223 of file JShower3EZRegressor.hh.

                                                                        :
      storage_type(fileDescriptor, T_ns),
      npe(getNPE()),
      estimator(new JMEstimatorNull())
    {}

◆ JRegressor() [3/3]

JFIT::JRegressor< JShower3EZ, JSimplex >::JRegressor ( const storage_type & storage )

inline

Constructor.

Parameters

storage PDF storage

Definition at line 234 of file JShower3EZRegressor.hh.

                                            :
      npe(storage.getNPE()),
      estimator(new JMEstimatorNull())
    {
      T_ns = storage.T_ns;
    }

Member Function Documentation

◆ operator()() [1/4]

double JFIT::JRegressor< JShower3EZ, JSimplex >::operator()	(	const JShower3EZ &	shower,
		const JPMTW0 &	pmt ) const

inline

Fit function.

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

Parameters

shower	shower
pmt	pmt

Returns: chi2

Definition at line 250 of file JShower3EZRegressor.hh.

    {
      using namespace JPP;
      
      JPosition3D  D(pmt.getPosition());
      JDirection3D U(pmt.getDirection());
 
      D.sub(shower.getPosition());
 
      const double z  = D.getDot(shower.getDirection());
      const double x  = D.getX();
      const double y  = D.getY();
      const double cd = z/D.getLength();                   // cosine angle between shower direction and PMT position
 
      U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
 
      const double theta = getPMTAngle(U.getTheta());
      const double phi   = getPMTAngle(U.getPhi());
 
      JNPE_t::result_type H0 = getH0(pmt.getR());                                    // background hypothesis value for time integrated PDF. 
      JNPE_t::result_type H1 = getH1(D.getLength(), cd, theta, phi, shower.getE());  // signal hypothesis value for time integrated PDF. 
 
      H1 *= pmt.getQE();
 
      if (get_value(H1) >= Vmax_npe) {
        H1 *= Vmax_npe / get_value(H1);
      }
 
      H1 += H0; // now H1 is signal + background
 
      const bool hit = pmt.getN() != 0;
      const double u = getChi2(get_value(H1), hit) - getChi2(get_value(H0), hit); // - log likelihood ratio
 
      return estimator->getRho(u);
    }

◆ getH0()

JNPE_t::result_type JFIT::JRegressor< JShower3EZ, JSimplex >::getH0 ( const double R_Hz ) const

inline

Get background hypothesis value for time integrated PDF.

Parameters

R_Hz rate [Hz]

Returns: hypothesis value

Definition at line 292 of file JShower3EZRegressor.hh.

    {
      return JNPE_t::result_type(R_Hz * 1e-9 * T_ns.getLength());
    }

◆ getH1()

JNPE_t::result_type JFIT::JRegressor< JShower3EZ, JSimplex >::getH1	(	const double	D,
		const double	cd,
		const double	theta,
		const double	phi,
		const double	E ) const

inline

Get signal hypothesis value for time integrated PDF.

Parameters

D	PMT distance from shower [m]
cd	cosine angle between shower direction and PMT position
theta	PMT zenith angle [deg]
phi	PMT azimuth angle [deg]
E	shower energy [GeV]

Returns: hypothesis value

Definition at line 307 of file JShower3EZRegressor.hh.

    {
      JNPE_t::result_type h1 = JMATH::zero;
        
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!npe[i].empty() && D <= npe[i].getXmax()) {
 
          try {
 
            JNPE_t::result_type y1 = E * npe[i](std::max(D, npe[i].getXmin()), cd, theta, phi);
 
            // safety measure
 
            if(y1 < 0){
              y1 = 0;  
            }
            
            h1 += y1;
          
          }
          catch(JLANG::JException& error) {
            ERROR(error << std::endl);
          }
        }
      }
 
      return h1;
    }

◆ operator()() [2/4]

result_type JFIT::JAbstractRegressor< JShower3EZ, JSimplex >::operator()	(	const JShower3EZ &	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< JShower3EZ >::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< JShower3EZ >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end,
		const JShower3EZ &	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< JShower3EZ >::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;
    }

◆ getNPE()

const JNPEs_t & JFIT::JRegressorStorage< JShower3EZ, JSimplex >::getNPE ( ) const

inlineinherited

Get NPEs.

Returns: PDFs

Definition at line 170 of file JShower3EZRegressor.hh.

    {
      return _npe;
    }

Member Data Documentation

◆ Vmax_npe

double JFIT::JRegressor< JShower3EZ, JSimplex >::Vmax_npe

static

Maximal integral of PDF [npe].

Definition at line 342 of file JShower3EZRegressor.hh.

◆ npe

const JNPEs_t& JFIT::JRegressor< JShower3EZ, JSimplex >::npe

Definition at line 344 of file JShower3EZRegressor.hh.

◆ estimator

std::shared_ptr<JMEstimator> JFIT::JRegressor< JShower3EZ, JSimplex >::estimator

M-Estimator function.

Definition at line 346 of file JShower3EZRegressor.hh.

◆ MAXIMUM_ITERATIONS

int JFIT::JSimplex< JShower3EZ >::MAXIMUM_ITERATIONS

staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 237 of file JSimplex.hh.

◆ EPSILON

double JFIT::JSimplex< JShower3EZ >::EPSILON

staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 238 of file JSimplex.hh.

◆ value

JShower3EZ JFIT::JSimplex< JShower3EZ >::value

inherited

Definition at line 240 of file JSimplex.hh.

◆ step

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

inherited

Definition at line 241 of file JSimplex.hh.

◆ numberOfIterations

int JFIT::JSimplex< JShower3EZ >::numberOfIterations

inherited

Definition at line 242 of file JSimplex.hh.

◆ p0

JShower3EZ JFIT::JSimplex< JShower3EZ >::p0

mutableprivateinherited

Definition at line 264 of file JSimplex.hh.

◆ p1

JShower3EZ JFIT::JSimplex< JShower3EZ >::p1

mutableprivateinherited

Definition at line 265 of file JSimplex.hh.

◆ wall

JShower3EZ JFIT::JSimplex< JShower3EZ >::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.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressorStorage< JShower3EZ, JSimplex >::NUMBER_OF_PDFS = 2

staticinherited

Definition at line 113 of file JShower3EZRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressorStorage< JShower3EZ, JSimplex >::pdf_t[NUMBER_OF_PDFS]

staticinherited

PDF types.

Definition at line 178 of file JShower3EZRegressor.hh.

◆ T_ns

JTimeRange JFIT::JRegressorStorage< JShower3EZ, JSimplex >::T_ns

inherited

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 179 of file JShower3EZRegressor.hh.

◆ _npe

JNPEs_t JFIT::JRegressorStorage< JShower3EZ, JSimplex >::_npe

privateinherited

PDFs.

Definition at line 182 of file JShower3EZRegressor.hh.

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

JShower3EZRegressor.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ storage_type

◆ minimiser_type

◆ regressor_type

◆ result_type

◆ JFunction1D_t

◆ JPDFMaplist_t

◆ JPDF_t

◆ JNPEMaplist_t

◆ JNPE_t

◆ JNPEs_t

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

◆ JRegressor() [2/3]

◆ JRegressor() [3/3]

Member Function Documentation

◆ operator()() [1/4]

◆ getH0()

◆ getH1()

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ evaluate()

◆ getNPE()

Member Data Documentation

◆ Vmax_npe

◆ npe

◆ estimator

◆ MAXIMUM_ITERATIONS

◆ EPSILON

◆ value

◆ step

◆ numberOfIterations

◆ p0

◆ p1

◆ wall

◆ debug

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ T_ns

◆ _npe