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

#include <JShower3EZRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >:

Public Types
typedef JRegressorStorage< JShower3EZ, JAbstractMinimiser >	storage_type

typedef JAbstractMinimiser< JShower3EZ >	minimiser_type

typedef JRegressor< JShower3EZ, JAbstractMinimiser >	regressor_type

typedef minimiser_type::result_type	result_type

typedef JTOOLS::JPolint1Function1D_t	JFunction1D_t

typedef JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap > > > >	JPDFMaplist_t

typedef JPHYSICS::JPDFTable< JFunction1D_t, JPDFMaplist_t >	JPDF_t

typedef JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList< JTOOLS::JPolint0FunctionalGridMap > > > >	JNPEMaplist_t

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

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)
	Constructor.

	JRegressor (const storage_type &storage)
	Constructor.

double	operator() (const JShower3EZ &shower, const JPMTW0 &pmt) const
	Fit function.

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 D, const double cd, const double theta, const double phi, const double E) const
	Get signal hypothesis value for time integrated PDF.

JNPE_t::result_type	getH1 (const JShower3EZ &shower, const JPMTW0 &pmt) const
	Get signal hypothesis value for time integrated PDF.

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

const JNPEs_t &	getNPE () const
	Get NPEs.

Public Attributes
const JNPEs_t &	npe

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 = 2

static const JPDFType_t	pdf_t [NUMBER_OF_PDFS]
	PDF types.

Private Attributes
JNPEs_t	_npe
	PDFs.

Detailed Description

Regressor function object for JShower3EZ fit using JGandalf minimiser.

Definition at line 729 of file JShower3EZRegressor.hh.

Member Typedef Documentation

◆ storage_type

typedef JRegressorStorage<JShower3EZ, JAbstractMinimiser> JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::storage_type

Definition at line 735 of file JShower3EZRegressor.hh.

◆ minimiser_type

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

inherited

Definition at line 80 of file JRegressor.hh.

◆ regressor_type

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

inherited

Definition at line 81 of file JRegressor.hh.

◆ result_type

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

inherited

Definition at line 82 of file JRegressor.hh.

◆ JFunction1D_t

typedef JTOOLS::JPolint1Function1D_t JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::JFunction1D_t

inherited

Definition at line 628 of file JShower3EZRegressor.hh.

◆ JPDFMaplist_t

typedef JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap> > > > JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::JPDFMaplist_t

inherited

Definition at line 632 of file JShower3EZRegressor.hh.

◆ JPDF_t

typedef JPHYSICS::JPDFTable<JFunction1D_t, JPDFMaplist_t> JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::JPDF_t

inherited

Definition at line 633 of file JShower3EZRegressor.hh.

◆ JNPEMaplist_t

typedef JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap, JTOOLS::JMapList<JTOOLS::JPolint0FunctionalGridMap> > > > JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::JNPEMaplist_t

inherited

Definition at line 638 of file JShower3EZRegressor.hh.

◆ JNPE_t

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

inherited

Definition at line 639 of file JShower3EZRegressor.hh.

◆ JNPEs_t

typedef std::array<JNPE_t, NUMBER_OF_PDFS> JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::JNPEs_t

inherited

NPEs.

Definition at line 644 of file JShower3EZRegressor.hh.

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::JRegressor ( )

inline

Default constructor.

Definition at line 740 of file JShower3EZRegressor.hh.

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

◆ JRegressor() [2/3]

JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::JRegressor	(	const std::string &	fileDescriptor,
		const JTimeRange &	T_ns )

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<JShower3EZ, JSimplex>::pdf_t.

Parameters

fileDescriptor	PDF file descriptor
T_ns	time range [ns]

Definition at line 756 of file JShower3EZRegressor.hh.

                                                                         :
      storage_type(fileDescriptor, T_ns),
      npe(getNPE()),
      estimator(new JMEstimatorNull())
    {}

◆ JRegressor() [3/3]

JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::JRegressor ( const storage_type & storage )

inline

Constructor.

Parameters

storage PDF storage

Definition at line 767 of file JShower3EZRegressor.hh.

                                            :
      npe(storage.getNPE()),
      estimator(new JMEstimatorNull())
    {
      T_ns = storage.T_ns;
    }

Member Function Documentation

◆ operator()() [1/2]

double JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::operator()	(	const JShower3EZ &	shower,
		const JPMTW0 &	pmt ) const

inline

Fit function.

This method is used to determine the chi2 of given PMT with respect to shower hypothesis.

Parameters

shower	shower
pmt	pmt

Returns: chi2

Definition at line 782 of file JShower3EZRegressor.hh.

    {
      using namespace JPP;
      
      JPosition3D  D(pmt.getPosition());
      JDirection3D U(pmt.getDirection());
 
      D.sub(shower.getPosition());
 
      const double z  = D.getDot(shower.getDirection());
      const double x  = D.getX();
      const double y  = D.getY();
      const double cd = z/D.getLength();                   // cosine angle between shower direction and PMT position
 
      U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
 
      const double theta = getPMTAngle(U.getTheta());
      const double phi   = getPMTAngle(U.getPhi());
 
      JNPE_t::result_type H0 = getH0(pmt.getR());                                    // background hypothesis value for time integrated PDF. 
      JNPE_t::result_type H1 = getH1(D.getLength(), cd, theta, phi, shower.getE());  // signal hypothesis value for time integrated PDF. 
 
      if (get_value(H1) >= Vmax_npe) {
        H1 *= Vmax_npe / get_value(H1);
      }
 
      H1 += H0; // now H1 is signal + background
 
      const bool hit = pmt.getN() != 0;
      const double u = getChi2(get_value(H1), hit) - getChi2(get_value(H0), hit); // -log likelihood ratio
 
      return estimator->getRho(u);
    }

