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

#include <CalibrationClasses.h>

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

Public Member Functions

 OffsetCalib ()
 
double applyCalib (double a_value) const
 returns a_value + m_offset More...
 
void setOffset (double a_offset)
 returns a_value + m_offset More...
 
virtual std::ostream & print (std::ostream &a_stream=std::cout) const
 prints nothing by default More...
 
virtual OffsetCalibclone ()
 
- 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_offset
 offset 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 single offset value to a measurement value inherits from above abc to provide common interface

Constructor & Destructor Documentation

◆ OffsetCalib()

OffsetCalib::OffsetCalib ( )

default constuctor puts the class into a functional state with a offset value of zero (does nothing to the original value)

Here is the caller graph for this function:

Member Function Documentation

◆ applyCalib()

double OffsetCalib::applyCalib ( double  a_value) const
inlinevirtual

returns a_value + m_offset

Implements DetectorCalib.

Reimplemented in TDepOffsetCalib.

◆ clone()

OffsetCalib * OffsetCalib::clone ( )
virtual

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

Implements DetectorCalib.

Reimplemented in TDepOffsetCalib.

Here is the call graph for this function:

◆ print()

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

prints nothing by default

Reimplemented from DetectorCalib.

Reimplemented in TDepOffsetCalib.

Here is the caller graph for this function:

◆ setOffset()

void OffsetCalib::setOffset ( double  a_offset)

returns a_value + m_offset

Here is the caller graph for this function:

Member Data Documentation

◆ m_offset

double OffsetCalib::m_offset
protected

offset for the calibration


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