Jpp  18.0.0-rc.1
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
JFIT::JRegressor< JEnergy, JSimplex > Struct Template Reference

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

#include <JShowerEnergyRegressor.hh>

Inheritance diagram for JFIT::JRegressor< JEnergy, JSimplex >:
JFIT::JAbstractRegressor< JEnergy, JSimplex > JFIT::JSimplex< JEnergy > JEEP::JMessage< T >

Public Types

typedef JTOOLS::JSplineFunction1S_t JFunction1D_t
 
typedef JTOOLS::JMAPLIST
< JTOOLS::JPolint1FunctionalMap,
JTOOLS::JPolint1FunctionalGridMap >
::maplist 
JMapList_t
 
typedef JPHYSICS::JPDFTable
< JFunction1D_t, JMapList_t
JPDF_t
 
typedef JPHYSICS::JNPETable
< double, double, JMapList_t
JNPE_t
 
typedef JSimplex< JEnergyminimiser_type
 
typedef JRegressor< JEnergy,
JSimplex
regressor_type
 
typedef minimiser_type::result_type result_type
 

Public Member Functions

 JRegressor (const std::string &fileDescriptor)
 Parameterized constructor. More...
 
double operator() (const JEnergy &x, const JShowerNPEHit &npe) const
 Fit function. More...
 
JShowerNPE getNPE (const JAxis3D &axis, const double R_Hz) const
 Create data structure for handling light yields for PMT. More...
 
result_type operator() (const JEnergy &value, T __begin, T __end)
 Global fit. More...
 
double operator() (const JFunction_t &fit, T __begin, T __end)
 Multi-dimensional fit. More...
 
double operator() (const JFunction_t &fit, T __begin, T __end, const JEnergy &step)
 1D fit. More...
 

Static Public Member Functions

static double getNPE (const std::vector< JNPE_t > &NPE, const double D, const double cd)
 Get number of photo-electrons. More...
 

Public Attributes

std::vector< JNPE_tY
 light from EM showers More...
 
JLANG::JSharedPointer
< JMEstimator
estimator
 M-Estimator function. More...
 
JEnergy value
 
std::vector< JEnergystep
 
int numberOfIterations
 

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 int debug = 0
 debug level (default is off). More...
 

Detailed Description

template<>
struct JFIT::JRegressor< JEnergy, JSimplex >

Regressor function object for JShower3EZ fit using JSimplex minimiser.

Definition at line 50 of file JShowerEnergyRegressor.hh.

Member Typedef Documentation

Definition at line 55 of file JShowerEnergyRegressor.hh.

Definition at line 57 of file JShowerEnergyRegressor.hh.

Definition at line 58 of file JShowerEnergyRegressor.hh.

Definition at line 60 of file JShowerEnergyRegressor.hh.

Definition at line 78 of file JRegressor.hh.

Definition at line 79 of file JRegressor.hh.

Definition at line 80 of file JRegressor.hh.

Constructor & Destructor Documentation

JFIT::JRegressor< JEnergy, JSimplex >::JRegressor ( const std::string fileDescriptor)
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 listed in JRegressor<JEnergy, JSimplex>::pdf_t.

Parameters
fileDescriptorPDF file descriptor

Definition at line 71 of file JShowerEnergyRegressor.hh.

71  :
73  {
74  using namespace std;
75  using namespace JPP;
76 
77 
78  const JPDF_t::JSupervisor supervisor(new JPDF_t::JDefaultResult(JMATH::zero));
79 
80  for (int i = 0; i != NUMBER_OF_PDFS; ++i) {
81 
82  try {
83 
84  JPDF_t pdf;
85 
86  const string file_name = getFilename(fileDescriptor, pdf_t[i]);
87 
88  NOTICE("loading PDF from file " << file_name << "... " << flush);
89 
90  pdf.load(file_name.c_str());
91 
92  NOTICE("OK" << endl);
93 
94  pdf.setExceptionHandler(supervisor);
95 
96  Y.push_back(JNPE_t(pdf));
97  }
98  catch(const JException& error) {
99  FATAL(error.what() << endl);
100  }
101  }
102 
103  // Add PDFs
104 
105  for (int i = 1; i < NUMBER_OF_PDFS; i += 2) {
106  Y[i].add(Y[i-1]);
107  }
108 
109  Y.erase(Y.begin());
110  }
Null M-estimator.
Definition: JMEstimator.hh:92
std::vector< JNPE_t > Y
light from EM showers
static const JZero zero
Function object to assign zero value.
Definition: JZero.hh:105
static const JPDFType_t pdf_t[NUMBER_OF_PDFS]
PDF types.
#define NOTICE(A)
Definition: JMessage.hh:64
#define FATAL(A)
Definition: JMessage.hh:67
JPHYSICS::JNPETable< double, double, JMapList_t > JNPE_t
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:128
JLANG::JSharedPointer< JMEstimator > estimator
M-Estimator function.
JPHYSICS::JPDFTable< JFunction1D_t, JMapList_t > JPDF_t

