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

#include <JKatoomba.hh>

Inheritance diagram for JACOUSTICS::JKatoomba< JAbstractMinimiser >:

Public Types
typedef double	result_type

typedef JKey_t	key_type

typedef JValue_t	mapped_type

typedef std::pair< JKey_t, JValue_t >	value_type

typedef JHashMapEvaluator < JEvaluator_t >	evaluator_type

typedef JHashCollection < value_type, evaluator_type >	collection_type

typedef collection_type::container_type	container_type

typedef container_type::const_iterator	const_iterator

typedef container_type::const_reverse_iterator	const_reverse_iterator

typedef container_type::iterator	iterator

typedef container_type::reverse_iterator	reverse_iterator

Public Member Functions
	JKatoomba (const JDetector &detector, const JSoundVelocity &velocity)
	Constructor. More...

template<class JPDF_t >
result_type	operator() (const JModel &model, const JHit< JPDF_t > &hit) const
	Fit function. More...

template<class T >
result_type	operator() (const JModel &model, T __begin, T __end)
	Fit. More...

template<class JFunction_t , class T >
result_type	operator() (const JFunction_t &fit, T __begin, T __end)
	Get chi2. More...

template<class JPDF_t >
double	getToA (const JModel &model, const JHit< JPDF_t > &hit) const
	Get estimated time-of-arrival for given hit. More...

bool	hasString (int string) const
	Check if this detector has given string. More...

bool	hasLocation (const JLocation &location) const
	Check if this detector has given location. More...

virtual void	clear () override
	Clear. More...

virtual mapped_type &	get (typename JClass< key_type >::argument_type key) override
	Get mapped value. More...

virtual const mapped_type &	get (typename JClass< key_type >::argument_type key) const override
	Get mapped value. More...

value_type &	get (const T &value)
	Get element with given value. More...

const value_type &	get (const T &value) const
	Get element with given value. More...

void	swap (JHashCollection &collection)
	Swap hash collection. More...

const_iterator	find (const T &value) const
	Find element with given value. More...

iterator	find (const T &value)
	Find element with given value. More...

virtual bool	insert (const value_type &element)
	Insert element. More...

void	insert (T __begin, T __end)
	Insert values. More...

void	erase (iterator pos)
	Erase element at given position. More...

void	erase (iterator __begin, iterator __end)
	Erase elements in given range. More...

bool	erase (const T &value)
	Erase element with given value. More...

bool	has (const T &value) const
	Test whether given value is present. More...

int	getIndex (const T &value) const
	Get index of given value. More...

const mapped_type &	operator[] (typename JClass< key_type >::argument_type key) const
	Get mapped value. More...

mapped_type &	operator[] (typename JClass< key_type >::argument_type key)
	Get mapped value. More...

void	put (typename JClass< key_type >::argument_type key, typename JClass< mapped_type >::argument_type value)
	Put pair-wise element (key,value) into collection. More...

Static Public Member Functions
static bool	getOption ()
	Get fit option. More...

static void	setOption (const bool option)
	Set fit option. More...

Public Attributes
JModel_t	value
	model value More...

const JDetector &	detector

JSoundVelocity	velocity

JLANG::JSharedPointer < JMEstimator >	estimator
	M-Estimator function. More...

JHashMapEvaluator< JEvaluator_t >	getValue
	Function object for evaluation of element. More...

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

Static Protected Member Functions
static bool &	get_option ()
	Get reference to fit option. More...

Protected Attributes
JTOOLS::JHashCollection::router_type	router

Detailed Description

template<>
struct JACOUSTICS::JKatoomba< JAbstractMinimiser >

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

This class can be used to evaluate the chi2.

Definition at line 226 of file JKatoomba.hh.

Member Typedef Documentation

typedef double JACOUSTICS::JKatoomba< JAbstractMinimiser >::result_type

Definition at line 230 of file JKatoomba.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JKey_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::key_type

inherited

Definition at line 78 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JValue_t JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::mapped_type

inherited

