JACOUSTICS::JMODEL::JEmission Struct Reference

Emission parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JMODEL::JEmission:

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

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

Public Attributes
double	t1

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

Detailed Description

Emission parameters.

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

Constructor & Destructor Documentation

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

inline

Default constructor.

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

                  :
        t1(0.0)
      {}

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

inline

Constructor.

Parameters

t1	time-of-emission [s]

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

                                 :
        t1(t1)
      {}

Member Function Documentation

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 353 of file JAcoustics/JModel.hh.

      {
        switch (option) {

        case FIT_UNDEFINED_t:
          return 0;

        default:
          return 1;
        }
      }

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

inline

Negate emission.

Returns

this emission

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

      {
        t1 = -t1;

        return *this;
      }

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

inline

Add emission.

Parameters

emission

emission

Returns

this emission

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

      {
        t1 += emission.t1;

        return *this;
      }

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

inline

Subtract emission.

Parameters

emission

emission

Returns

this emission

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

      {
        t1 -= emission.t1;

        return *this;
      }

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

inline

Scale emission.

Parameters

factor

multiplication factor

Returns

this emission

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

      {
        t1 *= factor;

        return *this;
      }

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

inline

Scale emission.

Parameters

factor

division factor

Returns

this emission

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

      {
        t1 /= factor;

        return *this;
      }

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 442 of file JAcoustics/JModel.hh.

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

template<class JFirst_t, class JSecond_t = JNullType>

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

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 456 of file JAcoustics/JModel.hh.

      {
        using namespace std;
        using namespace JPP;

        return out << FIXED(20,6) << emission.t1;
      }

Member Data Documentation

double JACOUSTICS::JMODEL::JEmission::t1

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

---

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

• JAcoustics/JModel.hh