JFIT::JRegressor< JLine3Z, JGandalf > Struct Reference

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

#include <JLine3ZRegressor.hh>

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

Public Types
typedef JRegressorStorage< JLine3Z, JGandalf >	storage_type
typedef JGandalf< JLine3Z >	minimiser_type
typedef JRegressor< JLine3Z, JGandalf >	regressor_type
typedef minimiser_type::result_type	result_type
typedef JTOOLS::JSplineFunction1S_t	JFunction1D_t
typedef JTOOLS::JMAPLIST< JTOOLS::JPolint1FunctionalMap, JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JPolint0FunctionalGridMap >::maplist	JPDFMaplist_t
typedef JPHYSICS::JPDFTable< JFunction1D_t, JPDFMaplist_t >	JPDF_t
	time dependent PDF
typedef JTOOLS::JMAPLIST< JTOOLS::JPolint1FunctionalMapH, JTOOLS::JPolint1FunctionalGridMap, JTOOLS::JPolint1FunctionalGridMap >::maplist	JNPEMaplist_t
typedef JPHYSICS::JNPETable< double, double, JNPEMaplist_t >	JNPE_t
	time integrated PDF
typedef JPDF_t::transformer_type	transformer_type
typedef std::array< JPDF_t, NUMBER_OF_PDFS >	JPDFs_t
	PDFs.
typedef std::array< JNPE_t, NUMBER_OF_PDFS >	JNPEs_t
	NPEs.

Public Member Functions
	JRegressor ()
	Default constructor.
	JRegressor (const std::string &fileDescriptor, const JTimeRange &T_ns, const double TTS_ns, 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 JLine3Z &track, const JHit_t &hit) const
	Fit function.
result_type	operator() (const JLine3Z &track, const JPMTW0 &pmt) 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 E, const double R, const double theta, const double phi, const double t1) const
	Get signal hypothesis value for time differentiated PDF.
JNPE_t::result_type	getH0 (const double R_Hz) const
	Get background hypothesis value for time integrated PDF.
JNPE_t::result_type	getH1 (const double E, const double R, const double theta, const double phi) const
	Get signal hypothesis value for time integrated PDF.
double	getRmax () const
	Get maximal road width of PDF.
result_type	operator() (const JLine3Z &value, T __begin, T __end)
	Global fit.
const JPDFs_t &	getPDF () const
	Get PDFs.
const JNPEs_t &	getNPE () const
	Get NPEs.
void	transform (const transformer_type &transformer)
	Transform PDFs and NPEs.

Public Attributes
const JPDFs_t &	pdf
	PDF.
const JNPEs_t &	npe
	PDF.
double	E_GeV = 0.0
	Energy of muon at vertex [GeV].
std::shared_ptr< JMEstimator >	estimator
	M-Estimator function.
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 = 6
	Number of PDFs.
static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types.

Private Attributes
JPDFs_t	_pdf
	PDFs.
JNPEs_t	_npe
	NPEs.

Detailed Description

Regressor function object for JLine3Z fit using JGandalf minimiser.

Definition at line 262 of file JLine3ZRegressor.hh.

Member Typedef Documentation

storage_type

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

Definition at line 268 of file JLine3ZRegressor.hh.

minimiser_type

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

inherited

Definition at line 80 of file JRegressor.hh.

regressor_type

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

inherited

Definition at line 81 of file JRegressor.hh.

result_type

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

inherited

Definition at line 82 of file JRegressor.hh.

JFunction1D_t

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

inherited

Definition at line 115 of file JLine3ZRegressor.hh.

JPDFMaplist_t

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMap,JTOOLS::JPolint0FunctionalGridMap,JTOOLS::JPolint0FunctionalGridMap>::maplist JFIT::JRegressorStorage< JLine3Z, JGandalf >::JPDFMaplist_t

inherited

Definition at line 118 of file JLine3ZRegressor.hh.

JPDF_t

typedef JPHYSICS::JPDFTable<JFunction1D_t, JPDFMaplist_t> JFIT::JRegressorStorage< JLine3Z, JGandalf >::JPDF_t

inherited

time dependent PDF

Definition at line 119 of file JLine3ZRegressor.hh.

JNPEMaplist_t

