elxResamplerBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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 elxResamplerBase_h
#define elxResamplerBase_h

#include "elxMacro.h"
 
#include "elxBaseComponentSE.h"
#include "elxPixelTypeToString.h"
#include "itkResampleImageFilter.h"
#include "itkCastImageFilter.h"
#include "elxProgressCommand.h"
 
namespace elastix
{
 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT ResamplerBase : public BaseComponentSE<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ResamplerBase);

  using Self = ResamplerBase;
  using Superclass = BaseComponentSE<TElastix>;

  itkOverrideGetNameOfClassMacro(ResamplerBase);

  using typename Superclass::ElastixType;
  using typename Superclass::RegistrationType;

  using InputImageType = typename ElastixType::MovingImageType;
  using OutputImageType = typename ElastixType::MovingImageType;
  // typedef typename ElastixType::FixedImageType      OutputImageType;
  using CoordinateType = ElastixBase::CoordinateType;

  using ITKBaseType = itk::ResampleImageFilter<InputImageType, OutputImageType, CoordinateType>;

  using TransformType = typename ITKBaseType::TransformType;
  using InterpolatorType = typename ITKBaseType::InterpolatorType;
  using SizeType = typename ITKBaseType::SizeType;
  using IndexType = typename ITKBaseType::IndexType;
  using SpacingType = typename ITKBaseType::SpacingType;
  using DirectionType = typename ITKBaseType::DirectionType;
  using OriginPointType = typename ITKBaseType::OriginPointType;
  using OutputPixelType = typename ITKBaseType::PixelType;

  using ParameterMapType = typename ElastixType::ParameterMapType;

  itkStaticConstMacro(ImageDimension, unsigned int, OutputImageType::ImageDimension);

  ITKBaseType *
  GetAsITKBaseType()
  {
    return &(this->GetSelf());
  }
 

  const ITKBaseType *
  GetAsITKBaseType() const
  {
    return &(this->GetSelf());
  }
 

  virtual int
  BeforeAllTransformix()
  {
    return 0;
  }

  void
  BeforeRegistrationBase() override;

  void
  AfterEachResolutionBase() override;

  void
  AfterEachIterationBase() override;

  void
  AfterRegistrationBase() override;

  virtual void
  ReadFromFile();

  void
  WriteToFile(std::ostream & transformationParameterInfo) const;

  void
  CreateTransformParameterMap(ParameterMapType & parameterMap) const;

  void
  ResampleAndWriteResultImage(const std::string & filename, const bool showProgress);

  virtual void
  CreateItkResultImage();
 
protected:
  ResamplerBase() = default;
  ~ResamplerBase() override = default;

  virtual void
  SetComponents();
 
private:
  elxDeclarePureVirtualGetSelfMacro(ITKBaseType);
 
  virtual ParameterMapType
  CreateDerivedTransformParameterMap() const
  {
    return {};
  }

  void
  WriteResultImage(OutputImageType * imageimage, const std::string & filename, const bool showProgress);

  void
  ReleaseMemory();

  template <typename TResultPixel>
  itk::SmartPointer<itk::ImageBase<ImageDimension>>
  CastImage(const InputImageType & inputImage) const
  {
    const auto castFilter =
      itk::CastImageFilter<InputImageType, itk::Image<TResultPixel, InputImageType::ImageDimension>>::New();
    castFilter->SetInput(&inputImage);
    castFilter->Update();
    return castFilter->GetOutput();
  }

  template <typename TResultPixel>
  bool
  CastImageIfPixelTypesMatch(const std::string_view                              resultImagePixelType,
                             const InputImageType &                              inputImage,
                             itk::SmartPointer<itk::ImageBase<ImageDimension>> & outputImage) const
  {
    if (resultImagePixelType == PixelTypeToFixedWidthString<TResultPixel>())
    {
      outputImage = CastImage<TResultPixel>(inputImage);
      return true;
    }
    return false;
  }

  template <typename... TResultPixel>
  itk::SmartPointer<itk::ImageBase<ImageDimension>>
  CastImageAsSpecifiedByFixedWidthPixelType(const std::string_view resultImagePixelType,
                                            const InputImageType & inputImage) const
  {
    if (itk::SmartPointer<itk::ImageBase<ImageDimension>> outputImage;
        (CastImageIfPixelTypesMatch<TResultPixel>(resultImagePixelType, inputImage, outputImage) || ...))
    {
      return outputImage;
    }
    return nullptr;
  }
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxResamplerBase.hxx"
#endif
 
#endif // end #ifndef elxResamplerBase_h