ITK  6.0.0
Insight Toolkit
itkStreamingImageFilter.h
Go to the documentation of this file.
1/*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18#ifndef itkStreamingImageFilter_h
19#define itkStreamingImageFilter_h
20
23
24namespace itk
25{
43template <typename TInputImage, typename TOutputImage>
44class ITK_TEMPLATE_EXPORT StreamingImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
45{
46public:
47 ITK_DISALLOW_COPY_AND_MOVE(StreamingImageFilter);
48
54
56 itkNewMacro(Self);
57
59 itkOverrideGetNameOfClassMacro(StreamingImageFilter);
60
62 using InputImageType = TInputImage;
65 using InputImagePixelType = typename InputImageType::PixelType;
66
67 using OutputImageType = TOutputImage;
70 using OutputImagePixelType = typename OutputImageType::PixelType;
71 using typename Superclass::DataObjectPointer;
72
74 static constexpr unsigned int InputImageDimension = InputImageType::ImageDimension;
75 static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension;
76
80
83 itkSetMacro(NumberOfStreamDivisions, unsigned int);
84
87 itkGetConstReferenceMacro(NumberOfStreamDivisions, unsigned int);
88
90 itkSetObjectMacro(RegionSplitter, SplitterType);
91 itkGetModifiableObjectMacro(RegionSplitter, SplitterType);
99 void
100 UpdateOutputData(DataObject * output) override;
101
106 void
108
109#ifdef ITK_USE_CONCEPT_CHECKING
110 // Begin concept checking
113 // End concept checking
114#endif
115
116protected:
118 ~StreamingImageFilter() override = default;
119 void
120 PrintSelf(std::ostream & os, Indent indent) const override;
121
122private:
123 unsigned int m_NumberOfStreamDivisions{};
124 RegionSplitterPointer m_RegionSplitter{};
125};
126} // end namespace itk
127
128#ifndef ITK_MANUAL_INSTANTIATION
129# include "itkStreamingImageFilter.hxx"
130#endif
131
132#endif
Base class for all data objects in ITK.
Divide an image region into several pieces.
Base class for all process objects that output image data.
typename OutputImageType::PixelType OutputImagePixelType
typename OutputImageType::RegionType OutputImageRegionType
TOutputImage OutputImageType
typename OutputImageType::Pointer OutputImagePointer
Base class for filters that take an image as input and produce an image as output.
typename InputImageType::Pointer InputImagePointer
typename InputImageType::PixelType InputImagePixelType
typename InputImageType::RegionType InputImageRegionType
Control indentation during Print() invocation.
Definition: itkIndent.h:50
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Pipeline object to control data streaming for large data processing.
typename SplitterType::Pointer RegionSplitterPointer
void UpdateOutputData(DataObject *output) override
void PrintSelf(std::ostream &os, Indent indent) const override
~StreamingImageFilter() override=default
void PropagateRequestedRegion(DataObject *output) override
SmartPointer< Self > Pointer
#define itkConceptMacro(name, concept)
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....