ITK  4.13.0
Insight Segmentation and Registration Toolkit
itkInPlaceImageFilter.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 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkInPlaceImageFilter_h
29 #define itkInPlaceImageFilter_h
30 
31 #include "itkImageToImageFilter.h"
32 #include "itkIsSame.h"
33 
34 namespace itk
35 {
71 template< typename TInputImage, typename TOutputImage = TInputImage >
72 class ITK_TEMPLATE_EXPORT InPlaceImageFilter:public ImageToImageFilter< TInputImage, TOutputImage >
73 {
74 public:
80 
83 
85  typedef typename Superclass::OutputImageType OutputImageType;
86  typedef typename Superclass::OutputImagePointer OutputImagePointer;
87  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;
88  typedef typename Superclass::OutputImagePixelType OutputImagePixelType;
89 
91  typedef TInputImage InputImageType;
92  typedef typename InputImageType::Pointer InputImagePointer;
93  typedef typename InputImageType::ConstPointer InputImageConstPointer;
94  typedef typename InputImageType::RegionType InputImageRegionType;
95  typedef typename InputImageType::PixelType InputImagePixelType;
96 
98  itkStaticConstMacro(InputImageDimension, unsigned int,
99  TInputImage::ImageDimension);
100  itkStaticConstMacro(OutputImageDimension, unsigned int,
101  TOutputImage::ImageDimension);
103 
109  itkSetMacro(InPlace, bool);
110  itkGetConstMacro(InPlace, bool);
111  itkBooleanMacro(InPlace);
113 
122  virtual bool CanRunInPlace() const;
123 
124 protected:
127 
128  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
129 
142  virtual void AllocateOutputs() ITK_OVERRIDE
143  {
144  this->InternalAllocateOutputs(IsSame<TInputImage, TOutputImage>());
145  }
146 
156  virtual void ReleaseInputs() ITK_OVERRIDE;
157 
162  itkGetConstMacro(RunningInPlace,bool);
163 
164 private:
165  ITK_DISALLOW_COPY_AND_ASSIGN(InPlaceImageFilter);
166 
167  // the type are different we can't run in place
168  void InternalAllocateOutputs( const FalseType& )
169  {
170  this->m_RunningInPlace = false;
171  this->Superclass::AllocateOutputs();
172  }
173 
174  void InternalAllocateOutputs( const TrueType& );
175 
176  bool m_InPlace; // enable the possibility of in-place
178 
179 };
180 } // end namespace itk
181 
182 #ifndef ITK_MANUAL_INSTANTIATION
183 #include "itkInPlaceImageFilter.hxx"
184 #endif
185 
186 #endif
Superclass::OutputImagePixelType OutputImagePixelType
SmartPointer< const Self > ConstPointer
Superclass::OutputImagePointer OutputImagePointer
ImageToImageFilter< TInputImage, TOutputImage > Superclass
InputImageType::Pointer InputImagePointer
virtual void AllocateOutputs() override
InputImageType::RegionType InputImageRegionType
Base class for filters that take an image as input and produce an image as output.
Superclass::OutputImageRegionType OutputImageRegionType
Control indentation during Print() invocation.
Definition: itkIndent.h:49
InputImageType::ConstPointer InputImageConstPointer
Base class for filters that take an image as input and overwrite that image as the output...
InputImageType::PixelType InputImagePixelType
SmartPointer< Self > Pointer
Superclass::OutputImageType OutputImageType