Regressor function object for JEnergy fit. More...

#include <JEnergyRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JEnergy >:

Public Types
typedef JTOOLS::JMAPLIST< JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint1FunctionalGridMap, JTOOLS::JPolint1FunctionalGridMap >::maplist	JNPEMaplist_t

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

typedef JAbstractMinimiser< JEnergy >	minimiser_type

typedef JRegressor< JEnergy, JAbstractMinimiser >	regressor_type

typedef minimiser_type::result_type	result_type

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

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

JNPE	getNPE (const JPMT &pmt, const double R_Hz) const
	Create data structure for handling light yields for PMT. More...

JNPE	getNPE (const JModule &module, const JK40Rates &rates_Hz) const
	Create data structure for handling light yields for module. More...

double	getRmax () const
	Get maximal road width of NPE. More...

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

result_type	operator() (const JEnergy &value, T1 __begin1, T1 __end1, T2 __begin2, T2 __end2)
	Global fit. More...

result_type	operator() (const JFunction_t &fit, T __begin, T __end)
	Get chi2. More...

Public Attributes
std::vector< JNPE_t >	Y1
	light from muon More...

std::vector< JNPE_t >	YB
	light from EM showers More...

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

JEnergy	value
	model value More...

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

static const int	NUMBER_OF_PDFS = 4

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

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

Static Protected Member Functions
static double	getRmax (const std::vector< JNPE_t > &NPE)
	Get maximal road width of PDF. More...

static double	getNPE (const std::vector< JNPE_t > &NPE, const double R, const double theta, const double phi)
	Get number of photo-electrons. More...

Detailed Description

template<>
struct JFIT::JRegressor< JEnergy >

Regressor function object for JEnergy fit.

Definition at line 49 of file JEnergyRegressor.hh.

Member Typedef Documentation

◆ JNPEMaplist_t

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint1FunctionalGridMap, JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressor< JEnergy >::JNPEMaplist_t

Definition at line 57 of file JEnergyRegressor.hh.

◆ JNPE_t

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

Definition at line 58 of file JEnergyRegressor.hh.

◆ minimiser_type

typedef JAbstractMinimiser <JEnergy > JFIT::JAbstractRegressor< JEnergy , JAbstractMinimiser >::minimiser_type

inherited

Definition at line 78 of file JRegressor.hh.

◆ regressor_type

typedef JRegressor<JEnergy , JAbstractMinimiser > JFIT::JAbstractRegressor< JEnergy , JAbstractMinimiser >::regressor_type

inherited

Definition at line 79 of file JRegressor.hh.

◆ result_type

typedef minimiser_type::result_type JFIT::JAbstractRegressor< JEnergy , JAbstractMinimiser >::result_type

inherited

Definition at line 80 of file JRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor()

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

inline

Constructor.

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

Parameters

fileDescriptor PDF file descriptor

Definition at line 69 of file JEnergyRegressor.hh.

                                                 :
       estimator(new JMEstimatorNormal())
     {
       using namespace std;
       using namespace JTOOLS;
       using namespace JPHYSICS;
  
       typedef JSplineFunction1D_t                                     JFunction1D_t;
       typedef JPDFTable<JFunction1D_t, JNPEMaplist_t>                 JPDF_t;
  
       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);
           
           if (!is_bremsstrahlung(pdf_t[i]))
             Y1.push_back(JNPE_t(pdf));
           else
             YB.push_back(JNPE_t(pdf));
         }
         catch(const JLANG::JException& error) {
           FATAL(error.what() << endl);
         }
       }
  
       // Add PDFs
  
       if (Y1.size() == 2) { Y1[1].add(Y1[0]); Y1.erase(Y1.begin()); }
       if (YB.size() == 2) { YB[1].add(YB[0]); YB.erase(YB.begin()); }
     }

Member Function Documentation

◆ operator()() [1/4]

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

inline

Fit function.

This method is used to determine chi2 of given number of photo-electrons for given energy of muon.

Parameters

x	energy
npe	npe

Returns: chi2

Definition at line 122 of file JEnergyRegressor.hh.

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

◆ getNPE() [1/3]

JNPE JFIT::JRegressor< JEnergy >::getNPE	(	const JPMT &	pmt,
		const double	R_Hz
	)		const

inline

Create data structure for handling light yields for PMT.

Note that the PMT geometry is relative to the muon trajectory, conform method JDETECTOR::JPMT::transform.

Parameters

pmt	PMT
R_Hz	singles rate [Hz]

Returns: light yields

Definition at line 140 of file JEnergyRegressor.hh.

     {
       using namespace JTOOLS;
  
       const double x  = pmt.getX();
       const double y  = pmt.getY();
       const double R  = sqrt(x*x + y*y);
       const double z  = pmt.getZ()  -  R / getTanThetaC();
  
       const double theta = pmt.getTheta();
       const double phi   = fabs(pmt.getPhi());
  
       const double yA = getNPE(Y1, R, theta, phi);
       const double yB = getNPE(YB, R, theta, phi);
  
       return JNPE(JK40(T_ns, R_Hz), yA, yB, z);
     }

◆ getNPE() [2/3]

JNPE JFIT::JRegressor< JEnergy >::getNPE	(	const JModule &	module,
		const JK40Rates &	rates_Hz
	)		const

inline

Create data structure for handling light yields for module.

Note that the module geometry is relative to the muon trajectory, conform method JDETECTOR::JModule::transform.

Parameters

module	module
rates_Hz	K40 singles and multiples rates [Hz]

Returns: light yields

Definition at line 169 of file JEnergyRegressor.hh.

     {
       using namespace JTOOLS;
  
       const double x  = module.getX();
       const double y  = module.getY();
       const double R  = sqrt(x*x + y*y);
       const double z  = module.getZ()  -  R / getTanThetaC();
  
       double yA = 0.0;
       double yB = 0.0;
  
       for (JModule::const_iterator pmt = module.begin(); pmt != module.end(); ++pmt) {
  
         const JNPE npe = this->getNPE(*pmt, rates_Hz.getSinglesRate());
  
         yA += npe.getYA();
         yB += npe.getYB();
       }
  
       return JNPE(JK40(T_ns, module.size(), rates_Hz), yA, yB, z);
     }

◆ getRmax() [1/2]

double JFIT::JRegressor< JEnergy >::getRmax ( ) const

inline

Get maximal road width of NPE.

Returns: road width [m]

Definition at line 199 of file JEnergyRegressor.hh.

     {
       return std::max(getRmax(Y1),
                       getRmax(YB));
     }

◆ getRmax() [2/2]

static double JFIT::JRegressor< JEnergy >::getRmax ( const std::vector< JNPE_t > & NPE )

inlinestaticprotected

Get maximal road width of PDF.

Parameters

NPE	NPE tables

Returns: road width [m]

Definition at line 226 of file JEnergyRegressor.hh.

     {
       double xmax = 0.0;
  
       for (std::vector<JNPE_t>::const_iterator i = NPE.begin(); i != NPE.end(); ++i) {
         if (!i->empty() && i->getXmax() > xmax) {
           xmax = i->getXmax();
         }
       }
  
       return xmax;
     }

◆ getNPE() [3/3]

static double JFIT::JRegressor< JEnergy >::getNPE	(	const std::vector< JNPE_t > &	NPE,
		const double	R,
		const double	theta,
		const double	phi
	)

inlinestaticprotected

Get number of photo-electrons.

Parameters

NPE	NPE tables
R	distance between muon and PMT [m]
theta	zenith angle orientation PMT [rad]
phi	azimuth angle orientation PMT [rad]

Returns: number of photo-electrons

Definition at line 249 of file JEnergyRegressor.hh.

     {
       using JTOOLS::get_value;
  
       double npe = 0.0;
  
       for (std::vector<JNPE_t>::const_iterator i = NPE.begin(); i != NPE.end(); ++i) {
  
         if (R <= i->getXmax()) {
  
           try {
  
             const double y = get_value((*i)(std::max(R, i->getXmin()), theta, phi));
  
             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 , JAbstractMinimiser >::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 92 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]

result_type JFIT::JAbstractRegressor< JEnergy , JAbstractMinimiser >::operator()	(	const JEnergy &	value,
		T1	__begin1,
		T1	__end1,
		T2	__begin2,
		T2	__end2
	)

inlineinherited

Global fit.

Parameters

value	start value
__begin1	begin of first data set
__end1	end of first data set
__begin2	begin of second data set
__end2	end of second data set

Returns: chi2

Definition at line 111 of file JRegressor.hh.

     {
       static_cast<minimiser_type&>(*this).value = value;
  
       return static_cast<minimiser_type&>(*this)(static_cast<regressor_type&>(*this), __begin1, __end1, __begin2, __end2);
     }

◆ operator()() [4/4]

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

inlineinherited

Get chi2.

Parameters

fit	fit function
__begin	begin of data
__end	end of data

Returns: chi2

Definition at line 46 of file JRegressor.hh.

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

Member Data Documentation

◆ Y1

std::vector<JNPE_t> JFIT::JRegressor< JEnergy >::Y1

light from muon

Definition at line 206 of file JEnergyRegressor.hh.

◆ YB

std::vector<JNPE_t> JFIT::JRegressor< JEnergy >::YB

light from EM showers

Definition at line 207 of file JEnergyRegressor.hh.

◆ T_ns

JTimeRange JFIT::JRegressor< JEnergy >::T_ns

static

Time window with respect to Cherenkov hypothesis [ns].

Time range.

Definition at line 209 of file JEnergyRegressor.hh.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressor< JEnergy >::NUMBER_OF_PDFS = 4

static

Definition at line 212 of file JEnergyRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressor< JEnergy >::pdf_t

static

Initial value:

= { DIRECT_LIGHT_FROM_MUON,
                                                    SCATTERED_LIGHT_FROM_MUON,
                                                    DIRECT_LIGHT_FROM_EMSHOWERS,
                                                    SCATTERED_LIGHT_FROM_EMSHOWERS }

PDF types.

Definition at line 214 of file JEnergyRegressor.hh.

◆ estimator

JLANG::JSinglePointer<JMEstimator> JFIT::JRegressor< JEnergy >::estimator

M-Estimator function.

Definition at line 216 of file JEnergyRegressor.hh.

◆ value

JEnergy JFIT::JAbstractMinimiser< JEnergy >::value

inherited

model value

Definition at line 57 of file JRegressor.hh.

◆ debug

int JEEP::JMessage< JAbstractMinimiser< JEnergy > >::debug

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:

JEnergyRegressor.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Detailed Description

template<> struct JFIT::JRegressor< JEnergy >

Member Typedef Documentation

◆ JNPEMaplist_t

◆ JNPE_t

◆ minimiser_type

◆ regressor_type

◆ result_type

Constructor & Destructor Documentation

◆ JRegressor()

Member Function Documentation

◆ operator()() [1/4]

◆ getNPE() [1/3]

◆ getNPE() [2/3]

◆ getRmax() [1/2]

◆ getRmax() [2/2]

◆ getNPE() [3/3]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

Member Data Documentation

◆ Y1

◆ YB

◆ T_ns

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ estimator

◆ value

◆ debug

template<>
struct JFIT::JRegressor< JEnergy >