◆ getH0()

JNPE_t::result_type JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::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 822 of file JShower3EZRegressor.hh.

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

◆ getH1() [1/2]

JNPE_t::result_type JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::getH1	(	const double	D,
		const double	cd,
		const double	theta,
		const double	phi,
		const double	E ) const

inline

Get signal hypothesis value for time integrated PDF.

Parameters

D	PMT distance from shower [m]
cd	cosine angle between shower direction and PMT position
theta	PMT zenith angle [deg]
phi	PMT azimuth angle [deg]
E	shower energy [GeV]

Returns: hypothesis value

Definition at line 837 of file JShower3EZRegressor.hh.

    {
      JNPE_t::result_type h1 = JMATH::zero;
        
      for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
 
        if (!npe[i].empty() && D <= npe[i].getXmax()) {
 
          try {
 
            JNPE_t::result_type y1 = E * npe[i](std::max(D, npe[i].getXmin()), cd, theta, phi);
 
            // safety measure
 
            if(y1 < 0){
              y1 = 0;  
            }
            
            h1 += y1;
          
          }
          catch(JLANG::JException& error) {
            ERROR(error << std::endl);
          }
        }
      }
 
      return h1;
    }

◆ getH1() [2/2]

JNPE_t::result_type JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::getH1	(	const JShower3EZ &	shower,
		const JPMTW0 &	pmt ) const

inline

Get signal hypothesis value for time integrated PDF.

Parameters

shower	shower
pmt	pmt

Returns: hypothesis value

Definition at line 878 of file JShower3EZRegressor.hh.

    {
      using namespace JPP; 
    
      JPosition3D  D(pmt.getPosition());
      JDirection3D U(pmt.getDirection());
 
 
      const double z  = D.getDot(shower.getDirection());
      const double x  = D.getX();
      const double y  = D.getY();
      const double cd = z/D.getLength();                   // cosine angle between shower direction and PMT position
 
      U.rotate(JRotation3Z(-atan2(y,x)));                  // rotate PMT axis to x-z plane
 
      const double theta = getPMTAngle(U.getTheta());
      const double phi   = getPMTAngle(U.getPhi());
 
      JNPE_t::result_type H1 = getH1(D.getLength(), cd, theta, phi, 1.0);  // signal hypothesis value for time integrated PDF. E=1 because it is linear with E.
 
      if (get_value(H1) >= Vmax_npe) {
        H1 *= Vmax_npe / get_value(H1);
      }
 
      return H1;
    }

◆ operator()() [2/2]

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

◆ getNPE()

const JNPEs_t & JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::getNPE ( ) const

inlineinherited

Get NPEs.

Returns: PDFs

Definition at line 702 of file JShower3EZRegressor.hh.

    {
      return _npe;
    }

Member Data Documentation

◆ Vmax_npe

double JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::Vmax_npe = std::numeric_limits<double>::max()

static

Maximal integral of PDF [npe].

Definition at line 904 of file JShower3EZRegressor.hh.

◆ npe

const JNPEs_t& JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::npe

Definition at line 906 of file JShower3EZRegressor.hh.

◆ estimator

std::shared_ptr<JMEstimator> JFIT::JRegressor< JShower3EZ, JAbstractMinimiser >::estimator

M-Estimator function

Definition at line 908 of file JShower3EZRegressor.hh.

◆ NUMBER_OF_PDFS

const int JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::NUMBER_OF_PDFS = 2

staticinherited

Definition at line 642 of file JShower3EZRegressor.hh.

◆ pdf_t

const JPDFType_t JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::pdf_t

staticinherited

Initial value:

= {
    DIRECT_LIGHT_FROM_EMSHOWER,
    SCATTERED_LIGHT_FROM_EMSHOWER
  }

PDF types.

Definition at line 710 of file JShower3EZRegressor.hh.

◆ T_ns

JTimeRange JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::T_ns

inherited

Time window with respect to Cherenkov hypothesis [ns].

Definition at line 711 of file JShower3EZRegressor.hh.

◆ _npe

JNPEs_t JFIT::JRegressorStorage< JShower3EZ, JAbstractMinimiser >::_npe

privateinherited

PDFs.

Definition at line 714 of file JShower3EZRegressor.hh.

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

JShower3EZRegressor.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

◆ JNPEMaplist_t

◆ JNPE_t

◆ JNPEs_t

Constructor & Destructor Documentation

◆ JRegressor() [1/3]

◆ JRegressor() [2/3]

◆ JRegressor() [3/3]

Member Function Documentation

◆ operator()() [1/2]

◆ getH0()

◆ getH1() [1/2]

◆ getH1() [2/2]

◆ operator()() [2/2]

◆ getNPE()

Member Data Documentation

◆ Vmax_npe

◆ npe

◆ estimator

◆ NUMBER_OF_PDFS

◆ pdf_t

◆ T_ns

◆ _npe