Member Function Documentation

double JFIT::JRegressor< JEnergy, JSimplex >::operator() ( const JEnergy x,
const JShowerNPEHit npe 
) const
inline

Fit function.

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

Parameters
xenergy
npenumber of photoelectrons
Returns
chi2

Definition at line 120 of file JShowerEnergyRegressor.hh.

121  {
122  using namespace JPP;
123 
124  const double E = x.getE();
125  const double u = npe.getChi2(E);
126 
127  return estimator->getRho(u);
128  }
double getE() const
Get energy.
Definition: JEnergy.hh:170
double getChi2(const double E_GeV) const
Get chi2.
then usage $script< input file >[option[primary[working directory]]] nWhere option can be E
Definition: JMuonPostfit.sh:36
double u[N+1]
Definition: JPolint.hh:776
JLANG::JSharedPointer< JMEstimator > estimator
M-Estimator function.
JShowerNPE JFIT::JRegressor< JEnergy, JSimplex >::getNPE ( const JAxis3D axis,
const double  R_Hz 
) const
inline

Create data structure for handling light yields for PMT.

Parameters
axisPMT axis
R_Hzsingles rate [Hz]
Returns
light yields

Definition at line 137 of file JShowerEnergyRegressor.hh.

139  {
140  using namespace JPP;
141 
142  const JPosition3D D(axis.getPosition());
143  const JDirection3D U(axis.getDirection());
144 
145  const double U_length = std::sqrt(U.getDX()*U.getDX() +
146  U.getDY()*U.getDY() +
147  U.getDZ()*U.getDZ());
148 
149  const double ct = U.getDot(D) / (D.getLength()*U_length);
150 
151  const double y = getNPE(Y, D.getLength(), ct);
152 
153  return JShowerNPE(getN(T_ns, R_Hz * 1.0e-9), y);
154  }
double getN(const JRange< T > &range, const double R)
Get expected number of occurrences due to given rate within specified interval.
Definition: JRange.hh:704
std::vector< JNPE_t > Y
light from EM showers
JShowerNPE getNPE(const JAxis3D &axis, const double R_Hz) const
Create data structure for handling light yields for PMT.
static JTimeRange T_ns
Time window with respect to Cherenkov hypothesis [ns].
Auxiliary class for handling EM shower light yield.
Definition: JShowerNPE.hh:25
do echo Generating $dir eval D
Definition: JDrawLED.sh:53
static double JFIT::JRegressor< JEnergy, JSimplex >::getNPE ( const std::vector< JNPE_t > &  NPE,
const double  D,
const double  cd 
)
inlinestatic

Get number of photo-electrons.

Parameters
NPENPE tables
DPMT distance from shower [m]
cdcosine of the PMT angle wrt the photon direction
Returns
number of photo-electrons

Definition at line 165 of file JShowerEnergyRegressor.hh.

168  {
169  double npe = 0.0;
170 
171  for (std::vector<JNPE_t>::const_iterator i = NPE.begin(); i != NPE.end(); ++i) {
172 
173  if (D <= i->getXmax()) {
174 
175  try {
176 
177  const double y = get_value((*i)(std::max(D, i->getXmin()), cd));
178 
179  if (y > 0.0) {
180  npe += y;
181  }
182  }
183  catch(const JLANG::JException& error) {
184  ERROR(error << std::endl);
185  }
186  }
187  }
188 
189  return npe;
190  }
General exception.
Definition: JException.hh:23
#define ERROR(A)
Definition: JMessage.hh:66
do echo Generating $dir eval D
Definition: JDrawLED.sh:53
JResultEvaluator< JResult_t >::result_type get_value(const JResult_t &value)
Helper method to recursively evaluate a to function value.
Definition: JResult.hh:998
result_type JFIT::JAbstractRegressor< JEnergy , JSimplex >::operator() ( const JEnergy 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  }
JRegressor< JEnergy, JSimplex > regressor_type
Definition: JRegressor.hh:79
JModel_t value
Definition: JSimplex.hh:240
double JFIT::JSimplex< JEnergy >::operator() ( const JFunction_t &  fit,
T  __begin,
T  __end 
)
inlineinherited

Multi-dimensional fit.

The given fit function should return the equivalent of chi2 for the current value of the given model and a given data point.

Parameters
fitfit function
__beginbegin of data
__endend of data
Returns
chi2

Definition at line 71 of file JSimplex.hh.

72  {
73  using namespace std;
74  using namespace JPP;
75 
76  double chi2_old = evaluate(fit, __begin, __end);
77 
78  const int N = step.size();
79 
80  if (N != 0) {
81 
82  p0 = value;
83  p1 = value;
84  wall = value;
85 
86  double chi2[N];
87 
89 
91 
92  DEBUG("old: " << FIXED(12,5) << chi2_old << endl);
93 
94  p0 = value;
95 
96  for (int i = 0; i != N; ++i) {
97 
98  DEBUG("step: " << i << ' ' << setw(5) << numberOfIterations << endl);
99 
100  chi2[i] = (*this)(fit, __begin, __end, step[i]);
101  }
102 
103  // overall step direction of last iteration
104 
105  wall = value;
106  wall -= p0;
107 
108  const double chi2_new = (*this)(fit, __begin, __end, wall);
109 
110  DEBUG("new: " << FIXED(12,5) << chi2_new << endl);
111 
112 
113  if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
114  return chi2_new;
115  }
116 
117  // double overall step
118 
119  wall = value;
120  wall -= p0;
121  value += wall;
122 
123  const double fe = evaluate(fit, __begin, __end);
124 
125  value -= wall;
126 
127 
128  for (int i = N-1; i != 0; --i) {
129  chi2[i] = chi2[i-1] - chi2[i];
130  }
131 
132  chi2[0] = chi2_old - chi2[0];
133 
134 
135  double df = 0.0;
136 
137  for (int i = 0; i != N; ++i) {
138  if (chi2[i] > df) {
139  df = chi2[i];
140  }
141  }
142 
143  const double fn = chi2_new;
144  const double f0 = chi2_old;
145  const double ff = f0 - fn - df;
146 
147  // shift step directions
148 
149  if (fe < f0 && 2.0*(f0 - 2.0*fn + fe)*ff*ff < (f0-fe)*(f0-fe)*df) {
150 
151  for (int i = 0; i != N - 1; ++i) {
152  step[i] = step[i+1];
153  }
154 
155  step[N-1] = wall;
156  }
157 
158  chi2_old = chi2_new;
159  }
160  }
161 
162  return chi2_old;
163  }
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:446
then usage $script< input file >[option[primary[working directory]]] nWhere option can be N
Definition: JMuonPostfit.sh:36
then if[[!-f $DETECTOR]] then JDetector sh $DETECTOR fi cat $WORKDIR trigger_parameters txt<< EOFtrigger3DMuon.enabled=1;trigger3DMuon.numberOfHits=5;trigger3DMuon.gridAngle_deg=1;ctMin=0.0;TMaxLocal_ns=15.0;EOF set_variable TRIGGEREFFICIENCY_TRIGGERED_EVENTS_ONLY INPUT_FILES=() for((i=1;$i<=$NUMBER_OF_RUNS;++i));do JSirene.sh $DETECTOR $JPP_DATA/genhen.km3net_wpd_V2_0.evt.gz $WORKDIR/sirene_ ${i}.root JTriggerEfficiency.sh $DETECTOR $DETECTOR $WORKDIR/sirene_ ${i}.root $WORKDIR/trigger_efficiency_ ${i}.root $WORKDIR/trigger_parameters.txt $JPP_DATA/PMT_parameters.txt INPUT_FILES+=($WORKDIR/trigger_efficiency_ ${i}.root) done for ANGLE_DEG in $ANGLES_DEG[*];do set_variable SIGMA_NS 3.0 set_variable OUTLIERS 3 set_variable OUTPUT_FILE $WORKDIR/matrix\[${ANGLE_DEG}\deg\].root $JPP_DIR/examples/JReconstruction-f"$INPUT_FILES[*]"-o $OUTPUT_FILE-S ${SIGMA_NS}-A ${ANGLE_DEG}-O ${OUTLIERS}-d ${DEBUG}--!fiif[[$OPTION=="plot"]];then if((0));then for H1 in h0 h1;do JPlot1D-f"$WORKDIR/matrix["${^ANGLES_DEG}" deg].root:${H1}"-y"1 2e3"-Y-L TR-T""-\^"number of events [a.u.]"-> o chi2
Definition: JMatrixNZ.sh:106
double evaluate(const JFunction_t &fit, T __begin, T __end) const
Evaluate chi2 for given data set.
Definition: JSimplex.hh:253
static int MAXIMUM_ITERATIONS
maximal number of iterations
Definition: JSimplex.hh:237
static double EPSILON
maximal distance to minimum
Definition: JSimplex.hh:238
#define DEBUG(A)
Message macros.
Definition: JMessage.hh:62
std::vector< JEnergy > step
Definition: JSimplex.hh:241
double JFIT::JSimplex< JEnergy >::operator() ( const JFunction_t &  fit,
T  __begin,
T  __end,
const JEnergy step 
)
inlineinherited

