itkSliceBySliceImageFilter.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 itkSliceBySliceImageFilter_h
#define itkSliceBySliceImageFilter_h
 
#include "itkImageToImageFilter.h"
 
namespace itk
{
 
template <typename TInputImage,
          typename TOutputImage,
          typename TInputFilter =
            ImageToImageFilter<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>,
                               Image<typename TOutputImage::PixelType, TOutputImage::ImageDimension - 1>>,
          class TOutputFilter = typename TInputFilter::Superclass,
          class TInternalInputImage = typename TInputFilter::InputImageType,
          class TInternalOutputImage = typename TOutputFilter::OutputImageType>
class ITK_TEMPLATE_EXPORT SliceBySliceImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SliceBySliceImageFilter);

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

  using typename Superclass::InputImagePointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SliceBySliceImageFilter);

  using InputImageType = TInputImage;
  using RegionType = typename TInputImage::RegionType;
  using SizeType = typename TInputImage::SizeType;
  using IndexType = typename TInputImage::IndexType;
  using PixelType = typename TInputImage::PixelType;
  using OffsetType = typename TInputImage::OffsetType;
 
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename TOutputImage::PixelType;
 
  using InputFilterType = TInputFilter;
  using OutputFilterType = TOutputFilter;
 
  using InternalInputImageType = TInternalInputImage;
  using InternalRegionType = typename InternalInputImageType::RegionType;
  using InternalSizeType = typename InternalInputImageType::SizeType;
  using InternalIndexType = typename InternalInputImageType::IndexType;
  using InternalOffsetType = typename InternalInputImageType::OffsetType;
  using InternalInputPixelType = typename InternalInputImageType::PixelType;
  using InternalSpacingType = typename InternalInputImageType::SpacingType;
  using InternalPointType = typename InternalInputImageType::PointType;
 
  using InternalOutputImageType = TInternalOutputImage;
  using InternalOutputPixelType = typename InternalOutputImageType::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  static constexpr unsigned int InternalImageDimension = InternalInputImageType::ImageDimension;
 
  itkSetMacro(Dimension, unsigned int);
  itkGetConstMacro(Dimension, unsigned int);
 
  void
  SetFilter(InputFilterType * filter);
 
  InputFilterType *
  GetFilter()
  {
    return this->m_InputFilter;
  }
 
  const InputFilterType *
  GetFilter() const
  {
    return this->m_InputFilter;
  }
 
  void
  SetInputFilter(InputFilterType * filter);
  itkGetModifiableObjectMacro(InputFilter, InputFilterType);
 
  void
  SetOutputFilter(OutputFilterType * filter);
  itkGetModifiableObjectMacro(OutputFilter, OutputFilterType);

  itkGetConstMacro(SliceIndex, IndexValueType);
 
protected:
  SliceBySliceImageFilter();
  ~SliceBySliceImageFilter() override = default;
 
  void
  VerifyInputInformation() const override;
 
  void
  GenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateInputRequestedRegion() override;
 
private:
  unsigned int m_Dimension{};
 
  typename InputFilterType::Pointer m_InputFilter{};
 
  typename OutputFilterType::Pointer m_OutputFilter{};
 
  IndexValueType m_SliceIndex{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSliceBySliceImageFilter.hxx"
#endif
 
#endif