Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
JFIT::JRegressor< JPoint4D, JGandalf > Struct Template Reference

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

#include <JShowerBrightPointRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JPoint4D, JGandalf >:
JFIT::JAbstractRegressor< JPoint4D, JGandalf > JFIT::JGandalf< JPoint4D > JEEP::JMessage< T >

Public Types

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 JGandalf< JPoint4Dminimiser_type
 
typedef JRegressor< JPoint4D,
JGandalf
regressor_type
 
typedef minimiser_type::result_type result_type
 
typedef JPoint4D::parameter_type parameter_type
 Data type of fit parameter. More...
 

Public Member Functions

 JRegressor (const std::string &fileDescriptor, const double TTS, const int numberOfPoints=25, const double epsilon=1.0e-10)
 Parameterized constructor. More...
 
template<class JHit_t >
result_type operator() (const JPoint4D &vx, const JHit_t &hit) const
 Fit function. More...
 
JPDF_t::result_type getH0 (const double R_Hz, const double t1) const
 Get background hypothesis value for time differentiated PDF. More...
 
JPDF_t::result_type getH1 (const double D, const double ct, const double t, const double E) const
 Get signal hypothesis value for bright point emission PDF. More...
 
double getRmax () const
 Get maximal road width of PDF. More...
 
result_type operator() (const JPoint4D &value, T __begin, T __end)
 Global fit. More...
 
result_type operator() (const JFunction_t &fit, T __begin, T __end, Args...args)
 Multi-dimensional fit of two data sets. More...
 

Public Attributes

JPDF_t pdf [NUMBER_OF_PDFS]
 PDF. More...
 
double E_GeV
 Energy of the shower [GeV]. More...
 
double lambda
 
JPoint4D value
 
JPoint4D error
 
std::vector< parameter_typeparameters
 
int numberOfIterations
 
JMATH::JMatrixNS V
 

Static Public Attributes

static JTimeRange T_ns
 Time window with respect to Cherenkov hypothesis [ns]. More...
 
static double Vmax_npe = std::numeric_limits<double>::max()
 Maximal integral of PDF [npe]. More...
 
static const int NUMBER_OF_PDFS = 2
 
static const JPDFType_t pdf_t [NUMBER_OF_PDFS]
 PDF types. More...
 
static int MAXIMUM_ITERATIONS
 maximal number of iterations More...
 
static double EPSILON
 maximal distance to minimum More...
 
static double LAMBDA_MIN
 minimal value control parameter More...
 
static double LAMBDA_MAX
 maximal value control parameter More...
 
static double LAMBDA_UP
 multiplication factor control parameter More...
 
static double LAMBDA_DOWN
 multiplication factor control parameter More...
 
static double PIVOT
 minimal value diagonal element of matrix More...
 
static int debug = 0
 debug level (default is off). More...
 

Detailed Description

template<>
struct JFIT::JRegressor< JPoint4D, JGandalf >

Regressor function object for JPoint4D fit using JGandalf minimiser.

Definition at line 43 of file JShowerBrightPointRegressor.hh.

Member Typedef Documentation

Definition at line 48 of file JShowerBrightPointRegressor.hh.

Definition at line 50 of file JShowerBrightPointRegressor.hh.

Definition at line 51 of file JShowerBrightPointRegressor.hh.

Definition at line 78 of file JRegressor.hh.

Definition at line 79 of file JRegressor.hh.

typedef minimiser_type::result_type JFIT::JAbstractRegressor< JPoint4D , JGandalf >::result_type
inherited

Definition at line 80 of file JRegressor.hh.

Data type of fit parameter.

Definition at line 63 of file JGandalf.hh.

Constructor & Destructor Documentation

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

Parameterized constructor.

The PDF file descriptor should contain the wild card character JPHYSICS::WILD_CARD which will be replaced by the corresponding PDF types.

Parameters
fileDescriptorPDF file descriptor
TTSTTS [ns]
numberOfPointsnumber of points for Gauss-Hermite integration of TTS
epsilonprecision for Gauss-Hermite integration of TTS

Definition at line 65 of file JShowerBrightPointRegressor.hh.

