OpenMS: ConsensusMapNormalizerAlgorithmMedian.h Source File

| OpenMS 2.5.0

ConsensusMapNormalizerAlgorithmMedian.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-2020.
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: Johannes Veit $
32 // $Authors: Johannes Junker $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/KERNEL/ConsensusMap.h>
38 #include <OpenMS/ANALYSIS/MAPMATCHING/ConsensusMapNormalizerAlgorithmThreshold.h>
39
40 namespace OpenMS
41 {
42
47 class OPENMS_DLLAPI ConsensusMapNormalizerAlgorithmMedian
48 {
50 friend class ConsensusMapNormalizerAlgorithmThreshold;
51
52 private:
54 ConsensusMapNormalizerAlgorithmMedian(const ConsensusMapNormalizerAlgorithmMedian & copyin);
55
57 ConsensusMapNormalizerAlgorithmMedian & operator=(const ConsensusMapNormalizerAlgorithmMedian & rhs);
58
59 public:
61 ConsensusMapNormalizerAlgorithmMedian();
62
64 virtual ~ConsensusMapNormalizerAlgorithmMedian();
65
70 enum NormalizationMethod { NM_SCALE, NM_SHIFT };
71
79 static void normalizeMaps(ConsensusMap & map, NormalizationMethod method, const String& acc_filter, const String& desc_filter);
80
89 static Size computeMedians(const ConsensusMap & map, std::vector<double> & medians, const String& acc_filter, const String& desc_filter);
90
100 static bool passesFilters_(ConsensusMap::ConstIterator cf_it, const ConsensusMap& map, const String& acc_filter, const String& desc_filter);
101 };
102
103 } // namespace OpenMS
104
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::ConsensusMapNormalizerAlgorithmMedian::NormalizationMethod
NormalizationMethod
The NormalizationMethod enum Whether to scale to same median using division/multiplication or shift u...
Definition: ConsensusMapNormalizerAlgorithmMedian.h:70
OpenMS::ConsensusMapNormalizerAlgorithmMedian
Algorithms of ConsensusMapNormalizer.
Definition: ConsensusMapNormalizerAlgorithmMedian.h:47
OpenMS::ConsensusMap::ConstIterator
std::vector< ConsensusFeature >::const_iterator ConstIterator
Non-mutable iterator.
Definition: ConsensusMap.h:162
OpenMS::ConsensusMapNormalizerAlgorithmThreshold
Algorithms of ConsensusMapNormalizer.
Definition: ConsensusMapNormalizerAlgorithmThreshold.h:46
ConsensusMap.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:79
ConsensusMapNormalizerAlgorithmThreshold.h
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127