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
	TracePeak (std::vector< DataPoint >::const_iterator it_begin, std::vector< DataPoint >::const_iterator it_end, bool remove_base)
	construct a peak given a trace, begin and end x coordinate
	TracePeak (const TracePeak &other)
	~TracePeak ()
TracePeakCstSPtr	makeTracePeakCstSPtr () const
DataPoint &	getMaxXicElement ()
const DataPoint &	getMaxXicElement () const
void	setMaxXicElement (const DataPoint &max)
DataPoint &	getLeftBoundary ()
const DataPoint &	getLeftBoundary () const
void	setLeftBoundary (const DataPoint &left)
DataPoint &	getRightBoundary ()
const DataPoint &	getRightBoundary () 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
TracePeak &	operator= (const TracePeak &other)

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 39 of file tracepeak.h.

Constructor & Destructor Documentation

TracePeak() [1/4]

pappso::TracePeak::TracePeak

(

)

Definition at line 31 of file tracepeak.cpp.

{
}

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

TracePeak() [2/4]

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 35 of file tracepeak.cpp.

{
 
  m_left  = *it_begin;
  m_right = *(it_end - 1);
  m_max   = *maxYDataPoint(it_begin, it_end);
  m_area  = areaTrace(it_begin, it_end);
}

References pappso::areaTrace(), m_area, m_left, m_max, m_right, and pappso::maxYDataPoint().

TracePeak() [3/4]

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

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

Parameters

it_begin	begining of trace
it_end	end of trace
remove_base	if true, remove the base peak signal

Definition at line 45 of file tracepeak.cpp.

{
 
  m_left  = *it_begin;
  m_right = *(it_end - 1);
  m_max   = *maxYDataPoint(it_begin, it_end);
  m_area  = areaTrace(it_begin, it_end);
  if(remove_base)
    {
      // remove the base of this peak
      m_area -= std::min(m_left.y, m_right.y) * (m_right.x - m_left.x);
      if(m_area < 0)
        m_area = 0;
    }
}

References pappso::areaTrace(), m_area, m_left, m_max, m_right, and pappso::maxYDataPoint().

TracePeak() [4/4]

pappso::TracePeak::TracePeak

(

const TracePeak &

other

)

Definition at line 63 of file tracepeak.cpp.

{
  m_area  = other.m_area;
  m_left  = other.m_left;
  m_right = other.m_right;
  m_max   = other.m_max;
}

References TracePeak(), m_area, m_left, m_max, and m_right.

~TracePeak()

pappso::TracePeak::~TracePeak

(

)

Definition at line 71 of file tracepeak.cpp.

{
}

Member Function Documentation

containsRt()

bool pappso::TracePeak::containsRt

(

pappso::pappso_double

rt

)

const

Definition at line 130 of file tracepeak.cpp.

{
  if((rt >= m_left.x) && (rt <= m_right.x))
    {
      return (true);
    }
  return (false);
}

References m_left, and m_right.

getArea()

pappso_double pappso::TracePeak::getArea

(

)

const

Definition at line 119 of file tracepeak.cpp.

{
  return m_area;
};

References m_area.

Referenced by pappso::masschroq::CborOutputStream::writeTracePeak().

getLeftBoundary() [1/2]

DataPoint & pappso::TracePeak::getLeftBoundary

(

)

Definition at line 93 of file tracepeak.cpp.

{
  return m_left;
};

References m_left.

Referenced by pappso::QCPXic::drawXicPeakBorders(), and pappso::masschroq::CborOutputStream::writeTracePeak().

getLeftBoundary() [2/2]

const DataPoint & pappso::TracePeak::getLeftBoundary

(

)

const

Definition at line 147 of file tracepeak.cpp.

{
  return m_left;
}

References m_left.

getMaxXicElement() [1/2]

DataPoint & pappso::TracePeak::getMaxXicElement

(

)

Definition at line 83 of file tracepeak.cpp.

{
  return m_max;
};

References m_max.

