pappsomspp
Library for mass spectrometry
pappso::QualifiedMassSpectrum Class Reference

Class representing a fully specified mass spectrum. More...

#include <qualifiedmassspectrum.h>

Public Member Functions

 QualifiedMassSpectrum ()
 Construct an uninitialized QualifiedMassSpectrum. More...
 
 QualifiedMassSpectrum (const MassSpectrumId &id)
 Construct a QualifiedMassSpectrum using a MassSpectrumId;. More...
 
 QualifiedMassSpectrum (MassSpectrumSPtr mass_spectrum_SPtr)
 
 QualifiedMassSpectrum (const QualifiedMassSpectrum &other)
 Construct a QualifiedMassSpectrum as a copy of other. More...
 
 ~QualifiedMassSpectrum ()
 Destruct this QualifiedMassSpectrum. More...
 
QualifiedMassSpectrumSPtr makeQualifiedMassSpectrumSPtr () const
 
QualifiedMassSpectrumCstSPtr makeQualifiedMassSpectrumCstSPtr () const
 
void setMassSpectrumId (const MassSpectrumId &iD)
 Set the MassSpectrumId. More...
 
const MassSpectrumIdgetMassSpectrumId () const
 Get the MassSpectrumId. More...
 
void setMassSpectrumSPtr (MassSpectrumSPtr massSpectrum)
 Set the MassSpectrumSPtr. More...
 
MassSpectrumSPtr getMassSpectrumSPtr () const
 Get the MassSpectrumSPtr. More...
 
MassSpectrumCstSPtr getMassSpectrumCstSPtr () const
 Get the MassSpectrumCstSPtr. More...
 
void setEmptyMassSpectrum (bool is_empty_mass_spectrum)
 
bool isEmptyMassSpectrum () const
 
void setPrecursorCharge (uint precursor_charge)
 Set the precursor charge. More...
 
uint getPrecursorCharge () const
 Get the precursor charge. More...
 
void setPrecursorMz (pappso_double precursor_mz)
 Set the precursor m/z ratio. More...
 
pappso_double getPrecursorMz () const
 Get the precursor m/z ratio. More...
 
void setMsLevel (uint ms_level)
 Set the mass spectrum level. More...
 
uint getMsLevel () const
 Get the mass spectrum level. More...
 
void setPrecursorSpectrumIndex (std::size_t precursor_scan_num)
 Set the scan number of the precursor ion. More...
 
std::size_t getPrecursorSpectrumIndex () const
 Get the scan number of the precursor ion. More...
 
void setPrecursorNativeId (const QString &native_id)
 Set the scan native id of the precursor ion. More...
 
const QString & getPrecursorNativeId () const
 
void setRtInSeconds (pappso_double rt)
 Set the retention time in seconds. More...
 
pappso_double getRtInSeconds () const
 Get the retention time in seconds. More...
 
pappso_double getRtInMinutes () const
 Get the retention time in minutes. More...
 
void setDtInMilliSeconds (pappso_double rt)
 Set the drift time in milliseconds. More...
 
pappso_double getDtInMilliSeconds () const
 Get the drift time in milliseconds. More...
 
void setPrecursorIntensity (pappso_double intensity)
 Set the intensity of the precursor ion. More...
 
pappso_double getPrecursorIntensity () const
 Get the intensity of the precursor ion. More...
 
void setParameterValue (QualifiedMassSpectrumParameter parameter, const QVariant &value)
 
const QVariant getParameterValue (QualifiedMassSpectrumParameter parameter) const
 
std::size_t size () const
 
QString toString () const
 

Protected Attributes

MassSpectrumSPtr msp_massSpectrum = nullptr
 Shared pointer to the mass spectrum. More...
 
MassSpectrumId m_massSpectrumId
 Id of the mass spectrum. More...
 
bool m_isEmptyMassSpectrum = false
 
unsigned int m_msLevel = 0
 Mass spectrometry level of this mass spectrum. More...
 
pappso_double m_rt = -1
 Retention time (in seconds) at which this mass spectrum was acquired. More...
 
pappso_double m_dt = -1
 Drift time (in milliseconds) at which this mass spectrum was acquired. More...
 
std::size_t m_precursorSpectrumIndex
 Index of the spectrum of the precusor ion that was fragmented to yield. More...
 
QString m_precursorNativeId
 Native XML id of the spectrum relative to the mz data native file. More...
 
pappso_double m_precursorMz = std::numeric_limits<double>::max()
 
unsigned int m_precursorCharge = std::numeric_limits<unsigned int>::max()
 Charge of the precursor that was fragmented to yield this mass spectrum. More...
 