Definition at line 79 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef std::pair<JKey_t, JValue_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::value_type

inherited

Definition at line 80 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JHashMapEvaluator<JEvaluator_t> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::evaluator_type

inherited

Definition at line 81 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef JHashCollection<value_type, evaluator_type> JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::collection_type

inherited

Definition at line 83 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef collection_type::container_type JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::container_type

inherited

Definition at line 84 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_iterator

inherited

Definition at line 86 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::const_reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::const_reverse_iterator

inherited

Definition at line 87 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::iterator

inherited

Definition at line 88 of file JHashMap.hh.

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

typedef container_type::reverse_iterator JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::reverse_iterator

inherited

Definition at line 89 of file JHashMap.hh.

Constructor & Destructor Documentation

JACOUSTICS::JKatoomba< JAbstractMinimiser >::JKatoomba	(	const JDetector &	detector,
		const JSoundVelocity &	velocity
	)

inline

Constructor.

Parameters

detector	detector
velocity	sound velocity

Definition at line 239 of file JKatoomba.hh.

                                               :
       JKatoomba_t(detector, velocity)
     {};

Member Function Documentation

template<class JPDF_t >

result_type JACOUSTICS::JKatoomba< JAbstractMinimiser >::operator()	(	const JModel &	model,
		const JHit< JPDF_t > &	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 and gradient

Definition at line 254 of file JKatoomba.hh.

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

template<class T >

result_type JACOUSTICS::JKatoomba< JAbstractMinimiser >::operator()	(	const JModel &	model,
		T	__begin,
		T	__end
	)

inline

Fit.

Parameters

model	model
__begin	begin of hits
__end	end of hits

Returns: chi2

Definition at line 272 of file JKatoomba.hh.

     {
       this->value = model;
 
       return JAbstractMinimiser<JModel>::operator()(*this, __begin, __end);
     }

template<class JModel_t>

template<class JFunction_t , class T >

result_type JFIT::JAbstractMinimiser< JModel_t >::operator()	(	const JFunction_t &	fit,
		T	__begin,
		T	__end
	)

inlineinherited

Get chi2.

Parameters

fit	fit function
__begin	begin of data
__end	end of data

Returns: chi2

Definition at line 46 of file JRegressor.hh.

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

template<class JPDF_t >

double JACOUSTICS::JKatoomba_t::getToA	(	const JModel &	model,
		const JHit< JPDF_t > &	hit
	)		const

inlineinherited

Get estimated time-of-arrival for given hit.

Parameters

model	model
hit	hit

Returns: time-of-arrival

Definition at line 78 of file JKatoomba.hh.

     {
       const JGEOMETRY::JString& string     = detector[hit.getString()];
       const JMODEL   ::JString& parameters = model.string[hit.getString()];
       const JPosition3D         position   = string.getPosition(parameters, hit.getFloor());
 
       const double D     = hit.getDistance(position);
       const double Vi    = velocity.getInverseVelocity(D, hit.getZ(), position.getZ());
 
       return model.emitter[hit.getEKey()].t1  +  D * Vi;
     }

static bool JACOUSTICS::JKatoomba_t::getOption ( )

inlinestaticinherited

Get fit option.

Returns: option

Definition at line 102 of file JKatoomba.hh.

     {
       return get_option();
     }

static void JACOUSTICS::JKatoomba_t::setOption ( const bool option )

inlinestaticinherited

Set fit option.

Parameters

option option

Definition at line 113 of file JKatoomba.hh.

     {
       get_option() = option;
     }

static bool& JACOUSTICS::JKatoomba_t::get_option ( )

inlinestaticprotectedinherited

Get reference to fit option.

Returns: option

Definition at line 124 of file JKatoomba.hh.

     {
       static bool option = true;
 
       return option;
     }

bool JACOUSTICS::JGEOMETRY::JDetector::hasString ( int string ) const

inlineinherited

Check if this detector has given string.

Parameters

string string

Returns: true if string present; else false

Definition at line 468 of file JGeometry.hh.

       {
         return this->has(string);
       }

bool JACOUSTICS::JGEOMETRY::JDetector::hasLocation ( const JLocation & location ) const

inlineinherited

Check if this detector has given location.

Parameters

location location

Returns: true if location present; else false

Definition at line 480 of file JGeometry.hh.

       {
         return this->hasString(location.getString()) && (*this)[location.getString()].hasFloor(location.getFloor());
       }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual void JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::clear ( )

inlineoverridevirtualinherited

Clear.

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 107 of file JHashMap.hh.

     {
       collection_type::clear();
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key )

inlineoverridevirtualinherited

Get mapped value.

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 119 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
       
       if (!this->router.has(ival)) {
         collection_type::insert(value_type(key, mapped_type()));
       }
 
       return container_type::operator[](this->router.get(ival)).second;
     }

