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

#include <JShowerBrightPointRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JPoint4E, JGandalf >:

Public Types
typedef JRegressorStorage< JPoint4E, JGandalf >	storage_type

typedef JGandalf< JPoint4E >	minimiser_type

typedef JRegressor< JPoint4E, JGandalf >	regressor_type

typedef minimiser_type::result_type	result_type

typedef JTOOLS::JSplineFunction1S_t	JFunction1D_t

typedef JTOOLS::JMAPLIST< JTOOLS::JPolint2FunctionalMap, JTOOLS::JPolint1FunctionalGridMap >::maplist	JPDFMapList_t

typedef JPHYSICS::JPDFTable< JFunction1D_t, JPDFMapList_t >	JPDF_t

typedef std::array< JPDF_t, NUMBER_OF_PDFS >	JPDFs_t
	PDFs.

Public Member Functions
	JRegressor ()
	Default constructor.

	JRegressor (const std::string &fileDescriptor, const JTimeRange &T_ns, const double TTS, const int numberOfPoints=25, const double epsilon=1.0e-10)
	Constructor.

	JRegressor (const storage_type &storage)
	Constructor.

template<class JHit_t >
result_type	operator() (const JPoint4E &vx, const JHit_t &hit) const
	Fit function.

JPDF_t::result_type	getH0 (const double R_Hz, const double t1) const
	Get background hypothesis value for time differentiated PDF.

JPDF_t::result_type	getH1 (const double D, const double ct, const double t) const
	Get signal hypothesis value per 1 GeV for bright point emission PDF.

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

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

const JPDFs_t &	getPDF () const
	Get PDFs.

Public Attributes
const JPDFs_t &	pdf
	PDF.

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

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

static const int	NUMBER_OF_PDFS = 2

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types.

Private Attributes
JPDFs_t	_pdf
	PDFs.

Detailed Description

Regressor function object for JLine3Z fit using JGandalf minimiser.

Definition at line 161 of file JShowerBrightPointRegressor.hh.

Member Typedef Documentation

◆ storage_type

typedef JRegressorStorage<JPoint4E, JGandalf> JFIT::JRegressor< JPoint4E, JGandalf >::storage_type

Definition at line 167 of file JShowerBrightPointRegressor.hh.

◆ minimiser_type

typedef JGandalf <JPoint4E > JFIT::JAbstractRegressor< JPoint4E , JGandalf >::minimiser_type

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

typedef JRegressor<JPoint4E , JGandalf > JFIT::JAbstractRegressor< JPoint4E , JGandalf >::regressor_type

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

typedef minimiser_type::result_type JFIT::JAbstractRegressor< JPoint4E , JGandalf >::result_type

inherited

Definition at line 82 of file JRegressor.hh.

◆ JFunction1D_t

typedef JTOOLS::JSplineFunction1S_t JFIT::JRegressorStorage< JPoint4E, JGandalf >::JFunction1D_t

inherited

Definition at line 61 of file JShowerBrightPointRegressor.hh.

◆ JPDFMapList_t

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint2FunctionalMap,JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressorStorage< JPoint4E, JGandalf >::JPDFMapList_t

inherited

Definition at line 63 of file JShowerBrightPointRegressor.hh.

◆ JPDF_t

typedef JPHYSICS::JPDFTable<JFunction1D_t, JPDFMapList_t> JFIT::JRegressorStorage< JPoint4E, JGandalf >::JPDF_t

inherited

Definition at line 64 of file JShowerBrightPointRegressor.hh.

◆ JPDFs_t

typedef std::array<JPDF_t, NUMBER_OF_PDFS> JFIT::JRegressorStorage< JPoint4E, JGandalf >::JPDFs_t

inherited

PDFs.

Definition at line 68 of file JShowerBrightPointRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

JFIT::JRegressor< JPoint4E, JGandalf >::JRegressor ( )

inline

Default constructor.

Definition at line 172 of file JShowerBrightPointRegressor.hh.

                 :
      storage_type(),
      pdf(getPDF())
    {}

◆ JRegressor() [2/3]

JFIT::JRegressor< JPoint4E, JGandalf >::JRegressor	(	const std::string &	fileDescriptor,
		const JTimeRange &	T_ns,
		const double	TTS,
		const int	numberOfPoints = 25,
		const double	epsilon = 1.0e-10 )

inline

Constructor.

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

The TTS corresponds to the additional time smearing applied to the PDFs.

Parameters