1D fit.

The given fit function should return the equivalent of chi2 for the current value of the given model and a given data point.

Parameters
fitfit function
__beginbegin of data
__endend of data
stepstep direction

Definition at line 178 of file JSimplex.hh.

179  {
180  using namespace std;
181  using namespace JPP;
182 
183  double lambda = 0.5; // control parameter
184  double factor = 1.0; // multiplication factor
185 
186  double chi2_old = evaluate(fit, __begin, __end);
187 
188  for (int i = 0; numberOfIterations != MAXIMUM_ITERATIONS; ++numberOfIterations, ++i) {
189 
190  p1 = step;
191  p1 *= lambda;
192  value += p1;
193 
194  const double chi2_new = evaluate(fit, __begin, __end);
195 
196  DEBUG("step: " << setw(3) << i << ' ' << FIXED(12,5) << chi2_old << ' ' << FIXED(12,5) << chi2_new << ' ' << FIXED(5,2) << lambda << endl);
197 
198  if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
199 
200  if (chi2_new > chi2_old) {
201 
202  p1 = step;
203  p1 *= lambda;
204  value -= p1; // undo last step
205 
206  return chi2_old;
207 
208  } else {
209 
210  return chi2_new;
211  }
212  }
213 
214  if (chi2_new < chi2_old) {
215 
216  chi2_old = chi2_new;
217 
218  } else {
219 
220  p1 = step;
221  p1 *= lambda;
222  value -= p1; // step back
223  lambda = -lambda; // change direction
224 
225  if (i != 0) {
226  factor = 0.5; // reduce step size
227  }
228  }
229 
230  lambda = factor * lambda;
231  }
232 
233  return chi2_old;
234  }
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:446
double evaluate(const JFunction_t &fit, T __begin, T __end) const
Evaluate chi2 for given data set.
Definition: JSimplex.hh:253
static int MAXIMUM_ITERATIONS
maximal number of iterations
Definition: JSimplex.hh:237
static double EPSILON
maximal distance to minimum
Definition: JSimplex.hh:238
#define DEBUG(A)
Message macros.
Definition: JMessage.hh:62
std::vector< JEnergy > step
Definition: JSimplex.hh:241

Member Data Documentation

JTimeRange JFIT::JRegressor< JEnergy, JSimplex >::T_ns
static

Time window with respect to Cherenkov hypothesis [ns].

Default values.

Definition at line 193 of file JShowerEnergyRegressor.hh.

double JFIT::JRegressor< JEnergy, JSimplex >::Vmax_npe = std::numeric_limits<double>::max()
static

Maximal integral of PDF [npe].

Definition at line 194 of file JShowerEnergyRegressor.hh.

const int JFIT::JRegressor< JEnergy, JSimplex >::NUMBER_OF_PDFS = 2
static

Definition at line 196 of file JShowerEnergyRegressor.hh.

const JPDFType_t JFIT::JRegressor< JEnergy, JSimplex >::pdf_t
static
Initial value:

PDF types.

Definition at line 198 of file JShowerEnergyRegressor.hh.

light from EM showers

Definition at line 200 of file JShowerEnergyRegressor.hh.

M-Estimator function.

Definition at line 202 of file JShowerEnergyRegressor.hh.

int JFIT::JSimplex< JEnergy >::MAXIMUM_ITERATIONS
staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 237 of file JSimplex.hh.

double JFIT::JSimplex< JEnergy >::EPSILON
staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 238 of file JSimplex.hh.

JEnergy JFIT::JSimplex< JEnergy >::value
inherited

Definition at line 240 of file JSimplex.hh.

std::vector<JEnergy > JFIT::JSimplex< JEnergy >::step
inherited

Definition at line 241 of file JSimplex.hh.

int JFIT::JSimplex< JEnergy >::numberOfIterations
inherited

Definition at line 242 of file JSimplex.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: