Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

MassAnalyzer Class Reference
[Metadata]

#include <OpenMS/METADATA/MassAnalyzer.h>

Inheritance diagram for MassAnalyzer:

MetaInfoInterface

List of all members.


Detailed Description

Descripton of a mass analyzer ( Part of a MS Instrument ).

Public Types

enum  AnalyzerType {
  ANALYZERNULL, QUADRUPOLE, PAULIONTRAP, RADIALEJECTIONLINEARIONTRAP,
  AXIALEJECTIONLINEARIONTRAP, TOF, SECTOR, FOURIERTRANSFORM,
  IONSTORAGE, SIZE_OF_ANALYZERTYPE
}
 analyzer type More...
enum  ResolutionMethod {
  RESMETHNULL, FWHM, TENPERCENTVALLEY, BASELINE,
  SIZE_OF_RESOLUTIONMETHOD
}
 resolution method More...
enum  ResolutionType { RESTYPENULL, CONSTANT, PROPORTIONAL, SIZE_OF_RESOLUTIONTYPE }
enum  ScanFunction { SCANFCTNULL, SELECTEDIONDETECTION, MASSSCAN, SIZE_OF_SCANFUNCTION }
enum  ScanDirection { SCANDIRNULL, UP, DOWN, SIZE_OF_SCANDIRECTION }
 direction of scanning More...
enum  ScanLaw {
  SCANLAWNULL, EXPONENTIAL, LINEAR, QUADRATIC,
  SIZE_OF_SCANLAW
}
enum  TandemScanningMethod {
  TANDEMNULL, PRODUCTIONSCAN, PRECURSORIONSCAN, CONSTANTNEUTRALLOSS,
  SINGLEREACTIONMONITORING, MULTIPLEREACTIONMONITORING, SINGLEIONMONITORING, MULTIPLEIONMONITORING,
  SIZE_OF_TANDEMSCANNINGMETHOD
}
 MS/MS scan method. More...
enum  ReflectronState {
  REFLSTATENULL, ON, OFF, NONE,
  SIZE_OF_REFLECTRONSTATE
}
 reflectron state More...

Public Member Functions

 MassAnalyzer ()
 Constructor.
 MassAnalyzer (const MassAnalyzer &source)
 Copy constructor.
 ~MassAnalyzer ()
 Destructor.
MassAnalyzeroperator= (const MassAnalyzer &source)
 Assignment operator.
bool operator== (const MassAnalyzer &rhs) const
 Equality operator.
bool operator!= (const MassAnalyzer &rhs) const
 Equality operator.
AnalyzerType getType () const
 returns the analyzer type
void setType (AnalyzerType type)
 sets the analyzer type
ResolutionMethod getResolutionMethod () const
 returns the method used for determination of the resolution
void setResolutionMethod (ResolutionMethod resolution_method)
 sets the method used for determination of the resolution
ResolutionType getResolutionType () const
 returns the
void setResolutionType (ResolutionType resolution_type)
 sets the
ScanFunction getScanFunction () const
 returns the
void setScanFunction (ScanFunction scan_function)
 sets the
ScanDirection getScanDirection () const
 returns the direction of scanning
void setScanDirection (ScanDirection scan_direction)
 sets the direction of scanning
ScanLaw getScanLaw () const
 returns the
void setScanLaw (ScanLaw scan_law)
 sets the
TandemScanningMethod getTandemScanMethod () const
 returns the MS/MS scanning method
void setTandemScanMethod (TandemScanningMethod tandem_scan_method)
 sets the MS/MS scanning method
ReflectronState getReflectronState () const
 returns the reflectron state (for TOF)
void setReflectronState (ReflectronState reflecton_state)
 sets the reflectron state (for TOF)
float getResolution () const
 returns the resolution
void setResolution (float resolution)
 sets the resolution
float getAccuracy () const
 returns the mass accuracy i.e. how much the theoretical mass differs from the measured mass (in m/z)
void setAccuracy (float accuracy)
 sets the accuracy i.e. how much the theoretical mass differs from the measured mass (in m/z)
float getScanRate () const
 returns the scan rate (in s)
void setScanRate (float scan_rate)
 sets the scan rate (in s)
float getScanTime () const
 returns the scan time for a single scan (in s)
void setScanTime (float scan_time)
 sets the scan time for a single scan (in s)
float getTOFTotalPathLength () const
 returns the path length for a TOF mass analyzer (in mm)
void setTOFTotalPathLength (float TOF_total_path_length)
 sets the path length for a TOF mass analyzer (in mm)
float getIsolationWidth () const
 returns the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)
void setIsolationWidth (float isolation_width)
 sets the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)
Int getFinalMSExponent () const
 returns the final MS exponent
void setFinalMSExponent (Int final_MS_exponent)
 sets the final MS exponent
float getMagneticFieldStrength () const
 returns the strength of the magnetic field (in T)
void setMagneticFieldStrength (float magnetic_field_strength)
 sets the strength of the magnetic field (in T)

Static Public Attributes

static const std::string NamesOfAnalyzerType [SIZE_OF_ANALYZERTYPE]
 Names of the analyzer types.
static const std::string NamesOfResolutionMethod [SIZE_OF_RESOLUTIONMETHOD]
 Names of resolustion methods.
static const std::string NamesOfResolutionType [SIZE_OF_RESOLUTIONTYPE]
 Names of resulution type.
static const std::string NamesOfScanFunction [SIZE_OF_SCANFUNCTION]
 Names of scan functions.
static const std::string NamesOfScanDirection [SIZE_OF_SCANDIRECTION]
 Names of direction of scanning.
static const std::string NamesOfScanLaw [SIZE_OF_SCANLAW]
 Names of scan laws.
static const std::string NamesOfTandemScanningMethod [SIZE_OF_TANDEMSCANNINGMETHOD]
 Names of MS/MS scan methods.
static const std::string NamesOfReflectronState [SIZE_OF_REFLECTRONSTATE]
 Names of reclectron states.

Protected Attributes

AnalyzerType type_
ResolutionMethod resolution_method_
ResolutionType resolution_type_
ScanFunction scan_function_
ScanDirection scan_direction_
ScanLaw scan_law_
TandemScanningMethod tandem_scan_method_
ReflectronState reflectron_state_
float resolution_
float accuracy_
float scan_rate_
float scan_time_
float TOF_total_path_length_
float isolation_width_
Int final_MS_exponent_
float magnetic_field_strength_

Member Enumeration Documentation

enum AnalyzerType

analyzer type

Enumerator:
ANALYZERNULL 
QUADRUPOLE 
PAULIONTRAP 
RADIALEJECTIONLINEARIONTRAP 
AXIALEJECTIONLINEARIONTRAP 
TOF 
SECTOR 
FOURIERTRANSFORM 
IONSTORAGE 
SIZE_OF_ANALYZERTYPE 

enum ResolutionMethod

resolution method

Which of the available standard measures is used to define whether two peaks are separate

Enumerator:
RESMETHNULL 
FWHM 
TENPERCENTVALLEY 
BASELINE 
SIZE_OF_RESOLUTIONMETHOD 

enum ResolutionType

Enumerator:
RESTYPENULL 
CONSTANT 
PROPORTIONAL 
SIZE_OF_RESOLUTIONTYPE 

enum ScanFunction

Enumerator:
SCANFCTNULL 
SELECTEDIONDETECTION 
MASSSCAN 
SIZE_OF_SCANFUNCTION 

enum ScanDirection

direction of scanning

Enumerator:
SCANDIRNULL 
UP 
DOWN 
SIZE_OF_SCANDIRECTION 

enum ScanLaw

Enumerator:
SCANLAWNULL 
EXPONENTIAL 
LINEAR 
QUADRATIC 
SIZE_OF_SCANLAW 

enum TandemScanningMethod

MS/MS scan method.

Enumerator:
TANDEMNULL 
PRODUCTIONSCAN 
PRECURSORIONSCAN 
CONSTANTNEUTRALLOSS 
SINGLEREACTIONMONITORING 
MULTIPLEREACTIONMONITORING 
SINGLEIONMONITORING 
MULTIPLEIONMONITORING 
SIZE_OF_TANDEMSCANNINGMETHOD 

enum ReflectronState

reflectron state

Enumerator:
REFLSTATENULL 
ON 
OFF 
NONE 
SIZE_OF_REFLECTRONSTATE 


Constructor & Destructor Documentation

MassAnalyzer (  ) 

Constructor.

MassAnalyzer ( const MassAnalyzer source  ) 

Copy constructor.

~MassAnalyzer (  ) 

Destructor.


Member Function Documentation

MassAnalyzer& operator= ( const MassAnalyzer source  ) 

Assignment operator.

bool operator== ( const MassAnalyzer rhs  )  const

Equality operator.

bool operator!= ( const MassAnalyzer rhs  )  const

