Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
FeatureGroupingAlgorithmUnlabeled.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-2013.
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: Clemens Groepl $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMUNLABELED_H
36 #define OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMUNLABELED_H
37 
39 
40 namespace OpenMS
41 {
60  class OPENMS_DLLAPI FeatureGroupingAlgorithmUnlabeled :
62  {
63 public:
66 
69 
77  template <typename MapType>
78  void setReference(int map_id, const MapType & map)
79  {
80  ConsensusMap::convert(map_id, map, pairfinder_input_[0]);
81  }
82 
87  {
88  return pairfinder_input_[0];
89  }
90 
96  virtual void group(const std::vector<FeatureMap<> > & maps, ConsensusMap & out);
97 
108  void addToGroup(int map_id, const FeatureMap<> & feature_map);
109 
112  {
114  }
115 
118  {
119  return "unlabeled";
120  }
121 
122 private:
123 
124  // This vector should always have 2 elements
125  // - the first element is the currently computed consensus map.
126  // After initialization of the algorithm, it will consist of the reference
127  // map alone, after adding all maps through addToGroup it will contain the
128  // final result (e.g. the consensus result of all maps).
129  // - the second element is the map which was last added to the consensus map
130  std::vector<ConsensusMap> pairfinder_input_;
131 
136 
137  };
138 
139 } // namespace OpenMS
140 
141 #endif // OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMUNLABELED_H
std::vector< ConsensusMap > pairfinder_input_
Definition: FeatureGroupingAlgorithmUnlabeled.h:130
A more convenient string class.
Definition: String.h:56
ConsensusMap & getResultMap()
Returns the computed consensus map (after calling addToGroup with all maps)
Definition: FeatureGroupingAlgorithmUnlabeled.h:86
A container for consensus elements.
Definition: ConsensusMap.h:60
void setReference(int map_id, const MapType &map)
Sets the reference map for the algorithm.
Definition: FeatureGroupingAlgorithmUnlabeled.h:78
A map feature grouping algorithm for unlabeled data.
Definition: FeatureGroupingAlgorithmUnlabeled.h:60
Base class for all feature grouping algorithms.
Definition: FeatureGroupingAlgorithm.h:50
static FeatureGroupingAlgorithm * create()
Creates a new instance of this class (for Factory)
Definition: FeatureGroupingAlgorithmUnlabeled.h:111
static void convert(UInt64 const input_map_index, FeatureMap< FeatureT > const &input_map, ConsensusMap &output_map, Size n=-1)
Convert a FeatureMap (of any feature type) to a ConsensusMap.
Definition: ConsensusMap.h:230
static String getProductName()
Returns the product name (for the Factory)
Definition: FeatureGroupingAlgorithmUnlabeled.h:117

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:13 using doxygen 1.8.5