itkChangeInformationImageFilter.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 itkChangeInformationImageFilter_h
#define itkChangeInformationImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkFixedArray.h"
 
namespace itk
{
template <typename TInputImage>
class ITK_TEMPLATE_EXPORT ChangeInformationImageFilter : public ImageToImageFilter<TInputImage, TInputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ChangeInformationImageFilter);

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

  itkNewMacro(Self);
 
  using InputImageType = TInputImage;
  using OutputImageType = TInputImage;

  using OutputImageRegionType = typename OutputImageType::RegionType;
  using InputImageRegionType = typename InputImageType::RegionType;

  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;

  using OutputImagePixelType = typename OutputImageType::PixelType;
  using InputImagePixelType = typename InputImageType::PixelType;

  using OutputImageIndexType = typename OutputImageType::IndexType;
  using OutputImageSizeType = typename OutputImageType::SizeType;
  using OutputImageOffsetType = typename OutputImageType::OffsetType;
  using OutputImageDirectionType = typename OutputImageType::DirectionType;
  using OutputImageOffsetValueType = typename OutputImageType::OffsetValueType;
  using InputImageIndexType = typename InputImageType::IndexType;
  using InputImageSizeType = typename InputImageType::SizeType;
  using InputImageOffsetType = typename InputImageType::OffsetType;
  using InputImageDirectionType = typename InputImageType::DirectionType;

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;

  using SpacingType = typename InputImageType::SpacingType;
  using PointType = typename InputImageType::PointType;
  using DirectionType = typename InputImageType::DirectionType;

  itkOverrideGetNameOfClassMacro(ChangeInformationImageFilter);

  void
  SetReferenceImage(InputImageType * image)
  {
    if (image != m_ReferenceImage)
    {
      m_ReferenceImage = image;
      this->ProcessObject::SetNthInput(1, const_cast<InputImageType *>(image));
      this->Modified();
    }
  }
 
  itkGetModifiableObjectMacro(ReferenceImage, TInputImage);
 
  itkSetMacro(UseReferenceImage, bool);
  itkBooleanMacro(UseReferenceImage);
  itkGetConstMacro(UseReferenceImage, bool);

  itkSetMacro(OutputSpacing, SpacingType);
  itkGetConstReferenceMacro(OutputSpacing, SpacingType);

  itkSetMacro(OutputOrigin, PointType);
  itkGetConstReferenceMacro(OutputOrigin, PointType);

  itkSetMacro(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  itkSetMacro(OutputOffset, OutputImageOffsetType);
  itkGetConstReferenceMacro(OutputOffset, OutputImageOffsetType);
  itkSetVectorMacro(OutputOffset, OutputImageOffsetValueType, ImageDimension);

  void
  ChangeAll()
  {
    this->ChangeSpacingOn();
    this->ChangeOriginOn();
    this->ChangeDirectionOn();
    this->ChangeRegionOn();
  }

  void
  ChangeNone()
  {
    this->ChangeSpacingOff();
    this->ChangeOriginOff();
    this->ChangeDirectionOff();
    this->ChangeRegionOff();
  }

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

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

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

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

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

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;
 
protected:
  ChangeInformationImageFilter() = default;
  ~ChangeInformationImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  VerifyInputInformation() const override
  {}
 
private:
  InputImagePointer m_ReferenceImage{ nullptr };
 
  bool m_CenterImage{ false };
  bool m_ChangeSpacing{ false };
  bool m_ChangeOrigin{ false };
  bool m_ChangeDirection{ false };
  bool m_ChangeRegion{ false };
  bool m_UseReferenceImage{ false };
 
  SpacingType   m_OutputSpacing{ MakeFilled<SpacingType>(1.0) };
  PointType     m_OutputOrigin{};
  DirectionType m_OutputDirection{ DirectionType::GetIdentity() };
 
  OutputImageOffsetType m_OutputOffset{};
  OutputImageOffsetType m_Shift{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkChangeInformationImageFilter.hxx"
#endif
 
#endif