MapAlignmentAlgorithmIdentification#

class pyopenms.MapAlignmentAlgorithmIdentification#

Bases: DefaultParamHandler

A map alignment algorithm based on peptide identifications from MS2 spectra

__init__() → None#

Methods

__init__()

align(map)

Overloaded function.

endProgress([bytes_processed])

Ends the progress display

getDefaults()

Returns the default parameters

getLogType()

Returns the type of progress log being used

getName()

Returns the name

getParameters()

Returns the parameters

getSubsections()

nextProgress()

Increment progress by 1 (according to range begin-end)

setLogType(type)

Sets the progress log that should be used.

setName(name)

Sets the name

setParameters(param)

Sets the parameters

setProgress(value)

Sets the current progress

setReference(ref)

Overloaded function.

startProgress(begin, end, label)

align(map: pyopenms.FeatureMap) → pyopenms.TransformationDescription#
align(map: pyopenms.ConsensusMap) → pyopenms.TransformationDescription
align(maps: collections.abc.Sequence[pyopenms.FeatureMap], reference_index: int = -1) → list[pyopenms.TransformationDescription]
align(maps: collections.abc.Sequence[pyopenms.ConsensusMap], reference_index: int = -1) → list[pyopenms.TransformationDescription]
align(maps: collections.abc.Sequence[pyopenms.PeptideIdentificationList], reference_index: int = -1) → list[pyopenms.TransformationDescription]
align(maps: collections.abc.Sequence[pyopenms.FeatureMap], transformations: list, reference_index: int = -1) → None
align(maps: collections.abc.Sequence[pyopenms.ConsensusMap], transformations: list, reference_index: int = -1) → None

Overloaded function.

  1. align(map: pyopenms.FeatureMap) -> pyopenms.TransformationDescription

Aligns a FeatureMap and returns the transformation

  1. align(map: pyopenms.ConsensusMap) -> pyopenms.TransformationDescription

Aligns a ConsensusMap and returns the transformation

  1. align(maps: collections.abc.Sequence[pyopenms.FeatureMap], reference_index: int = -1) -> list[pyopenms.TransformationDescription]

Aligns several FeatureMaps and returns one transformation per map. With reference_index >= 0, maps[reference_index] is the reference; with -1, the reference set with setReference() is used, or else the one chosen by parameter ‘auto_reference’ (by default the map that shares the most identified sequences with every other map)

  1. align(maps: collections.abc.Sequence[pyopenms.ConsensusMap], reference_index: int = -1) -> list[pyopenms.TransformationDescription]

Aligns several ConsensusMaps and returns one transformation per map; see the FeatureMap overload

  1. align(maps: collections.abc.Sequence[pyopenms.PeptideIdentificationList], reference_index: int = -1) -> list[pyopenms.TransformationDescription]

Aligns several runs of peptide identifications and returns one transformation per run; see the FeatureMap overload

  1. align(maps: collections.abc.Sequence[pyopenms.FeatureMap], transformations: list, reference_index: int = -1) -> None

  2. align(maps: collections.abc.Sequence[pyopenms.ConsensusMap], transformations: list, reference_index: int = -1) -> None

endProgress(bytes_processed: int = 0) → None#

Ends the progress display

getDefaults() → pyopenms.Param#

Returns the default parameters

getLogType() → pyopenms.ProgressLogger.LogType#

Returns the type of progress log being used

getName() → str#

Returns the name

getParameters() → pyopenms.Param#

Returns the parameters

getSubsections() → list[str]#
nextProgress() → None#

Increment progress by 1 (according to range begin-end)

setLogType(type: pyopenms.ProgressLogger.LogType) → None#

Sets the progress log that should be used. The default type is NONE!

setName(name: str) → None#

Sets the name

setParameters(param: pyopenms.Param) → None#

Sets the parameters

setProgress(value: int) → None#

Sets the current progress

setReference(ref: pyopenms.FeatureMap) → None#
setReference(ref: pyopenms.ConsensusMap) → None
setReference(ref: pyopenms.PeptideIdentificationList) → None

Overloaded function.

  1. setReference(ref: pyopenms.FeatureMap) -> None

Sets the reference for alignment (FeatureMap)

  1. setReference(ref: pyopenms.ConsensusMap) -> None

Sets the reference for alignment (ConsensusMap)

  1. setReference(ref: pyopenms.PeptideIdentificationList) -> None

Sets the reference for alignment (peptide identifications)

startProgress(begin: int, end: int, label: str) → None#