pappsomspp
Library for mass spectrometry
pappso::MsRunXicExtractorDiskBuffer Class Reference

#include <msrunxicextractordiskbuffer.h>

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

Public Member Functions

 MsRunXicExtractorDiskBuffer (const MsRunXicExtractorDiskBuffer &other)
 
virtual ~MsRunXicExtractorDiskBuffer ()
 
- Public Member Functions inherited from pappso::MsRunXicExtractorDisk
 MsRunXicExtractorDisk (MsRunReaderSPtr &msrun_reader)
 
 MsRunXicExtractorDisk (const MsRunXicExtractorDisk &other)
 
virtual ~MsRunXicExtractorDisk ()
 
virtual XicCstSPtr getXicCstSPtr (const MzRange &mz_range, pappso::pappso_double rt_begin, pappso::pappso_double rt_end) override
 get a XIC on this MsRun at the given mass range More...
 
virtual std::vector< XicCstSPtrgetXicCstSPtrList (const std::vector< MzRange > &mz_range_list) override
 extract a list of XIC given a list of mass to extract More...
 
- Public Member Functions inherited from pappso::MsRunXicExtractor
 MsRunXicExtractor (const MsRunXicExtractor &other)
 
virtual ~MsRunXicExtractor ()
 
- Public Member Functions inherited from pappso::MsRunXicExtractorInterface
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...
 
const MsRunIdCstSPtrgetMsRunId () const
 

Protected Member Functions

 MsRunXicExtractorDiskBuffer (MsRunReaderSPtr &msrun_reader, const QDir &temporary_dir)
 
virtual void storeSlices (std::map< unsigned int, MassSpectrum > &slice_vector, std::size_t ipos) override
 store MassSpectrum slices (by daltons) for a given retention time More...
 
void appendSliceInBuffer (unsigned int slice_number, MassSpectrum &spectrum, std::size_t ipos)
 
void flushBufferOnDisk ()
 
virtual void endPwizRead () override
 
- Protected Member Functions inherited from pappso::MsRunXicExtractorDisk
 MsRunXicExtractorDisk (MsRunReaderSPtr &msrun_reader, const QDir &temporary_dir)
 
void prepareExtractor ()
 
void serializeMsRun ()
 
void appendSliceOnDisk (unsigned int slice_number, MassSpectrum &spectrum, std::size_t ipos)
 append a slice on disk (in a file) More...
 
std::vector< MsRunSliceSPtracquireSlices (const MzRange &mz_range)
 retrieve all the slices corresponding to a given mz_range More...
 
MsRunSliceSPtr unserializeSlice (unsigned int slice_number)
 get one slice from disk by her slice number (dalton) More...
 
- Protected Member Functions inherited from pappso::MsRunXicExtractor
 MsRunXicExtractor (MsRunReaderSPtr &msrun_reader)
 
virtual void getXicFromPwizMSDataFile (std::vector< Xic * > &xic_list, const std::vector< MzRange > &mass_range_list, pappso::pappso_double rt_begin, pappso::pappso_double rt_end)
 
- Protected Member Functions inherited from pappso::MsRunXicExtractorInterface
 MsRunXicExtractorInterface (MsRunReaderSPtr &msrun_reader)
 constructor is private, use the MsRunXicExtractorFactory More...
 
 MsRunXicExtractorInterface (const MsRunXicExtractorInterface &other)
 
virtual ~MsRunXicExtractorInterface ()
 

Protected Attributes

std::map< unsigned int, QByteArray > m_sliceBufferMap
 
std::size_t m_bufferSize = 0
 
std::size_t m_bufferMaxSize = 150
 
- Protected Attributes inherited from pappso::MsRunXicExtractorDisk
QString m_temporaryDirectory
 
QTemporaryDir * mpa_temporaryDirectory = nullptr
 
std::vector< pappso::pappso_doublem_retentionTimeList
 
pappso::pappso_double m_maxMz = 0
 
pappso::pappso_double m_minMz = 5000
 
std::size_t m_rtSize = 0
 
std::deque< MsRunSliceSPtrm_msRunSliceListCache
 
QMutex m_mutex
 
- Protected Attributes inherited from pappso::MsRunXicExtractor
std::vector< MsRunXicExtractorPoints > m_msrun_points
 
- Protected Attributes inherited from pappso::MsRunXicExtractorInterface
MsRunReaderSPtr msp_msrun_reader
 
XicExtractMethod m_xicExtractMethod = XicExtractMethod::max
 