68  :
69  E_GeV(0.0)
70  {
71  using namespace std;
72  using namespace JPP;
73 
74  const JPDF_t::JSupervisor supervisor(new JPDF_t::JDefaultResult(JMATH::zero));
75 
76  for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
77 
78  try {
79 
80  const string file_name = getFilename(fileDescriptor, pdf_t[i]);
81 
82  NOTICE("loading PDF from file " << file_name << "... " << flush);
83 
84  pdf[i].load(file_name.c_str());
85 
86  NOTICE("OK" << endl);
87 
88  pdf[i].setExceptionHandler(supervisor);
89  }
90  catch(const JException& error) {
91  FATAL(error.what() << endl);
92  }
93  }
94 
95  // Add PDFs
96  for (int i = 1; i < NUMBER_OF_PDFS; i += 2) {
97 
98  pdf[ i ].add(pdf[i-1]);
99 
100  JPDF_t buffer;
101 
102  pdf[i-1].swap(buffer);
103 
104  if (TTS > 0.0) {
105  pdf[i].blur(TTS, numberOfPoints, epsilon);
106  } else if (TTS < 0.0) {
107  ERROR("Illegal value of TTS [ns]: " << TTS << endl);
108  }
109  }
110  }
void load(const char *file_name)
Load from input file.
JPHYSICS::JPDFTable< JFunction1D_t, JPDFMapList_t > JPDF_t
void setExceptionHandler(const supervisor_type &supervisor)
Set the supervisor for handling of exceptions.
void blur(const double TTS, const int numberOfPoints=25, const double epsilon=1.0e-10, const double quantile=0.99)
Blur PDF.
Definition: JPDFTable.hh:110
static const JZero zero
Function object to assign zero value.
Definition: JZero.hh:105
void add(const JMultiFunction_t &input)
Add function.
#define NOTICE(A)
Definition: JMessage.hh:64
static const JPDFType_t pdf_t[NUMBER_OF_PDFS]
PDF types.
#define FATAL(A)
Definition: JMessage.hh:67
int numberOfPoints
Definition: JResultPDF.cc:22
std::string getFilename(const std::string &file_name)
Get file name part, i.e. part after last JEEP::PATHNAME_SEPARATOR if any.
Definition: JeepToolkit.hh:88

Member Function Documentation

