Template specialisation of fit function of acoustic model based on linear approximation. More...

#include <JKatoomba.hh>

Inheritance diagram for JACOUSTICS::JKatoomba< JEstimator >:

Public Types
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, const int option)
	Constructor. More...

template<class T >
const JModel &	operator() (T __begin, T __end) const
	Get start values of string parameters. 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...

Public Attributes
const JDetector &	detector
	detector More...

JSoundVelocity	velocity
	sound velocity More...

int	option
	fit option More...

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

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

Static Public Attributes
static constexpr double	TOLERANCE = 1.0e-8
	Tolerance for SVD. More...

Protected Attributes
JTOOLS::JHashCollection::router_type	router

Private Attributes
JModel	value

Detailed Description

template<>
struct JACOUSTICS::JKatoomba< JEstimator >

Template specialisation of fit function of acoustic model based on linear approximation.

Definition at line 249 of file JKatoomba.hh.

Member Typedef Documentation

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< JEstimator >::JKatoomba	(	const JDetector &	detector,
		const JSoundVelocity &	velocity,
		const int	option
	)

inline

Constructor.

Parameters

detector	detector
velocity	sound velocity
option	option

Definition at line 261 of file JKatoomba.hh.

                                             :
       JKatoomba_t(detector, velocity, option)
     {};

Member Function Documentation

template<class T >

const JModel& JACOUSTICS::JKatoomba< JEstimator >::operator()	(	T	__begin,
		T	__end
	)		const

inline

Get start values of string parameters.

Note that this method may throw an exception.

Parameters

__begin	begin of hits
__end	end of hits

Returns: model

Definition at line 277 of file JKatoomba.hh.

     {
       using namespace std;
       using namespace JPP;
       using namespace JGEOMETRY;
 
       value = JModel(__begin, __end);                 // set up global model according data
 
       if (this->option == JMODEL::fit_emitters_only_t)
         JMODEL::setOption(JMODEL::fit_emitters_only_t);
       else
         JMODEL::setOption(JMODEL::fit_emitters_and_strings_1st_order_t);
       
       H_t H;                                          // H-equation as per hit
       I_t i;                                          // indices of H-equation in global model 
 
       const size_t N = value.getN();
 
       TMatrixD       V(N,N);                          // V = H^T x H
       vector<double> Y(N, 0.0);                       // Y = H^T x y
 
       for (T hit = __begin; hit != __end; ++hit) {
 
         const JString&    string   = detector[hit->getString()];
         const JPosition3D position = string.getPosition(hit->getFloor());
         const double      Vi       = velocity.getInverseVelocity(hit->getDistance(position), hit->getZ(), position.getZ());
 
         const double      h1 = string.getHeight(hit->getFloor());
         const JPosition3D p1 = string.getPosition()  -  hit->getPosition();
         const double      ds = sqrt(p1.getLengthSquared()  +  h1*h1  +  2.0*p1.getZ()*h1);
         const double      y  = hit->getValue()  -  Vi*ds;
         const double      W  = sqrt(hit->getWeight());
 
         H.t1  =  W * 1.0;
         H.tx  =  W * Vi * p1.getX() * h1 / ds;
         H.ty  =  W * Vi * p1.getY() * h1 / ds;
         
         i.t1  =  value.getIndex(hit->getEKey(),   &H_t::t1);
         i.tx  =  value.getIndex(hit->getString(), &H_t::tx);
         i.ty  =  value.getIndex(hit->getString(), &H_t::ty);
 
         V(i.t1, i.t1) += H.t1 * H.t1;
 
         Y[i.t1] += W * H.t1 * y;
 
         if (hit->getFloor() != 0) {
 
           if (JMODEL::getOption() != JMODEL::fit_emitters_only_t) {
           
             V(i.t1, i.tx) += H.t1 * H.tx;  V(i.t1, i.ty) += H.t1 * H.ty;
             V(i.tx, i.t1) += H.tx * H.t1;  V(i.ty, i.t1) += H.ty * H.t1;
 
             V(i.tx, i.tx) += H.tx * H.tx;  V(i.tx, i.ty) += H.tx * H.ty;
             V(i.ty, i.tx) += H.ty * H.tx;  V(i.ty, i.ty) += H.ty * H.ty;
 
             Y[i.tx] += W * H.tx * y;
             Y[i.ty] += W * H.ty * y;
           }
         }
       }
 
       // evaluate (H^T x H)^-1 x H^T x y 
 
       TDecompSVD svd(V, TOLERANCE);
 
       Bool_t status;
 
       V = svd.Invert(status);
 
       for (size_t row = 0; row != N; ++row) {
         for (size_t col = 0; col != N; ++col) {
           value[row] += V(row,col) * Y[col];
         }
       }
       
       return value;
     }

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 83 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;
     }

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 517 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 529 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

constexpr double JACOUSTICS::JKatoomba< JEstimator >::TOLERANCE = 1.0e-8

static

Tolerance for SVD.

Definition at line 252 of file JKatoomba.hh.

JModel JACOUSTICS::JKatoomba< JEstimator >::value

mutableprivate

Definition at line 356 of file JKatoomba.hh.

const JDetector& JACOUSTICS::JKatoomba_t::detector

inherited

detector

Definition at line 96 of file JKatoomba.hh.

JSoundVelocity JACOUSTICS::JKatoomba_t::velocity

inherited

sound velocity

Definition at line 97 of file JKatoomba.hh.

int JACOUSTICS::JKatoomba_t::option

inherited

fit option

Definition at line 98 of file JKatoomba.hh.

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

inherited

M-Estimator function.

Definition at line 99 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

Public Attributes

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

template<> struct JACOUSTICS::JKatoomba< JEstimator >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<>
struct JACOUSTICS::JKatoomba< JEstimator >