JACOUSTICS::JMODEL::JEmission Struct Reference

Emission parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JMODEL::JEmission:

Public Member Functions
	JEmission ()
	Default constructor.
	JEmission (const double t1)
	Constructor.
JEmission &	negate ()
	Negate emission.
JEmission &	add (const JEmission &emission)
	Add emission.
JEmission &	sub (const JEmission &emission)
	Subtract emission.
JEmission &	mul (const double factor)
	Scale emission.
JEmission &	div (const double factor)
	Scale emission.
bool	equals (const JEmission &emission, const double precision=std::numeric_limits< double >::min()) const
	Check equality.

Static Public Member Functions
static size_t	getN (const JMODEL::JOption_t option)
	Get number of fit parameters.

Public Attributes
double	t1

Friends
std::ostream &	operator<< (std::ostream &out, const JEmission &emission)
	Write emission parameters to output stream.

Detailed Description

Emission parameters.

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

Constructor & Destructor Documentation

JEmission() [1/2]

JACOUSTICS::JMODEL::JEmission::JEmission ( )

inline

Default constructor.

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

                  :
        t1(0.0)
      {}

JEmission() [2/2]

JACOUSTICS::JMODEL::JEmission::JEmission ( const double t1 )

inline

Constructor.

Parameters

t1	time-of-emission [s]

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

                                 :
        t1(t1)
      {}

Member Function Documentation

getN()

static size_t JACOUSTICS::JMODEL::JEmission::getN ( const JMODEL::JOption_t option )

inlinestatic

Get number of fit parameters.

Parameters

option

option

Returns

number of parameters

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

      {
        switch (option) {
 
        case FIT_UNDEFINED_t:
          return 0;
 
        default:
          return 1;
        }
      }

negate()

JEmission & JACOUSTICS::JMODEL::JEmission::negate ( )

inline

Negate emission.

Returns

this emission

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

      {
        t1 = -t1;
 
        return *this;
      }

add()

JEmission & JACOUSTICS::JMODEL::JEmission::add ( const JEmission & emission )

inline

Add emission.

Parameters

emission

emission

Returns

this emission

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

      {
        t1 += emission.t1;
 
        return *this;
      }

sub()

JEmission & JACOUSTICS::JMODEL::JEmission::sub ( const JEmission & emission )

inline

Subtract emission.

Parameters

emission

emission

Returns

this emission

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

      {
        t1 -= emission.t1;
 
        return *this;
      }

mul()

JEmission & JACOUSTICS::JMODEL::JEmission::mul ( const double factor )

inline

Scale emission.

Parameters

factor

multiplication factor

Returns

this emission

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

      {
        t1 *= factor;
 
        return *this;
      }

div()

JEmission & JACOUSTICS::JMODEL::JEmission::div ( const double factor )

inline

Scale emission.

Parameters

factor

division factor

Returns

this emission

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

      {
        t1 /= factor;
 
        return *this;
      }

equals()

bool JACOUSTICS::JMODEL::JEmission::equals ( const JEmission & emission, const double precision = std::numeric_limits<double>::min() ) const

inline

Check equality.

Parameters

emission	emission
precision	precision

Returns

true if emissions are equal; else false

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

      {
        return (fabs(t1 - emission.t1) <= precision);
      }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const JEmission & emission )

friend

Write emission parameters to output stream.

Parameters

out	output stream
emission	emission

Returns

output stream

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

      {
        using namespace std;
        using namespace JPP;
 
        return out << FIXED(20,6) << emission.t1;
      }

Member Data Documentation

t1

double JACOUSTICS::JMODEL::JEmission::t1

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

---

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

• JAcoustics/JModel.hh