libpappsomspp
Library for mass spectrometry
pappso::TracePeak Class Reference

#include <tracepeak.h>

Public Member Functions

 TracePeak ()
 
 TracePeak (std::vector< DataPoint >::const_iterator it_begin, std::vector< DataPoint >::const_iterator it_end)
 construct a peak given a trace, begin and end x coordinate More...
 
 TracePeak (const TracePeak &other)
 
 ~TracePeak ()
 
TracePeakCstSPtr makeTracePeakCstSPtr () const
 
DataPointgetMaxXicElement ()
 
const DataPointgetMaxXicElement () const
 
void setMaxXicElement (const DataPoint &max)
 
DataPointgetLeftBoundary ()
 
const DataPointgetLeftBoundary () const
 
void setLeftBoundary (const DataPoint &left)
 
DataPointgetRightBoundary ()
 
const DataPointgetRightBoundary () const
 
void setRightBoundary (const DataPoint &right)
 
pappso_double getArea () const
 
void setArea (pappso_double area)
 
bool containsRt (pappso::pappso_double rt) const
 
bool operator== (const TracePeak &other) const
 

Protected Attributes

pappso_double m_area = 0
 
DataPoint m_max
 
DataPoint m_left
 
DataPoint m_right
 

Detailed Description

@/brief Xic Peak stores peak boudaries detected from a Xic

Definition at line 60 of file tracepeak.h.

Constructor & Destructor Documentation

◆ TracePeak() [1/3]

pappso::TracePeak::TracePeak ( )

Definition at line 52 of file tracepeak.cpp.

53 {
54 }

◆ TracePeak() [2/3]

pappso::TracePeak::TracePeak ( std::vector< DataPoint >::const_iterator  it_begin,
std::vector< DataPoint >::const_iterator  it_end 
)

construct a peak given a trace, begin and end x coordinate

Definition at line 55 of file tracepeak.cpp.

59 {
60  return std::make_shared<const TracePeak>(*this);
61 }
62 
63 DataPoint &

◆ TracePeak() [3/3]

pappso::TracePeak::TracePeak ( const TracePeak other)

Definition at line 65 of file tracepeak.cpp.

65 {
66  return m_max;
67 };
68 void
69 TracePeak::setMaxXicElement(const DataPoint &max)
70 {
71  m_max = max;

References m_max.

◆ ~TracePeak()

pappso::TracePeak::~TracePeak ( )

Definition at line 73 of file tracepeak.cpp.

75 {

References m_left.

Member Function Documentation

◆ containsRt()

bool pappso::TracePeak::containsRt ( pappso::pappso_double  rt) const

Definition at line 132 of file tracepeak.cpp.

◆ getArea()

pappso_double pappso::TracePeak::getArea ( ) const

Definition at line 121 of file tracepeak.cpp.

◆ getLeftBoundary() [1/2]

DataPoint & pappso::TracePeak::getLeftBoundary ( )

Definition at line 95 of file tracepeak.cpp.

96 {
97  m_right = right;
98 };

References m_right.

Referenced by pappso::QCPXic::drawXicPeakBorders().

◆ getLeftBoundary() [2/2]

const DataPoint& pappso::TracePeak::getLeftBoundary ( ) const
inline

Definition at line 90 of file tracepeak.h.

◆ getMaxXicElement() [1/2]

DataPoint & pappso::TracePeak::getMaxXicElement ( )

Definition at line 85 of file tracepeak.cpp.

86 {
87  return m_right;
88 };

References m_right.

Referenced by pappso::QCPXic::drawXicPeakBorders().

◆ getMaxXicElement() [2/2]

const DataPoint& pappso::TracePeak::getMaxXicElement ( ) const
inline

Definition at line 82 of file tracepeak.h.

86  {

References m_area, m_left, m_max, and m_right.

◆ getRightBoundary() [1/2]

const DataPoint & pappso::TracePeak::getRightBoundary ( )

Definition at line 106 of file tracepeak.cpp.

106 {
107  m_area = area;
108 };
109 

References m_area.

Referenced by pappso::QCPXic::drawXicPeakBorders().

◆ getRightBoundary() [2/2]

const DataPoint& pappso::TracePeak::getRightBoundary ( ) const

◆ makeTracePeakCstSPtr()

TracePeakCstSPtr pappso::TracePeak::makeTracePeakCstSPtr ( ) const

Definition at line 79 of file tracepeak.cpp.

80 {
81  m_left = left;
82 };

References m_left.

◆ operator==()

bool pappso::TracePeak::operator== ( const TracePeak other) const
inline

Definition at line 106 of file tracepeak.h.

◆ setArea()

void pappso::TracePeak::setArea ( pappso_double  area)

Definition at line 126 of file tracepeak.cpp.

◆ setLeftBoundary()

void pappso::TracePeak::setLeftBoundary ( const DataPoint left)

Definition at line 100 of file tracepeak.cpp.

101 {
102  return m_area;
103 };

References m_area.

◆ setMaxXicElement()

void pappso::TracePeak::setMaxXicElement ( const DataPoint max)

Definition at line 90 of file tracepeak.cpp.

91 {
92  return m_right;
93 };

References m_right.

◆ setRightBoundary()

void pappso::TracePeak::setRightBoundary ( const DataPoint right)

Definition at line 116 of file tracepeak.cpp.

Member Data Documentation

◆ m_area

pappso_double pappso::TracePeak::m_area = 0
protected

Definition at line 63 of file tracepeak.h.

Referenced by getMaxXicElement(), getRightBoundary(), and setLeftBoundary().

◆ m_left

DataPoint pappso::TracePeak::m_left
protected

Definition at line 65 of file tracepeak.h.

Referenced by getMaxXicElement(), makeTracePeakCstSPtr(), and ~TracePeak().

◆ m_max

DataPoint pappso::TracePeak::m_max
protected

Definition at line 64 of file tracepeak.h.

Referenced by getMaxXicElement(), and TracePeak().

◆ m_right

DataPoint pappso::TracePeak::m_right
protected

Definition at line 66 of file tracepeak.h.

Referenced by getLeftBoundary(), getMaxXicElement(), and setMaxXicElement().


The documentation for this class was generated from the following files:
pappso::TracePeak::m_area
pappso_double m_area
Definition: tracepeak.h:63
pappso::XicExtractMethod::max
@ max
maximum of intensities
pappso::TracePeak::setMaxXicElement
void setMaxXicElement(const DataPoint &max)
Definition: tracepeak.cpp:90
pappso::TracePeak::m_right
DataPoint m_right
Definition: tracepeak.h:66
pappso::TracePeak::m_left
DataPoint m_left
Definition: tracepeak.h:65
pappso::TracePeak::m_max
DataPoint m_max
Definition: tracepeak.h:64