libpappsomspp
Library for mass spectrometry
Loading...
Searching...
No Matches
pappso::FilterQuantileBasedRemoveY Class Reference

removes a value found by quantile to all Y values More...

#include <filterpass.h>

Inheritance diagram for pappso::FilterQuantileBasedRemoveY:
pappso::FilterNameInterface pappso::FilterInterface

Public Member Functions

 FilterQuantileBasedRemoveY (double quantile_threshold)
 
 FilterQuantileBasedRemoveY (const QString &strBuildParams)
 
 FilterQuantileBasedRemoveY (const FilterQuantileBasedRemoveY &other)
 
virtual ~FilterQuantileBasedRemoveY ()
 
FilterQuantileBasedRemoveYoperator= (const FilterQuantileBasedRemoveY &other)
 
Tracefilter (Trace &data_points) const override
 
double getQuantileThreshold () const
 
virtual QString name () const override
 
QString toString () const override
 
- Public Member Functions inherited from pappso::FilterNameInterface
virtual ~FilterNameInterface ()
 
- Public Member Functions inherited from pappso::FilterInterface
virtual ~FilterInterface ()
 

Protected Member Functions

void buildFilterFromString (const QString &strBuildParams) override
 build this filter using a string
 

Private Attributes

double m_quantile = 0
 

Detailed Description

removes a value found by quantile to all Y values

sort all values by Y intensity and take the iest value located at the defined quantile the use it to remove this value to all Y intensities

Definition at line 257 of file filterpass.h.

Constructor & Destructor Documentation

◆ FilterQuantileBasedRemoveY() [1/3]

FilterQuantileBasedRemoveY::FilterQuantileBasedRemoveY ( double  quantile_threshold)

Definition at line 503 of file filterpass.cpp.

504 : m_quantile(quantile)
505{
506}

◆ FilterQuantileBasedRemoveY() [2/3]

pappso::FilterQuantileBasedRemoveY::FilterQuantileBasedRemoveY ( const QString &  strBuildParams)
Parameters
strBuildParamsstring to build the filter "passQuantileBasedRemoveY|0.6"

Definition at line 545 of file filterpass.cpp.

547{
548 buildFilterFromString(strBuildParams);
549}
void buildFilterFromString(const QString &strBuildParams) override
build this filter using a string

◆ FilterQuantileBasedRemoveY() [3/3]

FilterQuantileBasedRemoveY::FilterQuantileBasedRemoveY ( const FilterQuantileBasedRemoveY other)

Definition at line 508 of file filterpass.cpp.

510 : m_quantile(other.m_quantile)
511{
512}

◆ ~FilterQuantileBasedRemoveY()

virtual pappso::FilterQuantileBasedRemoveY::~FilterQuantileBasedRemoveY ( )
inlinevirtual

Definition at line 269 of file filterpass.h.

269{};

Member Function Documentation

◆ buildFilterFromString()

void pappso::FilterQuantileBasedRemoveY::buildFilterFromString ( const QString &  strBuildParams)
overrideprotectedvirtual

build this filter using a string

Parameters
strBuildParamsa string coding the filter and its parameters "filterName|param1;param2;param3"

Implements pappso::FilterNameInterface.

Definition at line 553 of file filterpass.cpp.

555{
556 //"passQuantileBasedRemoveY|0.6"
557 qDebug();
558 if(strBuildParams.startsWith("passQuantileBasedRemoveY|"))
559 {
560 QStringList params =
561 strBuildParams.split("|").back().split(";", Qt::SkipEmptyParts);
562
563 QString value = params.at(0);
564 m_quantile = value.toDouble();
565 }
566 else
567 {
569 QString(
570 "building passQuantileBasedRemoveY from string %1 is not possible")
571 .arg(strBuildParams));
572 }
573 qDebug();
574}
excetion to use when an item type is not recognized

◆ filter()

Trace & pappso::FilterQuantileBasedRemoveY::filter ( pappso::Trace data_points) const
overridevirtual

Implements pappso::FilterInterface.

Definition at line 528 of file filterpass.cpp.

529{
530
531 if(data_points.size() == 0)
532 return data_points;
533 double value_to_temove =
534 quantileYTrace(data_points.begin(), data_points.end(), m_quantile);
535 for(auto &&dataPoint : data_points)
536 {
537 if(dataPoint.y < value_to_temove)
538 dataPoint.y = 0;
539 else
540 dataPoint.y = dataPoint.y - value_to_temove;
541 }
542 return data_points;
543}
double quantileYTrace(std::vector< DataPoint >::const_iterator begin, std::vector< DataPoint >::const_iterator end, double quantile)
calculate the quantile of y value of a trace
Definition trace.cpp:265

References pappso::quantileYTrace().

◆ getQuantileThreshold()

double FilterQuantileBasedRemoveY::getQuantileThreshold ( ) const

Definition at line 522 of file filterpass.cpp.

523{
524 return m_quantile;
525}

References m_quantile.

◆ name()

QString pappso::FilterQuantileBasedRemoveY::name ( ) const
overridevirtual

Implements pappso::FilterNameInterface.

Definition at line 578 of file filterpass.cpp.

579{
580 return "passQuantileBasedRemoveY";
581}

◆ operator=()

FilterQuantileBasedRemoveY & FilterQuantileBasedRemoveY::operator= ( const FilterQuantileBasedRemoveY other)

Definition at line 515 of file filterpass.cpp.

516{
517 m_quantile = other.m_quantile;
518 return *this;
519}

References m_quantile.

◆ toString()

QString pappso::FilterQuantileBasedRemoveY::toString ( ) const
overridevirtual

Implements pappso::FilterNameInterface.

Definition at line 585 of file filterpass.cpp.

586{
587 QString strCode = QString("%1|%2").arg(name()).arg(m_quantile);
588
589 return strCode;
590}
virtual QString name() const override

Member Data Documentation

◆ m_quantile

double pappso::FilterQuantileBasedRemoveY::m_quantile = 0
private

Definition at line 285 of file filterpass.h.

Referenced by getQuantileThreshold(), and operator=().


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