1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
//# Copyright (C) 2000,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
#ifndef SCIMATH_STATSALGORITHMFACTORY_H
#define SCIMATH_STATSALGORITHMFACTORY_H
#include <casacore/scimath/Mathematics/NumericTraits.h>
#include <casacore/scimath/StatsFramework/StatisticsAlgorithm.h>
#include <casacore/scimath/StatsFramework/StatisticsAlgorithmFactoryData.h>
#include <casacore/scimath/StatsFramework/StatisticsData.h>
namespace casacore {
// Provides a single interface for creation of stats algorithm objects
template <
class AccumType, class DataIterator, class MaskIterator=const Bool *,
class WeightsIterator=DataIterator
>
class StatisticsAlgorithmFactory {
public:
// to make copy() more straight forward to implement
template <
class AccumType2, class DataIterator2, class MaskIterator2,
class WeightsIterator2
>
friend class StatisticsAlgorithmFactory;
// upon construction, the object is configured to use the classical stats
// algorithm
StatisticsAlgorithmFactory();
~StatisticsAlgorithmFactory();
void configureBiweight(Int maxIter=3, Double c=6.0);
void configureClassical();
// configure to use fit to half algorithm.
void configureFitToHalf(
FitToHalfStatisticsData::CENTER centerType
=FitToHalfStatisticsData::CMEAN,
FitToHalfStatisticsData::USE_DATA useData
=FitToHalfStatisticsData::LE_CENTER, AccumType centerValue=0
);
// configure to use hinges-fences algorithm
void configureHingesFences(Double f);
// configure to use Chauvenet's criterion
void configureChauvenet(Double zscore=-1, Int maxIterations=-1);
// copy the data from this object to an object with different template
// types. Note that the AccumType of <src>other</src> must be the same as
// the AccumType of this object.
template <class DataIterator2, class MaskIterator2, class WeightsIterator2>
void copy(
StatisticsAlgorithmFactory<
AccumType, DataIterator2, MaskIterator2, WeightsIterator2
>& other
) const;
// Create a pointer to an object of a class derived from StatisticsAlgorithm
// that reflects the current configuration
std::shared_ptr<StatisticsAlgorithm<CASA_STATP>> createStatsAlgorithm() const;
StatisticsData::ALGORITHM algorithm() const { return _algorithm; }
// Throws an exception if the current configuration is not relevant
// to the Biweight algorithm
StatisticsAlgorithmFactoryData::BiweightData biweightData() const;
// Throws an exception if the current configuration is not relevant
// to the Chauvenet/zscore algorithm
StatisticsAlgorithmFactoryData::ChauvenetData chauvenetData() const;
// Throws an exception if the current configuration is not relevant
// to the hinges-fences algorithm
Double hingesFencesFactor() const;
// Throws an exception if the current configuration is not relevant
// to the fit-to-half algorithm
StatisticsAlgorithmFactoryData::FitToHalfData<AccumType>
fitToHalfData() const;
// create a record from the current configuration that can be used
// to create another object using the fromRecord() method.
Record toRecord() const;
// create an object from a record
static StatisticsAlgorithmFactory<CASA_STATP> fromRecord(const Record& r);
private:
StatisticsData::ALGORITHM _algorithm;
// hinges-fences f factor
Double _hf;
StatisticsAlgorithmFactoryData::BiweightData _biweightData;
StatisticsAlgorithmFactoryData::FitToHalfData<AccumType> _fitToHalfData;
StatisticsAlgorithmFactoryData::ChauvenetData _chauvData;
};
}
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/StatsFramework/StatisticsAlgorithmFactory.tcc>
#endif
#endif
|
