libpappsomspp
Library for mass spectrometry
pappso::TimsXicExtractorInterface Class Referenceabstract

#include <timsxicextractorinterface.h>

Inheritance diagram for pappso::TimsXicExtractorInterface:
pappso::TimsDirectXicExtractor

Public Member Functions

 TimsXicExtractorInterface (const TimsData *mp_tims_data)
 
virtual ~TimsXicExtractorInterface ()
 
void setXicExtractMethod (XicExtractMethod method)
 set the XIC extraction method More...
 

Protected Member Functions

virtual void extractTimsXicList (std::vector< TimsXicStructure > &timsXicList, double rtRange) const =0
 extract XICs for given coordinates XICs are extracted given their coordinates : retention time target, mobility range, mz range More...
 

Protected Attributes

const TimsDatamp_timsData
 
XicExtractMethod m_xicExtractMethod = XicExtractMethod::max
 

Private Attributes

friend TimsData
 

Detailed Description

Todo:
set of minimum functions to build XICs using Tims data

Definition at line 41 of file timsxicextractorinterface.h.

Constructor & Destructor Documentation

◆ TimsXicExtractorInterface()

TimsXicExtractorInterface::TimsXicExtractorInterface ( const TimsData mp_tims_data)

Definition at line 32 of file timsxicextractorinterface.cpp.

34  : mp_timsData(mp_tims_data)
35 {
36 }

◆ ~TimsXicExtractorInterface()

TimsXicExtractorInterface::~TimsXicExtractorInterface ( )
virtual

Definition at line 38 of file timsxicextractorinterface.cpp.

39 {
40 }

Member Function Documentation

◆ extractTimsXicList()

virtual void pappso::TimsXicExtractorInterface::extractTimsXicList ( std::vector< TimsXicStructure > &  timsXicList,
double  rtRange 
) const
protectedpure virtual

extract XICs for given coordinates XICs are extracted given their coordinates : retention time target, mobility range, mz range

Parameters
timsXicListlist of TIMS XIC structures (XIC coordinates)
rtRangethe range in seconds that will be applied before and after XIC rtTarget to extract signal

Implemented in pappso::TimsDirectXicExtractor.

Referenced by pappso::TimsData::extractXicListByPrecursorIds().

◆ setXicExtractMethod()

void TimsXicExtractorInterface::setXicExtractMethod ( XicExtractMethod  method)

set the XIC extraction method

Definition at line 43 of file timsxicextractorinterface.cpp.

44 {
45  m_xicExtractMethod = method;
46 }

References m_xicExtractMethod.

Referenced by pappso::TimsData::extractXicListByPrecursorIds().

Member Data Documentation

◆ m_xicExtractMethod

XicExtractMethod pappso::TimsXicExtractorInterface::m_xicExtractMethod = XicExtractMethod::max
protected

◆ mp_timsData

const TimsData* pappso::TimsXicExtractorInterface::mp_timsData
protected

◆ TimsData

friend pappso::TimsXicExtractorInterface::TimsData
private

Definition at line 43 of file timsxicextractorinterface.h.


The documentation for this class was generated from the following files:
pappso::TimsXicExtractorInterface::mp_timsData
const TimsData * mp_timsData
Definition: timsxicextractorinterface.h:66
pappso::TimsXicExtractorInterface::m_xicExtractMethod
XicExtractMethod m_xicExtractMethod
Definition: timsxicextractorinterface.h:67