JMATH::JGauss Class Reference

Data structure for Gaussian function on top of a flat background. More...

#include <JGauss.hh>

Inheritance diagram for JMATH::JGauss:

Public Types
typedef double JGauss::*	parameter_type
	Type definition of fit parameter. More...

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

Public Attributes
double	mean
double	sigma
double	signal
double	background

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

Detailed Description

Data structure for Gaussian function on top of a flat background.

This class implements the JMATH::JMath interface.

Definition at line 30 of file JGauss.hh.

Member Typedef Documentation

parameter_type

typedef double JGauss::* JMATH::JGauss::parameter_type

Type definition of fit parameter.

Definition at line 38 of file JGauss.hh.

Constructor & Destructor Documentation

JGauss() [1/2]

JMATH::JGauss::JGauss ( )

inline

Default constructor.

Definition at line 44 of file JGauss.hh.

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

JGauss() [2/2]

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

inline

Constructor.

Parameters

mean	mean
sigma	sigma
signal	signal
background	background

Definition at line 60 of file JGauss.hh.

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

Member Function Documentation

add()

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

inline

Add gauss.

Parameters

gauss

gauss

Returns

this gauss

Definition at line 77 of file JGauss.hh.

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

sub()

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

inline

Subtract gauss.

Parameters

gauss

gauss

Returns

this gauss

Definition at line 94 of file JGauss.hh.

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

mul() [1/2]

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

inline

Scale gauss.

Parameters

factor

multiplication factor

Returns

this gauss

Definition at line 111 of file JGauss.hh.

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

equals()

bool JMATH::JGauss::equals ( const JGauss &  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 129 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);
    }

mul() [2/2]

JGauss & JMATH::JMath< JGauss , JSecond_t >::mul ( const JSecond_t &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Function Documentation

operator>>

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

friend

Write Gauss to input stream.

Parameters

in	input stream
gauss	gauss

Returns

input stream

Definition at line 146 of file JGauss.hh.

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

operator<<

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

friend

Write Gauss to output stream.

Parameters

out	output stream
gauss	gauss

Returns

output stream

Definition at line 159 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::mean

Definition at line 169 of file JGauss.hh.

sigma

double JMATH::JGauss::sigma

Definition at line 170 of file JGauss.hh.

signal

double JMATH::JGauss::signal

Definition at line 171 of file JGauss.hh.

background

double JMATH::JGauss::background

Definition at line 172 of file JGauss.hh.

---

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

• JGauss.hh