JMATH::JGauss_t Struct Reference

Gauss model. More...

#include <JGauss.hh>

Inheritance diagram for JMATH::JGauss_t:

Public Member Functions
	JGauss_t ()
	Default constructor.
	JGauss_t (const double mean, const double sigma, const double signal, const double background)
	Constructor.
bool	equals (const JGauss_t &gauss, const double eps=std::numeric_limits< double >::min()) const
	Equality.
JGauss_t &	add (const JGauss_t &gauss)
	Add gauss.
JGauss_t &	sub (const JGauss_t &gauss)
	Subtract gauss.
JGauss_t &	mul (const double factor)
	Scale gauss.
JGauss_t &	mul (const JSecond_t &object)
	Multiply with object.

Public Attributes
double	mean
double	sigma
double	signal
double	background

Friends
std::istream &	operator>> (std::istream &in, JGauss_t &gauss)
	Write Gauss to input stream.
std::ostream &	operator<< (std::ostream &out, const JGauss_t &gauss)
	Write Gauss to output stream.

Detailed Description

Gauss model.

Definition at line 30 of file JGauss.hh.

Constructor & Destructor Documentation

JGauss_t() [1/2]

JMATH::JGauss_t::JGauss_t ( )

inline

Default constructor.

Definition at line 37 of file JGauss.hh.

               :
      mean      (0.0),
      sigma     (0.0),
      signal    (0.0),
      background(0.0)
    {}

JGauss_t() [2/2]

JMATH::JGauss_t::JGauss_t ( const double mean, const double sigma, const double signal, const double background )

inline

Constructor.

Note that an error will be thrown for a sigma smaller or equal to zero.

Parameters

mean	mean
sigma	sigma
signal	signal
background	background

Definition at line 55 of file JGauss.hh.

                                      :
      mean      (mean),
      sigma     (sigma),
      signal    (signal),
      background(background)
    {}

Member Function Documentation

equals()

bool JMATH::JGauss_t::equals ( const JGauss_t & gauss, const double eps = std::numeric_limits<double>::min() ) const

inline

Equality.

Parameters

gauss	gauss
eps	numerical precision

Returns

true if gauss's identical; else false

Definition at line 73 of file JGauss.hh.

    {
      return (fabs(mean       - gauss.mean)       <=  eps  &&
              fabs(sigma      - gauss.sigma)      <=  eps  &&
              fabs(signal     - gauss.signal)     <=  eps  &&
              fabs(background - gauss.background) <=  eps);
    }

add()

JGauss_t & JMATH::JGauss_t::add ( const JGauss_t & gauss )

inline

Add gauss.

Parameters

gauss

gauss

Returns

this gauss

Definition at line 89 of file JGauss.hh.

    {
      mean       += gauss.mean;
      sigma      += gauss.sigma;
      signal     += gauss.signal;
      background += gauss.background;
 
      return *this;
    }

sub()

JGauss_t & JMATH::JGauss_t::sub ( const JGauss_t & gauss )

inline

Subtract gauss.

Parameters

gauss

gauss

Returns

this gauss

Definition at line 106 of file JGauss.hh.

    {
      mean       -= gauss.mean;
      sigma      -= gauss.sigma;
      signal     -= gauss.signal;
      background -= gauss.background;
 
      return *this;
    }

mul() [1/2]

JGauss_t & JMATH::JGauss_t::mul ( const double factor )

inline

Scale gauss.

Parameters

factor

multiplication factor

Returns

this gauss

Definition at line 123 of file JGauss.hh.

    {
      mean       *= factor;
      sigma      *= factor;
      signal     *= factor;
      background *= factor;
 
      return *this;
    }

mul() [2/2]

JGauss_t & JMATH::JMath< JGauss_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 Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JGauss_t & gauss )

friend

Write Gauss to input stream.

Parameters

in	input stream
gauss	gauss

Returns

input stream

Definition at line 141 of file JGauss.hh.

    {
      return in >> gauss.mean >> gauss.sigma >> gauss.signal >> gauss.background;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JGauss_t & gauss )

friend

Write Gauss to output stream.

Parameters

out	output stream
gauss	gauss

Returns

output stream

Definition at line 154 of file JGauss.hh.

    {
      using namespace std;
 
      return out << FIXED(7,3) << gauss.mean   << ' '
                 << FIXED(7,3) << gauss.sigma  << ' '
                 << FIXED(9,3) << gauss.signal << ' '
                 << FIXED(9,3) << gauss.background;
    }

Member Data Documentation

mean

double JMATH::JGauss_t::mean

Definition at line 164 of file JGauss.hh.

sigma

double JMATH::JGauss_t::sigma

Definition at line 165 of file JGauss.hh.

signal

double JMATH::JGauss_t::signal

Definition at line 166 of file JGauss.hh.

background

double JMATH::JGauss_t::background

Definition at line 167 of file JGauss.hh.

---

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

• JGauss.hh