template<class JHit_t >
result_type JFIT::JRegressor< JPoint4D, JGandalf >::operator() ( const JPoint4D 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
vxshower vertex
hithit
Returns
chi2 and gradient

Definition at line 130 of file JShowerBrightPointRegressor.hh.

131  {
132  using namespace JPP;
133 
134  JPosition3D D(hit.getPosition());
135  JDirection3D U(hit.getDirection());
136 
137  D.sub(vx.getPosition());
138 
139  double ct = U.getDot(D) / D.getLength();
140 
141  if (ct > +1.0) { ct = +1.0; }
142  if (ct < -1.0) { ct = -1.0; }
143 
144  const double t = vx.getT() + (D.getLength() * getIndexOfRefraction() * getInverseSpeedOfLight());
145 
146  const double dt = T_ns.constrain(hit.getT() - t);
147 
148  JPDF_t::result_type H0 = getH0(hit.getR(), dt); // getH0 = Get background hypothesis value
149  JPDF_t::result_type H1 = getH1(D.getLength(), ct, dt, E_GeV); // getH1 = Get signal hypothesis value
150 
151  if (get_value(H1) >= Vmax_npe) {
152  H1 *= Vmax_npe / get_value(H1);
153  }
154 
155  H1 += H0; // now H1 is signal + background
156 
158 
159  result.chi2 = H1.getChi2() - H0.getChi2(); // Likelihood ratio
160 
161  /*
162  * Here it is evaluated: d(chi2)/d(ct) * d(ct)/d(x0,y0,z0,t0)
163  */
164  result.gradient = JPoint4D(JVector3D(-getIndexOfRefraction() * D.getX() / D.getLength(), // d(ct)/d(x0)
165  -getIndexOfRefraction() * D.getY() / D.getLength(), // d(ct)/d(y0)
166  -getIndexOfRefraction() * D.getZ() / D.getLength()), // d(ct)/d(z0)
167  getSpeedOfLight()); // d(ct)/d(t0)
168 
169  result.gradient.mul(getInverseSpeedOfLight() * (H1.getDerivativeOfChi2() -
170  H0.getDerivativeOfChi2())); // x d(chi2)/d(ct1)
171 
172  return result;
173 
174  }
do echo Generating $dir eval D
Definition: JDrawLED.sh:50
double getIndexOfRefraction()
Get average index of refraction of water corresponding to group velocity.
do rm f tmp H1
Data structure for vertex fit.
Definition: JPoint4D.hh:22
minimiser_type::result_type result_type
Definition: JRegressor.hh:80
JPDF_t::result_type getH0(const double R_Hz, const double t1) const
Get background hypothesis value for time differentiated PDF.
return result
Definition: JPolint.hh:727
const JPosition3D & getPosition() const
Get position.
Definition: JPosition3D.hh:130
static double Vmax_npe
Maximal integral of PDF [npe].
const double getSpeedOfLight()
Get speed of light.
const double getInverseSpeedOfLight()
Get inverse speed of light.
double getT(const JVector3D &pos) const
Get arrival time of Cherenkov light at given position.
Definition: JVertex3D.hh:145
JResultEvaluator< JResult_t >::result_type get_value(const JResult_t &value)
Helper method to recursively evaluate a to function value.
Definition: JResult.hh:998
JPDF_t::result_type getH1(const double D, const double ct, const double t, const double E) const
Get signal hypothesis value for bright point emission PDF.
static JTimeRange T_ns
Time window with respect to Cherenkov hypothesis [ns].
JPDF_t::result_type JFIT::JRegressor< JPoint4D, JGandalf >::getH0 ( const double  R_Hz,
const double  t1 
) const
inline

Get background hypothesis value for time differentiated PDF.

Parameters
R_Hzrate [Hz]
t1time [ns]
Returns
hypothesis value

Definition at line 183 of file JShowerBrightPointRegressor.hh.

185  {
186  using namespace JPP;
187 
188  return JPDF_t::result_type(R_Hz * 1e-9, t1, T_ns);
189  }
static JTimeRange T_ns
Time window with respect to Cherenkov hypothesis [ns].
JPDF_t::result_type JFIT::JRegressor< JPoint4D, JGandalf >::getH1 ( const double  D,
const double  ct,
const double  t,
const double  E 
) const
inline

Get signal hypothesis value for bright point emission PDF.

Parameters
Dhit distance from shower vertex [m]
ctcosine of the HIT angle
tarrival time of the light
Eshower energy [GeV]
Returns
hypothesis value

Definition at line 200 of file JShowerBrightPointRegressor.hh.

204  {
205  using namespace JPP;
206 
207  JPDF_t::result_type h1 = JMATH::zero;
208 
209  for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
210 
211  if (!pdf[i].empty() && D <= pdf[i].getXmax()) {
212 
213  try {
214 
215  JPDF_t::result_type y1 = E * pdf[i](std::max(D, pdf[i].getXmin()), ct, t);
216 
217  // safety measures
218 
219  if (y1.f <= 0.0) {
220  y1.f = 0.0;
221  y1.fp = 0.0;
222  }
223 
224  if (y1.v <= 0.0) {
225  y1.v = 0.0;
226  }
227 
228  h1 += y1;
229 
230  }
231  catch(JLANG::JException& error) {
232  ERROR(error << std::endl);
233  }
234  }
235  }
236 
237  return h1;
238  }
General exception.
Definition: JException.hh:23
do echo Generating $dir eval D
Definition: JDrawLED.sh:50
then for HISTOGRAM in h0 h1
Definition: JMatrixNZ.sh:69
static const JZero zero
Function object to assign zero value.
Definition: JZero.hh:105
then usage $script[input file[working directory[option]]] nWhere option can be E
Definition: JMuonPostfit.sh:37
double JFIT::JRegressor< JPoint4D, JGandalf >::getRmax ( ) const
inline

Get maximal road width of PDF.

Returns
road width [m]

Definition at line 245 of file JShowerBrightPointRegressor.hh.

246  {
247  using namespace JPP;
248 
249  double xmax = 0.0;
250 
251  for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
252 
253  if (!pdf[i].empty() && pdf[i].getXmax() > xmax) {
254  xmax = pdf[i].getXmax();
255  }
256 
257  }
258 
259  return xmax;
260  }
result_type JFIT::JAbstractRegressor< JPoint4D , JGandalf >::operator() ( const JPoint4D value,
T  __begin,
T  __end 
)
inlineinherited

Global fit.

Parameters
valuestart value
__beginbegin of data set
__endend of data set
Returns
chi2

Definition at line 92 of file JRegressor.hh.

93  {
94  static_cast<minimiser_type&>(*this).value = value;
95 
96  return static_cast<minimiser_type&>(*this)(static_cast<regressor_type&>(*this), __begin, __end);
97  }
JModel_t value
Definition: JGandalf.hh:257
JRegressor< JPoint4D, JGandalf > regressor_type
Definition: JRegressor.hh:79
result_type JFIT::JGandalf< JPoint4D >::operator() ( const JFunction_t &  fit,
T  __begin,
T  __end,
Args...  args 
)
inlineinherited

Multi-dimensional fit of two data sets.

The fit function should return the equivalent of chi2 for the current value of the model and the given data point as well as the partial derivatives.

Parameters
fitfit function
__beginbegin of data
__endend of data
argsoptional data
Returns
chi2

Definition at line 128 of file JGandalf.hh.

129  {
130  using namespace std;
131  using namespace JPP;
132 
133  const int N = parameters.size();
134 
135  V.resize(N);
136  h.resize(N);
137 
138  previous = value;
139 
140  successor.gradient = value;
141  successor.gradient = zero;
142 
143  error = value;
144  error = zero;
145 
146  lambda = LAMBDA_MIN;
147 
148  result_type precessor = result_type(numeric_limits<double>::max(), value);
149 
151 
152  DEBUG("step: " << numberOfIterations << endl);
153 
154  reset();
155 
156  __evaluate__(fit, __begin, __end, args...);
157 
158  DEBUG("lambda: " << FIXED(12,5) << lambda << endl);
159  DEBUG("chi2: " << FIXED(12,5) << successor.chi2 << endl);
160 
161  if (successor.chi2 < precessor.chi2) {
162 
163  if (numberOfIterations != 0) {
164 
165  if (fabs(precessor.chi2 - successor.chi2) < EPSILON*fabs(precessor.chi2)) {
166  return successor;
167  }
168 
169  if (lambda > LAMBDA_MIN) {
170  lambda /= LAMBDA_DOWN;
171  }
172  }
173 
174  precessor = successor;
175  previous = value;
176 
177  } else {
178 
179  value = previous;
180  lambda *= LAMBDA_UP;
181 
182  if (lambda > LAMBDA_MAX) {
183  return precessor; // no improvement found
184  }
185 
186  reset();
187 
188  __evaluate__(fit, __begin, __end, args...);
189  }
190 
191  DEBUG("Hesse matrix:" << endl);
192  DEBUG(V << endl);
193 
194 
195  // force definite positiveness
196 
197  for (int i = 0; i != N; ++i) {
198 
199  if (V(i,i) < PIVOT) {
200  V(i,i) = PIVOT;
201  }
202 
203  h[i] = 1.0 / sqrt(V(i,i));
204  }
205 
206 
207  // normalisation
208 
209  for (int i = 0; i != N; ++i) {
210  for (int j = 0; j != i; ++j) {
211  V(j,i) *= h[i] * h[j];
212  V(i,j) = V(j,i);
213  }
214  }
215 
216  for (int i = 0; i != N; ++i) {
217  V(i,i) = 1.0 + lambda;
218  }
219 
220 
221  try {
222  V.invert();
223  }
224  catch (const JException& error) {
225  ERROR("JGandalf: " << error.what() << endl);
226  return precessor;
227  }
228 
229 
230  for (int i = 0; i != N; ++i) {
231 
232  DEBUG("u[" << noshowpos << i << "] = " << showpos << FIXED(15,5) << alias(value, parameters[i]));
233 
234  for (int j = 0; j != N; ++j) {
235  alias(value, parameters[i]) -= V(i,j) * alias(successor.gradient, parameters[j]) * h[i] * h[j];
236  }
237 
238  DEBUG(' ' << FIXED(15,5) << alias(value, parameters[i]) << noshowpos << endl);
239 
240  alias(error, parameters[i]) = h[i];
241  }
242  }
243 
244  return precessor;
245  }
static double EPSILON
maximal distance to minimum
Definition: JGandalf.hh:249
static double PIVOT
minimal value diagonal element of matrix
Definition: JGandalf.hh:254
static double alias(const JPoint4D &model, double JPoint4D::*parameter)
Read/write access to parameter value by data member.
Definition: JGandalf.hh:327
JMATH::JMatrixNS V
Definition: JGandalf.hh:261
static const JZero zero
Function object to assign zero value.
Definition: JZero.hh:105
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:445
std::vector< parameter_type > parameters
Definition: JGandalf.hh:259
void resize(const size_t size)
Resize matrix.
Definition: JMatrixND.hh:362
static double LAMBDA_MIN
minimal value control parameter
Definition: JGandalf.hh:250
static double LAMBDA_DOWN
multiplication factor control parameter
Definition: JGandalf.hh:253
#define ERROR(A)
Definition: JMessage.hh:66
static double LAMBDA_UP
multiplication factor control parameter
Definition: JGandalf.hh:252
void invert()
Invert matrix according LDU decomposition.
Definition: JMatrixNS.hh:80
void __evaluate__(const JFunction_t &fit, T __begin, T __end, Args...args)
Recursive method for evaluation of fit.
Definition: JGandalf.hh:288
static int MAXIMUM_ITERATIONS
maximal number of iterations
Definition: JGandalf.hh:248
int j
Definition: JPolint.hh:666
static double LAMBDA_MAX
maximal value control parameter
Definition: JGandalf.hh:251
then usage $script[input file[working directory[option]]] nWhere option can be N
Definition: JMuonPostfit.sh:37
#define DEBUG(A)
Message macros.
Definition: JMessage.hh:62
std::vector< double > h
Definition: JGandalf.hh:400

Member Data Documentation

JTimeRange JFIT::JRegressor< JPoint4D, JGandalf >::T_ns
static

Time window with respect to Cherenkov hypothesis [ns].

Default values.

Definition at line 262 of file JShowerBrightPointRegressor.hh.

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

Maximal integral of PDF [npe].

Definition at line 263 of file JShowerBrightPointRegressor.hh.

const int JFIT::JRegressor< JPoint4D, JGandalf >::NUMBER_OF_PDFS = 2
static

Definition at line 265 of file JShowerBrightPointRegressor.hh.

const JPDFType_t JFIT::JRegressor< JPoint4D, JGandalf >::pdf_t
static
Initial value:

PDF types.

Definition at line 267 of file JShowerBrightPointRegressor.hh.

PDF.

Definition at line 269 of file JShowerBrightPointRegressor.hh.

double JFIT::JRegressor< JPoint4D, JGandalf >::E_GeV

Energy of the shower [GeV].

Definition at line 271 of file JShowerBrightPointRegressor.hh.

int JFIT::JGandalf< JPoint4D >::MAXIMUM_ITERATIONS
staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 248 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::EPSILON
staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 249 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::LAMBDA_MIN
staticinherited

minimal value control parameter

Definition at line 250 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::LAMBDA_MAX
staticinherited

maximal value control parameter

Definition at line 251 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::LAMBDA_UP
staticinherited

multiplication factor control parameter

Definition at line 252 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::LAMBDA_DOWN
staticinherited

multiplication factor control parameter

Definition at line 253 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::PIVOT
staticinherited

minimal value diagonal element of matrix

Definition at line 254 of file JGandalf.hh.

double JFIT::JGandalf< JPoint4D >::lambda
inherited

Definition at line 256 of file JGandalf.hh.

JPoint4D JFIT::JGandalf< JPoint4D >::value
inherited

Definition at line 257 of file JGandalf.hh.

JPoint4D JFIT::JGandalf< JPoint4D >::error
inherited

Definition at line 258 of file JGandalf.hh.

Definition at line 259 of file JGandalf.hh.

int JFIT::JGandalf< JPoint4D >::numberOfIterations
inherited

Definition at line 260 of file JGandalf.hh.

Definition at line 261 of file JGandalf.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: