← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/OpenMS/TRANSFORMATIONS/FEATUREFINDER/BiGaussModel.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/TRANSFORMATIONS/FEATUREFINDER/BiGaussModel.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
 
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.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: Clemens Groepl $
34
41
 
35
42
namespace OpenMS
36
43
{
37
 
  /** 
38
 
                @brief Bigaussian distribution approximated using linear interpolation.
 
44
  /**
 
45
        @brief Bigaussian distribution approximated using linear interpolation.
39
46
 
40
 
                Asymmetric distribution realized via two normal distributions with
41
 
                different variances combined at the mean.
 
47
        Asymmetric distribution realized via two normal distributions with
 
48
        different variances combined at the mean.
42
49
 
43
50
    @htmlinclude OpenMS_BiGaussModel.parameters
44
 
        */
45
 
        class OPENMS_DLLAPI BiGaussModel
46
 
  : public InterpolationModel
 
51
    */
 
52
  class OPENMS_DLLAPI BiGaussModel :
 
53
    public InterpolationModel
47
54
  {
48
 
                public:
49
 
                typedef InterpolationModel::CoordinateType CoordinateType;
 
55
public:
 
56
    typedef InterpolationModel::CoordinateType CoordinateType;
50
57
 
51
58
    /// Default constructor
52
59
    BiGaussModel();
53
60
 
54
61
    /// copy constructor
55
 
        BiGaussModel(const BiGaussModel& source);
 
62
    BiGaussModel(const BiGaussModel & source);
56
63
 
57
64
    /// destructor
58
65
    virtual ~BiGaussModel();
59
66
 
60
67
    /// assignment operator
61
 
    virtual BiGaussModel& operator = (const BiGaussModel& source);
 
68
    virtual BiGaussModel & operator=(const BiGaussModel & source);
62
69
 
63
 
                /// create new BiGaussModel object (function needed by Factory)
64
 
                static BaseModel<1>* create()
 
70
    /// create new BiGaussModel object (function needed by Factory)
 
71
    static BaseModel<1> * create()
65
72
    {
66
 
             return new BiGaussModel();
67
 
        }
 
73
      return new BiGaussModel();
 
74
    }
68
75
 
69
 
                /// name of the model (needed by Factory)
 
76
    /// name of the model (needed by Factory)
70
77
    static const String getProductName()
71
78
    {
72
 
             return "BiGaussModel";
73
 
        }
74
 
 
75
 
                /** @brief set the offset of the model
76
 
 
77
 
                        The whole model will be shifted to the new offset without being computing all over.
78
 
                        and without any discrepancy.
79
 
                */
 
79
      return "BiGaussModel";
 
80
    }
 
81
 
 
82
    /** @brief set the offset of the model
 
83
 
 
84
        The whole model will be shifted to the new offset without being computing all over
 
85
        and without any discrepancy.
 
86
    */
80
87
    void setOffset(CoordinateType offset);
81
88
 
82
 
                /// set sample/supporting points of interpolation
83
 
                void setSamples();
84
 
 
85
 
                /// get the center of the BiGaussian model i.e. the position of the maximum
86
 
                CoordinateType getCenter() const;
87
 
 
88
 
                protected:
89
 
                        CoordinateType min_;
90
 
                        CoordinateType max_;
91
 
                        Math::BasicStatistics<> statistics1_;
92
 
                        Math::BasicStatistics<> statistics2_;
93
 
 
94
 
                        void updateMembers_();
 
89
    /// set sample/supporting points of interpolation
 
90
    void setSamples();
 
91
 
 
92
    /// get the center of the BiGaussian model i.e. the position of the maximum
 
93
    CoordinateType getCenter() const;
 
94
 
 
95
protected:
 
96
    CoordinateType min_;
 
97
    CoordinateType max_;
 
98
    Math::BasicStatistics<> statistics1_;
 
99
    Math::BasicStatistics<> statistics2_;
 
100
 
 
101
    void updateMembers_();
95
102
  };
96
103
}
97
104