Berkeley Nuclear Data Software
Public Member Functions | Protected Attributes | List of all members
QuadraticCalib Class Reference

#include <CalibrationClasses.h>

Inheritance diagram for QuadraticCalib:
Inheritance graph
[legend]
Collaboration diagram for QuadraticCalib:
Collaboration graph
[legend]

Public Member Functions

 QuadraticCalib ()
 returns a_value*a_value*m_quadScalar + a_value*m_scalar More...
 
double applyCalib (double a_value) const
 returns a_value*a_value*m_quadScalar + a_value*m_scalar More...
 
void setCalibration (double a_quadScalar, double a_scalar, double a_offset)
 
void setQuadScalar (double a_quadScalar)
 
void setScalar (double a_scalar)
 
void setOffset (double a_offset)
 
virtual std::ostream & print (std::ostream &a_stream=std::cout) const
 prints nothing by default More...
 
virtual QuadraticCalibclone ()
 
- Public Member Functions inherited from DetectorCalib
 DetectorCalib ()
 
virtual double invertCalib (double a_value) const
 
CalibType getCalibType ()
 
void setTime (uint32_t a_t)
 sets the experiment time during the processing in time since epoch More...
 
void setTDiv (int a_timeDiv)
 sets the divisor for which to consider the given time More...
 
virtual ~DetectorCalib ()
 

Protected Attributes

double m_quadScalar
 
double m_scalar
 scalar for the calibration More...
 
double m_offset
 scalar for the calibration More...
 
- Protected Attributes inherited from DetectorCalib
CalibType m_type
 
uint32_t m_t
 
int m_tDiv
 

Detailed Description

class used to apply a QuadraticCalibration to a measurement value inherits from above abc to provide common interface

Constructor & Destructor Documentation

◆ QuadraticCalib()

QuadraticCalib::QuadraticCalib ( )

returns a_value*a_value*m_quadScalar + a_value*m_scalar

default constuctor puts the class into a functional state with a qudratic sclaer value of 0, a scalar value of one and an offset value of zero (does nothing to the original value)

Here is the caller graph for this function:

Member Function Documentation

◆ applyCalib()

double QuadraticCalib::applyCalib ( double  a_value) const
inlinevirtual

returns a_value*a_value*m_quadScalar + a_value*m_scalar

Implements DetectorCalib.

◆ clone()

QuadraticCalib * QuadraticCalib::clone ( )
virtual

this is required to implement deep copies of derived classes and needs to be implemented for any inheriting class

Implements DetectorCalib.

Here is the call graph for this function:

◆ print()

std::ostream & QuadraticCalib::print ( std::ostream &  a_stream = std::cout) const
virtual

prints nothing by default

Reimplemented from DetectorCalib.

◆ setCalibration()

void QuadraticCalib::setCalibration ( double  a_quadScalar,
double  a_scalar,
double  a_offset 
)

◆ setOffset()

void QuadraticCalib::setOffset ( double  a_offset)

◆ setQuadScalar()

void QuadraticCalib::setQuadScalar ( double  a_quadScalar)

◆ setScalar()

void QuadraticCalib::setScalar ( double  a_scalar)

Member Data Documentation

◆ m_offset

double QuadraticCalib::m_offset
protected

scalar for the calibration

◆ m_quadScalar

double QuadraticCalib::m_quadScalar
protected

◆ m_scalar

double QuadraticCalib::m_scalar
protected

scalar for the calibration


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