JFIT::JRegressor< JEnergy > Struct Template Reference

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 JAxis3D &axis, const double R_Hz) const
	Create data structure for handling light yields for PMT. More...
template<class T >
JNPE	getNPE (T __begin, T __end, const JK40Rates &rates_Hz) const
	Create data structure for handling light yields for set of PMTs. 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 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 >	YA
	light from delta-rays 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 = 6
static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types. More...
static int	debug = 0
	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

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

Definition at line 57 of file JEnergyRegressor.hh.

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

Definition at line 58 of file JEnergyRegressor.hh.

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

inherited

Definition at line 78 of file JRegressor.hh.

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

inherited

Definition at line 79 of file JRegressor.hh.

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

inherited

Definition at line 80 of file JRegressor.hh.

Constructor & Destructor Documentation

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 JPP;

      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 JPDFType_t type      = pdf_t[i];
          const string     file_name = getFilename(fileDescriptor, type);
          
          NOTICE("loading PDF from file " << file_name << "... " << flush);
          
          pdf.load(file_name.c_str());
          
          NOTICE("OK" << endl);

          pdf.setExceptionHandler(supervisor);
          
          if      (is_bremsstrahlung(type))
            YB.push_back(JNPE_t(pdf));
          else if (is_deltarays(type))
            YA.push_back(JNPE_t(pdf));
          else
            Y1.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 (YA.size() == 2) { YA[1].add(YA[0]); YA.erase(YA.begin()); }
      if (YB.size() == 2) { YB[1].add(YB[0]); YB.erase(YB.begin()); }
    }

Member Function Documentation

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 125 of file JEnergyRegressor.hh.

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

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

inline

Create data structure for handling light yields for PMT.

Note that the PMT geometry should be relative to the muon trajectory, conform method JGEOMETRY3D::JAxis3D::transform.

Parameters

axis	PMT axis
R_Hz	singles rate [Hz]

Returns

light yields

Definition at line 143 of file JEnergyRegressor.hh.

    {
      using namespace std;
      using namespace JPP;

      const double x  = axis.getX();
      const double y  = axis.getY();
      const double R  = sqrt(x*x + y*y);
      const double z  = axis.getZ()  -  R / getTanThetaC();

      const double theta = axis.getTheta();
      const double phi   = fabs(axis.getPhi());

      const double y1 = getNPE(Y1, R, theta, phi);
      const double yA = getNPE(YA, R, theta, phi);
      const double yB = getNPE(YB, R, theta, phi);

      return JNPE(JK40(T_ns, R_Hz), y1, yA, yB, z);
    }

template<class T >

JNPE JFIT::JRegressor< JEnergy >::getNPE ( T  __begin, T  __end, const JK40Rates &  rates_Hz  ) const

inline

Create data structure for handling light yields for set of PMTs.

Note that the PMT geometry should be relative to the muon trajectory, conform method JGEOMETRY3D::JAxis3D::transform.

Parameters

__begin	begin of PMTs
__end	end of PMTs
rates_Hz	K40 singles and multiples rates [Hz]

Returns

light yields

Definition at line 176 of file JEnergyRegressor.hh.

    {
      using namespace std;
      using namespace JPP;

      double y1 = 0.0;
      double yA = 0.0;
      double yB = 0.0;
      double z  = 0.0;

      for (T i = __begin; i != __end; ++i) {

        const JNPE   npe = this->getNPE(*i, rates_Hz.getSinglesRate());
        const double x   = i->getX();
        const double y   = i->getY();
        const double R   = sqrt(x*x + y*y);

        y1 += npe.getY1();
        yA += npe.getYA();
        yB += npe.getYB();
        z  += i->getZ()  -  R / getTanThetaC();
      }

      const int N = distance(__begin, __end);

      return JNPE(JK40(T_ns, N, rates_Hz), y1, yA, yB, z / N);
    }

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

inline

Get maximal road width of NPE.

Returns

road width [m]

Definition at line 212 of file JEnergyRegressor.hh.

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

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

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

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

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

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

light from muon

Definition at line 218 of file JEnergyRegressor.hh.

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

light from delta-rays

Definition at line 219 of file JEnergyRegressor.hh.

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

light from EM showers

Definition at line 220 of file JEnergyRegressor.hh.

JTimeRange JFIT::JRegressor< JEnergy >::T_ns

static

Time window with respect to Cherenkov hypothesis [ns].

Time range.

Definition at line 222 of file JEnergyRegressor.hh.

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

static

Definition at line 225 of file JEnergyRegressor.hh.

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

static

Initial value:

= { DIRECT_LIGHT_FROM_MUON,
                                                    SCATTERED_LIGHT_FROM_MUON,
                                                    DIRECT_LIGHT_FROM_DELTARAYS,
                                                    SCATTERED_LIGHT_FROM_DELTARAYS,
                                                    DIRECT_LIGHT_FROM_EMSHOWERS,
                                                    SCATTERED_LIGHT_FROM_EMSHOWERS }

PDF types.

Definition at line 227 of file JEnergyRegressor.hh.

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

M-Estimator function.

Definition at line 229 of file JEnergyRegressor.hh.

JEnergy JFIT::JAbstractMinimiser< JEnergy >::value

inherited

model value

Definition at line 57 of file JRegressor.hh.

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:

• JEnergyRegressor.hh