typedef JTOOLS::JMAPLIST<JTOOLS::JPolint1FunctionalMapH,JTOOLS::JPolint1FunctionalGridMap,JTOOLS::JPolint1FunctionalGridMap>::maplist JFIT::JRegressorStorage< JLine3Z, JGandalf >::JNPEMaplist_t

inherited

Definition at line 123 of file JLine3ZRegressor.hh.

JNPE_t

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

inherited

time integrated PDF

Definition at line 124 of file JLine3ZRegressor.hh.

transformer_type

typedef JPDF_t::transformer_type JFIT::JRegressorStorage< JLine3Z, JGandalf >::transformer_type

inherited

Definition at line 126 of file JLine3ZRegressor.hh.

JPDFs_t

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

inherited

PDFs.

Definition at line 130 of file JLine3ZRegressor.hh.

JNPEs_t

typedef std::array<JNPE_t, NUMBER_OF_PDFS> JFIT::JRegressorStorage< JLine3Z, JGandalf >::JNPEs_t

inherited

NPEs.

Definition at line 131 of file JLine3ZRegressor.hh.

Constructor & Destructor Documentation

JRegressor() [1/3]

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

inline

Default constructor.

Definition at line 273 of file JLine3ZRegressor.hh.

                 :
      storage_type(),
      pdf(getPDF()),
      npe(getNPE()),
      estimator()
    {}

JRegressor() [2/3]

JFIT::JRegressor< JLine3Z, JGandalf >::JRegressor ( const std::string & fileDescriptor, const JTimeRange & T_ns, const double TTS_ns, 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<JLine3Z, JGandalf>::pdf_t.

The TTS_ns corresponds to the additional Gaussian time smearing applied to the PDFs.

Parameters

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

Definition at line 295 of file JLine3ZRegressor.hh.

                                                            :
      storage_type(fileDescriptor, T_ns, TTS_ns, numberOfPoints, epsilon),
      pdf(getPDF()),
      npe(getNPE()),
      estimator(new JMEstimatorNormal())
    {}

JRegressor() [3/3]

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

inline

Constructor.

Parameters

storage

PDF storage

Definition at line 312 of file JLine3ZRegressor.hh.

                                            :
      pdf(storage.getPDF()),
      npe(storage.getNPE()),
      estimator(new JMEstimatorNormal())
    {
      T_ns = storage.T_ns;
    }

Member Function Documentation

operator()() [1/3]

template<class JHit_t >

result_type JFIT::JRegressor< JLine3Z, JGandalf >::operator() ( const JLine3Z & track, const JHit_t & hit ) const

inline

Fit function.

This method is used to determine the chi2 and gradient of given hit with respect to trajectory of muon.

The template argument 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

track	track
hit	hit

Returns

chi2 and gradient

Definition at line 339 of file JLine3ZRegressor.hh.

    {
      using namespace JPP;
      
      JPosition3D  D(hit.getX(),  hit.getY(),  hit.getZ());
      JDirection3D U(hit.getDX(), hit.getDY(), hit.getDZ());
 
      D.sub(track.getPosition());
 
      const double z  = D.getDot(track.getDirection());
      const double x  = D.getX()  -  z * track.getDX();
      const double y  = D.getY()  -  z * track.getDY();
      const double R2 = D.getLengthSquared() - z*z;
      const double R  = sqrt(R2);
 
      const double t1 = track.getT() + (z + R * getTanThetaC()) * getInverseSpeedOfLight();
 
      U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
 
      const double theta = U.getTheta();
      const double phi   = fabs(U.getPhi());
 
      const double E  = gWater.getE(E_GeV, z);
      const double dt = T_ns.constrain(hit.getT()  -  t1);
 
      JPDF_t::result_type H0 = getH0(hit.getR(), dt);
      JPDF_t::result_type H1 = getH1(E, R, theta, phi, dt);
 
      if (H1.V >= Vmax_npe) {
        H1 *= Vmax_npe / H1.V;
      }
 
      H1 += H0;                                                                                      // signal + background
 
      result_type result;
 
      result.chi2     = H1.getChi2() - H0.getChi2();                                                 // Likelihood ratio
 
      const double wc = 1.0  -  getTanThetaC() * z / R;                                              // d(ct1)/d(z)
 
      result.gradient = JLine3Z(JLine1Z(JPosition3D(-getTanThetaC() * D.getX() / R,                  // d(ct1)/d(x)
                                                    -getTanThetaC() * D.getY() / R,                  // d(ct1)/d(y)
                                                    0.0),
                                        getSpeedOfLight()),                                          // d(ct1)/d(t)
                                JVersor3Z(wc * (D.getX() - D.getZ()*track.getDX()/track.getDZ()),    // d(ct1)/d(dx)
                                          wc * (D.getY() - D.getZ()*track.getDY()/track.getDZ())));  // d(ct1)/d(dy)
      
      result.gradient.mul(getInverseSpeedOfLight() * (H1.getDerivativeOfChi2() -
                                                      H0.getDerivativeOfChi2()));                    // x d(chi2)/d(ct1)
 
      return result;
    }

operator()() [2/3]

result_type JFIT::JRegressor< JLine3Z, JGandalf >::operator() ( const JLine3Z & track, const JPMTW0 & pmt ) const

inline

Fit function.

This method is used to determine the chi2 and gradient of given PMT with respect to trajectory of muon.

Parameters

track	track
pmt	pmt

Returns

chi2 and gradient

Definition at line 401 of file JLine3ZRegressor.hh.

    {
      using namespace JGEOMETRY3D;
      using namespace JPHYSICS;
      
      JPosition3D  D(pmt.getPosition());
      JDirection3D U(pmt.getDirection());
 
      D.sub(track.getPosition());
 
      const double z  = D.getDot(track.getDirection());
      const double x  = D.getX()  -  z * track.getDX();
      const double y  = D.getY()  -  z * track.getDY();
      const double R2 = D.getLengthSquared() - z*z;
      const double R  = sqrt(R2);
 
      U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
 
      const double theta = U.getTheta();
      const double phi   = fabs(U.getPhi());
 
      const double E  = gWater.getE(E_GeV, z);
 
      JNPE_t::result_type H0 = getH0(pmt.getR());
      JNPE_t::result_type H1 = getH1(E, R, theta, phi);
 
      if (H1.f >= Vmax_npe) {
        H1 *= Vmax_npe / H1.f;
      }
 
      H1 += H0;
 
      const bool   hit = pmt.getN() != 0;
      const double u   = H1.getChi2(hit);
 
      result_type result;
 
      result.chi2     = estimator->getRho(u);
 
      result.gradient = JLine3Z(JLine1Z(JPosition3D(-D.getX() / R,   // d(R)/d(x)
                                                    -D.getY() / R,   // d(R)/d(y)
                                                    0.0),
                                        0.0),
                                JVersor3Z(-z * D.getX() / R,         // d(R)/d(dx)
                                          -z * D.getY() / R));       // d(R)/d(dy)
 
      result.gradient.mul(estimator->getPsi(u));
      result.gradient.mul(H1.getDerivativeOfChi2(hit));              // x d(chi2)/d(R)
 
      return result;
    }

getH0() [1/2]

JPDF_t::result_type JFIT::JRegressor< JLine3Z, 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 461 of file JLine3ZRegressor.hh.

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

getH1() [1/2]

JPDF_t::result_type JFIT::JRegressor< JLine3Z, JGandalf >::getH1 ( const double E, const double R, const double theta, const double phi, const double t1 ) const

inline

Get signal hypothesis value for time differentiated PDF.

Parameters

E	muon energy at minimum distance of approach [GeV]
R	minimum distance of approach [m]
theta	PMT zenith angle [rad]
phi	PMT azimuth angle [rad]
t1	arrival time relative to Cherenkov hypothesis [ns]

Returns

hypothesis value

Definition at line 478 of file JLine3ZRegressor.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JPDF_t::result_type h1 = zero;
 
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!pdf[i].empty() && R <= pdf[i].getXmax()) {
 
          JPDF_t::result_type y1 = pdf[i](max(R, pdf[i].getXmin()), theta, phi, t1);
          
          // safety measures
          
          if (y1.f <= 0.0) {
            y1.f  = 0.0;
            y1.fp = 0.0;
          }
          
          if (y1.v <= 0.0) {
            y1.v  = 0.0;
          }
          
          // energy dependence
          
          if        (is_deltarays(pdf_t[i])) {
            y1 *= JDeltaRays::getEnergyLossFromMuon(E);
          } else if (is_bremsstrahlung(pdf_t[i])) {
            y1 *= E;
          }
          
          h1 += y1;
        }
      }
 
      return h1;
    }

