pappso::MassSpectrumCombiner Class Reference

#include <massspectrumcombiner.h>

Inheritance diagram for pappso::MassSpectrumCombiner:

Public Member Functions
	MassSpectrumCombiner ()
	Construct an uninitialized instance. More...
	MassSpectrumCombiner (std::vector< pappso_double > bins, int decimalPlaces=-1)
	MassSpectrumCombiner (int decimal_places)
	MassSpectrumCombiner (MassSpectrumCombinerCstSPtr other)
	MassSpectrumCombiner (const MassSpectrumCombiner &other)
	MassSpectrumCombiner (const MassSpectrumCombiner &&other)
virtual	~MassSpectrumCombiner ()
	Destruct the instance. More...
std::vector< pappso_double >::const_iterator	begin () const
std::vector< pappso_double >::const_iterator	end () const
std::vector< pappso_double >::iterator	begin ()
std::vector< pappso_double >::iterator	end ()
void	setBins (std::vector< pappso_double > bins)
const std::vector< pappso_double > &	getBins () const
std::size_t	binCount () const
virtual MapTrace &	combine (MapTrace &map_trace, const Trace &trace) const
virtual MapTrace &	combine (MapTrace &map_trace_out, const MapTrace &map_trace_in) const
Public Member Functions inherited from pappso::MassDataCombinerInterface
	MassDataCombinerInterface (int decimal_places=-1)
virtual	~MassDataCombinerInterface ()
void	setDecimalPlaces (int value)
int	getDecimalPlaces () const
void	setFilterResampleKeepXRange (const FilterResampleKeepXRange &range)
virtual MapTrace &	combine (MapTrace &map_trace, Iterator begin, Iterator end)

Protected Member Functions
std::vector< pappso_double >::iterator	findBin (pappso_double mz)
	Find the bin that will contain mz. More...

Protected Attributes
std::vector< pappso_double >	m_bins
Protected Attributes inherited from pappso::MassDataCombinerInterface
int	m_decimalPlaces = -1
	Number of decimals to use for the keys (x values) More...
bool	m_isApplyXRangeFilter = false
FilterResampleKeepXRange	m_filterXRange

Private Member Functions
virtual MapTrace &	combineNoFilteringStep (MapTrace &map_trace, const Trace &trace) const =0

Additional Inherited Members
Public Types inherited from pappso::MassDataCombinerInterface
using	Iterator = std::vector< const Trace * >::const_iterator

Detailed Description

Definition at line 29 of file massspectrumcombiner.h.

Constructor & Destructor Documentation

