Modification

class pyopenms.Modification

Bases: object

Cython implementation of _Modification

Original C++ documentation is available here

– Inherits from [‘SampleTreatment’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: Modification) → None

Methods

__init__	Overload:
clearMetaInfo(self)	Removes all meta values
getAffectedAminoAcids(self)	Returns a string containing the one letter code of the amino acids that are affected by the reagent (default "")
getComment(self)	Returns the description of the sample treatment
getKeys(self, keys)	Fills the given vector with a list of all keys for which a value is set
getMass(self)	Returns the mass change (default 0.0)
getMetaValue(self, in_0)	Returns the value corresponding to a string, or
getReagentName(self)	Returns the name of the reagent that was used (default "")
getSpecificityType(self)	Returns the specificity of the reagent (default AA)
getType(self)	Returns the treatment type
isMetaEmpty(self)	Returns if the MetaInfo is empty
metaRegistry(self)	Returns a reference to the MetaInfoRegistry
metaValueExists(self, in_0)	Returns whether an entry with the given name exists
removeMetaValue(self, in_0)	Removes the DataValue corresponding to name if it exists
setAffectedAminoAcids(self, affected_amino_acids)	Returns a string containing the one letter code of the amino acids that are affected by the reagent.
setComment(self, comment)	Sets the description of the sample treatment
setMass(self, mass)	Sets the mass change
setMetaValue(self, in_0, in_1)	Sets the DataValue corresponding to a name
setReagentName(self, reagent_name)	Sets the name of the reagent that was used
setSpecificityType(self, specificity_type)	Sets the specificity of the reagent

Modification_SpecificityType

alias of pyopenms._pyopenms_2.__Modification_SpecificityType

clearMetaInfo(self) → None

Removes all meta values

getAffectedAminoAcids(self) → Union[bytes, str, String]

Returns a string containing the one letter code of the amino acids that are affected by the reagent (default “”)

getComment(self) → Union[bytes, str, String]

Returns the description of the sample treatment

getKeys(self, keys: List[bytes]) → None

Fills the given vector with a list of all keys for which a value is set

getMass(self) → float

Returns the mass change (default 0.0)

getMetaValue(self, in_0: Union[bytes, str, String]) → Union[int, float, bytes, str, List[int], List[float], List[bytes]]

Returns the value corresponding to a string, or

getReagentName(self) → Union[bytes, str, String]

Returns the name of the reagent that was used (default “”)

getSpecificityType(self) → int

Returns the specificity of the reagent (default AA)

getType(self) → Union[bytes, str, String]

Returns the treatment type

isMetaEmpty(self) → bool

Returns if the MetaInfo is empty

metaRegistry(self) → MetaInfoRegistry

Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: Union[bytes, str, String]) → bool

Returns whether an entry with the given name exists

removeMetaValue(self, in_0: Union[bytes, str, String]) → None

Removes the DataValue corresponding to name if it exists

setAffectedAminoAcids(self, affected_amino_acids: Union[bytes, str, String]) → None

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(self, comment: Union[bytes, str, String]) → None

Sets the description of the sample treatment

setMass(self, mass: float) → None

Sets the mass change

setMetaValue(self, in_0: Union[bytes, str, String], in_1: Union[int, float, bytes, str, List[int], List[float], List[bytes]]) → None

Sets the DataValue corresponding to a name

setReagentName(self, reagent_name: Union[bytes, str, String]) → None

Sets the name of the reagent that was used

setSpecificityType(self, specificity_type: int) → None

Sets the specificity of the reagent