Template specialisation of fit function of acoustic model based on JSimplex minimiser. More...

#include <JKatoomba_t.hh>

Inheritance diagram for JACOUSTICS::JKatoomba< JSimplex >:

Public Types
typedef double	result_type

Public Member Functions
	JKatoomba (const JGeometry &geometry, const JSoundVelocity &velocity, const int option)
	Constructor The option corresponds to the use of fit parameters in the model of the detector geometry. More...

double	operator() (const JModel &model, const JHit &hit) const
	Fit function. More...

template<class T >
double	operator() (T __begin, T __end)
	Fit. More...

template<class JFunction_t , class T >
double	operator() (const JFunction_t &fit, T __begin, T __end)
	Multi-dimensional fit. More...

template<class JFunction_t , class T >
double	operator() (const JFunction_t &fit, T __begin, T __end, const JModel_t &step)
	1D fit. More...

Public Attributes
JModel_t	value

std::vector< JModel_t >	step

int	numberOfIterations

Static Public Attributes
static int	MAXIMUM_ITERATIONS = 1000
	maximal number of iterations More...

static double	EPSILON = 1.0e-4
	maximal distance to minimum More...

static int	debug = 0
	debug level (default is off). More...

Private Member Functions
template<class JFunction_t , class T >
double	evaluate (const JFunction_t &fit, T __begin, T __end) const
	Evaluate chi2 for given data set. More...

Private Attributes
JModel_t	p0

JModel_t	p1

JModel_t	wall

Detailed Description

Template specialisation of fit function of acoustic model based on JSimplex minimiser.

Definition at line 583 of file JKatoomba_t.hh.

Member Typedef Documentation

◆ result_type

template<class JModel_t >

typedef double JFIT::JSimplex< JModel_t >::result_type

inherited

Definition at line 47 of file JSimplex.hh.

Constructor & Destructor Documentation

◆ JKatoomba()

JACOUSTICS::JKatoomba< JSimplex >::JKatoomba	(	const JGeometry &	geometry,
		const JSoundVelocity &	velocity,
		const int	option
	)

inline

Constructor The option corresponds to the use of fit parameters in the model of the detector geometry.

A negative implies that all strings in the detector use common fit parameters.

Parameters

geometry	detector geometry
velocity	sound velocity
option	option

Definition at line 596 of file JKatoomba_t.hh.

                                             :
       JKatoomba<>(geometry, velocity, option)
     {};

Member Function Documentation

◆ operator()() [1/4]

double JACOUSTICS::JKatoomba< JSimplex >::operator()	(	const JModel &	model,
		const JHit &	hit
	)		const

inline

Fit function.

This method is used to determine the chi2 of given hit with respect to actual model.

Parameters

model	model
hit	hit

Returns: chi2

Definition at line 611 of file JKatoomba_t.hh.

     {
       const double toa_s = this->getToA(model, hit);
       const double u     = (toa_s - hit.getValue()) / hit.getSigma();
  
       return estimator->getRho(u);
     }

◆ operator()() [2/4]

template<class T >

double JACOUSTICS::JKatoomba< JSimplex >::operator()	(	T	__begin,
		T	__end
	)

inline

Fit.

Parameters

__begin	begin of hits
__end	end of hits

Returns: chi2

Definition at line 628 of file JKatoomba_t.hh.

     {
       this->step.clear();
  
       for (JModel::string_type::const_iterator i = this->value.string.begin(); i != this->value.string.end(); ++i) {
  
         JModel model;
  
         switch (this->option) {
  
         case JMODEL::FIT_EMITTERS_AND_STRINGS_2nd_ORDER_AND_STRETCHING_t:
           model.string[i->first] = JMODEL::JString(0.0, 0.0, 0.0, 0.0, 1.0e-6);  this->step.push_back(model);
  
         case JMODEL::FIT_EMITTERS_AND_STRINGS_2nd_ORDER_t:
           model.string[i->first] = JMODEL::JString(0.0, 0.0, 1.0e-6, 0.0, 0.0);  this->step.push_back(model);
           model.string[i->first] = JMODEL::JString(0.0, 0.0, 0.0, 1.0e-6, 0.0);  this->step.push_back(model);
  
         case JMODEL::FIT_EMITTERS_AND_STRINGS_1st_ORDER_t:
           model.string[i->first] = JMODEL::JString(1.0e-3, 0.0, 0.0, 0.0, 0.0);  this->step.push_back(model);
           model.string[i->first] = JMODEL::JString(0.0, 1.0e-3, 0.0, 0.0, 0.0);  this->step.push_back(model);
           break;
           
         default:
           break;
         }
       }
       
       for (JModel::emission_type::const_iterator i = this->value.emission.begin(); i != this->value.emission.end(); ++i) {
  
         JModel model;
  
         model.emission[i->first] = JMODEL::JEmission(5.0e-5);                    this->step.push_back(model);
       }
  
       return JSimplex<JModel>::operator()(*this, __begin, __end);
     }

◆ operator()() [3/4]

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::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

fit	fit function
__begin	begin of data
__end	end of data

Returns: chi2

