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

Constructor & Destructor Documentation

◆ FilterRescaleY() [1/2]

FilterRescaleY::FilterRescaleY ( double  dynamic)

Definition at line 244 of file filterpass.cpp.

244  : m_dynamic(dynamic)
245 {
246 }

◆ FilterRescaleY() [2/2]

FilterRescaleY::FilterRescaleY ( const FilterRescaleY other)

Definition at line 247 of file filterpass.cpp.

248  : m_dynamic(other.m_dynamic)
249 {
250 }

◆ ~FilterRescaleY()

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

Definition at line 189 of file filterpass.h.

190 {};

Member Function Documentation

◆ filter()

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

Implements pappso::FilterInterface.

Definition at line 252 of file filterpass.cpp.

253 {
254  if(m_dynamic == 0)
255  return data_points;
256  auto it_max = maxYDataPoint(data_points.begin(), data_points.end());
257  if(it_max == data_points.end())
258  return data_points;
259  double maximum = it_max->y;
260  for(auto &&dataPoint : data_points)
261  {
262  dataPoint.y = (dataPoint.y / maximum) * m_dynamic;
263  }
264  return data_points;
265 }

References m_dynamic, and pappso::maxYDataPoint().

◆ getDynamicRange()

double FilterRescaleY::getDynamicRange ( ) const

Definition at line 277 of file filterpass.cpp.

278 {
279  return m_dynamic;
280 }

References m_dynamic.

◆ operator=()

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

Definition at line 268 of file filterpass.cpp.

269 {
270  m_dynamic = other.m_dynamic;
271 
272  return *this;
273 }

References m_dynamic.

Member Data Documentation

◆ m_dynamic

double pappso::FilterRescaleY::m_dynamic = 0
private

Definition at line 184 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:184
pappso::maxYDataPoint
std::vector< DataPoint >::const_iterator maxYDataPoint(std::vector< DataPoint >::const_iterator begin, std::vector< DataPoint >::const_iterator end)
Definition: trace.cpp:127