OpenMS
SpectrumCount.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: Axel Walter $
32 // $Authors: Axel Walter $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/QC/QCBase.h>
38 
43 namespace OpenMS
44 {
45  class MSExperiment;
46 
47  class OPENMS_DLLAPI SpectrumCount : public QCBase
48  {
49  public:
51  SpectrumCount() = default;
52 
54  virtual ~SpectrumCount() = default;
55 
63  std::map<Size, UInt> compute(const MSExperiment& exp);
64 
65  const String& getName() const override;
66 
67  QCBase::Status requirements() const override;
68 
69  private:
70  const String name_ = "SpectrumCount";
71  };
72 } // namespace OpenMS
Stores and handles combinations of enum values, e.g. a set of flags as bits flipped in an UInt64.
Definition: FlagSet.h:54
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:72
This class serves as an abstract base class for all QC classes.
Definition: QCBase.h:55
Definition: SpectrumCount.h:48
std::map< Size, UInt > compute(const MSExperiment &exp)
Compute number of spectra per MS level and returns them in a map.
SpectrumCount()=default
Constructor.
const String & getName() const override
Returns the name of the metric.
QCBase::Status requirements() const override
Returns the input data requirements of the compute(...) function.
virtual ~SpectrumCount()=default
Destructor.
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48