ModificationDefinition#

class pyopenms.ModificationDefinition#

Bases: object

Cython implementation of _ModificationDefinition

Original C++ documentation is available here

__init__()#

Overload:

__init__(self) None

Overload:

__init__(self, in_0: ModificationDefinition) None

Overload:

__init__(self, mod: bytes | str | String) None

Overload:

__init__(self, mod: bytes | str | String, fixed: bool) None

Overload:

__init__(self, mod: bytes | str | String, fixed: bool, max_occur: int) None

Overload:

__init__(self, mod: ResidueModification) None

Overload:

__init__(self, mod: ResidueModification, fixed: bool) None

Overload:

__init__(self, mod: ResidueModification, fixed: bool, max_occur: int) None

Methods

__init__

Overload:

getMaxOccurrences(self)

Returns the maximal number of occurrences per peptide

getModification(self)

getModificationName(self)

Returns the name of the modification

isFixedModification(self)

Returns if the modification if fixed true, else false

setFixedModification(self, fixed)

Sets whether this modification definition is fixed or variable (modification must occur vs.

setMaxOccurrences(self, num)

Sets the maximal number of occurrences per peptide (unbounded if 0)

setModification(self, modification)

Sets the modification, allowed are unique names provided by ModificationsDB

getMaxOccurrences(self) int#

Returns the maximal number of occurrences per peptide

getModification(self) ResidueModification#
getModificationName(self) bytes | str | String#

Returns the name of the modification

isFixedModification(self) bool#

Returns if the modification if fixed true, else false

setFixedModification(self, fixed: bool) None#

Sets whether this modification definition is fixed or variable (modification must occur vs. can occur)

setMaxOccurrences(self, num: int) None#

Sets the maximal number of occurrences per peptide (unbounded if 0)

setModification(self, modification: bytes | str | String) None#

Sets the modification, allowed are unique names provided by ModificationsDB