libpappsomspp
Library for mass spectrometry
pappso::MassDataCombinerInterface Class Referenceabstract

#include <massdatacombinerinterface.h>

Inheritance diagram for pappso::MassDataCombinerInterface:
pappso::MassSpectrumCombiner pappso::TraceCombiner pappso::MassSpectrumMinusCombiner pappso::MassSpectrumPlusCombiner pappso::TraceMinusCombiner pappso::TracePlusCombiner

Public Types

using Iterator = std::vector< const Trace * >::const_iterator
 

Public Member Functions

 MassDataCombinerInterface (int decimal_places=-1)
 
virtual ~MassDataCombinerInterface ()
 
void setDecimalPlaces (int value)
 
int getDecimalPlaces () const
 
void setFilterResampleKeepXRange (const FilterResampleKeepXRange &range)
 
virtual MapTracecombine (MapTrace &map_trace, const Trace &trace) const =0
 
virtual MapTracecombine (MapTrace &map_trace_out, const MapTrace &map_trace_in) const =0
 
virtual MapTracecombine (MapTrace &map_trace, Iterator begin, Iterator end)
 

Protected Attributes

int m_decimalPlaces = -1
 Number of decimals to use for the keys (x values) More...
 
bool m_isApplyXRangeFilter = false
 
FilterResampleKeepXRange m_filterXRange
 

Detailed Description

Definition at line 23 of file massdatacombinerinterface.h.

Member Typedef Documentation

◆ Iterator

using pappso::MassDataCombinerInterface::Iterator = std::vector<const Trace *>::const_iterator

Definition at line 39 of file massdatacombinerinterface.h.

Constructor & Destructor Documentation

◆ MassDataCombinerInterface()

pappso::MassDataCombinerInterface::MassDataCombinerInterface ( int  decimal_places = -1)

Definition at line 19 of file massdatacombinerinterface.cpp.

20  : m_decimalPlaces(decimal_places)
21 {
22 }

◆ ~MassDataCombinerInterface()

pappso::MassDataCombinerInterface::~MassDataCombinerInterface ( )
virtual

Definition at line 25 of file massdatacombinerinterface.cpp.

26 {
27 }

Member Function Documentation

◆ combine() [1/3]

virtual MapTrace& pappso::MassDataCombinerInterface::combine ( MapTrace map_trace,
const Trace trace 
) const
pure virtual

◆ combine() [2/3]

MapTrace & pappso::MassDataCombinerInterface::combine ( MapTrace map_trace,
Iterator  begin,
Iterator  end 
)
virtual

Definition at line 53 of file massdatacombinerinterface.cpp.

56 {
57  for(Iterator iterator = begin; iterator != end; ++iterator)
58  combine(map_trace, *(*iterator));
59 
60  return map_trace;
61 }

References combine().

◆ combine() [3/3]

virtual MapTrace& pappso::MassDataCombinerInterface::combine ( MapTrace map_trace_out,
const MapTrace map_trace_in 
) const
pure virtual

◆ getDecimalPlaces()

int pappso::MassDataCombinerInterface::getDecimalPlaces ( ) const

Definition at line 37 of file massdatacombinerinterface.cpp.

38 {
39  return m_decimalPlaces;
40 }

References m_decimalPlaces.

◆ setDecimalPlaces()

void pappso::MassDataCombinerInterface::setDecimalPlaces ( int  value)

Definition at line 30 of file massdatacombinerinterface.cpp.

31 {
32  m_decimalPlaces = value;
33 }

References m_decimalPlaces.

◆ setFilterResampleKeepXRange()

void pappso::MassDataCombinerInterface::setFilterResampleKeepXRange ( const FilterResampleKeepXRange range)

Definition at line 44 of file massdatacombinerinterface.cpp.

46 {
47  m_filterXRange = range;
48  m_isApplyXRangeFilter = true;
49 }

References m_filterXRange, and m_isApplyXRangeFilter.

Member Data Documentation

◆ m_decimalPlaces

int pappso::MassDataCombinerInterface::m_decimalPlaces = -1
protected

◆ m_filterXRange

FilterResampleKeepXRange pappso::MassDataCombinerInterface::m_filterXRange
protected

◆ m_isApplyXRangeFilter

bool pappso::MassDataCombinerInterface::m_isApplyXRangeFilter = false
protected

The documentation for this class was generated from the following files:
pappso::MassDataCombinerInterface::Iterator
std::vector< const Trace * >::const_iterator Iterator
Definition: massdatacombinerinterface.h:39
pappso::MassDataCombinerInterface::m_decimalPlaces
int m_decimalPlaces
Number of decimals to use for the keys (x values)
Definition: massdatacombinerinterface.h:44
pappso::MassDataCombinerInterface::combine
virtual MapTrace & combine(MapTrace &map_trace, const Trace &trace) const =0
pappso::MassDataCombinerInterface::m_filterXRange
FilterResampleKeepXRange m_filterXRange
Definition: massdatacombinerinterface.h:48
pappso::MassDataCombinerInterface::m_isApplyXRangeFilter
bool m_isApplyXRangeFilter
Definition: massdatacombinerinterface.h:46