ProteoWizard
FrequencyEstimatorSimple.hpp
Go to the documentation of this file.
1//
2// $Id$
3//
4//
5// Original author: Darren Kessner <darren@proteowizard.org>
6//
7// Copyright 2007 Louis Warschaw Prostate Cancer Center
8// Cedars Sinai Medical Center, Los Angeles, California 90048
9//
10// Licensed under the Apache License, Version 2.0 (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14// http://www.apache.org/licenses/LICENSE-2.0
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21//
22
23
24#ifndef _FREQUENCYESTIMATORSIMPLE_HPP_
25#define _FREQUENCYESTIMATORSIMPLE_HPP_
26
27
29#include "FrequencyEstimator.hpp"
30#include <memory>
31
32
33namespace pwiz {
34namespace frequency {
35
36
37/// Simple implementation of the FrequencyEstimator interface.
39{
40 public:
41
42 enum PWIZ_API_DECL Type {LocalMax, Parabola, Lorentzian};
43
44 /// create an instance
45 static std::auto_ptr<FrequencyEstimatorSimple> create(Type type = Parabola,
46 unsigned int windowRadius = 1);
47
48 /// \name FrequencyEstimator interface
49 //@{
50 virtual Peak estimate(const FrequencyData& fd,
51 const Peak& initialEstimate) const = 0;
53 //@}
54};
55
56
57} // namespace frequency
58} // namespace pwiz
59
60
61#endif // _FREQUENCYESTIMATORSIMPLE_HPP_
62
63
#define PWIZ_API_DECL
Definition Export.hpp:32
Class for binary storage of complex frequency data.
Interface for frequency estimator modules.
Simple implementation of the FrequencyEstimator interface.
static std::auto_ptr< FrequencyEstimatorSimple > create(Type type=Parabola, unsigned int windowRadius=1)
create an instance
virtual Peak estimate(const FrequencyData &fd, const Peak &initialEstimate) const =0