![]() |
OpenMS
|
Classes for targeted quantitation workflows using MRM/SRM and SWATH/DIA data. More...
Classes | |
| class | ConfidenceScoring |
| Confidence scoring for SRM/MRM/PRM features against a targeted assay library. More... | |
| class | DIAScoring |
| Scoring of an spectrum at the peak apex of an chromatographic elution peak. More... | |
| class | LevelContextInference |
| Shared OpenSwath analysis context inference for peptide, protein, and gene rows. More... | |
| class | MRMBatchFeatureSelector |
| Batch processing wrapper for MRMFeatureSelector. More... | |
| class | MRMFeatureFilter |
| The MRMFeatureFilter either flags components and/or transitions that do not pass the QC criteria or filters out components and/or transitions that do not pass the QC criteria. More... | |
| class | MRMFeatureQC |
| The MRMFeatureQC is a class to handle the parameters and options for MRMFeatureFilter. More... | |
| class | MRMFeatureSelector |
| A base class for selection of MRM Features through Linear Programming optimization. More... | |
| class | MRMFeatureSelectorQMIP |
| MRMFeatureSelector implementation that selects MRM features via a quadratic-programming formulation over relative retention time. More... | |
| class | MRMFeatureSelectorScore |
| MRMFeatureSelector implementation that selects MRM features via a linear program with score-weighted per-feature variables. More... | |
| struct | OpenSwathExportFilterConfig |
| Shared filter configuration for OpenSWATH export readers. More... | |
| struct | OpenSwathResultsExportConfig |
| Configuration for user-facing feature results exports. More... | |
| struct | OpenSwathMatrixExportConfig |
| Configuration for matrix exports. More... | |
| struct | OpenSwathParquetExportConfig |
| Configuration for scored feature Parquet exports. More... | |
| struct | OpenSwathExportRow |
| Filtered feature-level row used by results and matrix exports. More... | |
| struct | OpenSwathFeatureScoreRow |
| Feature-level scored row for Parquet export. More... | |
| struct | OpenSwathFeatureScoreTable |
| Feature-level Parquet export table with dynamically discovered FEATURE_MS1 / FEATURE_MS2 columns. More... | |
| struct | OpenSwathTransitionScoreRow |
| Transition-level scored row for optional Parquet export. More... | |
| struct | OpenSwathTransitionScoreTable |
| Transition-level Parquet export table with dynamically discovered FEATURE_TRANSITION columns. More... | |
| struct | OpenSwathQuantMatrix |
| Dense matrix representation used by matrix exports. More... | |
| class | OpenSwathGeneInference |
| OpenSwath gene-level context inference. More... | |
| struct | ErrorEstimationConfig |
| Configuration for OpenSwath analyte level inference global and local error estimation. More... | |
| struct | PeptidoformInferenceConfig |
| Configuration for peptidoform inference. More... | |
| struct | LevelContextInferenceConfig |
| Configuration for peptide-, protein-, and gene-level context inference. More... | |
| struct | IPFPrecursorRow |
| Peak-group and precursor evidence for peptidoform inference. More... | |
| struct | IPFPrecursorProbabilityRow |
| Precursor-layer posterior error probability used by IPF. More... | |
| struct | IPFTransitionRow |
| Transition-layer evidence for peptidoform inference. More... | |
| struct | IPFAlignmentRow |
| Alignment-group membership for cross-run IPF signal propagation. More... | |
| struct | IPFResultRow |
| Final peptidoform inference result row. More... | |
| struct | LevelContextInputRow |
| Compact level-context input row independent of file format. More... | |
| struct | LevelContextResultRow |
| Final level-context result row. More... | |
| class | OpenSwathMatrixExporter |
| Build and write OpenSWATH quantification matrices. More... | |
| class | OpenSwathParquetExporter |
| Write scored OpenSWATH feature and transition tables to Parquet. More... | |
| class | OpenSwathPeptideInference |
| OpenSwath peptide-level context inference. More... | |
| class | OpenSwathPeptidoformInference |
| OpenSwath inference of peptidoforms (IPF). More... | |
| struct | OpenSwathPeptidoformInference::BayesianModelRow |
| Compact Bayesian model row used by the public helper methods. More... | |
| struct | OpenSwathPeptidoformInference::PosteriorRow |
| Posterior probability row returned by applyBM. More... | |
| class | OpenSwathProteinInference |
| OpenSwath protein-level context inference. More... | |
| class | OpenSwathResultsExporter |
| Write filtered OpenSWATH feature results to TSV or Parquet. More... | |
| class | OpenSwathWorkflowScheduler |
| Plans memory-bounded OpenSwathWorkflow work waves and exposes a small concurrency-limiter pair. More... | |
| class | PeakIntegrator |
| Compute the area, background and shape metrics of a peak. More... | |
| class | TargetedSpectraExtractor |
| This class filters, annotates, picks, and scores spectra (e.g., taken from a DDA experiment) based on a target list. More... | |
| class | AbsoluteQuantitation |
| AbsoluteQuantitation is a class to support absolute or relative quantitation for targeted or untargeted quantitation workflows (e.g., Isotope Dilution Mass Spectrometry). More... | |
| class | AbsoluteQuantitationMethod |
| AbsoluteQuantitationMethod is a class to hold information about the quantitation method and for applying and/or generating the quantitation method. More... | |
| class | ChromatogramProcessor |
| Convenience entry point that runs MRMFeatureFinderScoring on a list of already-extracted chromatograms. More... | |
| class | DefaultChromHandler |
| Dispatching chromatogram handler that picks SRM/MRM or DIA at runtime based on the input maps. More... | |
| class | DIAChromHandler |
| IChromatogramHandler implementation for DIA / SWATH / PRM / PASEF-DIA acquisitions, where chromatograms are extracted from full-scan MS2 data rather than being directly acquired as SRM/MRM traces. More... | |
| class | TOPPOpenSwathBase |
| Shared TOPPBase scaffolding for OpenSWATH-family CLI tools (currently OpenSwathWorkflow). More... | |
| struct | OSWHierarchy |
| Hierarchy levels of the OSWData tree. More... | |
| struct | OSWIndexTrace |
| Index path into the OSWData tree from the root down to a specific node. More... | |
| struct | OSWTransition |
| High-level meta-data of one fragment-ion transition referenced by an OSWPeakGroup. More... | |
| class | OSWPeakGroup |
| A peak group (also called feature) is defined on a small RT range (leftWidth to rightWidth) in a group of extracted transitions (chromatograms). More... | |
| class | OSWPeptidePrecursor |
| A peptide with a charge state. More... | |
| class | OSWProtein |
| A Protein is the highest entity and contains one or more peptides which were found/traced. More... | |
| class | OSWData |
| Holds all or partial information from an OSW file. More... | |
| class | EmgGradientDescent |
| Fit peaks to an Exponentially Modified Gaussian (EMG) model using gradient descent. More... | |
Enumerations | |
| enum class | OpenSwathExportFileFormat { TSV , Parquet } |
| Output file format for OpenSWATH export tables. More... | |
| enum class | OpenSwathIPFExportMode { Peptidoform , Augmented , Disable } |
| IPF handling mode for OpenSWATH exports. More... | |
| enum class | OpenSwathMatrixLevel { Precursor , Peptide , Protein , Gene } |
| Quantification matrix level for OpenSWATH matrix exports. More... | |
| enum class | OpenSwathMatrixNormalization { None , Median , MedianMedian } |
| Normalization method for OpenSWATH matrix exports. More... | |
| enum class | InferenceLevel { Peptidoform , Peptide , Protein , Gene } |
| Inference level for OpenSWATH-derived confidence inference. More... | |
| enum class | InferenceContext { Global , ExperimentWide , RunSpecific } |
| Context for peptide-, protein-, and gene-level inference. More... | |
Classes for targeted quantitation workflows using MRM/SRM and SWATH/DIA data.
This module provides a comprehensive set of algorithms for processing targeted mass spectrometry data, including Multiple Reaction Monitoring (MRM), Selected Reaction Monitoring (SRM), and SWATH/DIA acquisitions. These classes form the computational foundation used by tools like SmartPeaks for automated metabolomics and fluxomics data processing.
The typical targeted quantitation workflow proceeds through these stages:
These algorithms are described in:
| struct OpenMS::OpenSwathExportFilterConfig |
Shared filter configuration for OpenSWATH export readers.
Defaults mirror the corresponding PyProphet export CLI defaults
| Class Members | ||
|---|---|---|
| bool | exclude_decoys = true | |
| bool | gene = false | |
| double | ipf_max_peptidoform_pep = 0.4 | Filter results to maximum run-specific peptidoform-level PEP. |
| OpenSwathIPFExportMode | ipf_mode = OpenSwathIPFExportMode::Peptidoform | |
| double | max_alignment_pep = 0.7 | |
| double | max_global_gene_qvalue = 0.01 | |
| double | max_global_peptide_qvalue = 0.01 | |
| double | max_global_protein_qvalue = 0.01 | |
| double | max_rs_peakgroup_qvalue = 0.05 | Filter results to maximum run-specific peak group-level q-value. |
| double | max_transition_pep = 0.7 | Maximum PEP to retain scored transitions for quantification (requires transition-level scoring) |
| bool | peptide = true | |
| bool | protein = true | |
| bool | transition_quantification = true | Report aggregated transition-level quantification. |
| bool | use_alignment = false | |
| struct OpenMS::OpenSwathResultsExportConfig |
Configuration for user-facing feature results exports.
| Class Members | ||
|---|---|---|
| OpenSwathExportFilterConfig | filters | |
| OpenSwathExportFileFormat | format = OpenSwathExportFileFormat::TSV | |
| struct OpenMS::OpenSwathMatrixExportConfig |
Configuration for matrix exports.
| Class Members | ||
|---|---|---|
| bool | consistent_top = true | |
| OpenSwathExportFilterConfig | filters | |
| OpenSwathExportFileFormat | format = OpenSwathExportFileFormat::TSV | |
| OpenSwathMatrixLevel | level = OpenSwathMatrixLevel::Peptide | |
| OpenSwathMatrixNormalization | normalization = OpenSwathMatrixNormalization::None | |
| Size | top_n = 3 | |
| struct OpenMS::OpenSwathParquetExportConfig |
Configuration for scored feature Parquet exports.
| Class Members | ||
|---|---|---|
| OpenSwathExportFilterConfig | filters | |
| bool | include_transition_data = true | |
| struct OpenMS::OpenSwathExportRow |
Filtered feature-level row used by results and matrix exports.
This row intentionally stores only the columns needed by the user-facing results and matrix exports. The wider Parquet scoring export uses dedicated structs below because it may also carry dynamically discovered FEATURE_MS1 / FEATURE_MS2 / FEATURE_TRANSITION columns.
| Class Members | ||
|---|---|---|
| string | aggr_fragment_annotation | |
| string | aggr_peak_apex | |
| string | aggr_peak_area | |
| optional< double > | aggr_prec_peak_apex | |
| optional< double > | aggr_prec_peak_area | |
| optional< Int64 > | alignment_group_id | |
| optional< double > | alignment_pep | |
| optional< double > | alignment_qvalue | |
| optional< Int64 > | alignment_reference_feature_id | |
| optional< double > | alignment_reference_rt | |
| double | assay_irt = 0.0 | |
| double | assay_rt = 0.0 | |
| Int32 | charge = 0 | |
| double | d_score = 0.0 | |
| bool | decoy = false | |
| double | delta_irt = 0.0 | |
| double | delta_rt = 0.0 | |
| optional< double > | exp_im | |
| Int64 | feature_id = -1 | |
| string | filename | |
| bool | from_alignment = false | |
| string | full_peptide_name | |
| optional< double > | gene_experiment_wide_qvalue | |
| optional< double > | gene_global_qvalue | |
| string | gene_name | |
| optional< double > | gene_run_specific_qvalue | |
| optional< double > | im_left_width | |
| optional< double > | im_right_width | |
| double | intensity = 0.0 | |
| string | ipf_full_peptide_name | |
| optional< double > | ipf_pep | |
| optional< double > | ipf_peptidoform_m_score | |
| optional< double > | ipf_peptidoform_pep | |
| optional< double > | ipf_precursor_peakgroup_pep | |
| double | irt = 0.0 | |
| double | left_width = 0.0 | |
| double | m_score = 0.0 | |
| optional< double > | ms1_pep | |
| optional< double > | ms2_m_score | |
| optional< double > | ms2_pep | |
| double | mz = 0.0 | |
| Int32 | peak_group_rank = 0 | |
| optional< double > | pep | |
| optional< double > | peptide_experiment_wide_qvalue | |
| optional< double > | peptide_global_qvalue | |
| Int64 | peptide_id = -1 | |
| optional< double > | peptide_run_specific_qvalue | |
| Int64 | precursor_id = -1 | |
| optional< double > | precursor_pep | |
| optional< double > | protein_experiment_wide_qvalue | |
| optional< double > | protein_global_qvalue | |
| string | protein_name | |
| optional< double > | protein_run_specific_qvalue | |
| double | right_width = 0.0 | |
| double | rt = 0.0 | |
| Int64 | run_id = -1 | |
| string | run_name | |
| string | sequence | |
| string | transition_group_id | |
| struct OpenMS::OpenSwathFeatureScoreRow |
Feature-level scored row for Parquet export.
| Class Members | ||
|---|---|---|
| optional< Int64 > | alignment_group_id | |
| optional< double > | alignment_pep | |
| optional< double > | alignment_qvalue | |
| optional< Int64 > | alignment_reference_feature_id | |
| optional< double > | alignment_reference_rt | |
| double | delta_rt = 0.0 | |
| optional< double > | exp_im | |
| double | exp_rt = 0.0 | |
| Int64 | feature_id = -1 | |
| vector< double > | feature_ms1_values | |
| vector< double > | feature_ms2_values | |
| string | filename | |
| bool | from_alignment = false | |
| optional< bool > | gene_decoy | |
| optional< Int64 > | gene_id | |
| string | gene_name | |
| optional< double > | im_left_width | |
| optional< double > | im_right_width | |
| optional< Int64 > | ipf_peptide_id | |
| double | left_width = 0.0 | |
| string | modified_sequence | |
| double | norm_rt = 0.0 | |
| bool | peptide_decoy = false | |
| Int64 | peptide_id = -1 | |
| Int32 | precursor_charge = 0 | |
| bool | precursor_decoy = false | |
| string | precursor_group_label | |
| Int64 | precursor_id = -1 | |
| optional< double > | precursor_library_drift_time | |
| optional< double > | precursor_library_intensity | |
| optional< double > | precursor_library_rt | |
| double | precursor_mz = 0.0 | |
| string | precursor_traml_id | |
| string | protein_accession | |
| bool | protein_decoy = false | |
| Int64 | protein_id = -1 | |
| double | right_width = 0.0 | |
| Int64 | run_id = -1 | |
| optional< double > | score_gene_experiment_wide_pep | |
| optional< double > | score_gene_experiment_wide_pvalue | |
| optional< double > | score_gene_experiment_wide_qvalue | |
| optional< double > | score_gene_experiment_wide_score | |
| optional< double > | score_gene_global_pep | |
| optional< double > | score_gene_global_pvalue | |
| optional< double > | score_gene_global_qvalue | |
| optional< double > | score_gene_global_score | |
| optional< double > | score_gene_run_specific_pep | |
| optional< double > | score_gene_run_specific_pvalue | |
| optional< double > | score_gene_run_specific_qvalue | |
| optional< double > | score_gene_run_specific_score | |
| optional< double > | score_ipf_pep | |
| optional< double > | score_ipf_precursor_peakgroup_pep | |
| optional< double > | score_ipf_qvalue | |
| optional< double > | score_ms1_pep | |
| optional< double > | score_ms1_pvalue | |
| optional< double > | score_ms1_qvalue | |
| optional< Int32 > | score_ms1_rank | |
| optional< double > | score_ms1_score | |
| optional< Int32 > | score_ms2_peak_group_rank | |
| optional< double > | score_ms2_pep | |
| optional< double > | score_ms2_pvalue | |
| optional< double > | score_ms2_qvalue | |
| optional< double > | score_ms2_score | |
| optional< double > | score_peptide_experiment_wide_pep | |
| optional< double > | score_peptide_experiment_wide_pvalue | |
| optional< double > | score_peptide_experiment_wide_qvalue | |
| optional< double > | score_peptide_experiment_wide_score | |
| optional< double > | score_peptide_global_pep | |
| optional< double > | score_peptide_global_pvalue | |
| optional< double > | score_peptide_global_qvalue | |
| optional< double > | score_peptide_global_score | |
| optional< double > | score_peptide_run_specific_pep | |
| optional< double > | score_peptide_run_specific_pvalue | |
| optional< double > | score_peptide_run_specific_qvalue | |
| optional< double > | score_peptide_run_specific_score | |
| optional< double > | score_protein_experiment_wide_pep | |
| optional< double > | score_protein_experiment_wide_pvalue | |
| optional< double > | score_protein_experiment_wide_qvalue | |
| optional< double > | score_protein_experiment_wide_score | |
| optional< double > | score_protein_global_pep | |
| optional< double > | score_protein_global_pvalue | |
| optional< double > | score_protein_global_qvalue | |
| optional< double > | score_protein_global_score | |
| optional< double > | score_protein_run_specific_pep | |
| optional< double > | score_protein_run_specific_pvalue | |
| optional< double > | score_protein_run_specific_qvalue | |
| optional< double > | score_protein_run_specific_score | |
| string | unmodified_sequence | |
| struct OpenMS::OpenSwathFeatureScoreTable |
Feature-level Parquet export table with dynamically discovered FEATURE_MS1 / FEATURE_MS2 columns.
| Class Members | ||
|---|---|---|
| vector< string > | feature_ms1_column_names | |
| vector< string > | feature_ms2_column_names | |
| vector< OpenSwathFeatureScoreRow > | rows | |
| struct OpenMS::OpenSwathTransitionScoreRow |
Transition-level scored row for optional Parquet export.
| Class Members | ||
|---|---|---|
| string | annotation | |
| optional< Int64 > | feature_id | |
| vector< optional< double > > | feature_transition_values | |
| optional< Int64 > | ipf_peptide_id | |
| Int64 | precursor_id = -1 | |
| double | product_mz = 0.0 | |
| optional< Int64 > | run_id | |
| optional< double > | score_transition_pep | |
| optional< double > | score_transition_pvalue | |
| optional< double > | score_transition_qvalue | |
| optional< Int32 > | score_transition_rank | |
| optional< double > | score_transition_score | |
| Int32 | transition_charge = 0 | |
| bool | transition_decoy = false | |
| bool | transition_detecting = false | |
| Int64 | transition_id = -1 | |
| optional< double > | transition_library_intensity | |
| Int32 | transition_ordinal = 0 | |
| string | transition_traml_id | |
| string | transition_type | |
| struct OpenMS::OpenSwathTransitionScoreTable |
Transition-level Parquet export table with dynamically discovered FEATURE_TRANSITION columns.
| Class Members | ||
|---|---|---|
| vector< string > | feature_transition_column_names | |
| vector< OpenSwathTransitionScoreRow > | rows | |
| struct OpenMS::OpenSwathQuantMatrix |
Dense matrix representation used by matrix exports.
Numeric values are stored by row with missing values represented as std::nullopt to preserve sparse run coverage in TSV and Parquet output.
| Class Members | ||
|---|---|---|
| vector< string > | identifier_column_names | |
| vector< vector< string > > | identifier_rows | |
| vector< string > | sample_column_names | |
| vector< vector< optional< double > > > | values | |
| struct OpenMS::ErrorEstimationConfig |
Configuration for OpenSwath analyte level inference global and local error estimation.
Defaults mirror the current PyProphet CLI defaults.
| Class Members | ||
|---|---|---|
| double | lfdr_adj = 1.5 | Smoothing bandwidth multiplier used during local FDR density estimation. |
| double | lfdr_eps = 1e-8 | Tail clipping threshold used during local FDR calculation. |
| bool | lfdr_monotone = true | If true, enforce non-decreasing local FDR values with increasing p-values. |
| string | lfdr_transformation = "probit" | Transformation applied to p-values for local FDR estimation ("probit", "logit"). |
| bool | lfdr_truncate = true | If true, local FDR values above one are truncated to one. |
| bool | parametric = false | If true, perform parametric estimation of p-values. |
| bool | pfdr = false | If true, compute positive false discovery rate (pFDR) instead of FDR. |
| vector< double > | pi0_lambda {0.1, 0.15, 0.2, 0.25, 0.3, 0.35, 0.4, 0.45} | Lambda grid for pi0 estimation for non-parametric p-value estimation. |
| string | pi0_method = "bootstrap" | Method for choosing the pi0 tuning parameter ("smoother", "bootstrap"). |
| Int32 | pi0_smooth_df = 3 | Degrees of freedom for smoother-based pi0 estimation. |
| bool | pi0_smooth_log_pi0 = false | If true, smooth log(pi0) instead of pi0 directly. |
| struct OpenMS::PeptidoformInferenceConfig |
Configuration for peptidoform inference.
Defaults mirror the current PyProphet CLI defaults.
| struct OpenMS::LevelContextInferenceConfig |
Configuration for peptide-, protein-, and gene-level context inference.
| Class Members | ||
|---|---|---|
| InferenceContext | context = InferenceContext::RunSpecific | The context in which to perform inference (global, experiment-wide, or run-specific). |
| ErrorEstimationConfig | error | Error-estimation settings applied during inference. |
| InferenceLevel | level = InferenceLevel::Peptide | The analyte level to perform inference on. |
| struct OpenMS::IPFPrecursorRow |
| struct OpenMS::IPFPrecursorProbabilityRow |
| struct OpenMS::IPFTransitionRow |
| struct OpenMS::IPFAlignmentRow |
| struct OpenMS::IPFResultRow |
| struct OpenMS::LevelContextInputRow |
Compact level-context input row independent of file format.
| Class Members | ||
|---|---|---|
| InferenceContext | context = InferenceContext::RunSpecific | |
| bool | decoy = false | |
| Int64 | entity_id = -1 | |
| string | group_id | |
| optional< Int64 > | run_id | |
| double | score = 0.0 | |
| struct OpenMS::LevelContextResultRow |
Final level-context result row.
| Class Members | ||
|---|---|---|
| InferenceContext | context = InferenceContext::RunSpecific | |
| Int64 | entity_id = -1 | |
| double | pep = 1.0 | |
| double | pvalue = 1.0 | |
| double | qvalue = 1.0 | |
| optional< Int64 > | run_id | |
| double | score = 0.0 | |
| struct OpenMS::OpenSwathPeptidoformInference::BayesianModelRow |
Compact Bayesian model row used by the public helper methods.
The meaning of hypothesis depends on the inference layer:
1 for the true precursor state and hypothesis 0 for the false precursor state-1 for the H0/null hypothesis | Class Members | ||
|---|---|---|
| double | evidence = 0.0 | |
| Int64 | feature_id = -1 | |
| Int64 | hypothesis = -1 | |
| double | prior = 0.0 | |
| struct OpenMS::OpenSwathPeptidoformInference::PosteriorRow |
Posterior probability row returned by applyBM.
The hypothesis value follows the same conventions as in BayesianModelRow.
| Class Members | ||
|---|---|---|
| Int64 | feature_id = -1 | |
| Int64 | hypothesis = -1 | |
| double | posterior = 0.0 | |
|
strong |
|
strong |
Inference level for OpenSWATH-derived confidence inference.
See:
| Enumerator | |
|---|---|
| Peptidoform | |
| Peptide | |
| Protein | |
| Gene | |
|
strong |
|
strong |
|
strong |
|
strong |