ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::analysis::IsolationWindow Struct Reference

A container that wraps DemuxWindow to preserve the full precision window boundaries. More...

#include <IPrecursorMaskCodec.hpp>

Public Member Functions

 IsolationWindow (const msdata::Precursor &p)
 Constructs an IsolationWindow from a Precursor. More...
 
 IsolationWindow (double mzLow, double mzHigh)
 Constructs an IsolationWindow from a given mass range. More...
 
bool operator< (const IsolationWindow &rhs) const
 Isolation windows are sorted by their start value. More...
 

Public Attributes

double lowMz
 Full precision lower m/z bound. More...
 
double highMz
 Full precision upper m/z bound. More...
 
DemuxWindow demuxWindow
 Set of isolation window boundaries that provides useful operations for sorting and comparing different isolation windows. More...
 

Detailed Description

A container that wraps DemuxWindow to preserve the full precision window boundaries.

Definition at line 167 of file IPrecursorMaskCodec.hpp.

Constructor & Destructor Documentation

◆ IsolationWindow() [1/2]

pwiz::analysis::IsolationWindow::IsolationWindow ( const msdata::Precursor p)
inlineexplicit

Constructs an IsolationWindow from a Precursor.

Definition at line 171 of file IPrecursorMaskCodec.hpp.

◆ IsolationWindow() [2/2]

pwiz::analysis::IsolationWindow::IsolationWindow ( double  mzLow,
double  mzHigh 
)
inline

Constructs an IsolationWindow from a given mass range.

Definition at line 175 of file IPrecursorMaskCodec.hpp.

175  :
176  lowMz(mzLow), highMz(mzHigh), demuxWindow(IsoWindowHasher::Hash(mzLow), IsoWindowHasher::Hash(mzHigh)) {}

Member Function Documentation

◆ operator<()

bool pwiz::analysis::IsolationWindow::operator< ( const IsolationWindow rhs) const
inline

Isolation windows are sorted by their start value.

Definition at line 187 of file IPrecursorMaskCodec.hpp.

187 { return this->demuxWindow < rhs.demuxWindow; }

References demuxWindow.

Member Data Documentation

◆ lowMz

double pwiz::analysis::IsolationWindow::lowMz

Full precision lower m/z bound.

Definition at line 178 of file IPrecursorMaskCodec.hpp.

◆ highMz

double pwiz::analysis::IsolationWindow::highMz

Full precision upper m/z bound.

Definition at line 180 of file IPrecursorMaskCodec.hpp.

◆ demuxWindow

DemuxWindow pwiz::analysis::IsolationWindow::demuxWindow

Set of isolation window boundaries that provides useful operations for sorting and comparing different isolation windows.

Definition at line 184 of file IPrecursorMaskCodec.hpp.

Referenced by operator<().


The documentation for this struct was generated from the following file:
pwiz::analysis::IsolationWindow::demuxWindow
DemuxWindow demuxWindow
Set of isolation window boundaries that provides useful operations for sorting and comparing differen...
Definition: IPrecursorMaskCodec.hpp:184
pwiz::analysis::IsoWindowHasher::Hash
static MZHash Hash(double mz)
Hash a floating-point m/z value to an integer.
Definition: IPrecursorMaskCodec.hpp:104
pwiz::analysis::precursor_mz_low
double precursor_mz_low(const msdata::Precursor &p)
Definition: IPrecursorMaskCodec.hpp:59
pwiz::analysis::precursor_mz_high
double precursor_mz_high(const msdata::Precursor &p)
Definition: IPrecursorMaskCodec.hpp:64
pwiz::analysis::IsolationWindow::lowMz
double lowMz
Full precision lower m/z bound.
Definition: IPrecursorMaskCodec.hpp:178
pwiz::analysis::IsolationWindow::highMz
double highMz
Full precision upper m/z bound.
Definition: IPrecursorMaskCodec.hpp:180