MassSpectrumCombiner() [1/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner

(

)

Construct an uninitialized instance.

Definition at line 28 of file massspectrumcombiner.cpp.

{
}

MassSpectrumCombiner() [2/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner	(	std::vector< pappso_double >	bins,
		int	decimalPlaces = -1
	)

Definition at line 33 of file massspectrumcombiner.cpp.

  : MassDataCombinerInterface(decimalPlaces), m_bins(bins)
{
}

MassSpectrumCombiner() [3/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner

(

int

decimal_places

)

Definition at line 40 of file massspectrumcombiner.cpp.

  : MassDataCombinerInterface(decimal_places)
{
}

MassSpectrumCombiner() [4/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner

(

MassSpectrumCombinerCstSPtr

other

)

Definition at line 55 of file massspectrumcombiner.cpp.

  : MassDataCombinerInterface(other->m_decimalPlaces)
{
  // qDebug() << __FILE__ << "@" << __LINE__ << __FUNCTION__ << "()";
 
  m_bins.assign(other->m_bins.begin(), other->m_bins.end());
}

References m_bins.

MassSpectrumCombiner() [5/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner

(

const MassSpectrumCombiner &

other

)

Definition at line 46 of file massspectrumcombiner.cpp.

  : MassDataCombinerInterface(other.m_decimalPlaces)
{
  // qDebug() << __FILE__ << "@" << __LINE__ << __FUNCTION__ << "()";
 
  m_bins.assign(other.m_bins.begin(), other.m_bins.end());
}

References m_bins.

MassSpectrumCombiner() [6/6]

pappso::MassSpectrumCombiner::MassSpectrumCombiner

(

const MassSpectrumCombiner &&

other

)

~MassSpectrumCombiner()

pappso::MassSpectrumCombiner::~MassSpectrumCombiner ( )

virtual

Destruct the instance.

Definition at line 65 of file massspectrumcombiner.cpp.

{
  // Calls the destructor for each DataPoint object in the vector.
  m_bins.clear();
}

References m_bins.

Member Function Documentation

begin() [1/2]

std::vector< pappso_double >::iterator pappso::MassSpectrumCombiner::begin

(

)

Definition at line 91 of file massspectrumcombiner.cpp.

{
  return m_bins.begin();
}

References m_bins.

begin() [2/2]

std::vector< pappso_double >::const_iterator pappso::MassSpectrumCombiner::begin

(

)

const

Definition at line 105 of file massspectrumcombiner.cpp.

{
  return m_bins.begin();
}

References m_bins.

binCount()

std::size_t pappso::MassSpectrumCombiner::binCount

(

)

const

Definition at line 119 of file massspectrumcombiner.cpp.

{
  return m_bins.size();
}

References m_bins.

combine() [1/2]

MapTrace & pappso::MassSpectrumCombiner::combine ( MapTrace &  map_trace, const Trace &  trace  ) const

virtual

Implements pappso::MassDataCombinerInterface.

Definition at line 137 of file massspectrumcombiner.cpp.

{
 
  // qDebug() << "Thread:" << QThread::currentThreadId()
  //<< "Going to combine a trace this size:" << trace.size();
 
  if(!trace.size())
    {
      // qDebug() << "Thread:" << QThread::currentThreadId()
      //<< "Returning right away because trace is empty.";
      return map_trace;
    }
 
 
  // Let's check if we need to apply a filter to the input data.
 
  if(m_isApplyXRangeFilter)
    {
      Trace filtered_trace(trace);
 
      m_filterXRange.filter(filtered_trace);
 
      if(!filtered_trace.size())
        return map_trace;
 
      return combineNoFilteringStep(map_trace, filtered_trace);
    }
 
  return combineNoFilteringStep(map_trace, trace);
}

References combineNoFilteringStep(), pappso::FilterResampleKeepXRange::filter(), pappso::MassDataCombinerInterface::m_filterXRange, and pappso::MassDataCombinerInterface::m_isApplyXRangeFilter.

combine() [2/2]

MapTrace & pappso::MassSpectrumCombiner::combine ( MapTrace &  map_trace_out, const MapTrace &  map_trace_in  ) const

virtual

Implements pappso::MassDataCombinerInterface.

Definition at line 170 of file massspectrumcombiner.cpp.

{
 
  // qDebug() << "Thread:" << QThread::currentThreadId()
  //<< "Going to combine a map_trace_in this size:" << map_trace_in.size();
 
  if(!map_trace_in.size())
    {
      // qDebug() << "Thread:" << QThread::currentThreadId()
      //<< "Returning right away because map_trace_in is empty.";
      return map_trace_out;
    }
 
  // Let's check if we need to apply a filter to the input data.
 
  Trace filtered_trace_in(map_trace_in);
 
  if(m_isApplyXRangeFilter)
    {
      m_filterXRange.filter(filtered_trace_in);
 
      if(!filtered_trace_in.size())
        return map_trace_out;
    }
 
  return combineNoFilteringStep(map_trace_out, filtered_trace_in);
}

References combineNoFilteringStep(), pappso::FilterResampleKeepXRange::filter(), pappso::MassDataCombinerInterface::m_filterXRange, and pappso::MassDataCombinerInterface::m_isApplyXRangeFilter.

combineNoFilteringStep()

virtual MapTrace& pappso::MassSpectrumCombiner::combineNoFilteringStep ( MapTrace &  map_trace, const Trace &  trace  ) const

privatepure virtual

Implemented in pappso::MassSpectrumPlusCombiner, and pappso::MassSpectrumMinusCombiner.

Referenced by combine().

end() [1/2]

std::vector< pappso_double >::iterator pappso::MassSpectrumCombiner::end

(

)

Definition at line 98 of file massspectrumcombiner.cpp.

{
  return m_bins.end();
}

References m_bins.

end() [2/2]

std::vector< pappso_double >::const_iterator pappso::MassSpectrumCombiner::end

(

)

const

Definition at line 112 of file massspectrumcombiner.cpp.

{
  return m_bins.end();
}

References m_bins.

findBin()

std::vector< pappso_double >::iterator pappso::MassSpectrumCombiner::findBin ( pappso_double  mz )

protected

Find the bin that will contain mz.

Definition at line 128 of file massspectrumcombiner.cpp.

{
  return std::find_if(m_bins.begin(), m_bins.end(), [mz](pappso_double bin) {
    return (mz <= bin);
  });
}

References m_bins, and pappso::unset.

getBins()

const std::vector< pappso_double > & pappso::MassSpectrumCombiner::getBins

(

)

const

Definition at line 84 of file massspectrumcombiner.cpp.

{
  return m_bins;
}

References m_bins.

setBins()

void pappso::MassSpectrumCombiner::setBins

(

std::vector< pappso_double >

bins

)

Definition at line 73 of file massspectrumcombiner.cpp.

{
  m_bins.assign(bins.begin(), bins.end());
 
  // qDebug() << "After bins assignment, local bins are of this size:"
  //<< m_bins.size() << "Starting at:" << m_bins.front()
  //<< "and ending at:" << m_bins.back();
}

References m_bins.

Member Data Documentation

m_bins

std::vector<pappso_double> pappso::MassSpectrumCombiner::m_bins

protected

Definition at line 58 of file massspectrumcombiner.h.

Referenced by MassSpectrumCombiner(), ~MassSpectrumCombiner(), begin(), binCount(), pappso::MassSpectrumMinusCombiner::combineNoFilteringStep(), pappso::MassSpectrumPlusCombiner::combineNoFilteringStep(), end(), findBin(), getBins(), and setBins().

---

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

• pappsomspp/processing/combiners/massspectrumcombiner.h
• pappsomspp/processing/combiners/massspectrumcombiner.cpp