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
|
/*=========================================================================
*
* 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 itkBinShrinkImageFilter_h
#define itkBinShrinkImageFilter_h
#include "itkShrinkImageFilter.h"
#include "itkEnableIf.h"
namespace itk
{
/** \class BinShrinkImageFilter
* \brief Reduce the size of an image by an integer factor in each
* dimension while performing averaging of an input neighborhood.
*
*
* The output image size in each dimension is given by:
*
* outputSize[j] = max( std::floor(inputSize[j]/shrinkFactor[j]), 1 );
*
* The algorithm implemented can be describe with the following
* equation for 2D:
* \f[
* \mathsf{I}_{out}(x_o,x_1) =
* \frac{\sum_{i=0}^{f_0}\sum_{j=0}^{f_1}\mathsf{I}_{in}(f_0 x_o+i,f_1 x_1+j)}{f_0 f_1}
* \f]
*
* This filter is implemented so that the starting extent of the first
* pixel of the output matches that of the input.
*
* \image html BinShrinkGrid.png "The change in image geometry from a 5x5 image binned by a factor of 2x2."
*
* This code was contributed in the Insight Journal paper:
* "BinShrink: A multi-resolution filter with cache efficient averaging"
* by Lowekamp B., Chen D.
* https://hdl.handle.net/10380/3450
*
* \ingroup ITKImageGrid
* \ingroup Streamed
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BinShrinkImageFilter :
public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
/** Standard class typedefs. */
typedef BinShrinkImageFilter Self;
typedef ImageToImageFilter<TInputImage,TOutputImage> Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(BinShrinkImageFilter, ImageToImageFilter);
/** Typedef to images */
typedef TOutputImage OutputImageType;
typedef TInputImage InputImageType;
typedef typename OutputImageType::Pointer OutputImagePointer;
typedef typename InputImageType::Pointer InputImagePointer;
typedef typename InputImageType::ConstPointer InputImageConstPointer;
typedef typename TOutputImage::OffsetType OutputOffsetType;
typedef typename TOutputImage::IndexType OutputIndexType;
typedef typename TInputImage::IndexType InputIndexType;
/** Typedef to describe the output image region type. */
typedef typename TOutputImage::RegionType OutputImageRegionType;
/** ImageDimension enumeration. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension );
itkStaticConstMacro(OutputImageDimension, unsigned int,
TOutputImage::ImageDimension );
typedef FixedArray< unsigned int, ImageDimension > ShrinkFactorsType;
/** Set the shrink factors. Values are clamped to
* a minimum value of 1. Default is 1 for all dimensions. */
itkSetMacro(ShrinkFactors, ShrinkFactorsType);
void SetShrinkFactors(unsigned int factor);
void SetShrinkFactor(unsigned int i, unsigned int factor);
/** Get the shrink factors. */
itkGetConstReferenceMacro(ShrinkFactors, ShrinkFactorsType);
virtual void GenerateOutputInformation() ITK_OVERRIDE;
/** BinShrinkImageFilter needs a larger input requested region than the output
* requested region. As such, BinShrinkImageFilter needs to provide an
* implementation for GenerateInputRequestedRegion() in order to inform the
* pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
#ifdef ITK_USE_CONCEPT_CHECKING
/** Begin concept checking */
itkConceptMacro(InputConvertibleToOutputCheck,
(Concept::Convertible<typename TInputImage::PixelType, typename TOutputImage::PixelType>));
itkConceptMacro(SameDimensionCheck,
(Concept::SameDimension<ImageDimension, OutputImageDimension>));
/** End concept checking */
#endif
protected:
BinShrinkImageFilter();
void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
ThreadIdType threadId ) ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(BinShrinkImageFilter);
ShrinkFactorsType m_ShrinkFactors;
/** Round different pixel types. */
template< class TOutputType, class TInputType >
typename EnableIfC<std::numeric_limits<TOutputType>::is_integer, TOutputType>::Type
RoundIfInteger( TInputType input )
{
return Math::Round< TOutputType >( input );
}
// For Non-fundamental types numeric_limits is not specialized, and
// is_integer defaults to false.
template< class TOutputType, class TInputType >
typename DisableIfC<std::numeric_limits<TOutputType>::is_integer, TOutputType>::Type
RoundIfInteger( const TInputType & input, ...)
{
return static_cast<TOutputType>(input);
}
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkBinShrinkImageFilter.hxx"
#endif
#endif
|