Private Attributes

friend MsRunXicExtractorFactory
 

Detailed Description

Definition at line 42 of file msrunxicextractordiskbuffer.h.

Constructor & Destructor Documentation

◆ MsRunXicExtractorDiskBuffer() [1/2]

pappso::MsRunXicExtractorDiskBuffer::MsRunXicExtractorDiskBuffer ( MsRunReaderSPtr msrun_reader,
const QDir &  temporary_dir 
)
protected

Definition at line 59 of file msrunxicextractordiskbuffer.cpp.

63 {
64 
65  m_bufferSize++;

References m_bufferSize.

◆ MsRunXicExtractorDiskBuffer() [2/2]

pappso::MsRunXicExtractorDiskBuffer::MsRunXicExtractorDiskBuffer ( const MsRunXicExtractorDiskBuffer other)

Definition at line 67 of file msrunxicextractordiskbuffer.cpp.

67  {
68  appendSliceInBuffer(msrun_slice.first, msrun_slice.second, ipos);
69  }
70 
72  {

References appendSliceInBuffer().

◆ ~MsRunXicExtractorDiskBuffer()

pappso::MsRunXicExtractorDiskBuffer::~MsRunXicExtractorDiskBuffer ( )
virtual

Definition at line 75 of file msrunxicextractordiskbuffer.cpp.

Member Function Documentation

◆ appendSliceInBuffer()

void pappso::MsRunXicExtractorDiskBuffer::appendSliceInBuffer ( unsigned int  slice_number,
MassSpectrum spectrum,
std::size_t  ipos 
)
protected

Definition at line 97 of file msrunxicextractordiskbuffer.cpp.

98  { // new buffer
99  ret.first->second.resize(0);
100  QDataStream outstream(&ret.first->second, QIODevice::WriteOnly);
101  outstream << (quint32)ipos;
102  outstream << spectrum;
103  }
104  else
105  {
106  QDataStream outstream(&ret.first->second,
107  QIODevice::WriteOnly | QIODevice::Append);
108  outstream << (quint32)ipos;
109  outstream << spectrum;
110  }
111  }
112  catch(PappsoException &error_pappso)
113  {
115  QObject::tr("appendSliceInBuffer : error ipos=%1 :\n%2")
116  .arg(ipos)
117  .arg(error_pappso.qwhat()));
118  }
119  catch(std::exception &error)
120  {
122  QObject::tr("appendSliceInBuffer slice_number=%1 ipos=%2 error :\n%3")
123  .arg(slice_number)
124  .arg(ipos)
125  .arg(error.what()));
126  }
127  qDebug() << __FILE__ << " " << __FUNCTION__ << " " << __LINE__;
128 }
129 
130 
131 void
133 {
134  qDebug() << __FILE__ << " " << __FUNCTION__ << " " << __LINE__;
135 
136  try
137  {
138  for(auto &buffer_pair : m_sliceBufferMap)
139  {
140 
141  if(buffer_pair.second.size() > 0)
142  {
143  QFile slice_file(QString("%1/%2")
144  .arg(mpa_temporaryDirectory->path())
145  .arg(buffer_pair.first));
146  bool new_file = false;
147  if(!slice_file.exists())

Referenced by MsRunXicExtractorDiskBuffer().

◆ endPwizRead()

void pappso::MsRunXicExtractorDiskBuffer::endPwizRead ( )
overrideprotectedvirtual

Reimplemented from pappso::MsRunXicExtractorDisk.

Definition at line 227 of file msrunxicextractordiskbuffer.cpp.

◆ flushBufferOnDisk()

void pappso::MsRunXicExtractorDiskBuffer::flushBufferOnDisk ( )
protected

Definition at line 151 of file msrunxicextractordiskbuffer.cpp.

152  {
154  QObject::tr("unable to open file %1")
155  .arg(slice_file.fileName()));
156  }
157  }
158  else
159  {
160  if(!slice_file.open(QIODevice::WriteOnly | QIODevice::Append))
161  {
163  QObject::tr("unable to open file %1")
164  .arg(slice_file.fileName()));
165  }
166  }
167 
168  QDataStream stream(&slice_file);
169 
170  if(new_file)
171  {
172  stream << (quint32)buffer_pair.first;
173  stream << (quint32)m_rtSize;
174  stream.writeRawData(buffer_pair.second.constData(),
175  buffer_pair.second.size());
176  }
177  else
178  {
179  stream.writeRawData(buffer_pair.second.constData(),
180  buffer_pair.second.size());
181  }
182 
183 
184  slice_file.flush();
185  slice_file.close();
186  }
187  // buffer_pair.second = std::vector<MassSpectrum>();
188  }
189 
190  m_bufferSize = 0;
191  m_sliceBufferMap.clear();
192  }
193  catch(PappsoException &error_pappso)
194  {
196  QObject::tr("flushBufferOnDisk error :\n%1").arg(error_pappso.qwhat()));
197  }
198  catch(std::exception &error)
199  {
201  QObject::tr("flushBufferOnDisk error :\n%1").arg(error.what()));
202  }
203  qDebug() << __FILE__ << " " << __FUNCTION__ << " " << __LINE__;
204 }
205 
206 
207 void
209 {
211 
212  m_sliceBufferMap.clear();
213 }
214 } // namespace pappso

