OpenMS
Loading...
Searching...
No Matches
SiriusExportAlgorithm.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Oliver Alka, Axel Walter $
6// $Authors: Oliver Alka, Lukas Zimmermann $
7// --------------------------------------------------------------------------
8
9#pragma once
10
12
13#include <OpenMS/SYSTEM/File.h>
14
15namespace OpenMS
16{
35 class OPENMS_DLLAPI SiriusExportAlgorithm : public DefaultParamHandler
36 {
37 public:
40
42 bool isFeatureOnly() const { return param_.getValue("feature_only").toBool(); }
44 UInt getFilterByNumMassTraces() const { return param_.getValue("filter_by_num_masstraces"); }
46 double getPrecursorMzTolerance() const { return param_.getValue("precursor_mz_tolerance"); }
48 double getPrecursorRtTolerance() const { return param_.getValue("precursor_rt_tolerance"); }
50 bool precursorMzToleranceUnitIsPPM() const { return param_.getValue("precursor_mz_tolerance_unit") == "ppm"; }
52 bool isNoMasstraceInfoIsotopePattern() const { return param_.getValue("no_masstrace_info_isotope_pattern").toBool(); }
54 int getIsotopePatternIterations() const { return param_.getValue("isotope_pattern_iterations"); }
55
76 void preprocessing(const std::string& featureinfo,
77 const MSExperiment& spectra,
78 FeatureMapping::FeatureMappingInfo& feature_mapping_info,
79 FeatureMapping::FeatureToMs2Indices& feature_ms2_indices) const;
80
94 void logFeatureSpectraNumber(const std::string& featureinfo,
95 const FeatureMapping::FeatureToMs2Indices& feature_ms2_indices,
96 const MSExperiment& spectra) const;
97
113 void run(const StringList& mzML_files,
114 const StringList& featureXML_files,
115 const std::string& out_ms,
116 const std::string& out_compoundinfo) const;
117
118 };
119} // namespace OpenMS
A base class for all classes handling default parameters.
Definition DefaultParamHandler.h:66
Input bundle: feature maps and a spatial index over them.
Definition FeatureMapping.h:51
Output bundle: per-feature MS2 spectrum indices + the list of unassigned MS2 spectra.
Definition FeatureMapping.h:67
In-Memory representation of a mass spectrometry run.
Definition MSExperiment.h:49
Algorithm class behind the SiriusExport tool: writes a SIRIUS .ms input file from MS data and (option...
Definition SiriusExportAlgorithm.h:36
double getPrecursorMzTolerance() const
Half-width of the precursor m/z window used during MS2-to-feature mapping (unit per precursorMzTolera...
Definition SiriusExportAlgorithm.h:46
bool isNoMasstraceInfoIsotopePattern() const
true to suppress mass-trace-derived isotope-pattern hints in the .ms output (parameter no_masstrace_i...
Definition SiriusExportAlgorithm.h:52
void logFeatureSpectraNumber(const std::string &featureinfo, const FeatureMapping::FeatureToMs2Indices &feature_ms2_indices, const MSExperiment &spectra) const
Emit OPENMS_LOG_INFO messages summarising how many features / MS2 spectra will be processed.
bool isFeatureOnly() const
true if only feature-mapped MS2 spectra should be written (parameter feature_only)
Definition SiriusExportAlgorithm.h:42
SiriusExportAlgorithm()
Default constructor; installs the export parameters (see class docs)
double getPrecursorRtTolerance() const
Half-width of the precursor RT window (seconds) used during MS2-to-feature mapping.
Definition SiriusExportAlgorithm.h:48
bool precursorMzToleranceUnitIsPPM() const
true if getPrecursorMzTolerance is interpreted as ppm; otherwise as Th
Definition SiriusExportAlgorithm.h:50
void preprocessing(const std::string &featureinfo, const MSExperiment &spectra, FeatureMapping::FeatureMappingInfo &feature_mapping_info, FeatureMapping::FeatureToMs2Indices &feature_ms2_indices) const
Build the feature/MS2 mapping consumed by run() from a featureXML.
void run(const StringList &mzML_files, const StringList &featureXML_files, const std::string &out_ms, const std::string &out_compoundinfo) const
Export the SIRIUS .ms input file (and optional compound-info TSV).
UInt getFilterByNumMassTraces() const
Minimum number of mass traces a feature must have to be retained (parameter filter_by_num_masstraces)
Definition SiriusExportAlgorithm.h:44
int getIsotopePatternIterations() const
Number of SIRIUS isotope-pattern iterations to record in the .ms output (parameter isotope_pattern_it...
Definition SiriusExportAlgorithm.h:54
unsigned int UInt
Unsigned integer type.
Definition Types.h:64
std::vector< std::string > StringList
Vector of String.
Definition ListUtils.h:44
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19