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)
void	initialize (const QString &parameters)
QString	toString () const

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

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.

{};

Referenced by SavGolParams(), and initialize().

SavGolParams() [2/3]

pappso::SavGolParams::SavGolParams ( const SavGolParams & other )

inline

Definition at line 66 of file savgolfilter.h.

    : nL{other.nL},
      nR{other.nR},
      m{other.m},
      lD{other.lD},
      convolveWithNr{other.convolveWithNr}
  {
  }

References SavGolParams(), convolveWithNr, lD, m, nL, and nR.

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.

  {
    nL             = nLParam;
    nR             = nRParam;
    m              = mParam;
    lD             = lDParam;
    convolveWithNr = convolveWithNrParam;
  }

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

Member Function Documentation

initialize() [1/3]

void pappso::SavGolParams::initialize ( const QString & parameters )

inline

Definition at line 107 of file savgolfilter.h.

  {
    // Typical string: "15;15;4;0;false"
 
    QStringList params_list = parameters.split(";");
 
    nL             = params_list.at(0).toInt();
    nR             = params_list.at(1).toInt();
    m              = params_list.at(2).toInt();
    lD             = params_list.at(3).toInt();
    convolveWithNr = (params_list.at(4) == "true" ? true : false);
  }

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

initialize() [2/3]

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

inline

Definition at line 97 of file savgolfilter.h.

  {
    nL             = other.nL;
    nR             = other.nR;
    m              = other.m;
    lD             = other.lD;
    convolveWithNr = other.convolveWithNr;
  }

References SavGolParams(), convolveWithNr, lD, m, nL, and nR.

initialize() [3/3]

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

inline

Definition at line 86 of file savgolfilter.h.

  {
    nL             = nLParam;
    nR             = nRParam;
    m              = mParam;
    lD             = lDParam;
    convolveWithNr = convolveWithNrParam;
  }

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

toString()

QString pappso::SavGolParams::toString ( ) const

inline

Definition at line 121 of file savgolfilter.h.

  {
    // Typical string: "15;15;4;0;false"
    return QString("%1;%2;%3;%4;%5")
      .arg(QString::number(nL))
      .arg(QString::number(nR))
      .arg(QString::number(m))
      .arg(QString::number(lD))
      .arg(convolveWithNr ? "true" : "false");
  }

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

Member Data Documentation

convolveWithNr

bool pappso::SavGolParams::convolveWithNr = false

set to false for best results

Definition at line 61 of file savgolfilter.h.

Referenced by pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), SavGolParams(), SavGolParams(), initialize(), initialize(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and toString().

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::FilterSavitzkyGolay(), SavGolParams(), SavGolParams(), initialize(), initialize(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and toString().

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::FilterSavitzkyGolay(), SavGolParams(), SavGolParams(), initialize(), initialize(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and toString().

nL

int pappso::SavGolParams::nL = 15

number of data points on the left of the filtered point

Definition at line 51 of file savgolfilter.h.

Referenced by pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), SavGolParams(), SavGolParams(), initialize(), initialize(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and toString().

nR

int pappso::SavGolParams::nR = 15

number of data points on the right of the filtered point

Definition at line 53 of file savgolfilter.h.

Referenced by pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), pappso::FilterSavitzkyGolay::FilterSavitzkyGolay(), SavGolParams(), SavGolParams(), initialize(), initialize(), initialize(), pappso::FilterSavitzkyGolay::operator=(), and toString().

---

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

• pappsomspp/core/processing/filters/savgolfilter.h