IdentificationHit#
- class pyopenms.IdentificationHit#
Bases:
object
Cython implementation of _IdentificationHit
- Original C++ documentation is available here
– Inherits from [‘MetaInfoInterface’]
- __init__()#
Overload:
- __init__(self) None
Represents a object which can store the information of an analysisXML instance
Overload:
- __init__(self, in_0: IdentificationHit) None
Methods
Overload:
clearMetaInfo
(self)Removes all meta values
Returns the calculated mass to charge ratio
getCharge
(self)Returns the charge state
Returns the experimental mass to charge
getId
(self)Returns the id
getKeys
(self, keys)Fills the given vector with a list of all keys for which a value is set
getMetaValue
(self, in_0)Returns the value corresponding to a string, or
getName
(self)Returns the name
getPassThreshold
(self)Returns whether the peptide passed the threshold
getRank
(self)Returns the rank of the peptide
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
setCalculatedMassToCharge
(self, mz)Sets the calculated mass to charge ratio
setCharge
(self, charge)Sets the charge state of the peptide
setExperimentalMassToCharge
(self, mz)Sets the experimental mass to charge ratio
setId
(self, id)Sets the identifier
setMetaValue
(self, in_0, in_1)Sets the DataValue corresponding to a name
setName
(self, name)Sets the name
setPassThreshold
(self, in_0)Sets whether the peptide passed the threshold
setRank
(self, rank)Sets the rank of the peptide
- clearMetaInfo(self) None #
Removes all meta values
- getCalculatedMassToCharge(self) float #
Returns the calculated mass to charge ratio
- getCharge(self) int #
Returns the charge state
- getExperimentalMassToCharge(self) float #
Returns the experimental mass to charge
- getKeys(self, keys: List[bytes]) None #
Fills the given vector with a list of all keys for which a value is set
- getMetaValue(self, in_0: bytes | str | String) int | float | bytes | str | List[int] | List[float] | List[bytes] #
Returns the value corresponding to a string, or
- getPassThreshold(self) bool #
Returns whether the peptide passed the threshold
- getRank(self) int #
Returns the rank of the peptide
- isMetaEmpty(self) bool #
Returns if the MetaInfo is empty
- metaRegistry(self) MetaInfoRegistry #
Returns a reference to the MetaInfoRegistry
- metaValueExists(self, in_0: bytes | str | String) bool #
Returns whether an entry with the given name exists
- removeMetaValue(self, in_0: bytes | str | String) None #
Removes the DataValue corresponding to name if it exists
- setCalculatedMassToCharge(self, mz: float) None #
Sets the calculated mass to charge ratio
- setCharge(self, charge: int) None #
Sets the charge state of the peptide
- setExperimentalMassToCharge(self, mz: float) None #
Sets the experimental mass to charge ratio
- setMetaValue(self, in_0: bytes | str | String, in_1: int | float | bytes | str | List[int] | List[float] | List[bytes]) None #
Sets the DataValue corresponding to a name
- setPassThreshold(self, in_0: bool) None #
Sets whether the peptide passed the threshold
- setRank(self, rank: int) None #
Sets the rank of the peptide