libpappsomspp
Library for mass spectrometry
pappso::MzCalibrationInterface Class Referenceabstract

#include <mzcalibrationinterface.h>

Inheritance diagram for pappso::MzCalibrationInterface:
pappso::MzCalibrationModel1 pappso::MzCalibrationModel1Cached

Public Member Functions

 MzCalibrationInterface (double digitizerTimebase, double digitizerDelay)
 
virtual ~MzCalibrationInterface ()
 
MzCalibrationInterfaceoperator= (const MzCalibrationInterface &other)
 
bool operator== (const MzCalibrationInterface &other) const
 
double getTofFromTofIndex (quint32 tof_index) const
 get time of flight from raw index More...
 
double getTofFromTofIndex (double tof_index) const
 get time of flight from double index More...
 
virtual double getMzFromTofIndex (quint32 tof_index)=0
 get m/z from time of flight raw index More...
 
virtual quint32 getTofIndexFromMz (double mz)=0
 get raw TOF index of a given m/z More...
 

Protected Attributes

double m_digitizerTimebase = 0
 
double m_digitizerDelay = 0
 
std::vector< double > m_mzCalibrationArr
 MZ calibration parameters. More...
 

Detailed Description

Todo:
write docs

Definition at line 42 of file mzcalibrationinterface.h.

Constructor & Destructor Documentation

◆ MzCalibrationInterface()

pappso::MzCalibrationInterface::MzCalibrationInterface ( double  digitizerTimebase,
double  digitizerDelay 
)

Default constructor

Definition at line 34 of file mzcalibrationinterface.cpp.

36  : m_digitizerTimebase(digitizerTimebase), m_digitizerDelay(digitizerDelay)
37 {
38 }

◆ ~MzCalibrationInterface()

pappso::MzCalibrationInterface::~MzCalibrationInterface ( )
virtual

Destructor

Definition at line 40 of file mzcalibrationinterface.cpp.

41 {
42 }

Member Function Documentation

◆ getMzFromTofIndex()

virtual double pappso::MzCalibrationInterface::getMzFromTofIndex ( quint32  tof_index)
pure virtual

◆ getTofFromTofIndex() [1/2]

double pappso::MzCalibrationInterface::getTofFromTofIndex ( double  tof_index) const

get time of flight from double index

Definition at line 45 of file mzcalibrationinterface.cpp.

46 {
47  // mz calibration
48  return (index * m_digitizerTimebase) + m_digitizerDelay;
49 }

References m_digitizerDelay, and m_digitizerTimebase.

◆ getTofFromTofIndex() [2/2]

double pappso::MzCalibrationInterface::getTofFromTofIndex ( quint32  tof_index) const

get time of flight from raw index

Parameters
tof_indexdigitizer x raw value
Returns
tof time of flight

Definition at line 52 of file mzcalibrationinterface.cpp.

53 {
54  // mz calibration
55  return ((double)index * m_digitizerTimebase) + m_digitizerDelay;
56 }

References m_digitizerDelay, and m_digitizerTimebase.

◆ getTofIndexFromMz()

virtual quint32 pappso::MzCalibrationInterface::getTofIndexFromMz ( double  mz)
pure virtual

get raw TOF index of a given m/z

Parameters
mzthe mass to transform
Returns
integer x raw value

Implemented in pappso::MzCalibrationModel1.

◆ operator=()

MzCalibrationInterface& pappso::MzCalibrationInterface::operator= ( const MzCalibrationInterface other)

Assignment operator

Parameters
otherTODO
Returns
TODO

◆ operator==()

bool pappso::MzCalibrationInterface::operator== ( const MzCalibrationInterface other) const
Todo:
write docs
Parameters
otherTODO
Returns
TODO

Member Data Documentation

◆ m_digitizerDelay

◆ m_digitizerTimebase

double pappso::MzCalibrationInterface::m_digitizerTimebase = 0
protected

◆ m_mzCalibrationArr

std::vector<double> pappso::MzCalibrationInterface::m_mzCalibrationArr
protected

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