pappso::MsRunXicExtractorInterface Class Reference

#include <msrunxicextractorinterface.h>

Inheritance diagram for pappso::MsRunXicExtractorInterface:

Classes
struct	MsRunXicExtractorPoints
class	MsRunXicExtractorReadPoints
	class to read retention time points of MsRun More...

Public Member Functions
void	setXicExtractMethod (XicExtractMethod method)
	set the XIC extraction method More...
virtual XicCstSPtr	getXicCstSPtr (const MzRange &mz_range) final
	get a XIC on this MsRun at the given mass range More...
virtual XicCstSPtr	getXicCstSPtr (const MzRange &mz_range, pappso::pappso_double rt_begin, pappso::pappso_double rt_end)=0
	get a XIC on this MsRun at the given mass range More...
virtual std::vector< XicCstSPtr >	getXicCstSPtrList (const std::vector< MzRange > &mz_range_list)=0
	extract a list of XIC given a list of mass to extract More...
const MsRunIdCstSPtr &	getMsRunId () const

Protected Member Functions
	MsRunXicExtractorInterface (MsRunReaderSPtr &msrun_reader)
	constructor is private, use the MsRunXicExtractorFactory More...
	MsRunXicExtractorInterface (const MsRunXicExtractorInterface &other)
virtual	~MsRunXicExtractorInterface ()

Protected Attributes
MsRunReaderSPtr	msp_msrun_reader
XicExtractMethod	m_xicExtractMethod = XicExtractMethod::max

Detailed Description

Definition at line 63 of file msrunxicextractorinterface.h.

Constructor & Destructor Documentation

MsRunXicExtractorInterface() [1/2]

pappso::MsRunXicExtractorInterface::MsRunXicExtractorInterface ( MsRunReaderSPtr &  msrun_reader )

protected

constructor is private, use the MsRunXicExtractorFactory

Definition at line 58 of file msrunxicextractorinterface.cpp.

{

MsRunXicExtractorInterface() [2/2]

pappso::MsRunXicExtractorInterface::MsRunXicExtractorInterface ( const MsRunXicExtractorInterface &  other )

protected

Definition at line 65 of file msrunxicextractorinterface.cpp.

{
  return msp_msrun_reader.get()->getMsRunId();
}

~MsRunXicExtractorInterface()

pappso::MsRunXicExtractorInterface::~MsRunXicExtractorInterface ( )

protectedvirtual

Definition at line 72 of file msrunxicextractorinterface.cpp.

Member Function Documentation

getMsRunId()

const MsRunIdCstSPtr & pappso::MsRunXicExtractorInterface::getMsRunId

(

)

const

Definition at line 88 of file msrunxicextractorinterface.cpp.

getXicCstSPtr() [1/2]

XicCstSPtr pappso::MsRunXicExtractorInterface::getXicCstSPtr ( const MzRange &  mz_range )

finalvirtual

get a XIC on this MsRun at the given mass range

Parameters

mz_range

mz range to extract

Definition at line 77 of file msrunxicextractorinterface.cpp.

getXicCstSPtr() [2/2]

virtual XicCstSPtr pappso::MsRunXicExtractorInterface::getXicCstSPtr ( const MzRange &  mz_range, pappso::pappso_double  rt_begin, pappso::pappso_double  rt_end  )

pure virtual

get a XIC on this MsRun at the given mass range

Parameters

mz_range	mz range to extract
rt_begin	begining of the XIC in seconds
rt_end	end of the XIC in seconds

Implemented in pappso::MsRunXicExtractor, and pappso::MsRunXicExtractorDisk.

getXicCstSPtrList()

virtual std::vector<XicCstSPtr> pappso::MsRunXicExtractorInterface::getXicCstSPtrList ( const std::vector< MzRange > &  mz_range_list )

pure virtual

extract a list of XIC given a list of mass to extract

Implemented in pappso::MsRunXicExtractor, and pappso::MsRunXicExtractorDisk.

setXicExtractMethod()

void pappso::MsRunXicExtractorInterface::setXicExtractMethod

(

XicExtractMethod

method

)

set the XIC extraction method

Definition at line 83 of file msrunxicextractorinterface.cpp.

Member Data Documentation

m_xicExtractMethod

XicExtractMethod pappso::MsRunXicExtractorInterface::m_xicExtractMethod = XicExtractMethod::max

protected

Definition at line 106 of file msrunxicextractorinterface.h.

Referenced by pappso::MsRunXicExtractorDisk::getXicCstSPtr().

msp_msrun_reader

MsRunReaderSPtr pappso::MsRunXicExtractorInterface::msp_msrun_reader

protected

Definition at line 105 of file msrunxicextractorinterface.h.

Referenced by pappso::MsRunXicExtractor::MsRunXicExtractor(), pappso::MsRunXicExtractorDisk::MsRunXicExtractorDisk(), and pappso::MsRunXicExtractorDisk::serializeMsRun().

---

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

• pappsomspp/xicextractor/msrunxicextractorinterface.h
• pappsomspp/xicextractor/msrunxicextractorinterface.cpp