itkMirrorPadImageFilter.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 itkMirrorPadImageFilter_h
#define itkMirrorPadImageFilter_h
 
#include "itkPadImageFilter.h"
#include "itkNumericTraits.h"
#include <vector>
 
namespace itk
{

template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT MirrorPadImageFilter : public PadImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MirrorPadImageFilter);

  using Self = MirrorPadImageFilter;
  using Superclass = PadImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MirrorPadImageFilter);
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using typename Superclass::OutputImageRegionType;
  using typename Superclass::InputImageRegionType;

  using typename Superclass::OutputImagePixelType;
  using typename Superclass::InputImagePixelType;

  using typename Superclass::OutputImageIndexType;
  using typename Superclass::InputImageIndexType;
  using typename Superclass::OutputImageSizeType;
  using typename Superclass::InputImageSizeType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  itkGetMacro(DecayBase, double);
  itkSetClampMacro(DecayBase, double, NumericTraits<double>::min(), 1.0);
 
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
 
protected:
  MirrorPadImageFilter() = default;
  ~MirrorPadImageFilter() override = default;
 

  void
  ConvertOutputIndexToInputIndex(OutputImageIndexType &  outputIndex,
                                 InputImageIndexType &   inputIndex,
                                 OutputImageRegionType & outputRegion,
                                 InputImageRegionType &  inputRegion,
                                 int *                   oddRegionArray,
                                 IndexValueType &        distanceFromEdge);
 
  void
  ConvertOutputIndexToInputIndex(OutputImageIndexType &  outputIndex,
                                 InputImageIndexType &   inputIndex,
                                 OutputImageRegionType & outputRegion,
                                 InputImageRegionType &  inputRegion,
                                 const int *             oddRegionArray,
                                 double &                outDecayFactor);

  int
  RegionIsOdd(long base, long test, long size);

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 

  int
  GenerateNextInputRegion(long *                 regIndices,
                          const long *           regLimit,
                          std::vector<long> *    indices,
                          std::vector<long> *    sizes,
                          InputImageRegionType & inputRegion);

  int
  GenerateNextOutputRegion(long *                  regIndices,
                           const long *            regLimit,
                           std::vector<long> *     indices,
                           std::vector<long> *     sizes,
                           OutputImageRegionType & outputRegion);

  int
  FindRegionsInArea(long start, long end, long size, long offset);

  int
  BuildInterRegions(std::vector<long> & inputRegionStart,
                    std::vector<long> & outputRegionStart,
                    std::vector<long> & inputRegionSizes,
                    std::vector<long> & outputRegionSizes,
                    long                inputIndex,
                    long                outputIndex,
                    long                inputSize,
                    long                outputSize,
                    int                 numRegs,
                    int &               regCtr);

  int
  BuildPreRegions(std::vector<long> & inputRegionStart,
                  std::vector<long> & outputRegionStart,
                  std::vector<long> & inputRegionSizes,
                  std::vector<long> & outputRegionSizes,
                  long                inputIndex,
                  long                outputIndex,
                  long                inputSize,
                  long                outputSize,
                  int                 numRegs,
                  int &               regCtr);

  int
  BuildPostRegions(std::vector<long> & inputRegionStart,
                   std::vector<long> & outputRegionStart,
                   std::vector<long> & inputRegionSizes,
                   std::vector<long> & outputRegionSizes,
                   long                inputIndex,
                   long                outputIndex,
                   long                inputSize,
                   long                outputSize,
                   int                 numRegs,
                   int &               regCtr);

  void
  GenerateInputRequestedRegion() override;
 
private:
  double m_DecayBase = 1.0;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMirrorPadImageFilter.hxx"
#endif
 
#endif