Regressor function object for fit of muon energy. More...

#include <JEnergyRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JEnergy >:

Public Types
typedef JRegressorStorage< JEnergy >	storage_type

typedef JAbstractMinimiser< JEnergy >	minimiser_type

typedef JRegressor< JEnergy, JAbstractMinimiser >	regressor_type

typedef minimiser_type::result_type	result_type

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

typedef JPHYSICS::JNPETable< double, double, JNPEMaplist_t >	JNPE_t
	time integrated PDF

typedef std::vector< JNPE_t >	JNPEs_t
	NPEs.

Public Member Functions
	JRegressor (const std::string &fileDescriptor, const JTimeRange &T_ns=JTimeRange())
	Constructor.

	JRegressor (const storage_type &storage)
	Constructor.

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

double	getY1 (const JAxis3D &axis) const
	Get number of photo-electrons from muon.

double	getYA (const JAxis3D &axis) const
	Get number of photo-electrons from delta-rays.

double	getYB (const JAxis3D &axis) const
	Get number of photo-electrons from Bremsstrahlung.

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

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

const JNPEs_t &	getY1 () const
	Get light from muon.

const JNPEs_t &	getYA () const
	Get light from delta-rays.

const JNPEs_t &	getYB () const
	Get light from EM showers.

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

Public Attributes
const JNPEs_t &	Y1
	PDF.

const JNPEs_t &	YA
	PDF.

const JNPEs_t &	YB
	PDF.

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

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

Static Public Attributes
static const int	NUMBER_OF_PDFS = 6
	Number of PDFs.

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types.

Static Protected Member Functions
static double	getRmax (const JNPEs_t &NPE)
	Get maximal road width of PDF.

static double	getNPE (const JNPEs_t &NPE, const double R, const double theta, const double phi)
	Get number of photo-electrons.

Private Attributes
JNPEs_t	_Y1
	light from muon

JNPEs_t	_YA
	light from delta-rays

JNPEs_t	_YB
	light from EM showers

Detailed Description

Regressor function object for fit of muon energy.

Definition at line 180 of file JEnergyRegressor.hh.

Member Typedef Documentation

◆ storage_type

typedef JRegressorStorage<JEnergy> JFIT::JRegressor< JEnergy >::storage_type

Definition at line 186 of file JEnergyRegressor.hh.

◆ minimiser_type

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

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

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

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

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

inherited

Definition at line 82 of file JRegressor.hh.

◆ JNPEMaplist_t

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

inherited

Definition at line 55 of file JEnergyRegressor.hh.

◆ JNPE_t

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

inherited

time integrated PDF

Definition at line 56 of file JEnergyRegressor.hh.

◆ JNPEs_t

typedef std::vector<JNPE_t> JFIT::JRegressorStorage< JEnergy >::JNPEs_t

inherited

NPEs.

Definition at line 60 of file JEnergyRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor() [1/2]

JFIT::JRegressor< JEnergy >::JRegressor	(	const std::string &	fileDescriptor,
		const JTimeRange &	T_ns = JTimeRange() )

inline

Constructor.

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

Parameters

fileDescriptor	PDF file descriptor
T_ns	time range [ns]

Definition at line 202 of file JEnergyRegressor.hh.

                                                                                       :
      storage_type(fileDescriptor, T_ns),
      Y1(getY1()),
      YA(getYA()),
      YB(getYB()),
      estimator(new JMEstimatorNormal()) 
    {}

◆ JRegressor() [2/2]

JFIT::JRegressor< JEnergy >::JRegressor ( const storage_type & storage )

inline

Constructor.

Parameters

storage PDF storage

Definition at line 216 of file JEnergyRegressor.hh.

                                            :
      Y1(storage.getY1()),
      YA(storage.getYA()),
      YB(storage.getYB()),
      estimator(new JMEstimatorNormal()) 
    {
      T_ns = storage.T_ns;
    }

Member Function Documentation

◆ operator()() [1/2]

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

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

◆ getY1() [1/2]

double JFIT::JRegressor< JEnergy >::getY1 ( const JAxis3D & axis ) const

inline

Get number of photo-electrons from muon.

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

Parameters

axis PMT axis

Returns: npe

Definition at line 251 of file JEnergyRegressor.hh.

    {
      return getNPE(Y1, hypot(axis.getX(), axis.getY()), axis.getTheta(), fabs(axis.getPhi()));
    }

◆ getYA() [1/2]

double JFIT::JRegressor< JEnergy >::getYA ( const JAxis3D & axis ) const

inline

Get number of photo-electrons from delta-rays.

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

Parameters

axis PMT axis

Returns: npe

Definition at line 265 of file JEnergyRegressor.hh.

    {
      return getNPE(YA, hypot(axis.getX(), axis.getY()), axis.getTheta(), fabs(axis.getPhi()));
    }

