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

#include <JShowerBjorkenYRegressor.hh>

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

Public Types
typedef JTOOLS::JSplineFunction1S_t	JFunction1D_t

typedef JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap > > > >	JPDFMaplist_t

typedef JPHYSICS::JPDFTable< JFunction1D_t, JPDFMaplist_t >	JPDF_t

typedef JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap > > > >	JNPEMaplist_t

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

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

typedef JPHYSICS::JPDFTable< JFunction1D_t, JMapList_t2 >	JPDF_t2

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

typedef JPHYSICS::JNPETable< double, double, JNPEMapList_t2 >	JNPE_t2

typedef JSimplex< JShowerEH >	minimiser_type

typedef JRegressor< JShowerEH, JSimplex >	regressor_type

typedef minimiser_type::result_type	result_type

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

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

double	getH0 (const double R_Hz) const
	Get background hypothesis value for time integrated PDF. More...

double	getH1 (const double D, const double ct, const double cosDelta, const double theta, const double phi, const double Eem, const double Eh, const double Y) const
	Get signal hypothesis value for time integrated PDF. More...

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

template<class JFunction_t , class T >
double	operator() (const JFunction_t &fit, T __begin, T __end)
	Multi-dimensional fit. More...

template<class JFunction_t , class T >
double	operator() (const JFunction_t &fit, T __begin, T __end, const JModel_t &step)
	1D fit. More...

Public Attributes
JNPE_t	npe [NUMBER_OF_PDFS-2]
	PDF. More...

JNPE_t2	npe2 [NUMBER_OF_PDFS-2]
	PDF. More...

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

JModel_t	value

std::vector< JModel_t >	step

int	numberOfIterations

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

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

static const int	NUMBER_OF_PDFS = 4

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types. More...

static int	MAXIMUM_ITERATIONS = 1000
	maximal number of iterations More...

static double	EPSILON = 1.0e-4
	maximal distance to minimum More...

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

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

Private Attributes
JModel_t	p0

JModel_t	p1

JModel_t	wall

Detailed Description

Regressor function object for JShowerEH fit using JSimplex minimiser.

Definition at line 53 of file JShowerBjorkenYRegressor.hh.

Member Typedef Documentation

◆ JFunction1D_t

typedef JTOOLS::JSplineFunction1S_t JFIT::JRegressor< JShowerEH, JSimplex >::JFunction1D_t

Definition at line 58 of file JShowerBjorkenYRegressor.hh.

◆ JPDFMaplist_t

typedef JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap> > > > JFIT::JRegressor< JShowerEH, JSimplex >::JPDFMaplist_t

Definition at line 62 of file JShowerBjorkenYRegressor.hh.

◆ JPDF_t

typedef JPHYSICS::JPDFTable<JFunction1D_t, JPDFMaplist_t> JFIT::JRegressor< JShowerEH, JSimplex >::JPDF_t

Definition at line 63 of file JShowerBjorkenYRegressor.hh.

◆ JNPEMaplist_t

typedef JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap> > > > JFIT::JRegressor< JShowerEH, JSimplex >::JNPEMaplist_t

Definition at line 68 of file JShowerBjorkenYRegressor.hh.

◆ JNPE_t

typedef JPHYSICS::JNPETable<double, double, JNPEMaplist_t> JFIT::JRegressor< JShowerEH, JSimplex >::JNPE_t

Definition at line 69 of file JShowerBjorkenYRegressor.hh.

◆ JMapList_t2

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressor< JShowerEH, JSimplex >::JMapList_t2

Definition at line 74 of file JShowerBjorkenYRegressor.hh.

◆ JPDF_t2

typedef JPHYSICS::JPDFTable<JFunction1D_t, JMapList_t2> JFIT::JRegressor< JShowerEH, JSimplex >::JPDF_t2

Definition at line 75 of file JShowerBjorkenYRegressor.hh.

◆ JNPEMapList_t2

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressor< JShowerEH, JSimplex >::JNPEMapList_t2