fileDescriptor	PDF file descriptor
T_ns	time range [ns]
TTS	TTS [ns]
numberOfPoints	number of points for Gauss-Hermite integration of TTS
epsilon	precision for Gauss-Hermite integration of TTS

Definition at line 191 of file JShowerBrightPointRegressor.hh.

                                                            :
      storage_type(fileDescriptor, T_ns, TTS, numberOfPoints, epsilon),
      pdf(getPDF())
    {}

◆ JRegressor() [3/3]

JFIT::JRegressor< JPoint4E, JGandalf >::JRegressor ( const storage_type & storage )

inline

Constructor.

Parameters

storage PDF storage

Definition at line 205 of file JShowerBrightPointRegressor.hh.

                                            :
      pdf(storage.getPDF())
    {
      T_ns = storage.T_ns;
    }

Member Function Documentation

◆ operator()() [1/2]

template<class JHit_t >

result_type JFIT::JRegressor< JPoint4E, JGandalf >::operator()	(	const JPoint4E &	vx,
		const JHit_t &	hit ) const

inline

Fit function.

This method is used to determine the chi2 and gradient of given hit with respect a bright point emitting isotropically

JHit_t refers to a data structure which should have the following member methods:

double getX(); // [m]
double getY(); // [m]
double getZ(); // [m]
double getDX(); // [u]
double getDY(); // [u]
double getDZ(); // [u]
double getT(); // [ns]

Parameters

vx	shower vertex
hit	hit

Returns: chi2 and gradient

Definition at line 229 of file JShowerBrightPointRegressor.hh.

    {      
      using namespace JPP;
 
      JPosition3D  D(hit.getPosition());
      JDirection3D U(hit.getDirection());
 
      D.sub(vx.getPosition());
      double length = D.getLength();
      double ct = U.getDot(D) / length;
 
      if (ct > +1.0) { ct = +1.0; }
      if (ct < -1.0) { ct = -1.0; }
 
      const double t  = vx.getT() + (length * getIndexOfRefraction() * getInverseSpeedOfLight());
 
      const double dt = T_ns.constrain(hit.getT() - t);
 
      JPDF_t::result_type H0 = getH0(hit.getR(), dt);                    // getH0 = Get background hypothesis value 
      JPDF_t::result_type H1 = getH1(length, ct, dt);  // getH1 = Get signal hypothesis value / 1 GeV
 
      if (get_value(H1) >= Vmax_npe) {
        H1 *= Vmax_npe / get_value(H1);
      }
 
      double H1_value = get_value(H1);
      double v_H1 = H1.v; //Integral from tmin to t of just H1
      double V_H1 = H1.V; //Integral from tmin to tmax of just H1
      H1 *= vx.getE();
      
      JPDF_t::result_type HT = H1+H0; //now H1 is signal + background
      double HT_value = get_value(HT);
      result_type result;
      result.chi2 = HT.getChi2() - H0.getChi2();  // Likelihood ratio
      
      double exp_V_HT = exp(-HT.V); //V is the integral from tmin to tmax of EH1+H0
 
      double energy_gradient = -1 / HT_value; //dPdE
      energy_gradient *= (H1_value -  HT_value * v_H1) * (1-exp_V_HT)  -  HT_value * exp_V_HT * V_H1; //Numerator
      energy_gradient /= (1-exp_V_HT); // Denominator
 
      /*
       * Here it is evaluated: d(chi2)/d(ct) * d(ct)/d(x0,y0,z0,t0)  + d(chi2)/dE
       */
      result.gradient = JPoint4E(JPoint4D(JVector3D(-getIndexOfRefraction() * D.getX() / length,    // d(ct)/d(x0) 
                                                    -getIndexOfRefraction() * D.getY() / length,    // d(ct)/d(y0) 
                                                    -getIndexOfRefraction() * D.getZ() / length),   // d(ct)/d(z0) 
                                          getSpeedOfLight()),                                       // d(ct)/d(t0)
                                 energy_gradient);                                                  // d(chi2)/d(E)
      
      static_cast<JPoint4D&>(result.gradient).mul(getInverseSpeedOfLight() * (HT.getDerivativeOfChi2() -
                                                                              H0.getDerivativeOfChi2()));  // x d(chi2)/d(ct1)
 
      return result;
 
    }

◆ getH0()

JPDF_t::result_type JFIT::JRegressor< JPoint4E, JGandalf >::getH0	(	const double	R_Hz,
		const double	t1 ) const

inline

Get background hypothesis value for time differentiated PDF.

