libpappsomspp
Library for mass spectrometry
pappso::SavGolParams Struct Reference

Parameters for the Savitzky-Golay filter. More...

#include <savgolfilter.h>

Public Member Functions

 SavGolParams ()
 
 SavGolParams (const SavGolParams &other)
 
 SavGolParams (int nLParam, int nRParam, int mParam, int lDParam, bool convolveWithNrParam)
 
void initialize (int nLParam, int nRParam, int mParam, int lDParam, bool convolveWithNrParam)
 
void initialize (const SavGolParams &other)
 
QString toString () const
 

Public Attributes

int nL = 15
 number of data points on the left of the filtered point More...
 
int nR = 15
 number of data points on the right of the filtered point More...
 
int m = 4
 
int lD = 0
 
bool convolveWithNr = false
 set to false for best results More...
 

Detailed Description

Parameters for the Savitzky-Golay filter.

Definition at line 49 of file savgolfilter.h.

Constructor & Destructor Documentation

◆ SavGolParams() [1/3]

pappso::SavGolParams::SavGolParams ( )
inline

Definition at line 64 of file savgolfilter.h.

64{};

◆ SavGolParams() [2/3]

pappso::SavGolParams::SavGolParams ( const SavGolParams other)
inline

Definition at line 66 of file savgolfilter.h.

67 : nL{other.nL},
68 nR{other.nR},
69 m{other.m},
70 lD{other.lD},
71 convolveWithNr{other.convolveWithNr}
72 {
73 }
int nR
number of data points on the right of the filtered point
Definition: savgolfilter.h:53
int nL
number of data points on the left of the filtered point
Definition: savgolfilter.h:51
bool convolveWithNr
set to false for best results
Definition: savgolfilter.h:61

◆ SavGolParams() [3/3]

pappso::SavGolParams::SavGolParams ( int  nLParam,
int  nRParam,
int  mParam,
int  lDParam,
bool  convolveWithNrParam 
)
inline

Definition at line 75 of file savgolfilter.h.

77 {
78 nL = nLParam;
79 nR = nRParam;
80 m = mParam;
81 lD = lDParam;
82 convolveWithNr = convolveWithNrParam;
83 }

Member Function Documentation

◆ initialize() [1/2]

void pappso::SavGolParams::initialize ( const SavGolParams other)
inline

Definition at line 97 of file savgolfilter.h.

98 {
99 nL = other.nL;
100 nR = other.nR;
101 m = other.m;
102 lD = other.lD;
103 convolveWithNr = other.convolveWithNr;
104 }

References convolveWithNr, lD, m, nL, and nR.

◆ initialize() [2/2]

void pappso::SavGolParams::initialize ( int  nLParam,
int  nRParam,
int  mParam,
int  lDParam,
bool  convolveWithNrParam 
)
inline

Definition at line 86 of file savgolfilter.h.

88 {
89 nL = nLParam;
90 nR = nRParam;
91 m = mParam;
92 lD = lDParam;
93 convolveWithNr = convolveWithNrParam;
94 }

◆ toString()

QString pappso::SavGolParams::toString ( ) const
inline

Definition at line 107 of file savgolfilter.h.

108 {
109 return QString("%1;%2;%3;%4;%5")
110 .arg(QString::number(nL))
111 .arg(QString::number(nR))
112 .arg(QString::number(m))
113 .arg(QString::number(lD))
114 .arg(convolveWithNr ? "true" : "false");
115 }

Referenced by pappso::FilterSavitzkyGolay::toString().

Member Data Documentation

◆ convolveWithNr

◆ lD

int pappso::SavGolParams::lD = 0

specifies the order of the derivative to extract from the Savitzky-Golay smoothing algorithm (for regular smoothing, use 0)

Definition at line 58 of file savgolfilter.h.

Referenced by pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), pappso::FilterSavitzkyGolay::buildFilterFromString(), pappso::FilterSavitzkyGolay::getParameters(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and pappso::FilterSavitzkyGolay::runFilter().

◆ m

int pappso::SavGolParams::m = 4

order of the polynomial to use in the regression analysis leading to the Savitzky-Golay coefficients (typically between 2 and 6)

Definition at line 55 of file savgolfilter.h.

Referenced by pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), pappso::FilterSavitzkyGolay::buildFilterFromString(), pappso::FilterSavitzkyGolay::getParameters(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and pappso::FilterSavitzkyGolay::runFilter().

◆ nL

◆ nR


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