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
|
/*
//
// Copyright 1997-2009 Torsten Rohlfing
//
// Copyright 2004-2012 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 __cmtkHistogramBase_h_included_
#define __cmtkHistogramBase_h_included_
#include <cmtkconfig.h>
#include <Base/cmtkTypes.h>
#include <Base/cmtkMathUtil.h>
#include <System/cmtkSmartPtr.h>
#include <algorithm>
#ifndef CMTK_HISTOGRAM_AUTOBINS
/// Constant for number of bins to be determined automatically.
#define CMTK_HISTOGRAM_AUTOBINS 0
#endif
/// Constant for affirmative fractional bin flag.
#define CMTK_HISTOGRAM_FRACTIONAL true
/// Constant for affirmative fractional bin flag.
#define CMTK_HISTOGRAM_DISCRETE false
/// Constant for resetting histogram bins on instantiation.
#define CMTK_HISTOGRAM_RESET true
/// Constant for not resetting histogram bins on instantiation.
#define CMTK_HISTOGRAM_NORESET false
/// Constant for copying histogram bin values on object duplication.
#define CMTK_HISTOGRAM_COPY true
/// Constant for not copying histogram bin values on object duplication.
#define CMTK_HISTOGRAM_NOCOPY false
namespace
cmtk
{
/** \addtogroup Base */
//@{
/** Common (non-template) base class for all 1-D histograms.
*/
class HistogramBase
{
protected:
/// Width of data bins.
Types::DataItem m_BinWidth;
/// Lower value bound of data bins.
Types::DataItem m_BinsLowerBound;
/// Upper value bound of data bins.
Types::DataItem m_BinsUpperBound;
public:
/// This class.
typedef HistogramBase Self;
/// Default constructor.
HistogramBase()
{
this->m_BinWidth = 1.0;
this->m_BinsLowerBound = this->m_BinsUpperBound = 0.0;
}
/// Virtual destructor.
virtual ~HistogramBase() {}
/// Return number of histogram bins.
virtual size_t GetNumberOfBins() const = 0;
/** Set data range corresponding to this histogram.
*/
void SetRange ( const Types::DataItemRange& range )
{
this->m_BinsLowerBound = range.m_LowerBound;
this->m_BinsUpperBound = range.m_UpperBound;
this->m_BinWidth = range.Width() / (this->GetNumberOfBins() - 1);
}
/** Set data range corresponding to this histogram with upper and lower bound centered in first and last bin.
*/
void SetRangeCentered( const Types::DataItemRange& range )
{
this->m_BinWidth = range.Width() / (this->GetNumberOfBins() - 1);
this->m_BinsLowerBound = static_cast<Types::DataItem>( range.m_LowerBound - 0.5 * this->m_BinWidth );
this->m_BinsUpperBound = static_cast<Types::DataItem>( range.m_UpperBound + 0.5 * this->m_BinWidth );
}
/** Get value range of the distribution.
*/
const Types::DataItemRange GetRange() const
{
return Types::DataItemRange( this->m_BinsLowerBound, this->m_BinsUpperBound );
}
/** Get value range of a given bin.
*/
virtual const Types::DataItemRange GetRangeBin( const size_t bin ) const
{
const Types::DataItem from = this->m_BinsLowerBound + this->m_BinWidth * bin;
return Types::DataItemRange( from, from + this->m_BinWidth );
}
/// Get bin width.
Types::DataItem GetBinWidth() const
{
return this->m_BinWidth;
}
/** Return bin corresponding to a certain value of the distribution.
*\param value A value from the distribution.
*\return The index of the bin corresponding to the given value.
*/
virtual size_t ValueToBin ( const Types::DataItem value ) const
{
const size_t binIndex = static_cast<size_t>( (value - this->m_BinsLowerBound) / this->m_BinWidth );
return std::max<size_t>( 0, std::min( this->GetNumberOfBins()-1, binIndex ) );
}
/** Return fractional bin corresponding to a value of the distribution.
*\param value A value from the distribution.
*\return The index of the fractional bin index corresponding to the given
* value. This value is an integer if and only if the given value is
* identical to the lower bound of a bin.
*/
virtual Types::DataItem ValueToBinFractional ( const Types::DataItem value ) const
{
const Types::DataItem binIndex = (value - this->m_BinsLowerBound) / this->m_BinWidth;
return std::max<Types::DataItem>( 0, std::min<Types::DataItem>( static_cast<Types::DataItem>( this->GetNumberOfBins()-1 ), binIndex));
}
/** Return center of values represented by a certain bin.
*\param bin Index of a bin from the distribution.
*\return Average of upper and lower margin values of the given bin.
*/
virtual Types::DataItem BinToValue ( const size_t bin ) const
{
return static_cast<Types::DataItem>( this->m_BinsLowerBound + (bin+0.5) * this->m_BinWidth );
}
};
//@}
} // namespace cmtk
#endif // #ifndef __cmtkHistogramBase_h_included_
|
