Jpp  master_rocky-40-g5f0272dcd
the software that should make you happy
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
JACOUSTICS::JMODEL::JEmission Struct Reference

Emission parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JMODEL::JEmission:
JMATH::JMath< JFirst_t, JSecond_t > JLANG::JEquals< JFirst_t, JSecond_t > JACOUSTICS::JKatoomba< JType >::H_t

Public Member Functions

 JEmission ()
 Default constructor. More...
 
 JEmission (const double t1)
 Constructor. More...
 
JEmissionnegate ()
 Negate emission. More...
 
JEmissionadd (const JEmission &emission)
 Add emission. More...
 
JEmissionsub (const JEmission &emission)
 Subtract emission. More...
 
JEmissionmul (const double factor)
 Scale emission. More...
 
JEmissiondiv (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 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.

333  :
334  t1(0.0)
335  {}

◆ JEmission() [2/2]

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

Constructor.

Parameters
t1time-of-emission [s]

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

343  :
344  t1(t1)
345  {}

Member Function Documentation

◆ getN()

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

Get number of fit parameters.

Parameters
optionoption
Returns
number of parameters

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

355  {
356  switch (option) {
357 
358  case FIT_UNDEFINED_t:
359  return 0;
360 
361  default:
362  return 1;
363  }
364  }
@ FIT_UNDEFINED_t
fit undefined

◆ negate()

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

Negate emission.

Returns
this emission

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

373  {
374  t1 = -t1;
375 
376  return *this;
377  }

◆ add()

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

Add emission.

Parameters
emissionemission
Returns
this emission

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

387  {
388  t1 += emission.t1;
389 
390  return *this;
391  }

◆ sub()

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

Subtract emission.

Parameters
emissionemission
Returns
this emission

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

401  {
402  t1 -= emission.t1;
403 
404  return *this;
405  }

◆ mul() [1/2]

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

Scale emission.

Parameters
factormultiplication factor
Returns
this emission

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

415  {
416  t1 *= factor;
417 
418  return *this;
419  }

◆ div()

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

Scale emission.

Parameters
factordivision factor
Returns
this emission

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

429  {
430  t1 /= factor;
431 
432  return *this;
433  }

◆ equals()

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

Check equality.

Parameters
emissionemission
precisionprecision
Returns
true if emissions are equal; else false

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

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

◆ 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
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

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

Friends And Related Function Documentation

◆ operator<<

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

Write emission parameters to output stream.

Parameters
outoutput stream
emissionemission
Returns
output stream

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

458  {
459  using namespace std;
460  using namespace JPP;
461 
462  return out << FIXED(20,6) << emission.t1;
463  }
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition: JSTDTypes.hh:14
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:448

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: