JACOUSTICS::getModel Struct Reference

Auxiliary data structure to convert event to model. More...

#include <JEvtToolkit.hh>

Inheritance diagram for JACOUSTICS::getModel:

Public Types
typedef JMODEL::JString	JString
typedef JMODEL::JEmission	JEmission

Public Member Functions
template<class T >
	getModel (const T &object)
	Constructor. More...
template<>
	getModel (const JEvt &evt)
	Get model of detector. More...
template<>
	getModel (const JSuperEvt &evt)
	Get model of detector. 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...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. 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...

Public Attributes
JACOUSTICS::JModel::emission_type	emission
JACOUSTICS::JModel::string_type	string

Private Attributes
JMODEL::JOption_t	option

Detailed Description

Auxiliary data structure to convert event to model.

Definition at line 124 of file JAcoustics/JEvtToolkit.hh.

Member Typedef Documentation

JString

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

inherited

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

JEmission

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

inherited

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

Constructor & Destructor Documentation

getModel() [1/3]

template<class T >

JACOUSTICS::getModel::getModel

(

const T &

object

)

Constructor.

getModel() [2/3]

template<>

JACOUSTICS::getModel::getModel ( const JEvt &  evt )

inline

Get model of detector.

Parameters

evt

event

Definition at line 142 of file JAcoustics/JEvtToolkit.hh.

  {
    for (JEvt::const_iterator i = evt.begin(); i != evt.end(); ++i) {
      this->string[i->id] = getString(*i);
    }
  }

getModel() [3/3]

template<>

JACOUSTICS::getModel::getModel ( const JSuperEvt &  evt )

inline

Get model of detector.

Parameters

evt	super event

Definition at line 29 of file JSuperEvtToolkit.hh.

                                         :
    getModel(static_cast<const JEvt&>(evt))
  {
    for (JSuperEvt::tx_type::const_iterator i = evt.tx.begin(); i != evt.tx.end(); ++i) {
      this->emission[JEKey(i->id,i->counter)] = JMODEL::JEmission(i->toe);
    }
  }

Member Function Documentation

getOption()

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

inlineinherited

Get fit option.

Returns

option

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

    {
      return option;
    }

setOption()

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

inlineinherited

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 ( )

inlineinherited

Clear parameters.

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

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

reset()

void JACOUSTICS::JModel::reset ( )

inlineinherited

Reset parameters.

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

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

negate()

JModel& JACOUSTICS::JModel::negate ( )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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

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

div()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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 )

inlineinherited

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());
    }

Member Data Documentation

emission

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

inherited

string

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

inherited

option

JMODEL::JOption_t JACOUSTICS::JModel::option

privateinherited

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

---

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

• JAcoustics/JEvtToolkit.hh
• JSuperEvtToolkit.hh