template<class JKey_t, class JValue_t, class JEvaluator_t = JHashEvaluator>

virtual const mapped_type& JTOOLS::JHashMap< JKey_t, JValue_t, JEvaluator_t >::get ( typename JClass< key_type >::argument_type key ) const

inlineoverridevirtualinherited

Get mapped value.

This method will throw an exception if given key is not present following the prerequisite of constness.

Parameters

key key

Returns: mapped value

Implements JTOOLS::JMappableCollection< JKey_t, JValue_t >.

Definition at line 139 of file JHashMap.hh.

     {
       const int ival = this->getValue(key);
 
       if (this->router.has(ival))
         return container_type::operator[](this->router.get(ival)).second;
       else
         THROW(JIndexOutOfRange, "JHasMap::get(): invalid key " << STREAM("?") << key);
     }

value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::get ( const T & value )

inlineinherited

Get element with given value.

This method will throw an exception if given value is not present following the prerequisite of constness.

Parameters

value value

Returns: element

Definition at line 176 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
 
       if (!router.has(ival)) {
         this->insert(value);
       }
 
       return container_type::operator[](router.get(ival)).second;
     }

const value_type& JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::get ( const T & value ) const

inlineinherited

Get element with given value.

This method will throw an exception if given value is not present following the prerequisite of constness.

Parameters

value value

Returns: element

Definition at line 197 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
 
       if (router.has(ival)) {
         return container_type::operator[](router.get(ival)).second;
       }
 
       THROW(JIndexOutOfRange, "JHasCollection::get(): invalid value.");
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::swap ( JHashCollection< std::pair< JKey_t, JValue_t >, JHashMapEvaluator< JEvaluator_t > > & collection )

inlineinherited

Swap hash collection.

Parameters

collection hash collection

Definition at line 123 of file JHashCollection.hh.

     {
       router.swap(collection.router);
 
       container_type::swap(collection);
     }

const_iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::find ( const T & value ) const

inlineinherited

Find element with given value.

Parameters

value value

Returns: position of element with given value or end()

Definition at line 138 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
 
       if (router.has(ival))
         return this->begin() + router.get(ival);
       else
         return this->end();
     }

iterator JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::find ( const T & value )

inlineinherited

Find element with given value.

Parameters

value value

Returns: position of element with given value or end()

Definition at line 156 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
 
       if (router.has(ival))
         return this->begin() + router.get(ival);
       else
         return this->end();
     }

virtual bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::insert ( const value_type & element )

inlinevirtualinherited

Insert element.

Parameters

element element

Returns: true if inserted; else false

