Precursor meta information. More...
#include <OpenMS/METADATA/Precursor.h>
Public Types | |
| enum | ActivationMethod { CID, PSD, PD, SID, BIRD, ECD, IMD, SORI, HCID, LCID, PHD, ETD, PQD, SIZE_OF_ACTIVATIONMETHOD } |
Method of activation. More... | |
Public Member Functions | |
| Precursor () | |
| Constructor. | |
| Precursor (const Precursor &source) | |
| Copy constructor. | |
| virtual | ~Precursor () |
| Destructor. | |
| Precursor & | operator= (const Precursor &source) |
| Assignment operator. | |
| bool | operator== (const Precursor &rhs) const |
| Equality operator. | |
| bool | operator!= (const Precursor &rhs) const |
| Equality operator. | |
| const std::set < ActivationMethod > & | getActivationMethods () const |
| returns a const reference to the activation methods | |
| std::set< ActivationMethod > & | getActivationMethods () |
| returns a mutable reference to the activation methods | |
| void | setActivationMethods (const std::set< ActivationMethod > &activation_methods) |
| sets the activation methods | |
| DoubleReal | getActivationEnergy () const |
| returns the activation energy (in electronvolt) | |
| void | setActivationEnergy (DoubleReal activation_energy) |
| sets the activation energy (in electronvolt) | |
| DoubleReal | getIsolationWindowLowerOffset () const |
| returns the lower offset from the target m/z | |
| void | setIsolationWindowLowerOffset (DoubleReal bound) |
| sets the lower offset from the target m/z | |
| DoubleReal | getIsolationWindowUpperOffset () const |
| returns the upper offset from the target m/z | |
| void | setIsolationWindowUpperOffset (DoubleReal bound) |
| sets the upper offset from the target m/z | |
| Int | getCharge () const |
| Non-mutable access to the charge. | |
| void | setCharge (Int charge) |
| Mutable access to the charge. | |
| std::vector< Int > & | getPossibleChargeStates () |
| Mutable access to possible charge states. | |
| const std::vector< Int > & | getPossibleChargeStates () const |
| Non-mutable access to possible charge states. | |
| void | setPossibleChargeStates (const std::vector< Int > &possible_charge_states) |
| Sets the possible charge states. | |
| DoubleReal | getUnchargedMass () const |
| Returns the uncharged mass of the precursor, if charge is unknown, i.e. 0 best guess is its doubly charged. | |
Static Public Attributes | |
| static const std::string | NamesOfActivationMethod [SIZE_OF_ACTIVATIONMETHOD] |
| Names of activation methods. | |
Protected Attributes | |
| std::set< ActivationMethod > | activation_methods_ |
| DoubleReal | activation_energy_ |
| DoubleReal | window_low_ |
| DoubleReal | window_up_ |
| Int | charge_ |
| std::vector< Int > | possible_charge_states_ |
Precursor meta information.
This class contains precursor information:
| enum ActivationMethod |
Method of activation.
| Precursor | ( | ) |
Constructor.
| virtual ~Precursor | ( | ) | [virtual] |
Destructor.
| DoubleReal getActivationEnergy | ( | ) | const |
returns the activation energy (in electronvolt)
Referenced by MzMLHandler< MapType >::writePrecursor_(), and MzDataHandler< MapType >::writeTo().
| std::set<ActivationMethod>& getActivationMethods | ( | ) |
returns a mutable reference to the activation methods
| const std::set<ActivationMethod>& getActivationMethods | ( | ) | const |
returns a const reference to the activation methods
Referenced by MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::writePrecursor_(), and MzDataHandler< MapType >::writeTo().
| Int getCharge | ( | ) | const |
Non-mutable access to the charge.
Referenced by DTAFile::store(), MzMLHandler< MapType >::writePrecursor_(), MzXMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().
| DoubleReal getIsolationWindowLowerOffset | ( | ) | const |
returns the lower offset from the target m/z
Referenced by MzMLHandler< MapType >::writePrecursor_(), and MzXMLHandler< MapType >::writeTo().
| DoubleReal getIsolationWindowUpperOffset | ( | ) | const |
returns the upper offset from the target m/z
Referenced by MzMLHandler< MapType >::writePrecursor_(), and MzXMLHandler< MapType >::writeTo().
| const std::vector<Int>& getPossibleChargeStates | ( | ) | const |
Non-mutable access to possible charge states.
| std::vector<Int>& getPossibleChargeStates | ( | ) |
Mutable access to possible charge states.
Referenced by MzMLHandler< MapType >::handleCVParam_(), and MzMLHandler< MapType >::writePrecursor_().
| DoubleReal getUnchargedMass | ( | ) | const [inline] |
Returns the uncharged mass of the precursor, if charge is unknown, i.e. 0 best guess is its doubly charged.
References OpenMS::Constants::c, and OpenMS::Constants::PROTON_MASS_U.
| bool operator!= | ( | const Precursor & | rhs | ) | const |
Equality operator.
| bool operator== | ( | const Precursor & | rhs | ) | const |
Equality operator.
| void setActivationEnergy | ( | DoubleReal | activation_energy | ) |
sets the activation energy (in electronvolt)
Referenced by MzMLHandler< MapType >::handleCVParam_().
| void setActivationMethods | ( | const std::set< ActivationMethod > & | activation_methods | ) |
sets the activation methods
| void setCharge | ( | Int | charge | ) |
Mutable access to the charge.
Referenced by MzMLHandler< MapType >::handleCVParam_(), DTAFile::load(), TOPPRNPxl::main_(), OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap(), and TOPPViewBase::showSpectrumGenerationDialog().
| void setIsolationWindowLowerOffset | ( | DoubleReal | bound | ) |
sets the lower offset from the target m/z
Referenced by MzMLHandler< MapType >::handleCVParam_(), and ChromatogramExtractor::prepareSpectra_().
| void setIsolationWindowUpperOffset | ( | DoubleReal | bound | ) |
sets the upper offset from the target m/z
Referenced by MzMLHandler< MapType >::handleCVParam_(), and ChromatogramExtractor::prepareSpectra_().
| void setPossibleChargeStates | ( | const std::vector< Int > & | possible_charge_states | ) |
Sets the possible charge states.
DoubleReal activation_energy_ [protected] |
std::set<ActivationMethod> activation_methods_ [protected] |
const std::string NamesOfActivationMethod[SIZE_OF_ACTIVATIONMETHOD] [static] |
Names of activation methods.
Referenced by HasActivationMethod< SpectrumType >::operator()().
std::vector<Int> possible_charge_states_ [protected] |
DoubleReal window_low_ [protected] |
DoubleReal window_up_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |