itkOrientImageFilter.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 itkOrientImageFilter_h
#define itkOrientImageFilter_h
 
#include "itkPermuteAxesImageFilter.h"
#include "itkFlipImageFilter.h"
#include "itkAnatomicalOrientation.h"
#include <map>
#include <string>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT OrientImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OrientImageFilter);

  using Self = OrientImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using OutputImagePixelType = typename OutputImageType::PixelType;
  using CoordinateOrientationCode = AnatomicalOrientation;

  using PermuterType = PermuteAxesImageFilter<TInputImage>;
  using PermuteOrderArrayType = typename PermuterType::PermuteOrderArrayType;

  using FlipperType = FlipImageFilter<TInputImage>;
  using FlipAxesArrayType = typename FlipperType::FlipAxesArrayType;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(OrientImageFilter);

  itkGetEnumMacro(GivenCoordinateOrientation, CoordinateOrientationCode);
  void
  SetGivenCoordinateOrientation(CoordinateOrientationCode newCode);
 
  inline void
  SetGivenCoordinateDirection(const typename TInputImage::DirectionType & GivenDirection)
  {
    SetGivenCoordinateOrientation(AnatomicalOrientation(GivenDirection));
  }
 
  itkGetEnumMacro(DesiredCoordinateOrientation, CoordinateOrientationCode);
  void
  SetDesiredCoordinateOrientation(CoordinateOrientationCode newCode);
 
  inline void
  SetDesiredCoordinateDirection(const typename TOutputImage::DirectionType & DesiredDirection)
  {
    SetDesiredCoordinateOrientation(AnatomicalOrientation(DesiredDirection));
  }

  itkBooleanMacro(UseImageDirection);
  itkGetConstMacro(UseImageDirection, bool);
  itkSetMacro(UseImageDirection, bool);

  itkGetConstReferenceMacro(PermuteOrder, PermuteOrderArrayType);

  itkGetConstReferenceMacro(FlipAxes, FlipAxesArrayType);

  void
  SetDesiredCoordinateOrientationToAxial()
  {
    this->SetDesiredCoordinateOrientation({ AnatomicalOrientation::CoordinateEnum::RightToLeft,
                                            AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
                                            AnatomicalOrientation::CoordinateEnum::InferiorToSuperior });
  }

 
  void
  SetDesiredCoordinateOrientationToCoronal()
  {
    this->SetDesiredCoordinateOrientation({ AnatomicalOrientation::CoordinateEnum::RightToLeft,
                                            AnatomicalOrientation::CoordinateEnum::SuperiorToInferior,
                                            AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior });
  }
 
  void
  SetDesiredCoordinateOrientationToSagittal()
  {
    this->SetDesiredCoordinateOrientation({ AnatomicalOrientation::CoordinateEnum::AnteriorToPosterior,
                                            AnatomicalOrientation::CoordinateEnum::SuperiorToInferior,
                                            AnatomicalOrientation::CoordinateEnum::LeftToRight });
  }

  void
  GenerateOutputInformation() override;
 
  itkConceptMacro(InputConvertibleToOutput, (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
  itkConceptMacro(SameDimension, (Concept::SameDimension<Self::InputImageDimension, Self::OutputImageDimension>));
  itkConceptMacro(DimensionShouldBe3, (Concept::SameDimension<Self::InputImageDimension, 3>));
 
protected:
  OrientImageFilter();
  ~OrientImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
 
  void
  VerifyPreconditions() const override;
 
  /*** Member functions used by GenerateData: */
  void
  DeterminePermutationsAndFlips(const CoordinateOrientationCode fixed_orient,
                                const CoordinateOrientationCode moving_orient);

  bool
  NeedToPermute();

  bool
  NeedToFlip();

  void
  GenerateData() override;
 
private:
  CoordinateOrientationCode m_GivenCoordinateOrientation{ AnatomicalOrientation::CoordinateEnum::RightToLeft,
                                                          AnatomicalOrientation::CoordinateEnum::InferiorToSuperior,
                                                          AnatomicalOrientation::CoordinateEnum::PosteriorToAnterior };
  CoordinateOrientationCode m_DesiredCoordinateOrientation{
    AnatomicalOrientation::CoordinateEnum::RightToLeft,
    AnatomicalOrientation::CoordinateEnum::InferiorToSuperior,
    AnatomicalOrientation::CoordinateEnum::PosteriorToAnterior
  };
  bool m_UseImageDirection{ false };
 
  PermuteOrderArrayType m_PermuteOrder{};
  FlipAxesArrayType     m_FlipAxes{ false };
 
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkOrientImageFilter.hxx"
#endif
 
#endif