Definition at line 78 of file JShowerBjorkenYRegressor.hh.

◆ JNPE_t2

typedef JPHYSICS::JNPETable<double, double, JNPEMapList_t2> JFIT::JRegressor< JShowerEH, JSimplex >::JNPE_t2

Definition at line 79 of file JShowerBjorkenYRegressor.hh.

◆ minimiser_type

typedef JSimplex <JShowerEH > JFIT::JAbstractRegressor< JShowerEH , JSimplex >::minimiser_type

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

typedef JRegressor<JShowerEH , JSimplex > JFIT::JAbstractRegressor< JShowerEH , JSimplex >::regressor_type

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

typedef minimiser_type::result_type JFIT::JAbstractRegressor< JShowerEH , JSimplex >::result_type

inherited

Definition at line 82 of file JRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor()

JFIT::JRegressor< JShowerEH, 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<JShower3Z, JGandalf>::pdf_t.

Parameters

fileDescriptor PDF file descriptor

Definition at line 91 of file JShowerBjorkenYRegressor.hh.

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

Member Function Documentation

◆ operator()() [1/4]

double JFIT::JRegressor< JShowerEH, JSimplex >::operator()	(	const JShowerEH &	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 162 of file JShowerBjorkenYRegressor.hh.

     {
       using namespace JPP;
       using namespace std;
       
       JPosition3D D(pmt.getPosition());
       JDirection3D U(pmt.getDirection());
  
       D.sub(shower.getPosition());
  
       double ct = U.getDot(D) / D.getLength();
       
       JVersor3D shower_dir(shower.getDirection());
  
       const double z  = D.getDot(shower_dir);
       const double x  = D.getX()  -  z * shower.getDX();
       const double y  = D.getY()  -  z * shower.getDY();
       const double cosDelta = z/D.getLength();  // Delta = angle between shower direction and PMT position
  
       U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
  
       const double theta = U.getTheta();
       const double phi   = fabs(U.getPhi());
  
       double H0 = getH0(pmt.getR());  // background
       double H1 = getH1(D.getLength(), ct, cosDelta, theta, phi,
                         shower.getEem(), shower.getEh(), shower.getBy());  // signal
  
       if (H1 >= Vmax_npe) {
         H1 *= Vmax_npe / H1;
       }
       
       H1 += H0; // now H1 is signal + background
  
       const bool hit = pmt.getN() != 0;
       const double u = getChi2(H1, hit); // -log(lik)
       
       return estimator->getRho(u);
     }

◆ getH0()

double JFIT::JRegressor< JShowerEH, 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 208 of file JShowerBjorkenYRegressor.hh.

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

◆ getH1()

double JFIT::JRegressor< JShowerEH, JSimplex >::getH1	(	const double	D,
		const double	ct,
		const double	cosDelta,
		const double	theta,
		const double	phi,
		const double	Eem,
		const double	Eh,
		const double	Y
	)		const

inline

Get signal hypothesis value for time integrated PDF.

Parameters

D	PMT distance from shower [m]
ct	angle between shower direction and PMT position
cosDelta	angle between shower direction and PMT position
theta	PMT zenith angle [deg]
phi	PMT azimuth angle [deg]
Eem	EM shower energy [GeV]
Eh	H shower energy [GeV]
Y	Bjorken Y

Returns: hypothesis value

Definition at line 226 of file JShowerBjorkenYRegressor.hh.

     {
       
       double h1 = 0;
       
       for (int i = 0; i != (NUMBER_OF_PDFS-1); ++i) {
  
         if (!npe[i].empty() && D <= npe[i].getXmax() && !npe2[i].empty() && D <= npe2[i].getXmax()) {
  
           try {
  
             JNPE_t::result_type P_em;
             JNPE_t2::result_type P_h;
  
             P_em = fabs(Eem) * npe[i](std::max(D, npe[i].getXmin()), cosDelta, theta, phi);
   
             P_h = fabs(Eh) * npe2[i](std::max(D, npe2[i].getXmin()), ct);
  
             double y1 = get_value(P_em) + get_value(P_h);
             
             if(y1 > 0.0){
               h1 += y1;
             }
             
           }
           catch(JLANG::JException& error) {
             ERROR(error << std::endl);
           }
         }
       }
  
       return h1;
     }

◆ operator()() [2/4]

result_type JFIT::JAbstractRegressor< JShowerEH , JSimplex >::operator()	(	const JShowerEH &	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]

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::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]

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end,
		const JModel_t &	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()

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::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< JShowerEH, JSimplex >::T_ns