◆ storeSlices()

void pappso::MsRunXicExtractorDiskBuffer::storeSlices ( std::map< unsigned int, MassSpectrum > &  slice_vector,
std::size_t  ipos 
)
overrideprotectedvirtual

store MassSpectrum slices (by daltons) for a given retention time

Parameters
slice_vectormass spectrum chunks (by daltons)
iposthe position in the retention time vector

Reimplemented from pappso::MsRunXicExtractorDisk.

Definition at line 80 of file msrunxicextractordiskbuffer.cpp.

81 {
82  qDebug() << __FILE__ << " " << __FUNCTION__ << " " << __LINE__;
83 
84  if(ipos < 0)
85  return;
86  std::size_t spectrum_size = spectrum.size();
87 
88  if(spectrum_size == 0)
89  return;
90  try
91  {
92  std::pair<std::map<unsigned int, QByteArray>::iterator, bool> ret =
93  m_sliceBufferMap.insert(
94  std::pair<unsigned int, QByteArray>(slice_number, QByteArray()));

References m_sliceBufferMap.

Member Data Documentation

◆ m_bufferMaxSize

std::size_t pappso::MsRunXicExtractorDiskBuffer::m_bufferMaxSize = 150
protected

Definition at line 50 of file msrunxicextractordiskbuffer.h.

◆ m_bufferSize

std::size_t pappso::MsRunXicExtractorDiskBuffer::m_bufferSize = 0
protected

Definition at line 49 of file msrunxicextractordiskbuffer.h.

Referenced by MsRunXicExtractorDiskBuffer().

◆ m_sliceBufferMap

std::map<unsigned int, QByteArray> pappso::MsRunXicExtractorDiskBuffer::m_sliceBufferMap
protected

Definition at line 47 of file msrunxicextractordiskbuffer.h.

Referenced by storeSlices().

◆ MsRunXicExtractorFactory

friend pappso::MsRunXicExtractorDiskBuffer::MsRunXicExtractorFactory
private

Definition at line 44 of file msrunxicextractordiskbuffer.h.


The documentation for this class was generated from the following files:
pappso::MsRunXicExtractorDiskBuffer::flushBufferOnDisk
void flushBufferOnDisk()
Definition: msrunxicextractordiskbuffer.cpp:151
pappso::MsRunXicExtractorDisk::mpa_temporaryDirectory
QTemporaryDir * mpa_temporaryDirectory
Definition: msrunxicextractordisk.h:98
pappso::MsRunXicExtractorDiskBuffer::m_bufferMaxSize
std::size_t m_bufferMaxSize
Definition: msrunxicextractordiskbuffer.h:50
pappso::MsRunXicExtractorDiskBuffer::appendSliceInBuffer
void appendSliceInBuffer(unsigned int slice_number, MassSpectrum &spectrum, std::size_t ipos)
Definition: msrunxicextractordiskbuffer.cpp:97
pappso::MsRunXicExtractorDisk::m_rtSize
std::size_t m_rtSize
Definition: msrunxicextractordisk.h:104
pappso::MsRunXicExtractorDiskBuffer::m_bufferSize
std::size_t m_bufferSize
Definition: msrunxicextractordiskbuffer.h:49
pappso::MsRunXicExtractorDiskBuffer::m_sliceBufferMap
std::map< unsigned int, QByteArray > m_sliceBufferMap
Definition: msrunxicextractordiskbuffer.h:47
pappso::PappsoException
Definition: pappsoexception.h:60
pappso::MsRunXicExtractorDiskBuffer::endPwizRead
virtual void endPwizRead() override
Definition: msrunxicextractordiskbuffer.cpp:227