OpenMS  2.6.0
MetaInfoInterfaceUtils.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/OpenMSConfig.h>
40 
41 #include <algorithm>
42 #include <map>
43 #include <vector>
44 
45 
46 namespace OpenMS
47 {
48 
54  class /*OPENMS_DLLAPI -- disabled since it's template code only */ MetaInfoInterfaceUtils
55  {
56 public:
58  MetaInfoInterfaceUtils() = delete;
61  // no Move semantics for utils class
62 
64 
65 
80  template<typename T_In, typename T_Out>
81  static T_Out findCommonMetaKeys(const typename T_In::const_iterator& it_start, const typename T_In::const_iterator& it_end, float min_frequency)
82  {
83  // make sure min_frequency is within [0,100]
84  min_frequency = std::min((float)100.0, std::max((float)0.0, min_frequency));
85 
86  std::map<String, uint> counter;
87  typedef std::vector<String> KeysType;
88  KeysType keys;
89  for (typename T_In::const_iterator it = it_start; it != it_end; ++it)
90  {
91  it->getKeys(keys);
92  for (KeysType::const_iterator itk = keys.begin(); itk != keys.end(); ++itk)
93  {
94  ++counter[*itk];
95  }
96  }
97  // pick the keys which occur often enough
98  const uint required_counts = uint(min_frequency / 100.0 * std::distance(it_start, it_end));
99  T_Out common_keys;
100  for (std::map<String, uint>::const_iterator it = counter.begin(); it != counter.end(); ++it)
101  {
102  if (it->second >= required_counts)
103  {
104  common_keys.insert(common_keys.end(), it->first);
105  }
106  }
107  return common_keys;
108  }
109 
110  }; // class
111 
112 } // namespace OPENMS
113 
OpenMS::MetaInfoInterfaceUtils
Utilities operating on containers inheriting from MetaInfoInterface.
Definition: MetaInfoInterfaceUtils.h:54
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MetaInfoInterfaceUtils::MetaInfoInterfaceUtils
MetaInfoInterfaceUtils()=delete
hide c'tors to avoid instantiation of utils class
OpenMS::MetaInfoInterfaceUtils::findCommonMetaKeys
static T_Out findCommonMetaKeys(const typename T_In::const_iterator &it_start, const typename T_In::const_iterator &it_end, float min_frequency)
Find keys in a collection of MetaInfoInterface objects which reach a certain frequency threshold.
Definition: MetaInfoInterfaceUtils.h:81
OpenMS::MetaInfoInterfaceUtils::operator=
MetaInfoInterfaceUtils & operator=(MetaInfoInterfaceUtils &)=delete
MetaInfoInterface.h
String.h