itkVectorExpandImageFilter.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 itkVectorExpandImageFilter_h
#define itkVectorExpandImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkVectorLinearInterpolateImageFunction.h"
 
#if !defined(ITK_LEGACY_REMOVE)
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT VectorExpandImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VectorExpandImageFilter);

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

  itkNewMacro(Self);

  using InputImagePointer = typename TInputImage::Pointer;
  using OutputImagePointer = typename TOutputImage::Pointer;
  using OutputImageRegionType = typename TOutputImage::RegionType;

  itkOverrideGetNameOfClassMacro(VectorExpandImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;

  using OutputPixelType = typename OutputImageType::PixelType;
  using OutputValueType = typename OutputPixelType::ValueType;
  using InputPixelType = typename InputImageType::PixelType;
  using InputValueType = typename InputPixelType::ValueType;

  enum
  {
    VectorDimension = InputPixelType::Dimension
  };

  using ExpandFactorsType = float;
  using ExpandFactorsArrayType = FixedArray<ExpandFactorsType, ImageDimension>;

  using CoordinateType = double;
#  ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#  endif
  using InterpolatorType = VectorInterpolateImageFunction<InputImageType, CoordinateType>;
  using InterpolatorPointer = typename InterpolatorType::Pointer;
  using DefaultInterpolatorType = VectorLinearInterpolateImageFunction<InputImageType, CoordinateType>;

  itkSetObjectMacro(Interpolator, InterpolatorType);
  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkSetMacro(ExpandFactors, ExpandFactorsArrayType);
  virtual void
  SetExpandFactors(const float factor);
  itkSetVectorMacro(ExpandFactors, const unsigned int, ImageDimension);

  itkGetConstReferenceMacro(ExpandFactors, ExpandFactorsArrayType);

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputValueType>));
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputValueType>));
 
protected:
  VectorExpandImageFilter();
  ~VectorExpandImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 

  void
  BeforeThreadedGenerateData() override;
 
private:
  ExpandFactorsArrayType m_ExpandFactors{};
  InterpolatorPointer    m_Interpolator{};
};
} // end namespace itk
 
#  ifndef ITK_MANUAL_INSTANTIATION
#    include "itkVectorExpandImageFilter.hxx"
#  endif
 
#endif // ITK_LEGACY_REMOVE
#endif