Referenced by pappso::QCPXic::drawXicPeakBorders(), and pappso::masschroq::CborOutputStream::writeTracePeak().

getMaxXicElement() [2/2]

const DataPoint & pappso::TracePeak::getMaxXicElement

(

)

const

Definition at line 141 of file tracepeak.cpp.

{
  return m_max;
}

References m_max.

getRightBoundary() [1/2]

DataPoint & pappso::TracePeak::getRightBoundary

(

)

Definition at line 104 of file tracepeak.cpp.

{
  return m_right;
};

References m_right.

Referenced by pappso::QCPXic::drawXicPeakBorders(), and pappso::masschroq::CborOutputStream::writeTracePeak().

getRightBoundary() [2/2]

const DataPoint & pappso::TracePeak::getRightBoundary

(

)

const

Definition at line 109 of file tracepeak.cpp.

{
  return m_right;
};

References m_right.

makeTracePeakCstSPtr()

TracePeakCstSPtr pappso::TracePeak::makeTracePeakCstSPtr

(

)

const

Definition at line 77 of file tracepeak.cpp.

{
  return std::make_shared<const TracePeak>(*this);
}

operator=()

TracePeak & pappso::TracePeak::operator=

(

const TracePeak &

other

)

Definition at line 161 of file tracepeak.cpp.

{
  if(this == &other)
    return *this;
 
  m_area  = other.m_area;
  m_max   = other.m_max;
  m_left  = other.m_left;
  m_right = other.m_right;
 
  return *this;
}

References TracePeak(), m_area, m_left, m_max, and m_right.

operator==()

bool pappso::TracePeak::operator==

(

const TracePeak &

other

)

const

Definition at line 154 of file tracepeak.cpp.

{
  return ((m_area == other.m_area) && (m_max == other.m_max) &&
          (m_left == other.m_left) && (m_right == other.m_right));
}

References TracePeak(), m_area, m_left, m_max, and m_right.

setArea()

void pappso::TracePeak::setArea

(

pappso_double

area

)

Definition at line 124 of file tracepeak.cpp.

{
  m_area = area;
};

References m_area.

setLeftBoundary()

void pappso::TracePeak::setLeftBoundary

(

const DataPoint &

left

)

Definition at line 98 of file tracepeak.cpp.

{
  m_left = left;
};

References m_left.

setMaxXicElement()

void pappso::TracePeak::setMaxXicElement

(

const DataPoint &

max

)

Definition at line 88 of file tracepeak.cpp.

{
  m_max = max;
};

References m_max.

setRightBoundary()

void pappso::TracePeak::setRightBoundary

(

const DataPoint &

right

)

Definition at line 114 of file tracepeak.cpp.

{
  m_right = right;
};

References m_right.

Member Data Documentation

m_area

pappso_double pappso::TracePeak::m_area = 0

protected

Definition at line 88 of file tracepeak.h.

Referenced by TracePeak(), TracePeak(), TracePeak(), getArea(), operator=(), operator==(), and setArea().

m_left

DataPoint pappso::TracePeak::m_left

protected

Definition at line 90 of file tracepeak.h.

Referenced by TracePeak(), TracePeak(), TracePeak(), containsRt(), getLeftBoundary(), getLeftBoundary(), operator=(), operator==(), and setLeftBoundary().

m_max

DataPoint pappso::TracePeak::m_max

protected

Definition at line 89 of file tracepeak.h.

Referenced by TracePeak(), TracePeak(), TracePeak(), getMaxXicElement(), getMaxXicElement(), operator=(), operator==(), and setMaxXicElement().

m_right

DataPoint pappso::TracePeak::m_right

protected

Definition at line 91 of file tracepeak.h.

Referenced by TracePeak(), TracePeak(), TracePeak(), containsRt(), getRightBoundary(), getRightBoundary(), operator=(), operator==(), and setRightBoundary().

---

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

• pappsomspp/core/processing/detection/tracepeak.h
• pappsomspp/core/processing/detection/tracepeak.cpp