OpenMS
SpectrumSettings.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2023.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
45 
46 #include <map>
47 #include <vector>
48 
49 namespace OpenMS
50 {
63  class OPENMS_DLLAPI SpectrumSettings :
64  public MetaInfoInterface
65  {
66 
67 public:
68 
71  {
75  SIZE_OF_SPECTRUMTYPE
76  };
78  static const std::string NamesOfSpectrumType[SIZE_OF_SPECTRUMTYPE];
79 
83  SpectrumSettings(const SpectrumSettings &) = default;
88 
89  // Assignment operator
93 
95  bool operator==(const SpectrumSettings & rhs) const;
97  bool operator!=(const SpectrumSettings & rhs) const;
98 
100  void unify(const SpectrumSettings & rhs);
101 
105  void setType(SpectrumType type);
106 
108  const String & getNativeID() const;
110  void setNativeID(const String & native_id);
111 
113  const String & getComment() const;
115  void setComment(const String & comment);
116 
122  void setInstrumentSettings(const InstrumentSettings & instrument_settings);
123 
129  void setAcquisitionInfo(const AcquisitionInfo & acquisition_info);
130 
132  const SourceFile & getSourceFile() const;
136  void setSourceFile(const SourceFile & source_file);
137 
139  const std::vector<Precursor> & getPrecursors() const;
141  std::vector<Precursor> & getPrecursors();
143  void setPrecursors(const std::vector<Precursor> & precursors);
144 
146  const std::vector<Product> & getProducts() const;
148  std::vector<Product> & getProducts();
150  void setProducts(const std::vector<Product> & products);
151 
153  const std::vector<PeptideIdentification> & getPeptideIdentifications() const;
155  std::vector<PeptideIdentification> & getPeptideIdentifications();
157  void setPeptideIdentifications(const std::vector<PeptideIdentification> & identifications);
158 
160  void setDataProcessing(const std::vector< DataProcessingPtr > & data_processing);
161 
163  std::vector< DataProcessingPtr > & getDataProcessing();
164 
166  const std::vector< boost::shared_ptr<const DataProcessing > > getDataProcessing() const;
167 
168 protected:
169 
176  std::vector<Precursor> precursors_;
177  std::vector<Product> products_;
178  std::vector<PeptideIdentification> identification_;
179  std::vector< DataProcessingPtr > data_processing_;
180  };
181 
183  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const SpectrumSettings & spec);
184 
185 } // namespace OpenMS
186 
Description of the combination of raw data to a single spectrum.
Definition: AcquisitionInfo.h:55
Description of the settings a MS Instrument was run with.
Definition: InstrumentSettings.h:49
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
Description of a file location, used to store the origin of (meta) data.
Definition: SourceFile.h:48
Representation of 1D spectrum settings.
Definition: SpectrumSettings.h:65
SpectrumSettings & operator=(SpectrumSettings &&) &=default
Move assignment operator.
String comment_
Definition: SpectrumSettings.h:172
SpectrumSettings & operator=(const SpectrumSettings &)=default
AcquisitionInfo acquisition_info_
Definition: SpectrumSettings.h:175
SpectrumSettings()
Constructor.
SourceFile source_file_
Definition: SpectrumSettings.h:174
void setComment(const String &comment)
sets the free-text comment
InstrumentSettings instrument_settings_
Definition: SpectrumSettings.h:173
void unify(const SpectrumSettings &rhs)
merge another spectrum setting into this one (data is usually appended, except for spectrum type whic...
const std::vector< boost::shared_ptr< const DataProcessing > > getDataProcessing() const
returns a const reference to the description of the applied processing
void setProducts(const std::vector< Product > &products)
sets the products
void setInstrumentSettings(const InstrumentSettings &instrument_settings)
sets the instrument settings of the current spectrum
SpectrumType getType() const
returns the spectrum type (centroided (PEAKS) or profile data (RAW))
bool operator!=(const SpectrumSettings &rhs) const
Equality operator.
SpectrumSettings(const SpectrumSettings &)=default
Copy constructor.
std::vector< Precursor > & getPrecursors()
returns a mutable reference to the precursors
const SourceFile & getSourceFile() const
returns a const reference to the source file
AcquisitionInfo & getAcquisitionInfo()
returns a mutable reference to the acquisition info
SpectrumSettings(SpectrumSettings &&)=default
Move constructor.
std::vector< PeptideIdentification > & getPeptideIdentifications()
returns a mutable reference to the PeptideIdentification vector
String native_id_
Definition: SpectrumSettings.h:171
void setType(SpectrumType type)
sets the spectrum type
const AcquisitionInfo & getAcquisitionInfo() const
returns a const reference to the acquisition info
void setSourceFile(const SourceFile &source_file)
sets the source file
std::vector< Product > & getProducts()
returns a mutable reference to the products
const std::vector< PeptideIdentification > & getPeptideIdentifications() const
returns a const reference to the PeptideIdentification vector
const InstrumentSettings & getInstrumentSettings() const
returns a const reference to the instrument settings of the current spectrum
std::vector< DataProcessingPtr > data_processing_
Definition: SpectrumSettings.h:179
void setDataProcessing(const std::vector< DataProcessingPtr > &data_processing)
sets the description of the applied processing
SpectrumType type_
Definition: SpectrumSettings.h:170
std::vector< PeptideIdentification > identification_
Definition: SpectrumSettings.h:178
SpectrumType
Spectrum peak type.
Definition: SpectrumSettings.h:71
@ UNKNOWN
Unknown spectrum type.
Definition: SpectrumSettings.h:72
@ PROFILE
profile data
Definition: SpectrumSettings.h:74
@ CENTROID
centroid data or stick data
Definition: SpectrumSettings.h:73
bool operator==(const SpectrumSettings &rhs) const
Equality operator.
std::vector< DataProcessingPtr > & getDataProcessing()
returns a mutable reference to the description of the applied processing
const std::vector< Precursor > & getPrecursors() const
returns a const reference to the precursors
SourceFile & getSourceFile()
returns a mutable reference to the source file
std::vector< Precursor > precursors_
Definition: SpectrumSettings.h:176
const std::vector< Product > & getProducts() const
returns a const reference to the products
~SpectrumSettings()
Destructor.
const String & getComment() const
returns the free-text comment
void setPeptideIdentifications(const std::vector< PeptideIdentification > &identifications)
sets the PeptideIdentification vector
void setPrecursors(const std::vector< Precursor > &precursors)
sets the precursors
const String & getNativeID() const
returns the native identifier for the spectrum, used by the acquisition software.
void setAcquisitionInfo(const AcquisitionInfo &acquisition_info)
sets the acquisition info
std::vector< Product > products_
Definition: SpectrumSettings.h:177
InstrumentSettings & getInstrumentSettings()
returns a mutable reference to the instrument settings of the current spectrum
void setNativeID(const String &native_id)
sets the native identifier for the spectrum, used by the acquisition software.
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)