ProteinHit

class pyopenms.ProteinHit

Bases: object

Cython implementation of _ProteinHit

Original C++ documentation is available here

– Inherits from [‘MetaInfoInterface’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, score: float, rank: int, accession: bytes | str | String, sequence: bytes | str | String) → None

Overload:

__init__(self, in_0: ProteinHit) → None

Methods

__init__	Overload:
clearMetaInfo(self)	Removes all meta values
getAccession(self)	Returns the accession of the protein
getCoverage(self)	Returns the coverage (in percent) of the protein hit based upon matched peptides
getDescription(self)	Returns the description of the protein
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
getRank(self)	Returns the rank of the protein hit
getScore(self)	Returns the score of the protein hit
getSequence(self)	Returns the protein sequence
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
setAccession(self, in_0)	Sets the accession of the protein
setCoverage(self, in_0)	Sets the coverage (in percent) of the protein hit based upon matched peptides
setDescription(self, description)	Sets the description of the protein
setMetaValue(self, in_0, in_1)	Sets the DataValue corresponding to a name
setRank(self, in_0)	Sets the rank
setScore(self, in_0)	Sets the score of the protein hit
setSequence(self, in_0)	Sets the protein sequence

clearMetaInfo(self) → None

Removes all meta values

getAccession(self) → bytes | str | String

Returns the accession of the protein

getCoverage(self) → float

Returns the coverage (in percent) of the protein hit based upon matched peptides

getDescription(self) → bytes | str | String

Returns the description of the protein

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

getRank(self) → int

Returns the rank of the protein hit

getScore(self) → float

Returns the score of the protein hit

getSequence(self) → bytes | str | String

Returns the protein sequence

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

setAccession(self, in_0: bytes | str | String) → None

Sets the accession of the protein

setCoverage(self, in_0: float) → None

Sets the coverage (in percent) of the protein hit based upon matched peptides

setDescription(self, description: bytes | str | String) → None

Sets the description of the protein

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

setRank(self, in_0: int) → None

Sets the rank

setScore(self, in_0: float) → None

Sets the score of the protein hit

setSequence(self, in_0: bytes | str | String) → None

Sets the protein sequence