ProteoWizard
pwiz
analysis
frequency
FrequencyEstimatorPhysicalModel.hpp
Go to the documentation of this file.
1
//
2
// $Id$
3
//
4
//
5
// Original author: Darren Kessner <darren@proteowizard.org>
6
//
7
// Copyright 2006 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 _FREQUENCYESTIMATORPHYSICALMODEL_HPP_
25
#define _FREQUENCYESTIMATORPHYSICALMODEL_HPP_
26
27
28
#include "
pwiz/utility/misc/Export.hpp
"
29
#include "
FrequencyEstimator.hpp
"
30
#include <string>
31
#include <memory>
32
33
34
namespace
pwiz
{
35
namespace
frequency {
36
37
38
/// Physical model implementation of the FrequencyEstimator interface.
39
class
PWIZ_API_DECL
FrequencyEstimatorPhysicalModel
:
public
FrequencyEstimator
40
{
41
public
:
42
43
struct
PWIZ_API_DECL
Config
44
{
45
unsigned
int
windowRadius
;
46
unsigned
int
iterationCount
;
47
std::string
outputDirectory
;
// ("" == no logging output)
48
49
Config
() : windowRadius(10), iterationCount(20) {}
50
};
51
52
/// create an instance
53
static
std::auto_ptr<FrequencyEstimatorPhysicalModel>
create
(
const
Config
& config);
54
55
/// \name FrequencyEstimator interface
56
//@{
57
virtual
Peak
estimate
(
const
FrequencyData
& fd,
58
const
Peak
& initialEstimate)
const
= 0;
59
60
virtual
~FrequencyEstimatorPhysicalModel
(){}
61
//@}
62
};
63
64
65
}
// namespace frequency
66
}
// namespace pwiz
67
68
69
#endif // _FREQUENCYESTIMATORPHYSICALMODEL_HPP_
70
71
pwiz::data::peakdata::Peak
Definition:
PeakData.hpp:53
pwiz
Definition:
ChromatogramList_Filter.hpp:36
pwiz::data::FrequencyData
Class for binary storage of complex frequency data.
Definition:
FrequencyData.hpp:49
pwiz::frequency::FrequencyEstimatorPhysicalModel
Physical model implementation of the FrequencyEstimator interface.
Definition:
FrequencyEstimatorPhysicalModel.hpp:40
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition:
Export.hpp:32
Export.hpp
pwiz::frequency::FrequencyEstimatorPhysicalModel::Config
Definition:
FrequencyEstimatorPhysicalModel.hpp:44
FrequencyEstimator.hpp
pwiz::frequency::FrequencyEstimatorPhysicalModel::Config::Config
Config()
Definition:
FrequencyEstimatorPhysicalModel.hpp:49
pwiz::frequency::FrequencyEstimatorPhysicalModel::Config::windowRadius
unsigned int windowRadius
Definition:
FrequencyEstimatorPhysicalModel.hpp:45
pwiz::frequency::FrequencyEstimatorPhysicalModel::Config::outputDirectory
std::string outputDirectory
Definition:
FrequencyEstimatorPhysicalModel.hpp:47
pwiz::frequency::FrequencyEstimatorPhysicalModel::~FrequencyEstimatorPhysicalModel
virtual ~FrequencyEstimatorPhysicalModel()
Definition:
FrequencyEstimatorPhysicalModel.hpp:60
pwiz::frequency::FrequencyEstimator
Interface for frequency estimator modules.
Definition:
FrequencyEstimator.hpp:39
pwiz::frequency::FrequencyEstimatorPhysicalModel::Config::iterationCount
unsigned int iterationCount
Definition:
FrequencyEstimatorPhysicalModel.hpp:46
pwiz::frequency::FrequencyEstimatorPhysicalModel::create
static std::auto_ptr< FrequencyEstimatorPhysicalModel > create(const Config &config)
create an instance
pwiz::frequency::FrequencyEstimatorPhysicalModel::estimate
virtual Peak estimate(const FrequencyData &fd, const Peak &initialEstimate) const =0
Generated by
1.8.18