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
|
/*=========================================================================
*
* 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 itkRegionOfInterestImageFilter_h
#define itkRegionOfInterestImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkSmartPointer.h"
namespace itk
{
/**
* \class RegionOfInterestImageFilter
* \brief Extract a region of interest from the input image.
*
* This filter produces an output image of the same dimension as the input
* image. The user specifies the region of the input image that will be
* contained in the output image. The origin coordinates of the output images
* will be computed in such a way that if mapped to physical space, the output
* image will overlay the input image with perfect registration. In other
* words, a registration process between the output image and the input image
* will return an identity transform.
*
* If you are interested in changing the dimension of the image, you may want
* to consider the ExtractImageFilter. For example for extracting a 2D image
* from a slice of a 3D image.
*
* The region to extract is set using the method SetRegionOfInterest.
*
* \sa ExtractImageFilter
*
* \ingroup GeometricTransform
* \ingroup ITKImageGrid
*
* \sphinx
* \sphinxexample{Filtering/ImageGrid/ExtractRegionOfInterestInOneImage,Extract Region Of Interest In One Image}
* \endsphinx
*/
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT RegionOfInterestImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(RegionOfInterestImageFilter);
/** Standard class type aliases. */
using Self = RegionOfInterestImageFilter;
using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using typename Superclass::InputImageRegionType;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(RegionOfInterestImageFilter);
/** Typedef to describe the input image region types. */
using RegionType = typename TInputImage::RegionType;
using IndexType = typename TInputImage::IndexType;
using SizeType = typename TInputImage::SizeType;
/** Typedef to describe the type of pixel. */
using OutputImagePixelType = typename TOutputImage::PixelType;
using InputImagePixelType = typename TInputImage::PixelType;
/** Set/Get the output image region. */
itkSetMacro(RegionOfInterest, RegionType);
itkGetConstMacro(RegionOfInterest, RegionType);
/** ImageDimension enumeration */
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
// End concept checking
#endif
protected:
RegionOfInterestImageFilter();
~RegionOfInterestImageFilter() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GenerateInputRequestedRegion() override;
void
EnlargeOutputRequestedRegion(DataObject * output) override;
/** RegionOfInterestImageFilter can produce an image which is a different
* size than its input image. As such, RegionOfInterestImageFilter
* needs to provide an implementation for
* GenerateOutputInformation() in order to inform the pipeline
* execution model.
*
* \sa ProcessObject::GenerateOutputInformaton() */
void
GenerateOutputInformation() override;
/** RegionOfInterestImageFilter can be implemented as a multithreaded filter.
* Therefore, this implementation provides a DynamicThreadedGenerateData()
* routine which is called for each processing thread. The output
* image data is allocated automatically by the superclass prior to
* calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only
* write to the portion of the output image specified by the
* parameter "outputRegionForThread".
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
void
DynamicThreadedGenerateData(const RegionType & outputRegionForThread) override;
private:
RegionType m_RegionOfInterest{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkRegionOfInterestImageFilter.hxx"
#endif
#endif
|
