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
|
/*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkSampleToHistogramFilter_h
#define itkSampleToHistogramFilter_h
#include "itkMacro.h"
#include "itkProcessObject.h"
#include "itkMeasurementVectorTraits.h"
#include "itkSimpleDataObjectDecorator.h"
itkDeclareExceptionMacro( SampleToHistogramFilterException, ExceptionObject, "Histogram-related Exception");
itkDeclareExceptionMacro( MissingHistogramSizeInput, SampleToHistogramFilterException, "Histogram Size input is missing");
itkDeclareExceptionMacro( MissingHistogramMarginalScaleInput, SampleToHistogramFilterException, "Histogram marginal scale input is missing");
itkDeclareExceptionMacro( NullSizeHistogramInputMeasurementVectorSize, SampleToHistogramFilterException, "Input sample MeasurementVectorSize is zero");
itkDeclareExceptionMacro( MissingHistogramBinMaximumInput, SampleToHistogramFilterException, "Histogram Bin Maximum input is missing");
itkDeclareExceptionMacro( MissingHistogramBinMinimumInput, SampleToHistogramFilterException, "Histogram Bin Minimum input is missing");
itkDeclareExceptionMacro( HistogramWrongNumberOfComponents, SampleToHistogramFilterException, "Histogram has wrong number of components");
namespace itk
{
namespace Statistics
{
/** \class SampleToHistogramFilter
* \brief Computes the Histogram corresponding to a Sample.
*
* This filter produces as output the histogram corresponding to
* the values of a Sample.
*
* \sa Sample, Histogram
*
* \ingroup ITKStatistics
*
* \wiki
* \wikiexample{Statistics/SampleToHistogramFilter,Create a histogram from a list of sample measurements}
* \endwiki
*/
template< typename TSample, typename THistogram >
class ITK_TEMPLATE_EXPORT SampleToHistogramFilter:public ProcessObject
{
public:
/** Standard class typedefs */
typedef SampleToHistogramFilter Self;
typedef ProcessObject Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Run-time type information (and related methods) */
itkTypeMacro(SampleToHistogramFilter, ProcessObject);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** MeasurementVector typedef support */
typedef TSample SampleType;
typedef THistogram HistogramType;
typedef typename SampleType::MeasurementVectorType MeasurementVectorType;
typedef typename MeasurementVectorType::ValueType MeasurementType;
typedef typename HistogramType::SizeType HistogramSizeType;
typedef typename HistogramType::MeasurementType HistogramMeasurementType;
typedef typename HistogramType::MeasurementVectorType HistogramMeasurementVectorType;
/** Type for the data object output */
typedef typename Superclass::DataObjectPointer DataObjectPointer;
using Superclass::SetInput;
/** Set/Get the input sample */
virtual void SetInput(const SampleType *sample);
virtual const SampleType * GetInput() const;
/** Get the output Histogram */
const HistogramType * GetOutput() const;
/** Type of DataObjects to use for Size inputs */
typedef SimpleDataObjectDecorator<
HistogramSizeType > InputHistogramSizeObjectType;
/** Type of DataObjects to use for Marginal Scale inputs */
typedef SimpleDataObjectDecorator<
HistogramMeasurementType > InputHistogramMeasurementObjectType;
/** Type of DataObjects to use for Minimum and Maximums values of the
* histogram bins. */
typedef SimpleDataObjectDecorator<
HistogramMeasurementVectorType > InputHistogramMeasurementVectorObjectType;
/** Type of DataObjects to use for AutoMinimumMaximum input */
typedef SimpleDataObjectDecorator< bool > InputBooleanObjectType;
/** Methods for setting and getting the histogram size. The histogram size
* is encapsulated inside a decorator class. For this reason, it is possible
* to set and get the decorator class, but it is only possible to set the
* histogram size by value. This macro declares the methods
* SetHistogramSize(), SetHistogramSizeInput(), GetHistogramSizeInput().
*/
itkSetGetDecoratedInputMacro(HistogramSize, HistogramSizeType);
/** Methods for setting and getting the Marginal scale value. The marginal
* scale is used when the type of the measurement vector componets are of
* integer type. */
itkSetGetDecoratedInputMacro(MarginalScale, HistogramMeasurementType);
/** Methods for setting and getting the Minimum and Maximum values of the
* histogram bins.
\warning To use those values you need to set the AutoMinimumMaximum flag to false.*/
itkSetGetDecoratedInputMacro(HistogramBinMinimum, HistogramMeasurementVectorType);
itkSetGetDecoratedInputMacro(HistogramBinMaximum, HistogramMeasurementVectorType);
/** Methods for setting and getting the boolean flag that defines whether the
* minimum and maximum of the histogram are going to be computed
* automatically from the values of the sample.
\warning If the flag is set to false, it is required to set HistogramBinMinimum and HistogramBinMaximum. */
itkSetGetDecoratedInputMacro(AutoMinimumMaximum, bool);
/** Method that facilitates the use of this filter in the internal
* pipeline of another filter. */
virtual void GraftOutput(DataObject *output);
protected:
SampleToHistogramFilter();
virtual ~SampleToHistogramFilter() ITK_OVERRIDE;
virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** Make a DataObject of the correct type to used as the specified
* output. This method
* is automatically called when DataObject::DisconnectPipeline() is
* called.
* \sa ProcessObject
*/
typedef ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
using Superclass::MakeOutput;
virtual DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) ITK_OVERRIDE;
// Where the histogram is actually computed
virtual void GenerateData() ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(SampleToHistogramFilter);
/** SafeAssign -- avoid numeric overflow/underflow */
HistogramMeasurementType SafeAssign(MeasurementType from) const
{
if(NumericTraits<HistogramMeasurementType>::is_integer)
{
MeasurementType fromMax = static_cast<MeasurementType>
(NumericTraits<HistogramMeasurementType>::max());
MeasurementType fromMin = static_cast<MeasurementType>
(NumericTraits<HistogramMeasurementType>::min());
if (from >= fromMax)
{
return NumericTraits<HistogramMeasurementType>::max();
}
else if (from <= fromMin)
{
return NumericTraits<HistogramMeasurementType>::min();
}
}
return static_cast<HistogramMeasurementType>(from);
}
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSampleToHistogramFilter.hxx"
#endif
#endif
|