Definition at line 215 of file JHashCollection.hh.

     {
       const int ival = this->getValue(element);
 
       if (!router.has(ival)) {
         
         container_type::push_back(element);
 
         router.put(ival, this->size() - 1);
 
         return true;
       }
 
       return false;
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::insert	(	T	__begin,
		T	__end
	)

inlineinherited

Insert values.

Parameters

__begin	begin of values
__end	end of values

Definition at line 239 of file JHashCollection.hh.

     {
       for (T i = __begin; i != __end; ++i) {
         insert(*i);
       }
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::erase ( iterator pos )

inlineinherited

Erase element at given position.

Parameters

pos	valid position

Definition at line 252 of file JHashCollection.hh.

     {
       router.put(this->getValue(*pos), router.getDefaultAddress());
 
       for (iterator i = container_type::erase(pos); i != this->end(); ++i) {
         router.put(this->getValue(*i), distance(this->begin(), i));
       }
     }

void JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::erase	(	iterator	__begin,
		iterator	__end
	)

inlineinherited

Erase elements in given range.

Parameters

__begin	begin position (included)
__end	end position (excluded)

Definition at line 268 of file JHashCollection.hh.

     {
       for (iterator i = __begin; i != __end; ++i) {
         router.put(this->getValue(*i), router.getDefaultAddress());
       }
 
       for (iterator i = container_type::erase(__begin, __end); i != this->end(); ++i) {
         router.put(this->getValue(*i), distance(this->begin(), i));
       }
     }

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::erase ( const T & value )

inlineinherited

Erase element with given value.

Parameters

value value

Returns: true if element has been erased; else false

Definition at line 287 of file JHashCollection.hh.

     {
       const int ival = this->getValue(value);
 
       if (router.has(ival)) {
 
         this->erase(this->begin() + router.get(ival)); 
 
         return true;
       }
 
       return false;
     }

bool JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::has ( const T & value ) const

inlineinherited

Test whether given value is present.

Parameters

value value

Returns: true if present; else false

Definition at line 309 of file JHashCollection.hh.

     {
       return router.has(this->getValue(value));
     }

int JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::getIndex ( const T & value ) const

inlineinherited

Get index of given value.

Parameters

value value

Returns: indecx

Definition at line 322 of file JHashCollection.hh.

     {
       return router.get(this->getValue(value));
     }

template<class JKey_t, class JValue_t>

const mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key ) const

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 73 of file JMappableCollection.hh.

     {
       return get(key);
     }

template<class JKey_t, class JValue_t>

mapped_type& JTOOLS::JMappableCollection< JKey_t, JValue_t >::operator[] ( typename JClass< key_type >::argument_type key )

inlineinherited

Get mapped value.

Parameters

key key

Returns: value

Definition at line 85 of file JMappableCollection.hh.

     {
       return get(key);
     }

template<class JKey_t, class JValue_t>

void JTOOLS::JMappableCollection< JKey_t, JValue_t >::put	(	typename JClass< key_type >::argument_type	key,
		typename JClass< mapped_type >::argument_type	value
	)

inlineinherited

Put pair-wise element (key,value) into collection.

Parameters

key	key
value	value

Definition at line 97 of file JMappableCollection.hh.

     {
       get(key) = value;
     }

Member Data Documentation

template<class JModel_t>

JModel_t JFIT::JAbstractMinimiser< JModel_t >::value

inherited

model value

Definition at line 57 of file JRegressor.hh.

template<class T>

int JEEP::JMessage< T >::debug = 0

staticinherited

debug level (default is off).

Definition at line 45 of file JMessage.hh.

const JDetector& JACOUSTICS::JKatoomba_t::detector

inherited

Definition at line 91 of file JKatoomba.hh.

JSoundVelocity JACOUSTICS::JKatoomba_t::velocity

inherited

Definition at line 92 of file JKatoomba.hh.

JLANG::JSharedPointer<JMEstimator> JACOUSTICS::JKatoomba_t::estimator

inherited

M-Estimator function.

Definition at line 94 of file JKatoomba.hh.

JHashMapEvaluator< JEvaluator_t > JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::getValue

inherited

Function object for evaluation of element.

Definition at line 331 of file JHashCollection.hh.

JTOOLS::JHashCollection::router_type JTOOLS::JHashCollection< std::pair< JKey_t, JValue_t > , JHashMapEvaluator< JEvaluator_t > >::router

protectedinherited

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

JKatoomba.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

template<> struct JACOUSTICS::JKatoomba< JAbstractMinimiser >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<>
struct JACOUSTICS::JKatoomba< JAbstractMinimiser >