ITK  4.9.0
Insight Segmentation and Registration Toolkit
itkStreamingImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 StreamingImageFilter:public ImageToImageFilter< TInputImage, TOutputImage >
45 {
46 public:
52 
54  itkNewMacro(Self);
55 
58 
60  typedef TInputImage InputImageType;
61  typedef typename InputImageType::Pointer InputImagePointer;
62  typedef typename InputImageType::RegionType InputImageRegionType;
63  typedef typename InputImageType::PixelType InputImagePixelType;
64 
65  typedef TOutputImage OutputImageType;
66  typedef typename OutputImageType::Pointer OutputImagePointer;
67  typedef typename OutputImageType::RegionType OutputImageRegionType;
68  typedef typename OutputImageType::PixelType OutputImagePixelType;
70 
72  itkStaticConstMacro(InputImageDimension, unsigned int,
73  InputImageType::ImageDimension);
74  itkStaticConstMacro(OutputImageDimension, unsigned int,
75  OutputImageType::ImageDimension);
77 
81 
84  itkSetMacro(NumberOfStreamDivisions, unsigned int);
85 
88  itkGetConstReferenceMacro(NumberOfStreamDivisions, unsigned int);
89 
91  itkSetObjectMacro(RegionSplitter, SplitterType);
92  itkGetModifiableObjectMacro(RegionSplitter, SplitterType);
94 
100  virtual void UpdateOutputData(DataObject *output) ITK_OVERRIDE;
101 
106  virtual void PropagateRequestedRegion(DataObject *output) ITK_OVERRIDE;
107 
108 #ifdef ITK_USE_CONCEPT_CHECKING
109  // Begin concept checking
110  itkConceptMacro( SameDimensionCheck,
112  itkConceptMacro( InputConvertibleToOutputCheck,
114  // End concept checking
115 #endif
116 
117 protected:
120  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
121 
122 private:
123  StreamingImageFilter(const StreamingImageFilter &) ITK_DELETE_FUNCTION;
124  void operator=(const StreamingImageFilter &) ITK_DELETE_FUNCTION;
125 
128 };
129 } // end namespace itk
130 
131 #ifndef ITK_MANUAL_INSTANTIATION
132 #include "itkStreamingImageFilter.hxx"
133 #endif
134 
135 #endif
OutputImageType::RegionType OutputImageRegionType
InputImageType::Pointer InputImagePointer
Pipeline object to control data streaming for large data processing.
ImageRegionSplitterBase SplitterType
Superclass::DataObjectPointer DataObjectPointer
virtual void PropagateRequestedRegion(DataObject *output) override
Base class for all process objects that output image data.
void PrintSelf(std::ostream &os, Indent indent) const override
SplitterType::Pointer RegionSplitterPointer
ImageToImageFilter< TInputImage, TOutputImage > Superclass
virtual void UpdateOutputData(DataObject *output) override
Divide an image region into several pieces.
OutputImageType::PixelType OutputImagePixelType
RegionSplitterPointer m_RegionSplitter
Base class for filters that take an image as input and produce an image as output.
Control indentation during Print() invocation.
Definition: itkIndent.h:49
InputImageType::PixelType InputImagePixelType
static const unsigned int OutputImageDimension
SmartPointer< const Self > ConstPointer
OutputImageType::Pointer OutputImagePointer
static const unsigned int InputImageDimension
InputImageType::RegionType InputImageRegionType
#define itkConceptMacro(name, concept)
Base class for all data objects in ITK.