◆ getYB() [1/2]

double JFIT::JRegressor< JEnergy >::getYB ( const JAxis3D & axis ) const

inline

Get number of photo-electrons from Bremsstrahlung.

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

Parameters

axis PMT axis

Returns: npe

Definition at line 279 of file JEnergyRegressor.hh.

    {
      return getNPE(YB, hypot(axis.getX(), axis.getY()), axis.getTheta(), fabs(axis.getPhi()));
    }

◆ getNPE() [1/2]

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 294 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(getN(T_ns, R_Hz * 1.0e-9), y1, 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 321 of file JEnergyRegressor.hh.

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

◆ getRmax() [2/2]

static double JFIT::JRegressor< JEnergy >::getRmax ( const JNPEs_t & NPE )

inlinestaticprotected

Get maximal road width of PDF.

Parameters

NPE	NPE tables

Returns: road width [m]

Definition at line 340 of file JEnergyRegressor.hh.

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

◆ getNPE() [2/2]

static double JFIT::JRegressor< JEnergy >::getNPE	(	const JNPEs_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 363 of file JEnergyRegressor.hh.

    {
      using JTOOLS::get_value;
 
      double npe = 0.0;
 
      for (JNPEs_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;
    }    

◆ getY1() [2/2]

const JNPEs_t & JFIT::JRegressorStorage< JEnergy >::getY1 ( ) const

inline

Get light from muon.

Returns: NPEs

Definition at line 122 of file JEnergyRegressor.hh.

    {
      return _Y1;
    }

◆ getYA() [2/2]

const JNPEs_t & JFIT::JRegressorStorage< JEnergy >::getYA ( ) const

inline

Get light from delta-rays.

Returns: NPEs

Definition at line 133 of file JEnergyRegressor.hh.

    {
      return _YA;
    }

◆ getYB() [2/2]

const JNPEs_t & JFIT::JRegressorStorage< JEnergy >::getYB ( ) const

inline

Get light from EM showers.

Returns: NPEs

Definition at line 144 of file JEnergyRegressor.hh.

    {
      return _YB;
    }

◆ operator()() [2/2]

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 94 of file JRegressor.hh.

Member Data Documentation

◆ Y1

const JNPEs_t& JFIT::JRegressor< JEnergy >::Y1

PDF.

Definition at line 327 of file JEnergyRegressor.hh.

◆ YA

const JNPEs_t& JFIT::JRegressor< JEnergy >::YA

PDF.

Definition at line 328 of file JEnergyRegressor.hh.

◆ YB

const JNPEs_t& JFIT::JRegressor< JEnergy >::YB

PDF.

Definition at line 329 of file JEnergyRegressor.hh.

◆ estimator

std::shared_ptr<JMEstimator> JFIT::JRegressor< JEnergy >::estimator

M-Estimator function.

Definition at line 331 of file JEnergyRegressor.hh.

◆ NUMBER_OF_PDFS

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

staticinherited

Number of PDFs.

Definition at line 58 of file JEnergyRegressor.hh.

◆ pdf_t

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

staticinherited

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

◆ T_ns

JTimeRange JFIT::JRegressorStorage< JEnergy >::T_ns

inherited

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 155 of file JEnergyRegressor.hh.

◆ _Y1

JNPEs_t JFIT::JRegressorStorage< JEnergy >::_Y1

privateinherited

light from muon

Definition at line 158 of file JEnergyRegressor.hh.

◆ _YA

JNPEs_t JFIT::JRegressorStorage< JEnergy >::_YA

privateinherited

light from delta-rays

Definition at line 159 of file JEnergyRegressor.hh.

◆ _YB

JNPEs_t JFIT::JRegressorStorage< JEnergy >::_YB

privateinherited

light from EM showers

Definition at line 160 of file JEnergyRegressor.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

Private Attributes

Detailed Description

Member Typedef Documentation

◆ storage_type

◆ minimiser_type

◆ regressor_type

◆ result_type

◆ JNPEMaplist_t

◆ JNPE_t

◆ JNPEs_t

Constructor & Destructor Documentation

◆ JRegressor() [1/2]

◆ JRegressor() [2/2]

Member Function Documentation

◆ operator()() [1/2]

◆ getY1() [1/2]

◆ getYA() [1/2]

◆ getYB() [1/2]

◆ getNPE() [1/2]

◆ getRmax() [1/2]

◆ getRmax() [2/2]

◆ getNPE() [2/2]

◆ getY1() [2/2]

◆ getYA() [2/2]

◆ getYB() [2/2]

◆ operator()() [2/2]

Member Data Documentation

◆ Y1

◆ YA

◆ YB

◆ estimator

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ T_ns

◆ _Y1

◆ _YA

◆ _YB