Definition at line 71 of file JSimplex.hh.

     {
       using namespace std;
       using namespace JPP;
  
       double chi2_old = evaluate(fit, __begin, __end);
  
       const int N = step.size();
  
       if (N != 0) {
  
         p0   = value;
         p1   = value;
         wall = value;
  
         double chi2[N];
  
         numberOfIterations = 0;
  
         while (numberOfIterations != MAXIMUM_ITERATIONS) {
  
           DEBUG("old: " << FIXED(12,5) << chi2_old << endl);
  
           p0 = value;
  
           for (int i = 0; i != N; ++i) {
  
             DEBUG("step: " << i << ' ' << setw(5) << numberOfIterations << endl);
  
             chi2[i] = (*this)(fit, __begin, __end, step[i]);
           }
  
           // overall step direction of last iteration
  
           wall  = value;
           wall -= p0;
  
           const double chi2_new = (*this)(fit, __begin, __end, wall);
  
           DEBUG("new: " << FIXED(12,5) << chi2_new << endl);
  
  
           if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
             return chi2_new;
           }
  
           // double overall step
  
           wall   = value;
           wall  -= p0;
           value += wall;
  
           const double fe = evaluate(fit, __begin, __end);
  
           value -= wall;
  
  
           for (int i = N-1; i != 0; --i) {
             chi2[i] = chi2[i-1] - chi2[i];
           }
  
           chi2[0] = chi2_old - chi2[0];
  
  
           double df = 0.0;
  
           for (int i = 0; i != N; ++i) {
             if (chi2[i] > df) {
               df = chi2[i];
             }
           }
  
           const double fn = chi2_new;
           const double f0 = chi2_old;
           const double ff = f0 - fn - df;
  
           // shift step directions
  
           if (fe < f0 && 2.0*(f0 - 2.0*fn + fe)*ff*ff < (f0-fe)*(f0-fe)*df) {
  
             for (int i = 0; i != N - 1; ++i) {
               step[i] = step[i+1];
             }
  
             step[N-1] = wall;
           }
  
           chi2_old = chi2_new;
         }
       }
  
       return chi2_old;
     }

◆ operator()() [4/4]

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end,
		const JModel_t &	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

fit	fit function
__begin	begin of data
__end	end of data
step	step direction

Definition at line 178 of file JSimplex.hh.

     {
       using namespace std;
       using namespace JPP;
  
       double lambda = 0.5;                                     // control parameter
       double factor = 1.0;                                     // multiplication factor
  
       double chi2_old = evaluate(fit, __begin, __end);
  
       for (int i = 0; numberOfIterations != MAXIMUM_ITERATIONS; ++numberOfIterations, ++i) {
  
         p1      = step;
         p1     *= lambda;
         value  += p1;
  
         const double chi2_new = evaluate(fit, __begin, __end);
  
         DEBUG("step: " << setw(3) << i << ' ' << FIXED(12,5) << chi2_old << ' ' << FIXED(12,5) << chi2_new << ' ' << FIXED(5,2) << lambda << endl);
  
         if (fabs(chi2_old - chi2_new) < EPSILON*fabs(chi2_old)) {
  
           if (chi2_new > chi2_old) {
  
             p1      = step;
             p1     *= lambda;
             value  -= p1;                                      // undo last step
  
             return chi2_old;
  
           } else {
  
             return chi2_new;
           }
         }
  
         if (chi2_new < chi2_old) {
  
           chi2_old = chi2_new;
  
         } else {
             
           p1      = step;
           p1     *= lambda;
           value  -=  p1;                                       // step back
           lambda  = -lambda;                                   // change direction
           
           if (i != 0) {
             factor = 0.5;                                      // reduce step size
           }
         }
         
         lambda = factor * lambda;
       }
  
       return chi2_old;
     }

◆ evaluate()

template<class JModel_t >

template<class JFunction_t , class T >

double JFIT::JSimplex< JModel_t >::evaluate	(	const JFunction_t &	fit,
		T	__begin,
		T	__end
	)		const

inlineprivateinherited

Evaluate chi2 for given data set.

Parameters

fit	fit function
__begin	begin of data
__end	end of data

Definition at line 253 of file JSimplex.hh.

     {
       double chi2 = 0.0;
  
       for (T hit = __begin; hit != __end; ++hit) {
         chi2 += fit(value, *hit);
       }
  
       return chi2;
     }

Member Data Documentation

◆ MAXIMUM_ITERATIONS

template<class JModel_t >

int JFIT::JSimplex< JModel_t >::MAXIMUM_ITERATIONS = 1000

staticinherited

maximal number of iterations

maximal number of iterations.

Definition at line 237 of file JSimplex.hh.

◆ EPSILON

template<class JModel_t >

double JFIT::JSimplex< JModel_t >::EPSILON = 1.0e-4

staticinherited

maximal distance to minimum

maximal distance to minimum.

Definition at line 238 of file JSimplex.hh.

◆ value

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::value

inherited

Definition at line 240 of file JSimplex.hh.

◆ step

template<class JModel_t >

std::vector<JModel_t> JFIT::JSimplex< JModel_t >::step

inherited

Definition at line 241 of file JSimplex.hh.

◆ numberOfIterations

template<class JModel_t >

int JFIT::JSimplex< JModel_t >::numberOfIterations

inherited

Definition at line 242 of file JSimplex.hh.

◆ p0

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::p0

mutableprivateinherited

Definition at line 264 of file JSimplex.hh.

◆ p1

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::p1

mutableprivateinherited

Definition at line 265 of file JSimplex.hh.

◆ wall

template<class JModel_t >

JModel_t JFIT::JSimplex< JModel_t >::wall

mutableprivateinherited

Definition at line 266 of file JSimplex.hh.

◆ debug

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:

JKatoomba_t.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ result_type

Constructor & Destructor Documentation

◆ JKatoomba()

Member Function Documentation

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ evaluate()

Member Data Documentation

◆ MAXIMUM_ITERATIONS

◆ EPSILON

◆ value

◆ step

◆ numberOfIterations

◆ p0

◆ p1

◆ wall

◆ debug