Modification#

class pyopenms.Modification#

Bases: object

Cython implementation of _Modification

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1Modification.html: – Inherits from [‘SampleTreatment’]

__init__()#

Cython signature: void Modification()
Cython signature: void Modification(Modification &)

Methods

`__init__`	Cython signature: void Modification()
`clearMetaInfo`	Cython signature: void clearMetaInfo() Removes all meta values
`getAffectedAminoAcids`	Cython signature: String getAffectedAminoAcids() Returns a string containing the one letter code of the amino acids that are affected by the reagent (default "")
`getComment`	Cython signature: String getComment() Returns the description of the sample treatment
`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
`getMass`	Cython signature: double getMass() Returns the mass change (default 0.0)
`getMetaValue`	Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or
`getReagentName`	Cython signature: String getReagentName() Returns the name of the reagent that was used (default "")
`getSpecificityType`	Cython signature: Modification_SpecificityType getSpecificityType() Returns the specificity of the reagent (default AA)
`getType`	Cython signature: String getType() Returns the treatment type
`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
`setAffectedAminoAcids`	Cython signature: void setAffectedAminoAcids(const String & affected_amino_acids) Returns a string containing the one letter code of the amino acids that are affected by the reagent.
`setComment`	Cython signature: void setComment(const String & comment) Sets the description of the sample treatment
`setMass`	Cython signature: void setMass(double mass) Sets the mass change
`setMetaValue`	Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name
`setReagentName`	Cython signature: void setReagentName(const String & reagent_name) Sets the name of the reagent that was used
`setSpecificityType`	Cython signature: void setSpecificityType(Modification_SpecificityType & specificity_type) Sets the specificity of the reagent

Modification_SpecificityType#: alias of pyopenms.pyopenms_8.__Modification_SpecificityType

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

getAffectedAminoAcids()#: Cython signature: String getAffectedAminoAcids() Returns a string containing the one letter code of the amino acids that are affected by the reagent (default “”)

getComment()#: Cython signature: String getComment() Returns the description of the sample treatment

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

getMass()#: Cython signature: double getMass() Returns the mass change (default 0.0)

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

getReagentName()#: Cython signature: String getReagentName() Returns the name of the reagent that was used (default “”)

getSpecificityType()#: Cython signature: Modification_SpecificityType getSpecificityType() Returns the specificity of the reagent (default AA)

getType()#: Cython signature: String getType() Returns the treatment type

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

setAffectedAminoAcids()#: Cython signature: void setAffectedAminoAcids(const String & affected_amino_acids) Returns a string containing the one letter code of the amino acids that are affected by the reagent. Do not separate them by space, tab or comma!

setComment()#: Cython signature: void setComment(const String & comment) Sets the description of the sample treatment

setMass()#: Cython signature: void setMass(double mass) Sets the mass change

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

setReagentName()#: Cython signature: void setReagentName(const String & reagent_name) Sets the name of the reagent that was used

setSpecificityType()#: Cython signature: void setSpecificityType(Modification_SpecificityType & specificity_type) Sets the specificity of the reagent