Deisotoper#

class pyopenms.Deisotoper#

Bases: object

OpenMS class Deisotoper

__init__() → None#
__init__(arg: pyopenms.Deisotoper, /) → None

Methods

__init__()

deisotopeAndSingleCharge(spectrum, ...[, ...])

Deisotope and single charge a spectrum

deisotopeAndSingleChargeDefault(spectrum, ...)

Convenience method: deisotope and single charge a spectrum with default parameters.

deisotopeWithAveragineModel(spectrum, ...[, ...])

Detect isotopic clusters in a mass spectrum using an averagine model.

static deisotopeAndSingleCharge(spectrum: pyopenms.MSSpectrum, fragment_tolerance: float, fragment_unit_ppm: bool, min_charge: int = 1, max_charge: int = 3, keep_only_deisotoped: bool = False, min_isopeaks: int = 3, max_isopeaks: int = 10, make_single_charged: bool = True, annotate_charge: bool = False, annotate_iso_peak_count: bool = False, use_decreasing_model: bool = True, start_intensity_check: int = 2, add_up_intensity: bool = False, annotate_features: bool = False) → None#

Deisotope and single charge a spectrum

static deisotopeAndSingleChargeDefault(spectrum: pyopenms.MSSpectrum, fragment_tolerance: float, fragment_unit_ppm: bool) → None#

Convenience method: deisotope and single charge a spectrum with default parameters.

Calls deisotopeAndSingleCharge with all default parameters except the required ones.

Parameters:
  • spectrum – Input spectrum (sorted by m/z), modified in-place

  • fragment_tolerance – The tolerance used to match isotopic peaks

  • fragment_unit_ppm – Whether ppm or m/z is used as tolerance

static deisotopeWithAveragineModel(spectrum: pyopenms.MSSpectrum, fragment_tolerance: float, fragment_unit_ppm: bool, number_of_final_peaks: int = 5000, min_charge: int = 1, max_charge: int = 3, keep_only_deisotoped: bool = False, min_isopeaks: int = 2, max_isopeaks: int = 10, make_single_charged: bool = True, annotate_charge: bool = False, annotate_iso_peak_count: bool = False, add_up_intensity: bool = False) → None#

Detect isotopic clusters in a mass spectrum using an averagine model.

Deisotoping is based on C13 abundance and will try to identify isotopic clusters fitting to an averagine model, taking into account the corresponding charge state. This only makes sense for peptide fragment ion spectra.

Parameters:
  • spectrum – Input spectrum (sorted by m/z), modified in-place

  • fragment_tolerance – The tolerance used to match isotopic peaks

  • fragment_unit_ppm – Whether ppm or m/z is used as tolerance

  • number_of_final_peaks – Only the largest N peaks are kept. If 0, no filtering. For open search 1000, else 5000.

  • min_charge – The minimum charge considered

  • max_charge – The maximum charge considered

  • keep_only_deisotoped – Only monoisotopic peaks of fragments with isotopic pattern are retained

  • min_isopeaks – The minimum number of isotopic peaks (at least 2) required for an isotopic cluster

  • max_isopeaks – The maximum number of isotopic peaks (at least 2) considered for an isotopic cluster

  • make_single_charged – Convert deisotoped monoisotopic peak to single charge

  • annotate_charge – Annotate the charge to peaks in IntegerDataArray “charge”

  • annotate_iso_peak_count – Annotate the number of isotopic peaks in IntegerDataArray “iso_peak_count”

  • add_up_intensity – Sum up total intensity of each isotopic pattern into the monoisotopic peak