OpenMS
2.8.0
|
This class filters, annotates, picks, and scores spectra (e.g., taken from a DDA experiment) based on a target list. More...
#include <OpenMS/ANALYSIS/OPENSWATH/TargetedSpectraExtractor.h>
Classes | |
class | BinnedSpectrumComparator |
class | Comparator |
struct | Match |
Public Member Functions | |
TargetedSpectraExtractor () | |
~TargetedSpectraExtractor () override=default | |
void | getDefaultParameters (Param ¶ms) const |
void | annotateSpectra (const std::vector< MSSpectrum > &spectra, const TargetedExperiment &targeted_exp, std::vector< MSSpectrum > &annotated_spectra, FeatureMap &features, bool compute_features=true) const |
Filters and annotates those spectra that could potentially match the transitions of the target list. More... | |
void | annotateSpectra (const std::vector< MSSpectrum > &spectra, const TargetedExperiment &targeted_exp, std::vector< MSSpectrum > &annotated_spectra) const |
Filters and annotates those spectra that could potentially match the transitions of the target list. More... | |
void | annotateSpectra (const std::vector< MSSpectrum > &spectra, const FeatureMap &ms1_features, FeatureMap &ms2_features, std::vector< MSSpectrum > &annotated_spectra) const |
Annotates the MS2 spectra with the likely MS1 feature that it was derived from. More... | |
void | searchSpectrum (OpenMS::FeatureMap &feat_map, OpenMS::FeatureMap &feat_map_output) const |
Search accurate masses and add identification (peptide hits) as features/sub-features. More... | |
void | pickSpectrum (const MSSpectrum &spectrum, MSSpectrum &picked_spectrum) const |
Picks a spectrum's peaks and saves them in picked_spectrum. More... | |
void | scoreSpectra (const std::vector< MSSpectrum > &annotated_spectra, const std::vector< MSSpectrum > &picked_spectra, FeatureMap &features, std::vector< MSSpectrum > &scored_spectra, bool compute_features=true) const |
Assigns a score to the spectra given an input and saves them in scored_spectra. More... | |
void | scoreSpectra (const std::vector< MSSpectrum > &annotated_spectra, const std::vector< MSSpectrum > &picked_spectra, std::vector< MSSpectrum > &scored_spectra) const |
Assigns a score to the spectra given an input and saves them in scored_spectra. More... | |
void | selectSpectra (const std::vector< MSSpectrum > &scored_spectra, const FeatureMap &features, std::vector< MSSpectrum > &selected_spectra, FeatureMap &selected_features, bool compute_features=true) const |
The method selects the highest scoring spectrum for each possible annotation (i.e., transition name) More... | |
void | selectSpectra (const std::vector< MSSpectrum > &scored_spectra, std::vector< MSSpectrum > &selected_spectra) const |
The method selects the highest scoring spectrum for each possible annotation (i.e., transition name) More... | |
void | extractSpectra (const MSExperiment &experiment, const TargetedExperiment &targeted_exp, std::vector< MSSpectrum > &extracted_spectra, FeatureMap &extracted_features, bool compute_features=true) const |
Combines the functionalities given by all the other methods implemented in this class. More... | |
void | extractSpectra (const MSExperiment &experiment, const TargetedExperiment &targeted_exp, std::vector< MSSpectrum > &extracted_spectra) const |
Combines the functionalities given by all the other methods implemented in this class. More... | |
void | matchSpectrum (const MSSpectrum &input_spectrum, const Comparator &cmp, std::vector< Match > &matches) const |
Searches the spectral library for the top scoring candidates that match the input spectrum. More... | |
void | targetedMatching (const std::vector< MSSpectrum > &spectra, const Comparator &cmp, FeatureMap &features) |
Compares a list of spectra against a spectral library and updates the related features. More... | |
void | untargetedMatching (const std::vector< MSSpectrum > &spectra, const Comparator &cmp, FeatureMap &features) |
Compares a list of spectra against a spectral library and creates a `FeatureMap` with the relevant information. More... | |
void | storeSpectraTraML (const String &filename, const OpenMS::FeatureMap &ms1_features, const OpenMS::FeatureMap &ms2_features) const |
store MS1 and the associated MS2 features More... | |
void | storeSpectraMSP (const String &filename, MSExperiment &experiment) const |
store spectra in MSP format More... | |
void | mergeFeatures (const OpenMS::FeatureMap &fmap_input, OpenMS::FeatureMap &fmap_output) const |
organize into a map by combining features and subordinates with the same `identifier` More... | |
Public Member Functions inherited from DefaultParamHandler | |
DefaultParamHandler (const String &name) | |
Constructor with name that is displayed in error messages. More... | |
DefaultParamHandler (const DefaultParamHandler &rhs) | |
Copy constructor. More... | |
virtual | ~DefaultParamHandler () |
Destructor. More... | |
virtual DefaultParamHandler & | operator= (const DefaultParamHandler &rhs) |
Assignment operator. More... | |
virtual bool | operator== (const DefaultParamHandler &rhs) const |
Equality operator. More... | |
void | setParameters (const Param ¶m) |
Sets the parameters. More... | |
const Param & | getParameters () const |
Non-mutable access to the parameters. More... | |
const Param & | getDefaults () const |
Non-mutable access to the default parameters. More... | |
const String & | getName () const |
Non-mutable access to the name. More... | |
void | setName (const String &name) |
Mutable access to the name. More... | |
const std::vector< String > & | getSubsections () const |
Non-mutable access to the registered subsections. More... | |
Protected Member Functions | |
void | updateMembers_ () override |
Overridden function from DefaultParamHandler to keep members up to date, when a parameter is changed. More... | |
void | deisotopeMS2Spectra_ (MSExperiment &experiment) const |
Deisotope MS2 spectra. More... | |
void | removeMS2SpectraPeaks_ (MSExperiment &experiment) const |
Remove peaks form MS2 which are at a higher mz than the precursor + 10 ppm. More... | |
void | organizeMapWithSameIdentifier (const OpenMS::FeatureMap &fmap_input, std::map< std::string, std::vector< OpenMS::Feature >> &fmapmap) const |
organize into a map by combining features and subordinates with the same `identifier` More... | |
Protected Member Functions inherited from DefaultParamHandler | |
void | defaultsToParam_ () |
Updates the parameters after the defaults have been set in the constructor. More... | |
Private Attributes | |
bool | mz_unit_is_Da_ |
double | rt_window_ |
double | mz_tolerance_ |
double | peak_height_min_ |
double | peak_height_max_ |
double | fwhm_threshold_ |
double | tic_weight_ |
double | fwhm_weight_ |
double | snr_weight_ |
double | min_select_score_ |
bool | use_gauss_ |
Size | top_matches_to_report_ |
double | min_match_score_ |
Minimum score for a match to be considered valid in `matchSpectrum()`. More... | |
double | min_fragment_mz_ |
double | max_fragment_mz_ |
double | relative_allowable_product_mass_ |
bool | deisotoping_use_deisotoper_ |
double | deisotoping_fragment_tolerance_ |
std::string | deisotoping_fragment_unit_ |
int | deisotoping_min_charge_ |
int | deisotoping_max_charge_ |
int | deisotoping_min_isopeaks_ |
int | deisotoping_max_isopeaks_ |
bool | deisotoping_keep_only_deisotoped_ |
bool | deisotoping_annotate_charge_ |
double | max_precursor_mass_threashold_ |
Additional Inherited Members | |
Static Public Member Functions inherited from DefaultParamHandler | |
static void | writeParametersToMetaValues (const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="") |
Writes all parameters to meta values. More... | |
Protected Attributes inherited from DefaultParamHandler | |
Param | param_ |
Container for current parameters. More... | |
Param | defaults_ |
Container for default parameters. This member should be filled in the constructor of derived classes! More... | |
std::vector< String > | subsections_ |
Container for registered subsections. This member should be filled in the constructor of derived classes! More... | |
String | error_name_ |
Name that is displayed in error messages during the parameter checking. More... | |
bool | check_defaults_ |
If this member is set to false no checking if parameters in done;. More... | |
bool | warn_empty_defaults_ |
If this member is set to false no warning is emitted when defaults are empty;. More... | |
This class filters, annotates, picks, and scores spectra (e.g., taken from a DDA experiment) based on a target list.
The input experiment is expected to be a standard .mzML file. The input target list is expected to be a standard TraML formatted .csv file.
The class deals with filtering and annotating only those spectra that reflect the characteristics described by the target list. The filtering is done based on the transition_name, PrecursorMz and RetentionTime. The spectra are smoothed and peaks are picked for each spectrum. The spectra are then scored based on total TIC, FWHM and SNR. One spectrum is chosen for each of those transitions for which at least one valid spectrum was found and matched.
The user can decide to use only extractSpectra(), otherwise run the methods in the following order: annotateSpectra() pickSpectrum() (called once for each annotated spectrum) scoreSpectra() selectSpectra()
|
overridedefault |
void annotateSpectra | ( | const std::vector< MSSpectrum > & | spectra, |
const FeatureMap & | ms1_features, | ||
FeatureMap & | ms2_features, | ||
std::vector< MSSpectrum > & | annotated_spectra | ||
) | const |
Annotates the MS2 spectra with the likely MS1 feature that it was derived from.
Annotating based on MS1 feature results from AccurateMassSearch. In this case, the input will be e.g., const FeatureMap& ms1_features and the RTs and names (i.e., PeptideRef), defined in the FeatureMap.
[in] | spectra | The spectra to filter |
[in] | ms1_features | The MS1 features |
[out] | ms2_features | The MS2 features |
[out] | annotated_spectra | The resulting annotated spectra |
void annotateSpectra | ( | const std::vector< MSSpectrum > & | spectra, |
const TargetedExperiment & | targeted_exp, | ||
std::vector< MSSpectrum > & | annotated_spectra | ||
) | const |
Filters and annotates those spectra that could potentially match the transitions of the target list.
The spectra taken into account are those that fall within the precursor RT window and MZ tolerance set by the user through the parameters "rt_window" and "mz_tolerance". Default values are provided for both parameters.
[in] | spectra | The spectra to filter |
[in] | targeted_exp | The target list |
[out] | annotated_spectra | The spectra annotated with the related transition's name |
void annotateSpectra | ( | const std::vector< MSSpectrum > & | spectra, |
const TargetedExperiment & | targeted_exp, | ||
std::vector< MSSpectrum > & | annotated_spectra, | ||
FeatureMap & | features, | ||
bool | compute_features = true |
||
) | const |
Filters and annotates those spectra that could potentially match the transitions of the target list.
The spectra taken into account are those that fall within the precursor RT window and MZ tolerance set by the user through the parameters "rt_window" and "mz_tolerance". Default values are provided for both parameters.
[in] | spectra | The spectra to filter |
[in] | targeted_exp | The target list |
[out] | annotated_spectra | The spectra annotated with the related transition's name |
[out] | features | A FeatureMap which will contain informations about the name, precursor RT and precursor MZ of the matched transition |
[in] | compute_features | If false, `features` will be ignored |
|
protected |
Deisotope MS2 spectra.
void extractSpectra | ( | const MSExperiment & | experiment, |
const TargetedExperiment & | targeted_exp, | ||
std::vector< MSSpectrum > & | extracted_spectra | ||
) | const |
Combines the functionalities given by all the other methods implemented in this class.
The method expects an experiment and a target list in input, and constructs the extracted spectra. For each transition of the target list, the method tries to find its best spectrum match.
[in] | experiment | The input experiment |
[in] | targeted_exp | The target list |
[out] | extracted_spectra | The spectra related to the transitions |
void extractSpectra | ( | const MSExperiment & | experiment, |
const TargetedExperiment & | targeted_exp, | ||
std::vector< MSSpectrum > & | extracted_spectra, | ||
FeatureMap & | extracted_features, | ||
bool | compute_features = true |
||
) | const |
Combines the functionalities given by all the other methods implemented in this class.
The method expects an experiment and a target list in input, and constructs the extracted spectra and features. For each transition of the target list, the method tries to find its best spectrum match. A FeatureMap is also filled with informations about the extracted spectra.
[in] | experiment | The input experiment |
[in] | targeted_exp | The target list |
[out] | extracted_spectra | The spectra related to the transitions |
[out] | extracted_features | The features related to the output spectra |
[in] | compute_features | If false, `extracted_features` will be ignored |
void getDefaultParameters | ( | Param & | params | ) | const |
void matchSpectrum | ( | const MSSpectrum & | input_spectrum, |
const Comparator & | cmp, | ||
std::vector< Match > & | matches | ||
) | const |
Searches the spectral library for the top scoring candidates that match the input spectrum.
[in] | input_spectrum | The input spectrum for which a match is desired |
[in] | cmp | The comparator object containing the library and the logic for matching |
[out] | matches | A vector of `Match`es, containing the matched spectra and their scores |
void mergeFeatures | ( | const OpenMS::FeatureMap & | fmap_input, |
OpenMS::FeatureMap & | fmap_output | ||
) | const |
organize into a map by combining features and subordinates with the same `identifier`
[in] | fmap_input | input features map |
[in] | fmap_output | output features map |
|
protected |
organize into a map by combining features and subordinates with the same `identifier`
void pickSpectrum | ( | const MSSpectrum & | spectrum, |
MSSpectrum & | picked_spectrum | ||
) | const |
Picks a spectrum's peaks and saves them in picked_spectrum.
The spectrum is first smoothed with a Gaussian filter (default) or using the Savitzky-Golay method. The parameter "use_gauss" handles this choice. The peak picking is executed with PeakPickerHiRes. Custom parameters provided with the prefix "GaussFilter:", "SavitzkyGolayFilter:" and "PeakPickerHiRes:" are taken into account. Peaks are then filtered by their heights and FWHM values. It is possible to set the peaks' limits through the parameters: "peak_height_min", "peak_height_max" and "fwhm_threshold".
Exception::IllegalArgument | If `spectrum` is not sorted by position (mz). |
[in] | spectrum | The input spectrum |
[out] | picked_spectrum | A spectrum containing only the picked peaks |
|
protected |
Remove peaks form MS2 which are at a higher mz than the precursor + 10 ppm.
void scoreSpectra | ( | const std::vector< MSSpectrum > & | annotated_spectra, |
const std::vector< MSSpectrum > & | picked_spectra, | ||
FeatureMap & | features, | ||
std::vector< MSSpectrum > & | scored_spectra, | ||
bool | compute_features = true |
||
) | const |
Assigns a score to the spectra given an input and saves them in scored_spectra.
Also add the informations to the FeatureMap first constructed in annotateSpectra(). The scores are based on total TIC, SNR and FWHM. It is possible to assign a weight to these parameters using: "tic_weight", "fwhm_weight" and "snr_weight". For each spectrum, the TIC and the SNR are computed on the entire spectrum. The FWHMs are computed only on picked peaks. Both SNR and FWHM are averaged values. The informations are added as FloatDataArray in scored_spectra and as MetaValue in features.
Exception::InvalidSize | If `features` and `annotated_spectra` sizes don't match. |
[in] | annotated_spectra | The annotated spectra to score (for TIC and SNR) |
[in] | picked_spectra | The picked peaks found on each of the annotated spectra (for FWHM) |
[in,out] | features | The score informations are also added to this FeatureMap. Picked peaks' FWHMs are saved in features' subordinates. |
[out] | scored_spectra | The scored spectra. Basically a copy of annotated_spectra with the added score informations |
[in] | compute_features | If false, `features` will be ignored |
void scoreSpectra | ( | const std::vector< MSSpectrum > & | annotated_spectra, |
const std::vector< MSSpectrum > & | picked_spectra, | ||
std::vector< MSSpectrum > & | scored_spectra | ||
) | const |
Assigns a score to the spectra given an input and saves them in scored_spectra.
Also add the informations to the FeatureMap first constructed in annotateSpectra(). The scores are based on total TIC, SNR and FWHM. It is possible to assign a weight to these parameters using: "tic_weight", "fwhm_weight" and "snr_weight". For each spectrum, the TIC and the SNR are computed on the entire spectrum. The FWHMs are computed only on picked peaks. Both SNR and FWHM are averaged values.
void searchSpectrum | ( | OpenMS::FeatureMap & | feat_map, |
OpenMS::FeatureMap & | feat_map_output | ||
) | const |
Search accurate masses and add identification (peptide hits) as features/sub-features.
[in] | feat_map | The feature map to search in |
[in] | feat_map_output | The output feature map, with peptide identifaction as sub features |
void selectSpectra | ( | const std::vector< MSSpectrum > & | scored_spectra, |
const FeatureMap & | features, | ||
std::vector< MSSpectrum > & | selected_spectra, | ||
FeatureMap & | selected_features, | ||
bool | compute_features = true |
||
) | const |
The method selects the highest scoring spectrum for each possible annotation (i.e., transition name)
Exception::InvalidSize | If `scored_spectra` and `features` sizes don't match. |
[in] | scored_spectra | Input annotated and scored spectra |
[in] | features | Input features |
[out] | selected_spectra | Output selected spectra |
[out] | selected_features | Output selected features |
[in] | compute_features | If false, `selected_features` will be ignored |
void selectSpectra | ( | const std::vector< MSSpectrum > & | scored_spectra, |
std::vector< MSSpectrum > & | selected_spectra | ||
) | const |
The method selects the highest scoring spectrum for each possible annotation (i.e., transition name)
[in] | scored_spectra | Input annotated and scored spectra |
[out] | selected_spectra | Output selected spectra |
void storeSpectraMSP | ( | const String & | filename, |
MSExperiment & | experiment | ||
) | const |
store spectra in MSP format
[in] | filename | the filename of the file to write |
[in] | experiment | the experiment to store |
void storeSpectraTraML | ( | const String & | filename, |
const OpenMS::FeatureMap & | ms1_features, | ||
const OpenMS::FeatureMap & | ms2_features | ||
) | const |
store MS1 and the associated MS2 features
[in] | filename | the filename of the file to write |
[in] | ms1_features | the MS1 features |
[in] | ms2_features | the MS2 features |
void targetedMatching | ( | const std::vector< MSSpectrum > & | spectra, |
const Comparator & | cmp, | ||
FeatureMap & | features | ||
) |
Compares a list of spectra against a spectral library and updates the related features.
The metavalues added to each `Feature` within the `FeatureMap` are:
If a match for a given input spectrum is not found, the metavalues will be assigned a default value:
[in] | spectra | The input spectra |
[in] | cmp | The `Comparator` object containing the spectral library |
[in/out] | features The `FeatureMap` to be updated with matching info |
void untargetedMatching | ( | const std::vector< MSSpectrum > & | spectra, |
const Comparator & | cmp, | ||
FeatureMap & | features | ||
) |
Compares a list of spectra against a spectral library and creates a `FeatureMap` with the relevant information.
The metavalues added to each `Feature` within the `FeatureMap` are:
If a match for a given input spectrum is not found, the metavalues will be assigned a default value:
[in] | spectra | The input spectra |
[in] | cmp | The `Comparator` object containing the spectral library |
[out] | features | The `FeatureMap` to be filled with matching info |
|
overrideprotectedvirtual |
Overridden function from DefaultParamHandler to keep members up to date, when a parameter is changed.
Reimplemented from DefaultParamHandler.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
Used in pickSpectrum(), a peak's FWHM needs to be >= fwhm_threshold_ for it to be picked.
|
private |
FWHM's weight when computing a spectrum's score
|
private |
|
private |
|
private |
|
private |
Minimum score for a match to be considered valid in `matchSpectrum()`.
|
private |
Used in selectSpectra(), after the spectra have been assigned a score. Remained transitions will have at least one spectrum assigned. Each spectrum needs to have a score >= min_select_score_ to be valid, otherwise it gets filtered out.
|
private |
Precursor MZ tolerance used during the annotation phase. For each transition in the target list, annotateSpectra() looks for the first spectrum whose precursor MZ is close enough (+-mz_tolerance_) to the transition's MZ. Also the spectrum's precursor RT is checked against the transition RT.
|
private |
Unit to use for mz_tolerance_ and fwhm_threshold_: true for Da, false for ppm.
|
private |
Used in pickSpectrum(), a peak's intensity needs to be <= peak_height_max_ for it to be picked.
|
private |
Used in pickSpectrum(), a peak's intensity needs to be >= peak_height_min_ for it to be picked.
|
private |
|
private |
Precursor Retention Time window used during the annotation phase. For each transition in the target list, annotateSpectra() looks for the first spectrum whose RT time falls within the RT Window, whose left and right limits are computed at each analyzed spectrum. Also the spectrum's precursor MZ is checked against the transition MZ.
|
private |
SNR's weight when computing a spectrum's score
|
private |
Total TIC's weight when computing a spectrum's score
|
private |
The number of matches to output from `matchSpectrum()`. These will be the matches of highest scores, sorted in descending order.
|
private |
Used in pickSpectrum(), it selects which filtering method is used during the smoothing phase. By default the Gauss filter is selected. Set to false for the Savitzky-Golay method.