libpappsomspp
Library for mass spectrometry
pappso::FilterRescaleY Class Reference

rescales Y values into a dynamic range if the dynamic range is set to 0, this filter is ignored More...

#include <filterpass.h>

Inheritance diagram for pappso::FilterRescaleY:
pappso::FilterInterface

Public Member Functions

 FilterRescaleY (double dynamic)
 
 FilterRescaleY (const FilterRescaleY &other)
 
virtual ~FilterRescaleY ()
 
FilterRescaleYoperator= (const FilterRescaleY &other)
 
double getDynamicRange () const
 
Tracefilter (Trace &data_points) const override
 

Private Attributes

double m_dynamic = 0
 

Detailed Description

rescales Y values into a dynamic range if the dynamic range is set to 0, this filter is ignored

Definition at line 213 of file filterpass.h.

Constructor & Destructor Documentation

◆ FilterRescaleY() [1/2]

FilterRescaleY::FilterRescaleY ( double  dynamic)

Definition at line 353 of file filterpass.cpp.

353  : m_dynamic(dynamic)
354 {
355 }

◆ FilterRescaleY() [2/2]

FilterRescaleY::FilterRescaleY ( const FilterRescaleY other)

Definition at line 356 of file filterpass.cpp.

357  : m_dynamic(other.m_dynamic)
358 {
359 }

◆ ~FilterRescaleY()

virtual pappso::FilterRescaleY::~FilterRescaleY ( )
inlinevirtual

Definition at line 221 of file filterpass.h.

222 {};

Member Function Documentation

◆ filter()

Trace & FilterRescaleY::filter ( Trace data_points) const
overridevirtual

Implements pappso::FilterInterface.

Definition at line 361 of file filterpass.cpp.

362 {
363  if(m_dynamic == 0)
364  return data_points;
365  auto it_max = maxYDataPoint(data_points.begin(), data_points.end());
366  if(it_max == data_points.end())
367  return data_points;
368  double maximum = it_max->y;
369  for(auto &&dataPoint : data_points)
370  {
371  dataPoint.y = (dataPoint.y / maximum) * m_dynamic;
372  }
373  return data_points;
374 }

References m_dynamic, and pappso::maxYDataPoint().

◆ getDynamicRange()

double FilterRescaleY::getDynamicRange ( ) const

Definition at line 386 of file filterpass.cpp.

387 {
388  return m_dynamic;
389 }

References m_dynamic.

◆ operator=()

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

Definition at line 377 of file filterpass.cpp.

378 {
379  m_dynamic = other.m_dynamic;
380 
381  return *this;
382 }

References m_dynamic.

Member Data Documentation

◆ m_dynamic

double pappso::FilterRescaleY::m_dynamic = 0
private

Definition at line 216 of file filterpass.h.

Referenced by filter(), getDynamicRange(), and operator=().


The documentation for this class was generated from the following files:
pappso::FilterRescaleY::m_dynamic
double m_dynamic
Definition: filterpass.h:216
pappso::maxYDataPoint
std::vector< DataPoint >::const_iterator maxYDataPoint(std::vector< DataPoint >::const_iterator begin, std::vector< DataPoint >::const_iterator end)
Definition: trace.cpp:138