Model for fit to acoustics data. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JModel:

Classes
struct	emission_type
	Map emission key to model parameters of emission. More...

struct	hash_evaluator
	Auxiliary data structure for common fit parameters. More...

struct	hash_map
	Auxiliary data structure with extended functionality of hash-map. More...

struct	string_type
	Map string identifier to model parameters of string. More...

Public Types
typedef JMODEL::JString	JString

typedef JMODEL::JEmission	JEmission

Public Member Functions
	JModel ()
	Default constructor. More...

template<class T >
	JModel (T __begin, T __end)
	Constructor. More...

JModel &	operator= (const JMATH::JZero &zero)
	Reset parameters. More...

JMODEL::JOption_t	getOption () const
	Get fit option. More...

void	setOption (const int option)
	Set fit option. More...

void	clear ()
	Clear parameters. More...

void	reset ()
	Reset parameters. More...

JModel &	negate ()
	Negate model. More...

JModel &	add (const JModel &model)
	Add model. More...

JModel &	sub (const JModel &model)
	Subtract model. More...

JModel &	mul (const double factor)
	Scale model. More...

JModel &	div (const double factor)
	Scale model. More...

bool	equals (const JModel &model, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

size_t	getN () const
	Get number of fit parameters. More...

size_t	getIndex (int id, double JString::*p) const
	Get index of fit parameter for given string. More...

size_t	getIndex (const JEKey &id, double JEmission::*p) const
	Get index of fit parameter for given emission. More...

double	operator[] (const size_t index) const
	Read access to fit parameter value by index. More...

double &	operator[] (const size_t index)
	Read/write access to fit parameter value by index. More...

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Public Attributes
JACOUSTICS::JModel::emission_type	emission

JACOUSTICS::JModel::string_type	string

Private Attributes
JMODEL::JOption_t	option

Friends
std::ostream &	operator<< (std::ostream &out, const JModel &model)
	Write model parameters to output stream. More...

Detailed Description

Model for fit to acoustics data.

The model consists of string parameters and emission parameters.
These parameters relate to the string identifer and emission key, respectively.

Definition at line 477 of file JAcoustics/JModel.hh.

Member Typedef Documentation

◆ JString

typedef JMODEL::JString JACOUSTICS::JModel::JString

Definition at line 481 of file JAcoustics/JModel.hh.

◆ JEmission

typedef JMODEL::JEmission JACOUSTICS::JModel::JEmission

Definition at line 482 of file JAcoustics/JModel.hh.

Constructor & Destructor Documentation

◆ JModel() [1/2]

JACOUSTICS::JModel::JModel ( )

inline

Default constructor.

Definition at line 488 of file JAcoustics/JModel.hh.

              :
       option(JMODEL::FIT_UNDEFINED_t)
     {}

◆ JModel() [2/2]

template<class T >

JACOUSTICS::JModel::JModel	(	T	__begin,
		T	__end
	)

inline

Constructor.

This constructor can be used to set up a default model (i.e. all values at zero) for the given set of hits.
The data type corresponding to the hits should provide for the following policy methods.

   int      getString();        // get string identifier
   JEKey    getEKey();          // get emission key

Parameters

__begin	begin of hits
__end	end of hits

Definition at line 507 of file JAcoustics/JModel.hh.

                                :
       option(JMODEL::FIT_UNDEFINED_t)
     {
       for (T hit = __begin; hit != __end; ++hit) {
  
         if (!this->string.has(hit->getString())) {
           this->string[hit->getString()] = JString();
         }
  
         if (!this->emission.has(hit->getEKey())) {
           this->emission[hit->getEKey()] = JEmission();
         }
       }
     }

Member Function Documentation

◆ operator=()

JModel& JACOUSTICS::JModel::operator= ( const JMATH::JZero & zero )

inline

Reset parameters.

Parameters

zero zero

Returns: this model

Definition at line 529 of file JAcoustics/JModel.hh.

     {
       this->reset();
  
       return *this;
     }

◆ getOption()

JMODEL::JOption_t JACOUSTICS::JModel::getOption ( ) const

inline

Get fit option.

Returns: option

Definition at line 542 of file JAcoustics/JModel.hh.

     {
       return option;
     }

◆ setOption()

void JACOUSTICS::JModel::setOption ( const int option )

inline

Set fit option.

Parameters

option option

Definition at line 553 of file JAcoustics/JModel.hh.

     {
       using namespace JMODEL;
  
       switch (option) {
  
       case FIT_EMITTERS_ONLY_t:
       case FIT_EMITTERS_AND_STRINGS_1st_ORDER_t:
       case FIT_EMITTERS_AND_STRINGS_2nd_ORDER_t:
       case FIT_EMITTERS_AND_STRINGS_2nd_ORDER_AND_STRETCHING_t:
         this->option = static_cast<JOption_t>(option);
         break;
  
       default:
         THROW(JValueOutOfRange, "Invalid option " << option);
       }
     }

◆ clear()

void JACOUSTICS::JModel::clear ( )

inline

Clear parameters.

Definition at line 575 of file JAcoustics/JModel.hh.

     {
       string  .clear();
       emission.clear();
     }

◆ reset()

void JACOUSTICS::JModel::reset ( )

inline

Reset parameters.

Definition at line 585 of file JAcoustics/JModel.hh.

     {
       string  .reset();
       emission.reset();
     }

◆ negate()

JModel& JACOUSTICS::JModel::negate ( )

inline

Negate model.

Returns: this model

Definition at line 597 of file JAcoustics/JModel.hh.

     {
       this->string  .evaluate(&JString  ::negate);
       this->emission.evaluate(&JEmission::negate);
  
       return *this;
     }

◆ add()

JModel& JACOUSTICS::JModel::add ( const JModel & model )

inline

Add model.

Parameters

model model

Returns: this model

Definition at line 612 of file JAcoustics/JModel.hh.

     {
       this->string  .evaluate(model.string,   &JString  ::add);
       this->emission.evaluate(model.emission, &JEmission::add);
  
       return *this;
     }

◆ sub()

JModel& JACOUSTICS::JModel::sub ( const JModel & model )

inline

Subtract model.

Parameters

model model

Returns: this model

Definition at line 627 of file JAcoustics/JModel.hh.

     {
       this->string  .evaluate(model.string,   &JString  ::sub);
       this->emission.evaluate(model.emission, &JEmission::sub);
  
       return *this;
     }

◆ mul() [1/2]

JModel& JACOUSTICS::JModel::mul ( const double factor )

inline

Scale model.

Parameters

factor multiplication factor

Returns: this model

Definition at line 642 of file JAcoustics/JModel.hh.

     {
       this->string  .evaluate(&JString  ::mul, factor);
       this->emission.evaluate(&JEmission::mul, factor);
  
       return *this;
     }

◆ div()

JModel& JACOUSTICS::JModel::div ( const double factor )

inline

Scale model.

Parameters

factor division factor

Returns: this model

Definition at line 657 of file JAcoustics/JModel.hh.

     {
       this->string  .evaluate(&JString  ::div, factor);
       this->emission.evaluate(&JEmission::div, factor);
  
       return *this;
     }

◆ equals()

bool JACOUSTICS::JModel::equals	(	const JModel &	model,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inline

Check equality.

Parameters

model	model
precision	precision

Returns: true if models are equal; else false

Definition at line 673 of file JAcoustics/JModel.hh.

     {
       return (this->string  .equals(model.string,   precision) &&
               this->emission.equals(model.emission, precision));
     }

◆ getN()

size_t JACOUSTICS::JModel::getN ( ) const

inline

Get number of fit parameters.

Returns: number of parameters

Definition at line 710 of file JAcoustics/JModel.hh.

     {
       return emission.getN(this->option) + string.getN(this->option);
     }

◆ getIndex() [1/2]

size_t JACOUSTICS::JModel::getIndex	(	int	id,
		double JString::*	p
	)		const

inline

Get index of fit parameter for given string.

Parameters

id	string identifier
p	pointer to data member

Returns: parameter

Definition at line 723 of file JAcoustics/JModel.hh.

     {
       return emission.getN(this->option)  +  string.getIndex(id, p, this->option);
     }

◆ getIndex() [2/2]

size_t JACOUSTICS::JModel::getIndex	(	const JEKey &	id,
		double JEmission::*	p
	)		const

inline

Get index of fit parameter for given emission.

Parameters

id	emission key
p	pointer to data member

Returns: parameter

Definition at line 736 of file JAcoustics/JModel.hh.

     {
       return emission.getIndex(id, p, this->option);
     }

◆ operator[]() [1/2]

double JACOUSTICS::JModel::operator[] ( const size_t index ) const

inline

Read access to fit parameter value by index.

Parameters

index index

Returns: value

Definition at line 748 of file JAcoustics/JModel.hh.

     {
       size_t i = index;
  
       if (i < emission.getN(this->option)) { return emission.getParameter(i, this->option); }
  
       i -= emission.getN(this->option);
  
       if (i < string  .getN(this->option)) { return string .getParameter(i, this->option); }
  
       THROW(JIndexOutOfRange, "Invalid index " << index << " >= " << getN());
     }

◆ operator[]() [2/2]

double& JACOUSTICS::JModel::operator[] ( const size_t index )

inline

Read/write access to fit parameter value by index.

Parameters

index index

Returns: value

Definition at line 768 of file JAcoustics/JModel.hh.

     {
       size_t i = index;
  
       if (i < emission.getN(this->option)) { return emission.getParameter(i, this->option); }
  
       i -= emission.getN(this->option);
  
       if (i < string  .getN(this->option)) { return string .getParameter(i, this->option); }
  
       THROW(JIndexOutOfRange, "Invalid index " << index << " >= " << getN());
     }

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
     }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const JModel &	model
	)

friend

Write model parameters to output stream.

Parameters

out	output stream
model	model

Returns: output stream

Definition at line 688 of file JAcoustics/JModel.hh.

     {
       using namespace std;
       using namespace JPP;
  
       for (hash_map<int, JString>::const_iterator i = model.string.begin(); i != model.string.end(); ++i) {
         out << "string:   " << setw(4) << i->first << ' ' << i->second << endl;
       }
  
       for (hash_map<JEKey, JEmission>::const_iterator i = model.emission.begin(); i != model.emission.end(); ++i) {
         out << "emission: " << setw(3) << i->first << ' ' << i->second << endl;
       }
  
       return out;
     }

Member Data Documentation

◆ emission

JACOUSTICS::JModel::emission_type JACOUSTICS::JModel::emission

◆ string

JACOUSTICS::JModel::string_type JACOUSTICS::JModel::string

◆ option

JMODEL::JOption_t JACOUSTICS::JModel::option

private

Definition at line 1050 of file JAcoustics/JModel.hh.

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

JAcoustics/JModel.hh

Classes

Public Types

Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ JString

◆ JEmission

Constructor & Destructor Documentation

◆ JModel() [1/2]

◆ JModel() [2/2]

Member Function Documentation

◆ operator=()

◆ getOption()

◆ setOption()

◆ clear()

◆ reset()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ equals()

◆ getN()

◆ getIndex() [1/2]

◆ getIndex() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ mul() [2/2]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ emission

◆ string

◆ option