matchms.filtering.metadata_processing.require_precursor_mz module

matchms.filtering.metadata_processing.require_precursor_mz.require_precursor_below_mz(spectrum_in: Spectrum, max_mz: float = 1000) Spectrum[source]
Returns None if the precursor_mz of a spectrum is above

max_mz.

Parameters:
  • spectrum_in – Input spectrum.

  • max_mz – Maximum mz value for the precursor mz of a spectrum. All precursor mz values greater or equal to this will return none. Default is 1000.

matchms.filtering.metadata_processing.require_precursor_mz.require_precursor_mz(spectrum_in: Spectrum, minimum_accepted_mz: float | None = 10.0, maximum_mz: float | None = None, clone: bool | None = True) Spectrum | None[source]

Returns None if there is no precursor_mz or if <= minimum_accepted_mz

Parameters:
  • spectrum_in – Input spectrum.

  • minimum_accepted_mz – Set to minimum acceptable value for precursor m/z. Default is set to 10.0.

  • maximum_mz – Set the maximum value for precursor m/z.

  • clone – Optionally clone the Spectrum.

Returns:

Spectrum with precursor_mz, or None if not present.

Return type:

Spectrum or None