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
|
/*
//
// Copyright 1997-2009 Torsten Rohlfing
//
// Copyright 2004-2010 SRI International
//
// This file is part of the Computational Morphometry Toolkit.
//
// http://www.nitrc.org/projects/cmtk/
//
// The Computational Morphometry Toolkit is free software: you can
// redistribute it and/or modify it under the terms of the GNU General Public
// License as published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
//
// The Computational Morphometry Toolkit 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with the Computational Morphometry Toolkit. If not, see
// <http://www.gnu.org/licenses/>.
//
// $Revision: 5436 $
//
// $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
// $LastChangedBy: torstenrohlfing $
//
*/
#ifndef __cmtkValueSequence_h_included_
#define __cmtkValueSequence_h_included_
#include <cmtkconfig.h>
#include <math.h>
namespace
cmtk
{
/** \addtogroup Base */
//@{
/** Class for computing characteristic values of number sequences.
* Instances of this class take a sequence of (real) numbers via calls to the
* Proceed() member function. After last last number in the sequence, the
* object can be queried for minimum and maximum values (both absolute and
* standard), variance, and average value. Further calls to Proceed() are
* allowed, thus enabling incremental computations.
*\note This class performs a lot of potentially unnecessary computations if,
* for example, only the sum of values is to be computed. If you need efficient
* evaluation of more elementary expressions, you are encouraged to implement
* these directly; this present class is merely a convenience tool.
*/
template<class T=float>
class ValueSequence
{
public:
/// This class.
typedef ValueSequence<T> Self;
/// Default constructor.
ValueSequence()
{
this->Reset();
}
/// Reset all computations.
void Reset()
{
NValues = 0; Sum = 0; SumAbs = 0; SumOfSquares = 0;
Minimum = Maximum = MinimumAbs = MaximumAbs = 0;
}
/// Proceed with the next number in the sequence.
void Proceed( const T v )
{
if ( ! NValues )
{
Minimum = Maximum = v;
MinimumAbs = MaximumAbs = fabs( v );
}
else
{
if ( v < Minimum ) Minimum = v;
if ( v > Maximum ) Maximum = v;
if ( fabs( v ) < MinimumAbs ) MinimumAbs = fabs( v );
if ( fabs( v ) > MaximumAbs ) MaximumAbs = fabs( v );
}
++NValues; Sum += v; SumAbs += fabs( v ); SumOfSquares += v*v;
}
/// Return minimum of all values.
double GetMinimum() const { return Minimum; }
/// Return maximum of all values.
double GetMaximum() const { return Maximum; }
/// Return minimum of all absolute values.
double GetMinimumAbs() const { return MinimumAbs; }
/// Return maximum of all absolute values.
double GetMaximumAbs() const { return MaximumAbs; }
/// Return total number of values.
int GetNValues() const { return NValues; }
/// Return variance of all values.
double GetVariance( const bool unbiased = true ) const
{
const double mu = this->GetAverage();
return ( NValues * mu * mu - 2 * mu * Sum + SumOfSquares ) / ( unbiased ? (NValues-1) : NValues );
}
/// Return sum of all values.
double GetSum() const { return static_cast<double>( Sum ); }
/// Return sum of squres of all values.
double GetSumOfSquares() const { return static_cast<double>( SumOfSquares ); }
/// Return average value.
double GetAverage() const { return static_cast<double>( Sum / NValues ); }
/// Return average value.
double GetAverageAbs() const { return static_cast<double>( SumAbs / NValues ); }
/// Assignment operator.
ValueSequence<T>& operator=( const ValueSequence<T>& other );
private:
/// Sum of all values.
T Sum;
/// Sum of all absolute values.
T SumAbs;
/// Sum of the squares of all values.
T SumOfSquares;
/// Number of values.
int NValues;
/// Minimum value so far.
T Minimum;
/// Maximum value so far.
T Maximum;
/// Minimum absolute value so far.
T MinimumAbs;
/// Maximum absolute value so far.
T MaximumAbs;
/// Allow addition operator direct access.
template<class TT>
friend ValueSequence<TT> operator+( const ValueSequence<TT>& a, const ValueSequence<TT>& b );
};
//@}
} // namespace cmtk
#include "cmtkValueSequence.txx"
#endif // #ifndef __cmtkValueSequence_h_included_
|
