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 262 of file filterpass.h.

Constructor & Destructor Documentation

◆ FilterQuantileBasedRemoveY() [1/3]

FilterQuantileBasedRemoveY::FilterQuantileBasedRemoveY ( double quantile_threshold)

Definition at line 526 of file filterpass.cpp.

526 : m_quantile(quantile)
527{
528}

References m_quantile.

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

◆ FilterQuantileBasedRemoveY() [2/3]

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

Definition at line 565 of file filterpass.cpp.

566{
567 buildFilterFromString(strBuildParams);
568}
void buildFilterFromString(const QString &strBuildParams) override
build this filter using a string

References buildFilterFromString().

◆ FilterQuantileBasedRemoveY() [3/3]

FilterQuantileBasedRemoveY::FilterQuantileBasedRemoveY ( const FilterQuantileBasedRemoveY & other)

Definition at line 530 of file filterpass.cpp.

531 : m_quantile(other.m_quantile)
532{
533}

References FilterQuantileBasedRemoveY(), and m_quantile.

◆ ~FilterQuantileBasedRemoveY()

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

Definition at line 274 of file filterpass.h.

274{};

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 572 of file filterpass.cpp.

573{
574 //"passQuantileBasedRemoveY|0.6"
575 qDebug();
576 if(strBuildParams.startsWith("passQuantileBasedRemoveY|"))
577 {
578 QStringList params = strBuildParams.split("|").back().split(";", Qt::SkipEmptyParts);
579
580 QString value = params.at(0);
581 m_quantile = value.toDouble();
582 }
583 else
584 {
585 throw pappso::ExceptionNotRecognized(
586 QString("building passQuantileBasedRemoveY from string %1 is not possible")
587 .arg(strBuildParams));
588 }
589 qDebug();
590}

References m_quantile.

Referenced by FilterQuantileBasedRemoveY().

◆ filter()

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

Implements pappso::FilterInterface.

Definition at line 549 of file filterpass.cpp.

550{
551
552 if(data_points.size() == 0)
553 return data_points;
554 double value_to_temove = quantileYTrace(data_points.begin(), data_points.end(), m_quantile);
555 for(auto &&dataPoint : data_points)
556 {
557 if(dataPoint.y < value_to_temove)
558 dataPoint.y = 0;
559 else
560 dataPoint.y = dataPoint.y - value_to_temove;
561 }
562 return data_points;
563}
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:249

References m_quantile, and pappso::quantileYTrace().

◆ getQuantileThreshold()

double FilterQuantileBasedRemoveY::getQuantileThreshold ( ) const

Definition at line 543 of file filterpass.cpp.

544{
545 return m_quantile;
546}

References m_quantile.

◆ name()

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

Implements pappso::FilterNameInterface.

Definition at line 594 of file filterpass.cpp.

595{
596 return "passQuantileBasedRemoveY";
597}

Referenced by toString().

◆ operator=()

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

Definition at line 536 of file filterpass.cpp.

537{
538 m_quantile = other.m_quantile;
539 return *this;
540}

References FilterQuantileBasedRemoveY(), and m_quantile.

◆ toString()

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

Implements pappso::FilterNameInterface.

Definition at line 601 of file filterpass.cpp.

602{
603 QString strCode = QString("%1|%2").arg(name()).arg(m_quantile);
604
605 return strCode;
606}
virtual QString name() const override

References m_quantile, and name().

Member Data Documentation

◆ m_quantile

double pappso::FilterQuantileBasedRemoveY::m_quantile = 0
private

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