OpenMS  3.0.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-2022.
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 namespace OpenMS
46 {
47  namespace Detail
48  {
49  template<typename T>
51  {
52  static void getKeys(const T& object, std::vector<String>& keys)
53  {
54  object.getKeys(keys);
55  };
56  };
57  }
58 
64  class /*OPENMS_DLLAPI -- disabled since it's template code only */ MetaInfoInterfaceUtils
65  {
66 public:
68  MetaInfoInterfaceUtils() = delete;
71  // no Move semantics for utils class
72 
73 
75 
76 
91  template<typename T_In, typename T_Out>
92  static T_Out findCommonMetaKeys(const typename T_In::const_iterator& it_start, const typename T_In::const_iterator& it_end, float min_frequency, typename Detail::MetaKeyGetter<typename T_In::value_type> getter = Detail::MetaKeyGetter<typename T_In::value_type>())
93  {
94  // make sure min_frequency is within [0,100]
95  min_frequency = std::min(100.0f, std::max(0.0f, min_frequency));
96 
97  std::map<String, UInt> counter;
98  typedef std::vector<String> KeysType;
99  KeysType keys;
100  for (typename T_In::const_iterator it = it_start; it != it_end; ++it)
101  {
102  getter.getKeys(*it, keys);
103  for (KeysType::const_iterator itk = keys.begin(); itk != keys.end(); ++itk)
104  {
105  ++counter[*itk];
106  }
107  }
108  // pick the keys which occur often enough
109  const UInt required_counts = UInt(min_frequency / 100.0 * std::distance(it_start, it_end));
110  T_Out common_keys;
111  for (const auto& [key, count] : counter)
112  {
113  if (count >= required_counts)
114  {
115  common_keys.insert(common_keys.end(), key);
116  }
117  }
118  return common_keys;
119  }
120 
121  }; // class
122 
123 } // namespace OPENMS
124 
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, typename Detail::MetaKeyGetter< typename T_In::value_type > getter=Detail::MetaKeyGetter< typename T_In::value_type >())
Find keys in a collection of MetaInfoInterface objects which reach a certain frequency threshold.
Definition: MetaInfoInterfaceUtils.h:92
OpenMS::Detail::MetaKeyGetter
Definition: MetaInfoInterfaceUtils.h:50
OpenMS::MetaInfoInterfaceUtils
Utilities operating on containers inheriting from MetaInfoInterface.
Definition: MetaInfoInterfaceUtils.h:64
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Detail::MetaKeyGetter::getKeys
static void getKeys(const T &object, std::vector< String > &keys)
Definition: MetaInfoInterfaceUtils.h:52
OpenMS::MetaInfoInterfaceUtils::MetaInfoInterfaceUtils
MetaInfoInterfaceUtils()=delete
hide c'tors to avoid instantiation of utils class
OpenMS::MetaInfoInterfaceUtils::operator=
MetaInfoInterfaceUtils & operator=(MetaInfoInterfaceUtils &)=delete
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
MetaInfoInterface.h
String.h