otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbUnaryFunctorNeighborhoodWithOffsetImageFilter_h
#define otbUnaryFunctorNeighborhoodWithOffsetImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkProcessObject.h"
 
namespace otb
{
template <class TInputImage, class TOutputImage, class TFunction>
class ITK_EXPORT UnaryFunctorNeighborhoodWithOffsetImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef UnaryFunctorNeighborhoodWithOffsetImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(UnaryFunctorNeighborhoodWithOffsetImageFilter, ImageToImageFilter);
 
  typedef TFunction                             FunctorType;
  typedef typename Superclass::InputImageType   InputImageType;
  typedef typename InputImageType::ConstPointer InputImagePointer;
  typedef typename InputImageType::RegionType   InputImageRegionType;
  typedef typename InputImageType::PixelType    InputImagePixelType;
  typedef typename InputImageType::SizeType     InputImageSizeType;
  typedef typename InputImageType::OffsetType   InputImageOffsetType;
  typedef typename Superclass::OutputImageType  OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  OutputImageRegionType;
  typedef typename OutputImageType::PixelType   OutputImagePixelType;
 
  typedef itk::ProcessObject ProcessObjectType;
 
  itkSetMacro(Radius, InputImageSizeType);
  itkGetMacro(Radius, InputImageSizeType);
 
  void SetRadius(unsigned int radius)
  {
    m_Radius.Fill(radius);
  }
 
  virtual void SetOffset(InputImageOffsetType off)
  {
    m_Offset = off;
    this->GetFunctor().SetOffset(off);
    this->Modified();
  }
  itkGetMacro(Offset, InputImageOffsetType);
 
  FunctorType& GetFunctor()
  {
    this->Modified();
    return m_Functor;
  }
 
  const FunctorType& GetFunctor() const
  {
    return m_Functor;
  }
 
  void SetFunctor(const FunctorType& functor)
  {
    m_Functor = functor;
    this->Modified();
  }
 
  typedef itk::ConstNeighborhoodIterator<TInputImage>   NeighborhoodIteratorType;
  typedef typename NeighborhoodIteratorType::RadiusType RadiusType;
  typedef unsigned char                                 RadiusSizeType;
 
protected:
  UnaryFunctorNeighborhoodWithOffsetImageFilter();
 
  ~UnaryFunctorNeighborhoodWithOffsetImageFilter() override
  {
  }
 
  void BeforeThreadedGenerateData() override;
 
  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
  void                     GenerateInputRequestedRegion(void) override;
  std::vector<FunctorType> m_FunctorList;
 
private:
  UnaryFunctorNeighborhoodWithOffsetImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  InputImageSizeType m_Radius;
 
  FunctorType m_Functor;
 
  InputImageOffsetType m_Offset;
};
 
} // namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbUnaryFunctorNeighborhoodWithOffsetImageFilter.hxx"
#endif
 
#endif