SpectraFilterNLargest

Filters the top Peaks in the given spectra according to a given schema/thresholdset

pot. predecessor tools	→ SpectraFilter →	pot. successor tools
PeakPickerHiRes		any tool operating on MS peak data (in mzML format)

The command line parameters of this tool are:

SpectraFilterNLargest -- Keeps only the n largest peaks per spectrum.
Full documentation: http://www.openms.de/doxygen/release/3.5.0/html/TOPP_SpectraFilterNLargest.html
Version: 3.5.0 May  9 2025, 17:07:55, Revision: 12ccccf
To cite OpenMS:
 + Pfeuffer, J., Bielow, C., Wein, S. et al.. OpenMS 3 enables reproducible analysis of large-scale mass spec
   trometry data. Nat Methods (2024). doi:10.1038/s41592-024-02197-7.

Usage:
  SpectraFilterNLargest <options>

This tool has algorithm parameters that are not shown here! Please check the ini file for a detailed descript
ion or use the --helphelp option

Options (mandatory options marked with '*'):
  -in <file>*        Input file  (valid formats: 'mzML')
  -out <file>*       Output file  (valid formats: 'mzML')
                     
Common TOPP options:
  -ini <file>        Use the given TOPP INI file
  -threads <n>       Sets the number of threads allowed to be used by the TOPP tool (default: '1')
  -write_ini <file>  Writes the default configuration file
  --help             Shows options
  --helphelp         Shows all options (including advanced)

The following configuration subsections are valid:
 - algorithm   Algorithm parameter subsection.

You can write an example INI file using the '-write_ini' option.
Documentation of subsection parameters can be found in the doxygen documentation or the INIFileEditor.
For more information, please consult the online documentation for this tool:
  - http://www.openms.de/doxygen/release/3.5.0/html/TOPP_SpectraFilterNLargest.html

INI file documentation of this tool:

Legend:

required parameter

advanced parameter

+SpectraFilterNLargestKeeps only the n largest peaks per spectrum.

version3.5.0 Version of the tool that generated this parameters file.

++1Instance '1' section for 'SpectraFilterNLargest'

in input file input file*.mzML

out output file output file*.mzML

log Name of log file (created only when specified)

debug0 Sets the debug level

threads1 Sets the number of threads allowed to be used by the TOPP tool

no_progressfalse Disables progress logging to command linetrue, false

forcefalse Overrides tool-specific checkstrue, false

testfalse Enables the test mode (needed for internal use only)true, false

+++algorithmAlgorithm parameter subsection.

n200 The number of peaks to keep