← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/ANALYSIS/MAPMATCHING/FeatureGroupingAlgorithmIdentification.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/ANALYSIS/MAPMATCHING/FeatureGroupingAlgorithmIdentification.h
 
1
// -*- mode: C++; tab-width: 2; -*-
 
2
// vi: set ts=2:
 
3
//
 
4
// --------------------------------------------------------------------------
 
5
//                   OpenMS Mass Spectrometry Framework
 
6
// --------------------------------------------------------------------------
 
7
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
 
8
//
 
9
//  This library is free software; you can redistribute it and/or
 
10
//  modify it under the terms of the GNU Lesser General Public
 
11
//  License as published by the Free Software Foundation; either
 
12
//  version 2.1 of the License, or (at your option) any later version
 
13
//
 
14
//  This library is distributed in the hope that it will be useful,
 
15
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
//  Lesser General Public License for more details
 
18
//
 
19
//  You should have received a copy of the GNU Lesser General Public
 
20
//  License along with this library; if not, write to the Free Software
 
21
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
22
//
 
23
// --------------------------------------------------------------------------
 
24
// $Maintainer: Clemens Groepl $
 
25
// $Authors: Katharina Albers $
 
26
// --------------------------------------------------------------------------
 
27
 
 
28
#ifndef OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMIDENTIFICATION_H
 
29
#define OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMIDENTIFICATION_H
 
30
 
 
31
#include <OpenMS/ANALYSIS/MAPMATCHING/FeatureGroupingAlgorithm.h>
 
32
 
 
33
namespace OpenMS
 
34
{
 
35
  /**
 
36
         @deprecated Deprecated in OpenMS 1.7.
 
37
 
 
38
   @brief A map feature grouping algorithm for identified features.
 
39
 
 
40
   It takes many maps and searches for corresponding features.
 
41
   The corresponding features must be aligned, but may have small position deviations.
 
42
 
 
43
   @htmlinclude OpenMS_FeatureGroupingAlgorithmIdentification.parameters
 
44
 
 
45
   @ingroup FeatureGrouping
 
46
   */
 
47
  class OPENMS_DLLAPI FeatureGroupingAlgorithmIdentification : public FeatureGroupingAlgorithm
 
48
  {
 
49
  public:
 
50
    /// Default constructor
 
51
    FeatureGroupingAlgorithmIdentification();
 
52
 
 
53
    /// Destructor
 
54
    virtual
 
55
    ~FeatureGroupingAlgorithmIdentification();
 
56
 
 
57
    /**
 
58
     @brief Applies the algorithm
 
59
 
 
60
     @exception IllegalArgument is thrown if less than two input maps are given.
 
61
     */
 
62
    virtual void
 
63
    group(const std::vector<FeatureMap<> >& maps, ConsensusMap& out);
 
64
 
 
65
    /// Creates a new instance of this class (for Factory)
 
66
    static FeatureGroupingAlgorithm*
 
67
    create()
 
68
    {
 
69
      return new FeatureGroupingAlgorithmIdentification();
 
70
    }
 
71
 
 
72
    /// Returns the product name (for the Factory)
 
73
    static String
 
74
    getProductName()
 
75
    {
 
76
      return "identification";
 
77
    }
 
78
 
 
79
  private:
 
80
 
 
81
    /// Copy constructor intentionally not implemented -> private
 
82
    FeatureGroupingAlgorithmIdentification(const FeatureGroupingAlgorithmIdentification&);
 
83
    /// Assignment operator intentionally not implemented -> private
 
84
    FeatureGroupingAlgorithmIdentification&
 
85
    operator=(const FeatureGroupingAlgorithmIdentification&);
 
86
 
 
87
  };
 
88
 
 
89
} // namespace OpenMS
 
90
 
 
91
#endif // OPENMS_ANALYSIS_MAPMATCHING_FEATUREGROUPINGALGORITHMIDENTIFICATION_H