static

Time window with respect to Cherenkov hypothesis [ns].

Default values.

Definition at line 267 of file JShowerBjorkenYRegressor.hh.

◆ Vmax_npe

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

static

Maximal integral of PDF [npe].

Definition at line 268 of file JShowerBjorkenYRegressor.hh.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressor< JShowerEH, JSimplex >::NUMBER_OF_PDFS = 4

static

Definition at line 270 of file JShowerBjorkenYRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressor< JShowerEH, JSimplex >::pdf_t

static

Initial value:

= { DIRECT_LIGHT_FROM_EMSHOWER, 
                                                                   SCATTERED_LIGHT_FROM_EMSHOWER,
                                                                   DIRECT_LIGHT_FROM_BRIGHT_POINT,
                                                                   SCATTERED_LIGHT_FROM_BRIGHT_POINT }

PDF types.

Definition at line 272 of file JShowerBjorkenYRegressor.hh.

◆ npe

JNPE_t JFIT::JRegressor< JShowerEH, JSimplex >::npe[NUMBER_OF_PDFS-2]

PDF.

Definition at line 274 of file JShowerBjorkenYRegressor.hh.

◆ npe2

JNPE_t2 JFIT::JRegressor< JShowerEH, JSimplex >::npe2[NUMBER_OF_PDFS-2]

PDF.

Definition at line 275 of file JShowerBjorkenYRegressor.hh.

◆ estimator

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

M-Estimator function.

Definition at line 277 of file JShowerBjorkenYRegressor.hh.

◆ MAXIMUM_ITERATIONS

template<class JModel_t >

int JFIT::JSimplex< JModel_t >::MAXIMUM_ITERATIONS = 1000

staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 237 of file JSimplex.hh.

◆ EPSILON

template<class JModel_t >

double JFIT::JSimplex< JModel_t >::EPSILON = 1.0e-4

staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 238 of file JSimplex.hh.

◆ value

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::value

inherited

Definition at line 240 of file JSimplex.hh.

◆ step

template<class JModel_t >

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

inherited

Definition at line 241 of file JSimplex.hh.

◆ numberOfIterations

template<class JModel_t >

int JFIT::JSimplex< JModel_t >::numberOfIterations

inherited

Definition at line 242 of file JSimplex.hh.

◆ p0

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::p0

mutableprivateinherited

Definition at line 264 of file JSimplex.hh.

◆ p1

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::p1

mutableprivateinherited

Definition at line 265 of file JSimplex.hh.

◆ wall

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::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:

JShowerBjorkenYRegressor.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JFunction1D_t

◆ JPDFMaplist_t

◆ JPDF_t

◆ JNPEMaplist_t

◆ JNPE_t

◆ JMapList_t2

◆ JPDF_t2

◆ JNPEMapList_t2

◆ JNPE_t2

◆ minimiser_type

◆ regressor_type

◆ result_type

Constructor & Destructor Documentation

◆ JRegressor()

Member Function Documentation

◆ operator()() [1/4]

◆ getH0()

◆ getH1()

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ evaluate()

Member Data Documentation

◆ T_ns

◆ Vmax_npe

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ npe

◆ npe2

◆ estimator

◆ MAXIMUM_ITERATIONS

◆ EPSILON

◆ value

◆ step

◆ numberOfIterations

◆ p0

◆ p1

◆ wall

◆ debug