OpenMS  3.0.0
PoseClusteringShiftSuperimposer.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: Timo Sachsenberg $
32 // $Authors: Eva Lange, Clemens Groepl $
33 // --------------------------------------------------------------------------
34 
35 
36 #pragma once
37 
39 
40 namespace OpenMS
41 {
42 
64  class OPENMS_DLLAPI PoseClusteringShiftSuperimposer :
65  public BaseSuperimposer
66  {
67 public:
68 
71 
74  {}
75 
90  void run(const ConsensusMap & map_model, const ConsensusMap & map_scene, TransformationDescription & transformation) override;
91 
94  {
96  }
97 
99  static const String getProductName()
100  {
101  return "poseclustering_shift";
102  }
103 
104  };
105 } // namespace OpenMS
106 
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::PoseClusteringShiftSuperimposer
A superimposer that uses a voting scheme, also known as pose clustering, to find a good shift transfo...
Definition: PoseClusteringShiftSuperimposer.h:64
OpenMS::PoseClusteringShiftSuperimposer::~PoseClusteringShiftSuperimposer
~PoseClusteringShiftSuperimposer() override
Destructor.
Definition: PoseClusteringShiftSuperimposer.h:73
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:82
OpenMS::BaseSuperimposer
The base class of all superimposer algorithms.
Definition: BaseSuperimposer.h:56
OpenMS::PoseClusteringShiftSuperimposer::getProductName
static const String getProductName()
Returns the name of this module.
Definition: PoseClusteringShiftSuperimposer.h:99
OpenMS::PoseClusteringShiftSuperimposer::create
static BaseSuperimposer * create()
Returns an instance of this class.
Definition: PoseClusteringShiftSuperimposer.h:93
BaseSuperimposer.h
OpenMS::TransformationDescription
Generic description of a coordinate transformation.
Definition: TransformationDescription.h:62