libpappsomspp
Library for mass spectrometry
pappso::MsRunXicExtractorInterface Class Referenceabstract

#include <msrunxicextractorinterface.h>

Inheritance diagram for pappso::MsRunXicExtractorInterface:
pappso::MsRunXicExtractor pappso::MsRunXicExtractorDisk pappso::MsRunXicExtractorDiskBuffer

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< XicCstSPtrgetXicCstSPtrList (const std::vector< MzRange > &mz_range_list)=0
 extract a list of XIC given a list of mass to extract More...
 
const MsRunIdCstSPtrgetMsRunId () 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 45 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 37 of file msrunxicextractorinterface.cpp.

39  : msp_msrun_reader(msrun_reader)
40 {
41 }

◆ MsRunXicExtractorInterface() [2/2]

pappso::MsRunXicExtractorInterface::MsRunXicExtractorInterface ( const MsRunXicExtractorInterface other)
protected

Definition at line 44 of file msrunxicextractorinterface.cpp.

46  : msp_msrun_reader(other.msp_msrun_reader)
47 {
48  m_xicExtractMethod = other.m_xicExtractMethod;
49 }

References m_xicExtractMethod.

◆ ~MsRunXicExtractorInterface()

pappso::MsRunXicExtractorInterface::~MsRunXicExtractorInterface ( )
protectedvirtual

Definition at line 51 of file msrunxicextractorinterface.cpp.

52 {
53 }

Member Function Documentation

◆ getMsRunId()

const MsRunIdCstSPtr & pappso::MsRunXicExtractorInterface::getMsRunId ( ) const

Definition at line 67 of file msrunxicextractorinterface.cpp.

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

References msp_msrun_reader.

◆ 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_rangemz range to extract

Definition at line 56 of file msrunxicextractorinterface.cpp.

57 {
58  return getXicCstSPtr(mz_range, 0, 100000000);
59 }
virtual XicCstSPtr getXicCstSPtr(const MzRange &mz_range) final
get a XIC on this MsRun at the given mass range

◆ 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_rangemz range to extract
rt_beginbegining of the XIC in seconds
rt_endend of the XIC in seconds

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

◆ 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::MsRunXicExtractorDisk, and pappso::MsRunXicExtractor.

◆ setXicExtractMethod()

void pappso::MsRunXicExtractorInterface::setXicExtractMethod ( XicExtractMethod  method)

set the XIC extraction method

Definition at line 62 of file msrunxicextractorinterface.cpp.

63 {
64  m_xicExtractMethod = method;
65 }

References m_xicExtractMethod.

Member Data Documentation

◆ m_xicExtractMethod

◆ msp_msrun_reader


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