Equality operator.

AnalyzerType getType (  )  const

returns the analyzer type

void setType ( AnalyzerType  type  ) 

sets the analyzer type

ResolutionMethod getResolutionMethod (  )  const

returns the method used for determination of the resolution

void setResolutionMethod ( ResolutionMethod  resolution_method  ) 

sets the method used for determination of the resolution

ResolutionType getResolutionType (  )  const

returns the

void setResolutionType ( ResolutionType  resolution_type  ) 

sets the

ScanFunction getScanFunction (  )  const

returns the

void setScanFunction ( ScanFunction  scan_function  ) 

sets the

ScanDirection getScanDirection (  )  const

returns the direction of scanning

void setScanDirection ( ScanDirection  scan_direction  ) 

sets the direction of scanning

ScanLaw getScanLaw (  )  const

returns the

void setScanLaw ( ScanLaw  scan_law  ) 

sets the

TandemScanningMethod getTandemScanMethod (  )  const

returns the MS/MS scanning method

void setTandemScanMethod ( TandemScanningMethod  tandem_scan_method  ) 

sets the MS/MS scanning method

ReflectronState getReflectronState (  )  const

returns the reflectron state (for TOF)

void setReflectronState ( ReflectronState  reflecton_state  ) 

sets the reflectron state (for TOF)

float getResolution (  )  const

returns the resolution

The maximum m/z value at which two peaks can be resolved, according to one of the standard measures

void setResolution ( float  resolution  ) 

sets the resolution

float getAccuracy (  )  const

returns the mass accuracy i.e. how much the theoretical mass differs from the measured mass (in m/z)

void setAccuracy ( float  accuracy  ) 

sets the accuracy i.e. how much the theoretical mass differs from the measured mass (in m/z)

float getScanRate (  )  const

returns the scan rate (in s)

void setScanRate ( float  scan_rate  ) 

sets the scan rate (in s)

float getScanTime (  )  const

returns the scan time for a single scan (in s)

void setScanTime ( float  scan_time  ) 

sets the scan time for a single scan (in s)

float getTOFTotalPathLength (  )  const

returns the path length for a TOF mass analyzer (in mm)

void setTOFTotalPathLength ( float  TOF_total_path_length  ) 

sets the path length for a TOF mass analyzer (in mm)

float getIsolationWidth (  )  const

returns the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)

void setIsolationWidth ( float  isolation_width  ) 

sets the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)

Int getFinalMSExponent (  )  const

returns the final MS exponent

void setFinalMSExponent ( Int  final_MS_exponent  ) 

sets the final MS exponent

float getMagneticFieldStrength (  )  const

returns the strength of the magnetic field (in T)

void setMagneticFieldStrength ( float  magnetic_field_strength  ) 

sets the strength of the magnetic field (in T)


Member Data Documentation

const std::string NamesOfAnalyzerType[SIZE_OF_ANALYZERTYPE] [static]

Names of the analyzer types.

const std::string NamesOfResolutionMethod[SIZE_OF_RESOLUTIONMETHOD] [static]

Names of resolustion methods.

const std::string NamesOfResolutionType[SIZE_OF_RESOLUTIONTYPE] [static]

Names of resulution type.

const std::string NamesOfScanFunction[SIZE_OF_SCANFUNCTION] [static]

Names of scan functions.

const std::string NamesOfScanDirection[SIZE_OF_SCANDIRECTION] [static]

Names of direction of scanning.

const std::string NamesOfScanLaw[SIZE_OF_SCANLAW] [static]

Names of scan laws.

const std::string NamesOfTandemScanningMethod[SIZE_OF_TANDEMSCANNINGMETHOD] [static]

Names of MS/MS scan methods.

const std::string NamesOfReflectronState[SIZE_OF_REFLECTRONSTATE] [static]

Names of reclectron states.

AnalyzerType type_ [protected]

ResolutionMethod resolution_method_ [protected]

ResolutionType resolution_type_ [protected]

ScanFunction scan_function_ [protected]

ScanDirection scan_direction_ [protected]

ScanLaw scan_law_ [protected]

TandemScanningMethod tandem_scan_method_ [protected]

ReflectronState reflectron_state_ [protected]

float resolution_ [protected]

float accuracy_ [protected]

float scan_rate_ [protected]

float scan_time_ [protected]

float TOF_total_path_length_ [protected]

float isolation_width_ [protected]

Int final_MS_exponent_ [protected]

float magnetic_field_strength_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:46 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1