OTB  9.0.0
Orfeo Toolbox
otbUnaryFunctorWithIndexImageFilter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 #ifndef otbUnaryFunctorWithIndexImageFilter_h
22 #define otbUnaryFunctorWithIndexImageFilter_h
23 
24 #include "itkImageToImageFilter.h"
25 #include "itkImageRegionConstIteratorWithIndex.h"
26 #include "itkProcessObject.h"
27 
28 namespace otb
29 {
41 template <class TInputImage, class TOutputImage, class TFunction>
42 class ITK_EXPORT UnaryFunctorWithIndexImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
43 {
44 public:
47  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
48  typedef itk::SmartPointer<Self> Pointer;
49  typedef itk::SmartPointer<const Self> ConstPointer;
50 
52  itkNewMacro(Self);
53 
55  itkTypeMacro(UnaryFunctorWithIndexImageFilter, ImageToImageFilter);
56 
58  typedef TFunction FunctorType;
59  typedef typename Superclass::InputImageType InputImageType;
60  typedef typename InputImageType::ConstPointer InputImagePointer;
61  typedef typename InputImageType::RegionType InputImageRegionType;
62  typedef typename InputImageType::PixelType InputImagePixelType;
63  typedef typename InputImageType::SizeType InputImageSizeType;
64  typedef typename InputImageType::IndexType InputImageIndexType;
65  typedef typename Superclass::OutputImageType OutputImageType;
66  typedef typename OutputImageType::Pointer OutputImagePointer;
67  typedef typename OutputImageType::RegionType OutputImageRegionType;
68  typedef typename OutputImageType::PixelType OutputImagePixelType;
69 
70  typedef itk::ProcessObject ProcessObjectType;
71 
77  {
78  this->Modified();
79  return m_Functor;
80  }
82 
87  const FunctorType& GetFunctor() const
88  {
89  return m_Functor;
90  }
91 
98  void SetFunctor(const FunctorType& functor)
99  {
100  m_Functor = functor;
101  this->Modified();
102  }
104 
105  typedef itk::ImageRegionConstIteratorWithIndex<TInputImage> IteratorType;
106 
107 protected:
112 
117  {
118  }
119 
130  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
131 
135  void GenerateInputRequestedRegion(void) override;
136 
137 private:
138  UnaryFunctorWithIndexImageFilter(const Self&) = delete;
139  void operator=(const Self&) = delete;
140 
142 };
143 
144 } // namespace otb
145 
146 #ifndef OTB_MANUAL_INSTANTIATION
148 #endif
149 
150 #endif
otb::UnaryFunctorWithIndexImageFilter::OutputImageType
Superclass::OutputImageType OutputImageType
Definition: otbUnaryFunctorWithIndexImageFilter.h:65
otb::UnaryFunctorWithIndexImageFilter::InputImageIndexType
InputImageType::IndexType InputImageIndexType
Definition: otbUnaryFunctorWithIndexImageFilter.h:64
otb::UnaryFunctorWithIndexImageFilter::Self
UnaryFunctorWithIndexImageFilter Self
Definition: otbUnaryFunctorWithIndexImageFilter.h:46
otb::UnaryFunctorWithIndexImageFilter::FunctorType
TFunction FunctorType
Definition: otbUnaryFunctorWithIndexImageFilter.h:55
otb::UnaryFunctorWithIndexImageFilter::m_Functor
FunctorType m_Functor
Definition: otbUnaryFunctorWithIndexImageFilter.h:141
otb::UnaryFunctorWithIndexImageFilter::~UnaryFunctorWithIndexImageFilter
~UnaryFunctorWithIndexImageFilter() override
Definition: otbUnaryFunctorWithIndexImageFilter.h:116
otb::UnaryFunctorWithIndexImageFilter::IteratorType
itk::ImageRegionConstIteratorWithIndex< TInputImage > IteratorType
Definition: otbUnaryFunctorWithIndexImageFilter.h:105
otb::UnaryFunctorWithIndexImageFilter::ProcessObjectType
itk::ProcessObject ProcessObjectType
Definition: otbUnaryFunctorWithIndexImageFilter.h:70
otb::UnaryFunctorWithIndexImageFilter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbUnaryFunctorWithIndexImageFilter.h:49
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::UnaryFunctorWithIndexImageFilter::InputImageSizeType
InputImageType::SizeType InputImageSizeType
Definition: otbUnaryFunctorWithIndexImageFilter.h:63
otb::UnaryFunctorWithIndexImageFilter::InputImagePixelType
InputImageType::PixelType InputImagePixelType
Definition: otbUnaryFunctorWithIndexImageFilter.h:62
otb::UnaryFunctorWithIndexImageFilter::OutputImageRegionType
OutputImageType::RegionType OutputImageRegionType
Definition: otbUnaryFunctorWithIndexImageFilter.h:67
otbUnaryFunctorWithIndexImageFilter.hxx
otb::UnaryFunctorWithIndexImageFilter
Implements neighborhood-wise generic operation on image.
Definition: otbUnaryFunctorWithIndexImageFilter.h:42
otb::UnaryFunctorWithIndexImageFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbUnaryFunctorWithIndexImageFilter.h:48
otb::UnaryFunctorWithIndexImageFilter::GetFunctor
FunctorType & GetFunctor()
Definition: otbUnaryFunctorWithIndexImageFilter.h:76
otb::UnaryFunctorWithIndexImageFilter::InputImagePointer
InputImageType::ConstPointer InputImagePointer
Definition: otbUnaryFunctorWithIndexImageFilter.h:60
otb::UnaryFunctorWithIndexImageFilter::OutputImagePixelType
OutputImageType::PixelType OutputImagePixelType
Definition: otbUnaryFunctorWithIndexImageFilter.h:68
otb::UnaryFunctorWithIndexImageFilter::SetFunctor
void SetFunctor(const FunctorType &functor)
Definition: otbUnaryFunctorWithIndexImageFilter.h:98
otb::UnaryFunctorWithIndexImageFilter::InputImageType
Superclass::InputImageType InputImageType
Definition: otbUnaryFunctorWithIndexImageFilter.h:59
otb::UnaryFunctorWithIndexImageFilter::Superclass
itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
Definition: otbUnaryFunctorWithIndexImageFilter.h:47
otb::UnaryFunctorWithIndexImageFilter::GetFunctor
const FunctorType & GetFunctor() const
Definition: otbUnaryFunctorWithIndexImageFilter.h:87
otb::UnaryFunctorWithIndexImageFilter::OutputImagePointer
OutputImageType::Pointer OutputImagePointer
Definition: otbUnaryFunctorWithIndexImageFilter.h:66
otb::UnaryFunctorWithIndexImageFilter::InputImageRegionType
InputImageType::RegionType InputImageRegionType
Definition: otbUnaryFunctorWithIndexImageFilter.h:61