itkPermuteAxesImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkPermuteAxesImageFilter_h
#define itkPermuteAxesImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkFixedArray.h"
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT PermuteAxesImageFilter : public ImageToImageFilter<TImage, TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PermuteAxesImageFilter);

  using Self = PermuteAxesImageFilter;
  using Superclass = ImageToImageFilter<TImage, TImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PermuteAxesImageFilter);

  static constexpr unsigned int ImageDimension = TImage::ImageDimension;

  using typename Superclass::InputImagePointer;
  using typename Superclass::OutputImagePointer;
  using typename Superclass::OutputImageRegionType;

  using PermuteOrderArrayType = FixedArray<unsigned int, Self::ImageDimension>;

  void
  SetOrder(const PermuteOrderArrayType & order);

  itkGetConstReferenceMacro(Order, PermuteOrderArrayType);

  itkGetConstReferenceMacro(InverseOrder, PermuteOrderArrayType);
 
protected:
  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;
 
  PermuteAxesImageFilter();
  ~PermuteAxesImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
 
private:
  PermuteOrderArrayType m_Order{};
  PermuteOrderArrayType m_InverseOrder{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPermuteAxesImageFilter.hxx"
#endif
 
#endif