itkTobogganImageFilter.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 itkTobogganImageFilter_h
#define itkTobogganImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkConstNeighborhoodIterator.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage = Image<IdentifierType, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT TobogganImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TobogganImageFilter);

  using Self = TobogganImageFilter;

  using InputImageType = TInputImage;

  static constexpr unsigned int NDimensions = TInputImage::ImageDimension;

  using OutputImageType = TOutputImage;

  using OutputImagePixelType = typename OutputImageType::PixelType;

  using InputImagePixelType = typename InputImageType::PixelType;

  enum
  {
    ImageDimension = InputImageType::ImageDimension
  };

  using RegionType = typename InputImageType::RegionType;
  using SizeType = typename InputImageType::SizeType;
  using IndexType = typename InputImageType::IndexType;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using OutputImagePointer = typename OutputImageType::Pointer;

  using Superclass = ImageToImageFilter<InputImageType, OutputImageType>;

  using ScalarType = typename InputImageType::PixelType;

  using Pointer = SmartPointer<Self>;

  itkOverrideGetNameOfClassMacro(TobogganImageFilter);

  itkNewMacro(Self);

  void
  GenerateData() override;
 
  void
  GenerateInputRequestedRegion() override;
 
  void
  EnlargeOutputRequestedRegion(DataObject *) override;

  using NeighborhoodIteratorType = ConstNeighborhoodIterator<Image<float, 2>>;
 
  itkConceptMacro(LessThanComparableCheck, (Concept::LessThanComparable<InputImagePixelType>));
  itkConceptMacro(OStreamWritableCheck, (Concept::OStreamWritable<InputImagePixelType>));
 
protected:
  TobogganImageFilter() = default;
  ~TobogganImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTobogganImageFilter.hxx"
#endif
 
#endif