pappso_double m_precursorIntensity = std::numeric_limits<double>::max()
 
std::map< QualifiedMassSpectrumParameter, QVariant > m_params
 map containing any parameter value for this spectrum More...
 

Detailed Description

Class representing a fully specified mass spectrum.

The member data that qualify the MassSpectrum msp_massSpectrum member allow to unambiguously characterize the mass spectrum.

See also
MassSpectrum

Definition at line 83 of file qualifiedmassspectrum.h.

Constructor & Destructor Documentation

◆ QualifiedMassSpectrum() [1/4]

pappso::QualifiedMassSpectrum::QualifiedMassSpectrum ( )

Construct an uninitialized QualifiedMassSpectrum.

Definition at line 56 of file qualifiedmassspectrum.cpp.

◆ QualifiedMassSpectrum() [2/4]

pappso::QualifiedMassSpectrum::QualifiedMassSpectrum ( const MassSpectrumId id)

Construct a QualifiedMassSpectrum using a MassSpectrumId;.

Definition at line 62 of file qualifiedmassspectrum.cpp.

72 {

◆ QualifiedMassSpectrum() [3/4]

pappso::QualifiedMassSpectrum::QualifiedMassSpectrum ( MassSpectrumSPtr  mass_spectrum_SPtr)

Definition at line 68 of file qualifiedmassspectrum.cpp.

72 {

◆ QualifiedMassSpectrum() [4/4]

pappso::QualifiedMassSpectrum::QualifiedMassSpectrum ( const QualifiedMassSpectrum other)

Construct a QualifiedMassSpectrum as a copy of other.

Definition at line 76 of file qualifiedmassspectrum.cpp.

78 {
79  // qDebug() << __FILE__ << "@" << __LINE__ << __FUNCTION__ << " ()";
80 }
81 
82 
85 {
86  return std::make_shared<QualifiedMassSpectrum>(*this);
87 }
88 
89 

◆ ~QualifiedMassSpectrum()

pappso::QualifiedMassSpectrum::~QualifiedMassSpectrum ( )

Destruct this QualifiedMassSpectrum.

Definition at line 94 of file qualifiedmassspectrum.cpp.

Member Function Documentation

◆ getDtInMilliSeconds()

pappso_double pappso::QualifiedMassSpectrum::getDtInMilliSeconds ( ) const

Get the drift time in milliseconds.

Definition at line 253 of file qualifiedmassspectrum.cpp.

253 {
255 }
256 

References m_precursorSpectrumIndex.

◆ getMassSpectrumCstSPtr()

MassSpectrumCstSPtr pappso::QualifiedMassSpectrum::getMassSpectrumCstSPtr ( ) const

◆ getMassSpectrumId()

◆ getMassSpectrumSPtr()

MassSpectrumSPtr pappso::QualifiedMassSpectrum::getMassSpectrumSPtr ( ) const

◆ getMsLevel()

unsigned int pappso::QualifiedMassSpectrum::getMsLevel ( ) const

◆ getParameterValue()

const QVariant pappso::QualifiedMassSpectrum::getParameterValue ( QualifiedMassSpectrumParameter  parameter) const

Definition at line 371 of file qualifiedmassspectrum.cpp.

◆ getPrecursorCharge()

unsigned int pappso::QualifiedMassSpectrum::getPrecursorCharge ( ) const

Get the precursor charge.

Definition at line 178 of file qualifiedmassspectrum.cpp.

178 {
179  return m_precursorMz;
180 }
181 

References m_precursorMz.

Referenced by pappso::MassSpectrumWidget::setQualifiedMassSpectrum(), and pappso::MzxmlOutput::writeQualifiedMassSpectrum().

◆ getPrecursorIntensity()

pappso_double pappso::QualifiedMassSpectrum::getPrecursorIntensity ( ) const

Get the intensity of the precursor ion.

Definition at line 297 of file qualifiedmassspectrum.cpp.

299 {
300  QString text;

References msp_massSpectrum.

Referenced by pappso::MsRunRetentionTime< T >::addPeptideAsSeamark(), and pappso::MzxmlOutput::writeQualifiedMassSpectrum().

◆ getPrecursorMz()

pappso_double pappso::QualifiedMassSpectrum::getPrecursorMz ( ) const

Get the precursor m/z ratio.

Definition at line 194 of file qualifiedmassspectrum.cpp.

194 {
195  return m_msLevel;
196 }
197 

References m_msLevel.

Referenced by pappso::MzxmlOutput::writeQualifiedMassSpectrum().

◆ getPrecursorNativeId()

const QString & pappso::QualifiedMassSpectrum::getPrecursorNativeId ( ) const

◆ getPrecursorSpectrumIndex()

std::size_t pappso::QualifiedMassSpectrum::getPrecursorSpectrumIndex ( ) const

Get the scan number of the precursor ion.

Definition at line 269 of file qualifiedmassspectrum.cpp.

273 {

References m_precursorIntensity.

Referenced by pappso::MzxmlOutput::getPrecursorScanNumber().

◆ getRtInMinutes()

pappso_double pappso::QualifiedMassSpectrum::getRtInMinutes ( ) const

Get the retention time in minutes.

Definition at line 234 of file qualifiedmassspectrum.cpp.

237 {

References m_dt.

◆ getRtInSeconds()

pappso_double pappso::QualifiedMassSpectrum::getRtInSeconds ( ) const

Get the retention time in seconds.

Definition at line 226 of file qualifiedmassspectrum.cpp.

226 {
227  if(isinf(dt_in_milli_seconds))
228  m_dt = -1;
229  else

References m_dt.

Referenced by pappso::MsRunRetentionTime< T >::addPeptideAsSeamark(), RetentionTimeReader::setQualifiedMassSpectrum(), and pappso::MzxmlOutput::writeQualifiedMassSpectrum().

◆ isEmptyMassSpectrum()

bool pappso::QualifiedMassSpectrum::isEmptyMassSpectrum ( ) const

Definition at line 162 of file qualifiedmassspectrum.cpp.

162 {
163  return m_precursorCharge;
164 }
165 

References m_precursorCharge.

◆ makeQualifiedMassSpectrumCstSPtr()

QualifiedMassSpectrumCstSPtr pappso::QualifiedMassSpectrum::makeQualifiedMassSpectrumCstSPtr ( ) const

Definition at line 108 of file qualifiedmassspectrum.cpp.

108 {
109  return m_massSpectrumId;
110 }
111 

References m_massSpectrumId.

◆ makeQualifiedMassSpectrumSPtr()

QualifiedMassSpectrumSPtr pappso::QualifiedMassSpectrum::makeQualifiedMassSpectrumSPtr ( ) const

Definition at line 101 of file qualifiedmassspectrum.cpp.

◆ setDtInMilliSeconds()

void pappso::QualifiedMassSpectrum::setDtInMilliSeconds ( pappso_double  rt)

Set the drift time in milliseconds.

Definition at line 242 of file qualifiedmassspectrum.cpp.

246 {
247  m_precursorSpectrumIndex = precursor_spectrum_index;
248 }

References m_precursorSpectrumIndex.

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

◆ setEmptyMassSpectrum()

void pappso::QualifiedMassSpectrum::setEmptyMassSpectrum ( bool  is_empty_mass_spectrum)

◆ setMassSpectrumId()

◆ setMassSpectrumSPtr()

◆ setMsLevel()

void pappso::QualifiedMassSpectrum::setMsLevel ( uint  ms_level)

◆ setParameterValue()

void pappso::QualifiedMassSpectrum::setParameterValue ( QualifiedMassSpectrumParameter  parameter,
const QVariant &  value 
)

Definition at line 358 of file qualifiedmassspectrum.cpp.

359  {
360  return QVariant();
361  }
362  else
363  {
364  return it->second;
365  }
366 }
367 
368 } // namespace pappso

Referenced by pappso::TimsData::getQualifiedMassSpectrumByRawIndex(), pappso::TimsData::getQualifiedMs1MassSpectrumByPrecursorId(), and pappso::TimsData::getQualifiedMs2MassSpectrumByPrecursorId().

◆ setPrecursorCharge()

void pappso::QualifiedMassSpectrum::setPrecursorCharge ( uint  precursor_charge)

◆ setPrecursorIntensity()

void pappso::QualifiedMassSpectrum::setPrecursorIntensity ( pappso_double  intensity)

Set the intensity of the precursor ion.

Definition at line 289 of file qualifiedmassspectrum.cpp.

290  {
291  throw pappso::PappsoException(QObject::tr("msp_massSpectrum == nullptr"));
292  }

Referenced by pappso::TimsData::getQualifiedMassSpectrumByRawIndex(), pappso::TimsData::getQualifiedMs1MassSpectrumByPrecursorId(), and pappso::TimsData::getQualifiedMs2MassSpectrumByPrecursorId().

◆ setPrecursorMz()

void pappso::QualifiedMassSpectrum::setPrecursorMz ( pappso_double  precursor_mz)

◆ setPrecursorNativeId()

void pappso::QualifiedMassSpectrum::setPrecursorNativeId ( const QString &  native_id)

Set the scan native id of the precursor ion.

Definition at line 276 of file qualifiedmassspectrum.cpp.

Referenced by pappso::TimsData::getQualifiedMassSpectrumByRawIndex(), and pappso::TimsData::getQualifiedMs2MassSpectrumByPrecursorId().

◆ setPrecursorSpectrumIndex()

void pappso::QualifiedMassSpectrum::setPrecursorSpectrumIndex ( std::size_t  precursor_scan_num)

◆ setRtInSeconds()

void pappso::QualifiedMassSpectrum::setRtInSeconds ( pappso_double  rt)

◆ size()

std::size_t pappso::QualifiedMassSpectrum::size ( ) const

Definition at line 304 of file qualifiedmassspectrum.cpp.

305  : %1 ")
306  .arg(Utils::pointerToString((void *)msp_massSpectrum.get()));
307 
308  text += pointer_string;
309  }
310  else
311  text += QString("msp_massSpectrum is nullptr ");

Referenced by pappso::TimsData::getQualifiedMassSpectrumByRawIndex(), and pappso::MzxmlOutput::writeQualifiedMassSpectrum().

◆ toString()

QString pappso::QualifiedMassSpectrum::toString ( ) const

Definition at line 315 of file qualifiedmassspectrum.cpp.

317  : %1 \n"
318  "m_msLevel: %2 ; m_rt (min): %3 ; m_dt (ms): %4 ; prec. spec. "
319  "index: %5 ; prec. mz: %6 ; prec. z: %7 ; prec. int.: %8")
320  .arg(m_massSpectrumId.toString())
321  .arg(m_msLevel)
322  .arg(getRtInMinutes(), 0, 'f', 2)
323  .arg(m_dt, 0, 'f', 5)
324  .arg(m_precursorSpectrumIndex != std::numeric_limits<std::size_t>::max()
325  ? m_precursorSpectrumIndex
326  : -1)
327  .arg(m_precursorMz != std::numeric_limits<double>::max() ? m_precursorMz
328  : -1)
329  .arg(m_precursorCharge != std::numeric_limits<unsigned int>::max()
330  ? m_precursorCharge
331  : -1)
332  .arg(m_precursorIntensity != std::numeric_limits<double>::max()
333  ? m_precursorIntensity
334  : -1);
335 
336  return text;
337 }
338 
339 
340 void
341 QualifiedMassSpectrum::setParameterValue(
342  QualifiedMassSpectrumParameter parameter, const QVariant &value)
343 {
344 
345  auto ret = m_params.insert(
346  std::pair<QualifiedMassSpectrumParameter, QVariant>(parameter, value));
347 
348  if(ret.second == false)
349  {
350  ret.first->second = value;
351  }
352 }
353 const QVariant
354 QualifiedMassSpectrum::getParameterValue(

Member Data Documentation

◆ m_dt

pappso_double pappso::QualifiedMassSpectrum::m_dt = -1
protected

Drift time (in milliseconds) at which this mass spectrum was acquired.

Definition at line 156 of file qualifiedmassspectrum.h.

Referenced by getRtInMinutes(), and getRtInSeconds().

◆ m_isEmptyMassSpectrum

bool pappso::QualifiedMassSpectrum::m_isEmptyMassSpectrum = false
protected

Definition at line 147 of file qualifiedmassspectrum.h.

◆ m_massSpectrumId

MassSpectrumId pappso::QualifiedMassSpectrum::m_massSpectrumId
protected

Id of the mass spectrum.

Definition at line 145 of file qualifiedmassspectrum.h.

Referenced by makeQualifiedMassSpectrumCstSPtr().

◆ m_msLevel

unsigned int pappso::QualifiedMassSpectrum::m_msLevel = 0
protected

Mass spectrometry level of this mass spectrum.

Definition at line 150 of file qualifiedmassspectrum.h.

Referenced by getPrecursorMz(), and setPrecursorMz().

◆ m_params

std::map<QualifiedMassSpectrumParameter, QVariant> pappso::QualifiedMassSpectrum::m_params
protected

map containing any parameter value for this spectrum

Definition at line 178 of file qualifiedmassspectrum.h.

◆ m_precursorCharge

unsigned int pappso::QualifiedMassSpectrum::m_precursorCharge = std::numeric_limits<unsigned int>::max()
protected

Charge of the precursor that was fragmented to yield this mass spectrum.

Definition at line 171 of file qualifiedmassspectrum.h.

Referenced by isEmptyMassSpectrum().

◆ m_precursorIntensity

pappso_double pappso::QualifiedMassSpectrum::m_precursorIntensity = std::numeric_limits<double>::max()
protected

Intensity of the precursor that was fragmented to yield this mass spectrum.

Definition at line 175 of file qualifiedmassspectrum.h.

Referenced by getPrecursorSpectrumIndex().

◆ m_precursorMz

pappso_double pappso::QualifiedMassSpectrum::m_precursorMz = std::numeric_limits<double>::max()
protected

m/z ratio of the precursor that was fragmented to yield this mass spectrum.

Definition at line 168 of file qualifiedmassspectrum.h.

Referenced by getPrecursorCharge(), and setPrecursorCharge().

◆ m_precursorNativeId

QString pappso::QualifiedMassSpectrum::m_precursorNativeId
protected

Native XML id of the spectrum relative to the mz data native file.

Definition at line 164 of file qualifiedmassspectrum.h.

◆ m_precursorSpectrumIndex

std::size_t pappso::QualifiedMassSpectrum::m_precursorSpectrumIndex
protected
Initial value:
=
std::numeric_limits<std::size_t>::max()

Index of the spectrum of the precusor ion that was fragmented to yield.

Definition at line 160 of file qualifiedmassspectrum.h.

Referenced by getDtInMilliSeconds(), and setDtInMilliSeconds().

◆ m_rt

pappso_double pappso::QualifiedMassSpectrum::m_rt = -1
protected

Retention time (in seconds) at which this mass spectrum was acquired.

Definition at line 153 of file qualifiedmassspectrum.h.

Referenced by getMsLevel(), setMsLevel(), and setRtInSeconds().

◆ msp_massSpectrum

MassSpectrumSPtr pappso::QualifiedMassSpectrum::msp_massSpectrum = nullptr
protected

Shared pointer to the mass spectrum.

Definition at line 142 of file qualifiedmassspectrum.h.

Referenced by getMassSpectrumId(), getPrecursorIntensity(), setMassSpectrumId(), and setMassSpectrumSPtr().


The documentation for this class was generated from the following files:
pappso::QualifiedMassSpectrum::m_precursorCharge
unsigned int m_precursorCharge
Charge of the precursor that was fragmented to yield this mass spectrum.
Definition: qualifiedmassspectrum.h:171
pappso::QualifiedMassSpectrum::m_dt
pappso_double m_dt
Drift time (in milliseconds) at which this mass spectrum was acquired.
Definition: qualifiedmassspectrum.h:156
pappso::QualifiedMassSpectrumSPtr
std::shared_ptr< QualifiedMassSpectrum > QualifiedMassSpectrumSPtr
Definition: qualifiedmassspectrum.h:57
pappso::QualifiedMassSpectrum::m_rt
pappso_double m_rt
Retention time (in seconds) at which this mass spectrum was acquired.
Definition: qualifiedmassspectrum.h:153
pappso::QualifiedMassSpectrum::m_precursorMz
pappso_double m_precursorMz
Definition: qualifiedmassspectrum.h:168
pappso::QualifiedMassSpectrum::makeQualifiedMassSpectrumSPtr
QualifiedMassSpectrumSPtr makeQualifiedMassSpectrumSPtr() const
Definition: qualifiedmassspectrum.cpp:101
pappso::QualifiedMassSpectrum::makeQualifiedMassSpectrumCstSPtr
QualifiedMassSpectrumCstSPtr makeQualifiedMassSpectrumCstSPtr() const
Definition: qualifiedmassspectrum.cpp:108
pappso::QualifiedMassSpectrum::msp_massSpectrum
MassSpectrumSPtr msp_massSpectrum
Shared pointer to the mass spectrum.
Definition: qualifiedmassspectrum.h:142
pappso::QualifiedMassSpectrum::m_massSpectrumId
MassSpectrumId m_massSpectrumId
Id of the mass spectrum.
Definition: qualifiedmassspectrum.h:145
pappso::QualifiedMassSpectrum::m_precursorSpectrumIndex
std::size_t m_precursorSpectrumIndex
Index of the spectrum of the precusor ion that was fragmented to yield.
Definition: qualifiedmassspectrum.h:160
pappso::QualifiedMassSpectrumCstSPtr
std::shared_ptr< const QualifiedMassSpectrum > QualifiedMassSpectrumCstSPtr
Definition: qualifiedmassspectrum.h:61
pappso::QualifiedMassSpectrum::m_msLevel
unsigned int m_msLevel
Mass spectrometry level of this mass spectrum.
Definition: qualifiedmassspectrum.h:150
pappso::PeptideIonCter::z
pappso::PrecisionUnit::mz
pappso::PappsoException
Definition: pappsoexception.h:60