ITK  5.2.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  * http://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 
21 #include "itkImageToImageFilter.h"
23 
24 namespace itk
25 {
43 template <typename TInputImage, typename TOutputImage>
44 class ITK_TEMPLATE_EXPORT StreamingImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
45 {
46 public:
47  ITK_DISALLOW_COPY_AND_MOVE(StreamingImageFilter);
48 
54 
56  itkNewMacro(Self);
57 
60 
62  using InputImageType = TInputImage;
63  using InputImagePointer = typename InputImageType::Pointer;
65  using InputImagePixelType = typename InputImageType::PixelType;
66 
67  using OutputImageType = TOutputImage;
68  using OutputImagePointer = typename OutputImageType::Pointer;
70  using OutputImagePixelType = typename OutputImageType::PixelType;
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);
93 
99  void
100  UpdateOutputData(DataObject * output) override;
101 
106  void
107  PropagateRequestedRegion(DataObject * output) override;
108 
109 #ifdef ITK_USE_CONCEPT_CHECKING
110  // Begin concept checking
113  // End concept checking
114 #endif
115 
116 protected:
118  ~StreamingImageFilter() override = default;
119  void
120  PrintSelf(std::ostream & os, Indent indent) const override;
121 
122 private:
125 };
126 } // end namespace itk
127 
128 #ifndef ITK_MANUAL_INSTANTIATION
129 # include "itkStreamingImageFilter.hxx"
130 #endif
131 
132 #endif
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::StreamingImageFilter::m_RegionSplitter
RegionSplitterPointer m_RegionSplitter
Definition: itkStreamingImageFilter.h:124
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::StreamingImageFilter::RegionSplitterPointer
typename SplitterType::Pointer RegionSplitterPointer
Definition: itkStreamingImageFilter.h:79
itk::Concept::SameDimension
Definition: itkConceptChecking.h:694
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::ImageRegionSplitterBase
Divide an image region into several pieces.
Definition: itkImageRegionSplitterBase.h:58
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itkImageRegionSplitterBase.h
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:65
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::Concept::Convertible
Definition: itkConceptChecking.h:216
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::StreamingImageFilter::m_NumberOfStreamDivisions
unsigned int m_NumberOfStreamDivisions
Definition: itkStreamingImageFilter.h:123
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293
itk::StreamingImageFilter
Pipeline object to control data streaming for large data processing.
Definition: itkStreamingImageFilter.h:44