ITK  5.2.0
Insight Toolkit
itkPermuteAxesImageFilter.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 itkPermuteAxesImageFilter_h
19 #define itkPermuteAxesImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "itkFixedArray.h"
23 
24 namespace itk
25 {
50 template <typename TImage>
51 class ITK_TEMPLATE_EXPORT PermuteAxesImageFilter : public ImageToImageFilter<TImage, TImage>
52 {
53 public:
54  ITK_DISALLOW_COPY_AND_MOVE(PermuteAxesImageFilter);
55 
61 
63  itkNewMacro(Self);
64 
67 
69  static constexpr unsigned int ImageDimension = TImage::ImageDimension;
70 
72  using InputImagePointer = typename Superclass::InputImagePointer;
73  using OutputImagePointer = typename Superclass::OutputImagePointer;
74  using OutputImageRegionType = typename Superclass::OutputImageRegionType;
75 
78 
81  void
82  SetOrder(const PermuteOrderArrayType & order);
83 
85  itkGetConstReferenceMacro(Order, PermuteOrderArrayType);
86 
88  itkGetConstReferenceMacro(InverseOrder, PermuteOrderArrayType);
89 
90 protected:
98  void
99  GenerateOutputInformation() override;
100 
106  void
107  GenerateInputRequestedRegion() override;
108 
110  ~PermuteAxesImageFilter() override = default;
111  void
112  PrintSelf(std::ostream & os, Indent indent) const override;
113 
124  void
125  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
126 
127 
128 private:
131 };
132 } // end namespace itk
133 
134 #ifndef ITK_MANUAL_INSTANTIATION
135 # include "itkPermuteAxesImageFilter.hxx"
136 #endif
137 
138 #endif
itk::PermuteAxesImageFilter::m_Order
PermuteOrderArrayType m_Order
Definition: itkPermuteAxesImageFilter.h:129
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::PermuteAxesImageFilter
Permutes the image axes according to a user specified order.
Definition: itkPermuteAxesImageFilter.h:51
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkFixedArray.h
itkImageToImageFilter.h
itk::FixedArray< unsigned int, Self::ImageDimension >
itk::PermuteAxesImageFilter::m_InverseOrder
PermuteOrderArrayType m_InverseOrder
Definition: itkPermuteAxesImageFilter.h:130
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::PermuteAxesImageFilter::OutputImagePointer
typename Superclass::OutputImagePointer OutputImagePointer
Definition: itkPermuteAxesImageFilter.h:73
itk::PermuteAxesImageFilter::OutputImageRegionType
typename Superclass::OutputImageRegionType OutputImageRegionType
Definition: itkPermuteAxesImageFilter.h:74
itk::PermuteAxesImageFilter::InputImagePointer
typename Superclass::InputImagePointer InputImagePointer
Definition: itkPermuteAxesImageFilter.h:72