ITK  5.0.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:
75  ITK_DISALLOW_COPY_AND_ASSIGN(InPlaceImageFilter);
76 
82 
85 
87  using OutputImageType = typename Superclass::OutputImageType;
88  using OutputImagePointer = typename Superclass::OutputImagePointer;
89  using OutputImageRegionType = typename Superclass::OutputImageRegionType;
90  using OutputImagePixelType = typename Superclass::OutputImagePixelType;
91 
93  using InputImageType = TInputImage;
94  using InputImagePointer = typename InputImageType::Pointer;
95  using InputImageConstPointer = typename InputImageType::ConstPointer;
97  using InputImagePixelType = typename InputImageType::PixelType;
98 
100  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
101  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
102 
108  itkSetMacro(InPlace, bool);
109  itkGetConstMacro(InPlace, bool);
110  itkBooleanMacro(InPlace);
112 
121  virtual bool CanRunInPlace() const;
122 
123 protected:
124  InPlaceImageFilter() = default;
125  ~InPlaceImageFilter() override = default;
126 
127  void PrintSelf(std::ostream & os, Indent indent) const override;
128 
141  void AllocateOutputs() override
142  {
143  this->InternalAllocateOutputs(IsSame<TInputImage, TOutputImage>());
144  }
145 
155  void ReleaseInputs() override;
156 
161  itkGetConstMacro(RunningInPlace,bool);
162 
163 private:
164  // the type are different we can't run in place
165  void InternalAllocateOutputs( const FalseType& )
166  {
167  this->m_RunningInPlace = false;
168  this->Superclass::AllocateOutputs();
169  }
170 
171  void InternalAllocateOutputs( const TrueType& );
172 
173  bool m_InPlace{true}; // enable the possibility of in-place
174  bool m_RunningInPlace{false};
175 
176 };
177 } // end namespace itk
178 
179 #ifndef ITK_MANUAL_INSTANTIATION
180 #include "itkInPlaceImageFilter.hxx"
181 #endif
182 
183 #endif
typename OutputImageType::Pointer OutputImagePointer
Light weight base class for most itk classes.
typename OutputImageType::PixelType OutputImagePixelType
typename InputImageType::PixelType InputImagePixelType
typename InputImageType::Pointer InputImagePointer
typename OutputImageType::RegionType OutputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Base class for filters that take an image as input and produce an image as output.
void InternalAllocateOutputs(const FalseType &)
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Base class for filters that take an image as input and overwrite that image as the output...
typename InputImageType::ConstPointer InputImageConstPointer