Description of the settings a MS Instrument was run with. More...
#include <OpenMS/METADATA/InstrumentSettings.h>
Public Types | |
| enum | ScanMode { UNKNOWN, MASSSPECTRUM, MS1SPECTRUM, MSNSPECTRUM, SIM, SRM, CRM, CNG, CNL, PRECURSOR, EMC, TDF, EMR, EMISSION, ABSORBTION, SIZE_OF_SCANMODE } |
scan mode More... | |
Public Member Functions | |
| InstrumentSettings () | |
| Constructor. | |
| InstrumentSettings (const InstrumentSettings &source) | |
| Copy constructor. | |
| ~InstrumentSettings () | |
| Destructor. | |
| InstrumentSettings & | operator= (const InstrumentSettings &source) |
| Assignment operator. | |
| bool | operator== (const InstrumentSettings &rhs) const |
| Equality operator. | |
| bool | operator!= (const InstrumentSettings &rhs) const |
| Equality operator. | |
| ScanMode | getScanMode () const |
| returns the scan mode | |
| void | setScanMode (ScanMode scan_mode) |
| sets the scan mode | |
| bool | getZoomScan () const |
| return if this scan is a zoom (enhanced resolution) scan | |
| void | setZoomScan (bool zoom_scan) |
| sets if this scan is a zoom (enhanced resolution) scan | |
| IonSource::Polarity | getPolarity () const |
| returns the polarity | |
| void | setPolarity (IonSource::Polarity polarity) |
| sets the polarity | |
| const std::vector< ScanWindow > & | getScanWindows () const |
| returns a const reference to the m/z scan windows | |
| std::vector< ScanWindow > & | getScanWindows () |
| returns a mutable reference to the m/z scan windows | |
| void | setScanWindows (std::vector< ScanWindow > scan_windows) |
| sets the m/z scan windows | |
Static Public Attributes | |
| static const std::string | NamesOfScanMode [SIZE_OF_SCANMODE] |
| Names of scan modes. | |
Protected Attributes | |
| ScanMode | scan_mode_ |
| bool | zoom_scan_ |
| IonSource::Polarity | polarity_ |
| std::vector< ScanWindow > | scan_windows_ |
Detailed Description
Description of the settings a MS Instrument was run with.
Member Enumeration Documentation
| enum ScanMode |
scan mode
- Enumerator:
UNKNOWN Unknown scan method.
MASSSPECTRUM general spectrum type
MS1SPECTRUM full scan mass spectrum, is a "mass spectrum"
Synonyms: 'full spectrum', 'Q1 spectrum', 'Q3 spectrum', 'Single-Stage Mass Spectrometry'MSNSPECTRUM MS2+ mass spectrum, is a "mass spectrum".
SIM Selected ion monitoring scan
Synonyms: 'Multiple ion monitoring scan', 'SIM scan', 'MIM scan'.SRM Selected reaction monitoring scan
Synonyms: 'Multiple reaction monitoring scan', 'SRM scan', 'MRM scan'.CRM Consecutive reaction monitoring scan
Synonyms: 'CRM scan'.CNG Constant neutral gain scan
Synonyms: 'CNG scan'.CNL Constant neutral loss scan
Synonyms: 'CNG scan'.PRECURSOR Precursor ion scan.
EMC Enhanced multiply charged scan.
TDF Time-delayed fragmentation scan.
EMR Electromagnetic radiation scan
Synonyms: 'EMR spectrum'.EMISSION Emission scan.
ABSORBTION Absorbtion scan.
SIZE_OF_SCANMODE
Constructor & Destructor Documentation
Constructor.
| InstrumentSettings | ( | const InstrumentSettings & | source | ) |
Copy constructor.
| ~InstrumentSettings | ( | ) |
Destructor.
Member Function Documentation
| IonSource::Polarity getPolarity | ( | ) | const |
returns the polarity
Referenced by DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
| ScanMode getScanMode | ( | ) | const |
returns the scan mode
Referenced by DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
| const std::vector<ScanWindow>& getScanWindows | ( | ) | const |
returns a const reference to the m/z scan windows
Referenced by MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::handleUserParam_(), MzMLHandler< MapType >::startElement(), MzDataHandler< MapType >::startElement(), DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
| std::vector<ScanWindow>& getScanWindows | ( | ) |
returns a mutable reference to the m/z scan windows
| bool getZoomScan | ( | ) | const |
return if this scan is a zoom (enhanced resolution) scan
Referenced by DBAdapter::storeExperiment(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
| bool operator!= | ( | const InstrumentSettings & | rhs | ) | const |
Equality operator.
| InstrumentSettings& operator= | ( | const InstrumentSettings & | source | ) |
Assignment operator.
| bool operator== | ( | const InstrumentSettings & | rhs | ) | const |
Equality operator.
| void setPolarity | ( | IonSource::Polarity | polarity | ) |
sets the polarity
Referenced by MzDataHandler< MapType >::cvParam_(), MzMLHandler< MapType >::handleCVParam_(), XMassFile::load(), and DBAdapter::loadSpectrum().
| void setScanMode | ( | ScanMode | scan_mode | ) |
sets the scan mode
Referenced by MzDataHandler< MapType >::cvParam_(), MzMLHandler< MapType >::handleCVParam_(), XMassFile::load(), and DBAdapter::loadSpectrum().
| void setScanWindows | ( | std::vector< ScanWindow > | scan_windows | ) |
sets the m/z scan windows
| void setZoomScan | ( | bool | zoom_scan | ) |
sets if this scan is a zoom (enhanced resolution) scan
Referenced by MzDataHandler< MapType >::cvParam_(), MzMLHandler< MapType >::handleCVParam_(), XMassFile::load(), and DBAdapter::loadSpectrum().
Member Data Documentation
const std::string NamesOfScanMode[SIZE_OF_SCANMODE] [static] |
Names of scan modes.
Referenced by MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
IonSource::Polarity polarity_ [protected] |
ScanMode scan_mode_ [protected] |
std::vector<ScanWindow> scan_windows_ [protected] |
bool zoom_scan_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |