Precursor#

class pyopenms.Precursor#

Bases: object

Cython implementation of _Precursor

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1Precursor.html: – Inherits from [‘Peak1D’, ‘CVTermList’]

__init__()#

Cython signature: void Precursor()
Cython signature: void Precursor(Precursor &)

Methods

`__init__`	Cython signature: void Precursor()
`addCVTerm`	Cython signature: void addCVTerm(CVTerm & term) Adds a CV term
`clearMetaInfo`	Cython signature: void clearMetaInfo() Removes all meta values
`consumeCVTerms`	Cython signature: void consumeCVTerms(libcpp_map[String,libcpp_vector[CVTerm]] cv_term_map) Merges the given map into the member map, no duplicate checking
`empty`	Cython signature: bool empty()
`getActivationEnergy`	Cython signature: double getActivationEnergy() Returns the activation energy (in electronvolt)
`getActivationMethods`	Cython signature: libcpp_set[ActivationMethod] getActivationMethods() Returns the activation methods
`getCVTerms`	Cython signature: libcpp_map[String,libcpp_vector[CVTerm]] getCVTerms() Returns the accession string of the term
`getCharge`	Cython signature: int getCharge() Returns the charge
`getDriftTime`	Cython signature: double getDriftTime() Returns the ion mobility drift time in milliseconds (-1 means it is not set)
`getDriftTimeWindowLowerOffset`	Cython signature: double getDriftTimeWindowLowerOffset() Returns the lower offset from the target ion mobility in milliseconds
`getDriftTimeWindowUpperOffset`	Cython signature: double getDriftTimeWindowUpperOffset() Returns the upper offset from the target ion mobility in milliseconds
`getIntensity`	Cython signature: float getIntensity()
`getIsolationWindowLowerOffset`	Cython signature: double getIsolationWindowLowerOffset() Returns the lower offset from the target m/z
`getIsolationWindowUpperOffset`	Cython signature: double getIsolationWindowUpperOffset() Returns the upper offset from the target m/z
`getKeys`	Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set
`getMZ`	Cython signature: double getMZ()
`getMetaValue`	Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or
`getPos`	Cython signature: double getPos()
`getPossibleChargeStates`	Cython signature: libcpp_vector[int] getPossibleChargeStates() Returns the possible charge states
`getUnchargedMass`	Cython signature: double getUnchargedMass() Returns the uncharged mass of the precursor, if charge is unknown, i.e. 0 best guess is its doubly charged.
`hasCVTerm`	Cython signature: bool hasCVTerm(String accession)
`isMetaEmpty`	Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty
`metaRegistry`	Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry
`metaValueExists`	Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists
`removeMetaValue`	Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists
`replaceCVTerm`	Cython signature: void replaceCVTerm(CVTerm & term) Replaces the specified CV term
`replaceCVTerms`	Cython signature: void replaceCVTerms(libcpp_vector[CVTerm] cv_terms, String accession)
`setActivationEnergy`	Cython signature: void setActivationEnergy(double activation_energy) Sets the activation energy (in electronvolt)
`setActivationMethods`	Cython signature: void setActivationMethods(libcpp_set[ActivationMethod] activation_methods) Sets the activation methods
`setCVTerms`	Cython signature: void setCVTerms(libcpp_vector[CVTerm] & terms) Sets the CV terms
`setCharge`	Cython signature: void setCharge(int charge) Sets the charge
`setDriftTime`	Cython signature: void setDriftTime(double drift_time) Sets the ion mobility drift time in milliseconds
`setDriftTimeWindowLowerOffset`	Cython signature: void setDriftTimeWindowLowerOffset(double drift_time) Sets the lower offset from the target ion mobility
`setDriftTimeWindowUpperOffset`	Cython signature: void setDriftTimeWindowUpperOffset(double drift_time) Sets the upper offset from the target ion mobility
`setIntensity`	Cython signature: void setIntensity(float)
`setIsolationWindowLowerOffset`	Cython signature: void setIsolationWindowLowerOffset(double bound) Sets the lower offset from the target m/z
`setIsolationWindowUpperOffset`	Cython signature: void setIsolationWindowUpperOffset(double bound) Sets the upper offset from the target m/z
`setMZ`	Cython signature: void setMZ(double)
`setMetaValue`	Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name
`setPos`	Cython signature: void setPos(double pos)
`setPossibleChargeStates`	Cython signature: void setPossibleChargeStates(libcpp_vector[int] possible_charge_states) Sets the possible charge states

addCVTerm()#: Cython signature: void addCVTerm(CVTerm & term) Adds a CV term

clearMetaInfo()#: Cython signature: void clearMetaInfo() Removes all meta values

consumeCVTerms()#: Cython signature: void consumeCVTerms(libcpp_map[String,libcpp_vector[CVTerm]] cv_term_map) Merges the given map into the member map, no duplicate checking

empty()#: Cython signature: bool empty()

getActivationEnergy()#: Cython signature: double getActivationEnergy() Returns the activation energy (in electronvolt)

getActivationMethods()#: Cython signature: libcpp_set[ActivationMethod] getActivationMethods() Returns the activation methods

getCVTerms()#: Cython signature: libcpp_map[String,libcpp_vector[CVTerm]] getCVTerms() Returns the accession string of the term

getCharge()#: Cython signature: int getCharge() Returns the charge

getDriftTime()#: Cython signature: double getDriftTime() Returns the ion mobility drift time in milliseconds (-1 means it is not set)

getDriftTimeWindowLowerOffset()#: Cython signature: double getDriftTimeWindowLowerOffset() Returns the lower offset from the target ion mobility in milliseconds

getDriftTimeWindowUpperOffset()#: Cython signature: double getDriftTimeWindowUpperOffset() Returns the upper offset from the target ion mobility in milliseconds

getIntensity()#: Cython signature: float getIntensity()

getIsolationWindowLowerOffset()#: Cython signature: double getIsolationWindowLowerOffset() Returns the lower offset from the target m/z

getIsolationWindowUpperOffset()#: Cython signature: double getIsolationWindowUpperOffset() Returns the upper offset from the target m/z

getKeys()#: Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set

getMZ()#: Cython signature: double getMZ()

getMetaValue()#: Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or

getPos()#: Cython signature: double getPos()

getPossibleChargeStates()#: Cython signature: libcpp_vector[int] getPossibleChargeStates() Returns the possible charge states

getUnchargedMass()#: Cython signature: double getUnchargedMass() Returns the uncharged mass of the precursor, if charge is unknown, i.e. 0 best guess is its doubly charged

hasCVTerm()#: Cython signature: bool hasCVTerm(String accession)

isMetaEmpty()#: Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty

metaRegistry()#: Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry

metaValueExists()#: Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists

removeMetaValue()#: Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists

replaceCVTerm()#: Cython signature: void replaceCVTerm(CVTerm & term) Replaces the specified CV term

replaceCVTerms()#: Cython signature: void replaceCVTerms(libcpp_vector[CVTerm] cv_terms, String accession)

setActivationEnergy()#: Cython signature: void setActivationEnergy(double activation_energy) Sets the activation energy (in electronvolt)

setActivationMethods()#: Cython signature: void setActivationMethods(libcpp_set[ActivationMethod] activation_methods) Sets the activation methods

setCVTerms()#: Cython signature: void setCVTerms(libcpp_vector[CVTerm] & terms) Sets the CV terms

setCharge()#: Cython signature: void setCharge(int charge) Sets the charge

setDriftTime()#: Cython signature: void setDriftTime(double drift_time) Sets the ion mobility drift time in milliseconds

setDriftTimeWindowLowerOffset()#: Cython signature: void setDriftTimeWindowLowerOffset(double drift_time) Sets the lower offset from the target ion mobility

setDriftTimeWindowUpperOffset()#: Cython signature: void setDriftTimeWindowUpperOffset(double drift_time) Sets the upper offset from the target ion mobility

setIntensity()#: Cython signature: void setIntensity(float)

setIsolationWindowLowerOffset()#: Cython signature: void setIsolationWindowLowerOffset(double bound) Sets the lower offset from the target m/z

setIsolationWindowUpperOffset()#: Cython signature: void setIsolationWindowUpperOffset(double bound) Sets the upper offset from the target m/z

setMZ()#: Cython signature: void setMZ(double)

setMetaValue()#: Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name

setPos()#: Cython signature: void setPos(double pos)

setPossibleChargeStates()#: Cython signature: void setPossibleChargeStates(libcpp_vector[int] possible_charge_states) Sets the possible charge states