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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkSliceBySliceImageFilter_h
#define itkSliceBySliceImageFilter_h
#include "itkImageToImageFilter.h"
namespace itk
{
/**
* \class SliceBySliceImageFilter
* \brief Apply a filter or a pipeline slice by slice on an image
*
* SliceBySliceImageFilter let the user apply a filter or a pipeline
* of filters on the slices of an image. The filters must work on images
* smaller of one dimension than the input and output images of the
* SliceBySliceImageFilter - if the SliceBySliceImageFilter work on 3D
* images, the filters used internally must work on 2D images.
*
* The dimension along which the slices are extracted can be selected with SetDimension()
* and defaults to the last one.
*
* SliceBySliceImageFilter takes the input and the output filters of a pipeline
* as parameter. They can be set with SetInputFilter() and SetOutputFilter().
* The pipeline will be run once per slice.
*
* If there is only one filter to apply to the slices of the input image,
* the SetFilter() method can be used to set the filter passed as parameter
* both as the input and as the output filter.
*
* SliceBySliceImageFilter can take several images as input. In that case, the same
* number of slices will be passed to the input filter. If the output filter
* produce several output slices, SliceBySliceImageFilter produce the same number
* of output images. The input images are passed with the same input number
* to the input filter - if SetInput( 3, img ) is used on the SliceBySliceImageFilter
* the corresponding slice will be passed to the input filter with SetInput( 3, img ).
* See https://www.itk.org/pipermail/insight-users/2008-May/026112.html for an
* example of usage of that feature with MaskImageFilter.
*
* The input requested region is enlarged to cover whole slices,
* but not in the slice direction - however, the internal pipeline
* only requests the output requested region for that slice (the
* requested region per slice is not enlarged to the whole slice
* unless done by the internal filters ).
*
* The output images of SliceBySliceImageFilter must be of the same size than the
* input images. All the input images must be of the same pixel type. All the
* output images must be of the same pixel type.
*
* \author Gaetan Lehmann
*
* This class was taken from the Insight Journal paper:
* https://www.insight-journal.org/browse/publication/133
*
* \ingroup ITKImageGrid
*/
template <typename TInputImage,
typename TOutputImage,
typename TInputFilter =
ImageToImageFilter<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>,
Image<typename TOutputImage::PixelType, TOutputImage::ImageDimension - 1>>,
class TOutputFilter = typename TInputFilter::Superclass,
class TInternalInputImage = typename TInputFilter::InputImageType,
class TInternalOutputImage = typename TOutputFilter::OutputImageType>
class ITK_TEMPLATE_EXPORT SliceBySliceImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(SliceBySliceImageFilter);
/** Standard class type aliases. */
using Self = SliceBySliceImageFilter;
using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Superclass type alias. */
using typename Superclass::InputImagePointer;
/** Standard New method. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(SliceBySliceImageFilter);
/** Image related type alias. */
using InputImageType = TInputImage;
using RegionType = typename TInputImage::RegionType;
using SizeType = typename TInputImage::SizeType;
using IndexType = typename TInputImage::IndexType;
using PixelType = typename TInputImage::PixelType;
using OffsetType = typename TInputImage::OffsetType;
using OutputImageType = TOutputImage;
using OutputPixelType = typename TOutputImage::PixelType;
using InputFilterType = TInputFilter;
using OutputFilterType = TOutputFilter;
using InternalInputImageType = TInternalInputImage;
using InternalRegionType = typename InternalInputImageType::RegionType;
using InternalSizeType = typename InternalInputImageType::SizeType;
using InternalIndexType = typename InternalInputImageType::IndexType;
using InternalOffsetType = typename InternalInputImageType::OffsetType;
using InternalInputPixelType = typename InternalInputImageType::PixelType;
using InternalSpacingType = typename InternalInputImageType::SpacingType;
using InternalPointType = typename InternalInputImageType::PointType;
using InternalOutputImageType = TInternalOutputImage;
using InternalOutputPixelType = typename InternalOutputImageType::PixelType;
/** Image related type alias. */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
static constexpr unsigned int InternalImageDimension = InternalInputImageType::ImageDimension;
itkSetMacro(Dimension, unsigned int);
itkGetConstMacro(Dimension, unsigned int);
void
SetFilter(InputFilterType * filter);
InputFilterType *
GetFilter()
{
return this->m_InputFilter;
}
const InputFilterType *
GetFilter() const
{
return this->m_InputFilter;
}
void
SetInputFilter(InputFilterType * filter);
itkGetModifiableObjectMacro(InputFilter, InputFilterType);
void
SetOutputFilter(OutputFilterType * filter);
itkGetModifiableObjectMacro(OutputFilter, OutputFilterType);
/** The index of the slice currently processed by the filter. This is intended to be
* used with the IterationEvent sent before the processing of each object. It contains
* a relevant value only during the filter update.
*/
itkGetConstMacro(SliceIndex, IndexValueType);
protected:
SliceBySliceImageFilter();
~SliceBySliceImageFilter() override = default;
void
VerifyInputInformation() ITKv5_CONST override;
void
GenerateData() override;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GenerateInputRequestedRegion() override;
private:
unsigned int m_Dimension{};
typename InputFilterType::Pointer m_InputFilter{};
typename OutputFilterType::Pointer m_OutputFilter{};
IndexValueType m_SliceIndex{};
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkSliceBySliceImageFilter.hxx"
#endif
#endif
|