Parameters

R_Hz	rate [Hz]
t1	time [ns]

Returns: hypothesis value

Definition at line 293 of file JShowerBrightPointRegressor.hh.

    {
      using namespace JPP;
 
      return JPDF_t::result_type(R_Hz * 1e-9, t1, T_ns);
    }

◆ getH1()

JPDF_t::result_type JFIT::JRegressor< JPoint4E, JGandalf >::getH1	(	const double	D,
		const double	ct,
		const double	t ) const

inline

Get signal hypothesis value per 1 GeV for bright point emission PDF.

Parameters

D	hit distance from shower vertex [m]
ct	cosine of the HIT angle
t	arrival time of the light

Returns: hypothesis value / GeV

Definition at line 309 of file JShowerBrightPointRegressor.hh.

    {
      using namespace JPP;
 
      JPDF_t::result_type h1 = JMATH::zero;
        
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!pdf[i].empty() && D <= pdf[i].getXmax()) {
 
          try {
 
            JPDF_t::result_type y1 = pdf[i](std::max(D, pdf[i].getXmin()), ct, t);
            
            // safety measures
            
            if (y1.f <= 0.0) {
              y1.f  = 0.0;
              y1.fp = 0.0;
            }
            
            if (y1.v <= 0.0) {
              y1.v  = 0.0;
            }
            
            h1 += y1;     
          }
          catch(JLANG::JException& error) {
            ERROR(error << std::endl);
          }
        }
      }
 
      return h1;
    }

◆ getRmax()

double JFIT::JRegressor< JPoint4E, JGandalf >::getRmax ( ) const

inline

Get maximal road width of PDF.

Returns: road width [m]

Definition at line 352 of file JShowerBrightPointRegressor.hh.

    {
      using namespace JPP;
 
      double xmax = 0.0;
 
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!pdf[i].empty() && pdf[i].getXmax() > xmax) {
          xmax = pdf[i].getXmax();
        }
 
      }
 
      return xmax;
    }

◆ operator()() [2/2]

result_type JFIT::JAbstractRegressor< JPoint4E , JGandalf >::operator()	(	const JPoint4E &	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.

◆ getPDF()

const JPDFs_t & JFIT::JRegressorStorage< JPoint4E, JGandalf >::getPDF ( ) const

inlineinherited

Get PDFs.

Returns: PDFs

Definition at line 132 of file JShowerBrightPointRegressor.hh.

    {
      return _pdf;
    }

Member Data Documentation

◆ Vmax_npe

double JFIT::JRegressor< JPoint4E, JGandalf >::Vmax_npe = std::numeric_limits<double>::max()

static

Maximal integral of PDF [npe].

Default values.

Definition at line 369 of file JShowerBrightPointRegressor.hh.

◆ pdf

const JPDFs_t& JFIT::JRegressor< JPoint4E, JGandalf >::pdf

PDF.

Definition at line 371 of file JShowerBrightPointRegressor.hh.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressorStorage< JPoint4E, JGandalf >::NUMBER_OF_PDFS = 2

staticinherited

Definition at line 66 of file JShowerBrightPointRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressorStorage< JPoint4E, JGandalf >::pdf_t

staticinherited

Initial value:

= {
    DIRECT_LIGHT_FROM_BRIGHT_POINT,
    SCATTERED_LIGHT_FROM_BRIGHT_POINT
  }

PDF types.

Definition at line 141 of file JShowerBrightPointRegressor.hh.

◆ T_ns

JTimeRange JFIT::JRegressorStorage< JPoint4E, JGandalf >::T_ns

inherited

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 142 of file JShowerBrightPointRegressor.hh.

◆ _pdf

JPDFs_t JFIT::JRegressorStorage< JPoint4E, JGandalf >::_pdf

privateinherited

PDFs.

Definition at line 145 of file JShowerBrightPointRegressor.hh.

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

JShowerBrightPointRegressor.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ storage_type

◆ minimiser_type

◆ regressor_type

◆ result_type

◆ JFunction1D_t

◆ JPDFMapList_t

◆ JPDF_t

◆ JPDFs_t

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

◆ JRegressor() [2/3]

◆ JRegressor() [3/3]

Member Function Documentation

◆ operator()() [1/2]

◆ getH0()

◆ getH1()

◆ getRmax()

◆ operator()() [2/2]

◆ getPDF()

Member Data Documentation

◆ Vmax_npe

◆ pdf

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ T_ns

◆ _pdf