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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
//# 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_CONSTRAINEDRANGEQUANTILECOMPUTER_H
#define SCIMATH_CONSTRAINEDRANGEQUANTILECOMPUTER_H
#include <casacore/scimath/StatsFramework/ClassicalQuantileComputer.h>
#include <casacore/casa/aips.h>
namespace casacore {
// Basic concrete QuantileComputer class for data constrained to be
// in a specified range. Some derived classes of ConstrainedRangeStatistics
// use it. It should never be explicitly instantiated by an API developer.
// See the class documentation of StatisticsAlgorithm for details on
// QuantileComputer classes.
template <
class AccumType, class DataIterator, class MaskIterator=const Bool*,
class WeightsIterator=DataIterator
>
class ConstrainedRangeQuantileComputer
: public ClassicalQuantileComputer<CASA_STATP> {
public:
ConstrainedRangeQuantileComputer() = delete;
ConstrainedRangeQuantileComputer(StatisticsDataset<CASA_STATP>* dataset);
// copy semantics
ConstrainedRangeQuantileComputer(
const ConstrainedRangeQuantileComputer& csq
);
virtual ~ConstrainedRangeQuantileComputer();
// copy semantics
ConstrainedRangeQuantileComputer& operator=(
const ConstrainedRangeQuantileComputer& other
);
// clone this object by returning a pointer to a copy
virtual StatisticsAlgorithmQuantileComputer<CASA_STATP>* clone() const;
// Caller is responsible for passing correct values of mynpts, mymin, and
// mymax; no checking is done for correctness in this method.
virtual AccumType getMedian(
uInt64 mynpts, AccumType mymin, AccumType mymax,
uInt binningThreshholdSizeBytes, Bool persistSortedArray, uInt nBins
);
// get the median of the absolute deviation about the median of the data.
virtual AccumType getMedianAbsDevMed(
uInt64 mynpts, AccumType mymin, AccumType mymax,
uInt binningThreshholdSizeBytes, Bool persistSortedArray, uInt nBins
);
void setRange(const std::pair<AccumType, AccumType>& r) {
_range = r;
}
protected:
// <group>
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const DataRanges& ranges, Bool isInclude,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, const WeightsIterator& weightsBegin,
uInt64 nr, uInt dataStride,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const ;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin,
const WeightsIterator& weightsBegin, uInt64 nr, uInt dataStride,
const DataRanges& ranges, Bool isInclude,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, const WeightsIterator& weightsBegin,
uInt64 nr, uInt dataStride, const MaskIterator& maskBegin,
uInt maskStride, const DataRanges& ranges, Bool isInclude,
const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
virtual void _findBins(
std::vector<BinCountArray>& binCounts,
std::vector<std::shared_ptr<AccumType>>& sameVal, std::vector<Bool>& allSame,
const DataIterator& dataBegin, const WeightsIterator& weightBegin,
uInt64 nr, uInt dataStride, const MaskIterator& maskBegin,
uInt maskStride, const std::vector<StatsHistogram<AccumType>>& binDesc,
const std::vector<AccumType>& maxLimit
) const;
// </group>
//<group>
// populate an unsorted array with valid data. If <src>includeLimits</src>
// is defined, then restrict values that are entered in the array to those
// limits (inclusive of the minimum, exclusive of the maximum).
// <src>maxCount</src> and <src>currentCount</src> are used only if
// <src>includeLimits</src> is defined. In this case, the method will return
// when currentCount == maxCount, thus avoiding scanning remaining data
// unnecessarily.
// no weights, no mask, no ranges
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride
) const;
// ranges
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const DataRanges& ranges, Bool isInclude
) const;
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const MaskIterator& maskBegin, uInt maskStride
) const;
// mask and ranges
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude
) const;
// weights
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightsBegin, uInt64 nr, uInt dataStride
) const;
// weights and ranges
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightsBegin, uInt64 nr, uInt dataStride,
const DataRanges& ranges, Bool isInclude
) const;
// weights and mask
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride
) const;
// weights, mask, ranges
virtual void _populateArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude
) const;
// no weights, no mask, no ranges
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// ranges
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const DataRanges& ranges, Bool isInclude,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// mask and ranges
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// weights
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, const WeightsIterator& weightsBegin,
uInt64 nr, uInt dataStride, const IncludeLimits& includeLimits,
uInt64 maxCount
) const;
// weights and ranges
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, const WeightsIterator& weightsBegin,
uInt64 nr, uInt dataStride, const DataRanges& ranges, Bool isInclude,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// weights and mask
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, const WeightsIterator& weightBegin,
uInt64 nr, uInt dataStride, const MaskIterator& maskBegin,
uInt maskStride, const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// weights, mask, ranges
virtual void _populateArrays(
std::vector<DataArray>& arys, uInt64& currentCount,
const DataIterator& dataBegin, const WeightsIterator& weightBegin,
uInt64 nr, uInt dataStride, const MaskIterator& maskBegin,
uInt maskStride, const DataRanges& ranges, Bool isInclude,
const IncludeLimits& includeLimits, uInt64 maxCount
) const;
// </group>
// <group>
// no weights, no mask, no ranges
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, uInt maxElements
) const;
// ranges
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const DataRanges& ranges, Bool isInclude,
uInt maxElements
) const;
// mask
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const MaskIterator& maskBegin, uInt maskStride,
uInt maxElements
) const;
// mask and ranges
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin, uInt64 nr,
uInt dataStride, const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude, uInt maxElements
) const;
// weights
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightBegin, uInt64 nr, uInt dataStride,
uInt maxElements
) const;
// weights and ranges
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightsBegin, uInt64 nr, uInt dataStride,
const DataRanges& ranges, Bool isInclude, uInt maxElements
) const;
// weights and mask
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride, uInt maxElements
) const;
// weights, mask, ranges
virtual Bool _populateTestArray(
DataArray& ary, const DataIterator& dataBegin,
const WeightsIterator& weightBegin, uInt64 nr, uInt dataStride,
const MaskIterator& maskBegin, uInt maskStride,
const DataRanges& ranges, Bool isInclude, uInt maxElements
) const;
// </group>
private:
Bool _doMedAbsDevMed{False};
// for use in macros of often repeatedly run methods
AccumType _myMedian{0};
std::pair<AccumType, AccumType> _range{};
};
}
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/StatsFramework/ConstrainedRangeQuantileComputer.tcc>
#endif
#endif
|