getH0() [2/2]

JNPE_t::result_type JFIT::JRegressor< JLine3Z, JGandalf >::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 528 of file JLine3ZRegressor.hh.

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

getH1() [2/2]

JNPE_t::result_type JFIT::JRegressor< JLine3Z, JGandalf >::getH1 ( const double E, const double R, const double theta, const double phi ) const

inline

Get signal hypothesis value for time integrated PDF.

Parameters

E	muon energy at minimum distance of approach [GeV]
R	minimum distance of approach [m]
theta	PMT zenith angle [rad]
phi	PMT azimuth angle [rad]

Returns

hypothesis value

Definition at line 543 of file JLine3ZRegressor.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JNPE_t::result_type h1 = JMATH::zero;
        
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!npe[i].empty() && R <= npe[i].getXmax()) {
 
          try {
 
            JNPE_t::result_type y1 = npe[i](max(R, npe[i].getXmin()), theta, phi);
          
            // safety measures
            
            if (y1.f > 0.0) {
            
              // energy dependence
            
              if        (is_deltarays(pdf_t[i])) {
                y1 *= JDeltaRays::getEnergyLossFromMuon(E);
              } else if (is_bremsstrahlung(pdf_t[i])) {
                y1 *= E;
              }
          
              h1 += y1;
            }
          }
          catch(JException& error) {
            ERROR(error << endl);
          }
        }
      }
 
      return h1;
    }

getRmax()

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

inline

Get maximal road width of PDF.

Returns

road width [m]

Definition at line 591 of file JLine3ZRegressor.hh.

    {
      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()() [3/3]

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

inlineinherited

Get PDFs.

Returns

PDFs

Definition at line 201 of file JLine3ZRegressor.hh.

    {
      return _pdf;
    }

getNPE()

const JNPEs_t & JFIT::JRegressorStorage< JLine3Z, JGandalf >::getNPE ( ) const

inlineinherited

Get NPEs.

Returns

NPEs

Definition at line 212 of file JLine3ZRegressor.hh.

    {
      return _npe;
    }

transform()

void JFIT::JRegressorStorage< JLine3Z, JGandalf >::transform ( const transformer_type & transformer )

inlineinherited

Transform PDFs and NPEs.

Parameters

transformer

transformer

Definition at line 223 of file JLine3ZRegressor.hh.

    {
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
        _pdf[i].transform(transformer);
        _npe[i].transform(transformer);
      }
    }

Member Data Documentation

Vmax_npe

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

static

Maximal integral of PDF [npe].

Default values.

Definition at line 605 of file JLine3ZRegressor.hh.

pdf

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

PDF.

Definition at line 607 of file JLine3ZRegressor.hh.

npe

const JNPEs_t& JFIT::JRegressor< JLine3Z, JGandalf >::npe

PDF.

Definition at line 608 of file JLine3ZRegressor.hh.

E_GeV

double JFIT::JRegressor< JLine3Z, JGandalf >::E_GeV = 0.0

Energy of muon at vertex [GeV].

Definition at line 610 of file JLine3ZRegressor.hh.

estimator

std::shared_ptr<JMEstimator> JFIT::JRegressor< JLine3Z, JGandalf >::estimator

M-Estimator function.

Definition at line 612 of file JLine3ZRegressor.hh.

NUMBER_OF_PDFS

const int JFIT::JRegressorStorage< JLine3Z, JGandalf >::NUMBER_OF_PDFS = 6

staticinherited

Number of PDFs.

Definition at line 128 of file JLine3ZRegressor.hh.

pdf_t

const JPDFType_t JFIT::JRegressorStorage< JLine3Z, JGandalf >::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 235 of file JLine3ZRegressor.hh.

T_ns

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

inherited

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 237 of file JLine3ZRegressor.hh.

_pdf

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

privateinherited

PDFs.

Definition at line 240 of file JLine3ZRegressor.hh.

_npe

JNPEs_t JFIT::JRegressorStorage< JLine3Z, JGandalf >::_npe

privateinherited

NPEs.

Definition at line 241 of file JLine3ZRegressor.hh.

---

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

• JLine3ZRegressor.hh