OTB  9.0.0
Orfeo Toolbox
otbDrawPathListFilter.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 otbDrawPathListFilter_h
22 #define otbDrawPathListFilter_h
23 
24 #include "itkImageToImageFilter.h"
25 #include "otbObjectList.h"
26 
27 namespace otb
28 {
49 template <class TInputImage, class TInputPath, class TOutputImage>
50 class ITK_EXPORT DrawPathListFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
51 {
52 public:
55  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
56  typedef itk::SmartPointer<Self> Pointer;
57  typedef itk::SmartPointer<const Self> ConstPointer;
58 
60  itkNewMacro(Self);
61 
63  itkTypeMacro(DrawPathListFilter, ImageToImageFilter);
64 
66  typedef TInputImage InputImageType;
67  typedef typename InputImageType::Pointer InputImagePointerType;
68  typedef typename InputImageType::ConstPointer InputImageConstPointerType;
69  typedef typename InputImageType::RegionType InputImageRegionType;
70  typedef typename InputImageType::PixelType InputImagePixelType;
71  typedef typename InputImageType::SizeType InputImageSizeType;
72  typedef typename InputImageType::ValueType InputImageValueType;
73 
74  typedef TInputPath InputPathType;
75  typedef typename InputPathType::Pointer InputPathPointerType;
79 
80  typedef TOutputImage OutputImageType;
81  typedef typename OutputImageType::Pointer OutputImagePointerType;
82  typedef typename OutputImageType::ConstPointer OutputImageConstPointerType;
83  typedef typename OutputImageType::RegionType OutputImageRegionType;
84  typedef typename OutputImageType::PixelType OutputImagePixelType;
85  typedef typename OutputImageType::SizeType OutputImageSizeType;
86  typedef typename OutputImageType::ValueType OutputImageValueType;
87  typedef typename OutputImageType::IndexType OutputImageIndexType;
88 
89  typedef itk::ProcessObject ProcessObjectType;
90 
91  itkGetMacro(UseInternalPathValue, bool);
92  itkSetMacro(UseInternalPathValue, bool);
93  itkBooleanMacro(UseInternalPathValue);
94 
95  itkGetMacro(AddValue, bool);
96  itkSetMacro(AddValue, bool);
97  itkBooleanMacro(AddValue);
98 
99  itkSetMacro(PathValue, OutputImagePixelType);
100  itkGetMacro(PathValue, OutputImagePixelType);
101 
103  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
104 
106  virtual void SetInputPath(InputPathListType* path);
107  const InputPathListType* GetInputPath(void);
109 
110 protected:
113 
116  {
117  }
118 
120  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
121 
123  void GenerateData() override;
124 
125 private:
126  DrawPathListFilter(const Self&) = delete;
127  void operator=(const Self&) = delete;
128 
131 
134 
136 };
137 
138 } // end namespace otb
139 
140 #ifndef OTB_MANUAL_INSTANTIATION
141 #include "otbDrawPathListFilter.hxx"
142 #endif
143 
144 #endif
otb::DrawPathListFilter::InputImageSizeType
InputImageType::SizeType InputImageSizeType
Definition: otbDrawPathListFilter.h:71
otb::DrawPathListFilter::InputImageType
TInputImage InputImageType
Definition: otbDrawPathListFilter.h:63
otb::DrawPathListFilter::InputPathListType
otb::ObjectList< InputPathType > InputPathListType
Definition: otbDrawPathListFilter.h:76
otb::DrawPathListFilter::OutputImageType
TOutputImage OutputImageType
Definition: otbDrawPathListFilter.h:80
otb::DrawPathListFilter::m_PathValue
OutputImagePixelType m_PathValue
Definition: otbDrawPathListFilter.h:130
otb::DrawPathListFilter::InputImageRegionType
InputImageType::RegionType InputImageRegionType
Definition: otbDrawPathListFilter.h:69
otb::DrawPathListFilter::InputImageValueType
InputImageType::ValueType InputImageValueType
Definition: otbDrawPathListFilter.h:72
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::DrawPathListFilter::OutputImageValueType
OutputImageType::ValueType OutputImageValueType
Definition: otbDrawPathListFilter.h:86
otb::DrawPathListFilter::InputPathType
TInputPath InputPathType
Definition: otbDrawPathListFilter.h:74
otb::DrawPathListFilter::~DrawPathListFilter
~DrawPathListFilter() override
Definition: otbDrawPathListFilter.h:115
otb::DrawPathListFilter::InputImageConstPointerType
InputImageType::ConstPointer InputImageConstPointerType
Definition: otbDrawPathListFilter.h:68
otb::DrawPathListFilter::Superclass
itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
Definition: otbDrawPathListFilter.h:55
otb::ObjectList::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbObjectList.h:46
otb::DrawPathListFilter::InputImagePointerType
InputImageType::Pointer InputImagePointerType
Definition: otbDrawPathListFilter.h:67
otb::DrawPathListFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbDrawPathListFilter.h:56
otb::DrawPathListFilter::OutputImagePixelType
OutputImageType::PixelType OutputImagePixelType
Definition: otbDrawPathListFilter.h:84
otb::DrawPathListFilter::InputPathListPointerType
InputPathListType::Pointer InputPathListPointerType
Definition: otbDrawPathListFilter.h:78
otb::DrawPathListFilter::InputPathPointerType
InputPathType::Pointer InputPathPointerType
Definition: otbDrawPathListFilter.h:75
otbObjectList.h
otbDrawPathListFilter.hxx
otb::DrawPathListFilter::m_AddValue
bool m_AddValue
Definition: otbDrawPathListFilter.h:135
otb::DrawPathListFilter::OutputImageIndexType
OutputImageType::IndexType OutputImageIndexType
Definition: otbDrawPathListFilter.h:87
otb::DrawPathListFilter::m_UseInternalPathValue
bool m_UseInternalPathValue
Definition: otbDrawPathListFilter.h:133
otb::DrawPathListFilter::InputPathListConstPointerType
InputPathListType::ConstPointer InputPathListConstPointerType
Definition: otbDrawPathListFilter.h:77
otb::DrawPathListFilter::OutputImagePointerType
OutputImageType::Pointer OutputImagePointerType
Definition: otbDrawPathListFilter.h:81
otb::DrawPathListFilter::OutputImageConstPointerType
OutputImageType::ConstPointer OutputImageConstPointerType
Definition: otbDrawPathListFilter.h:82
otb::DrawPathListFilter::OutputImageRegionType
OutputImageType::RegionType OutputImageRegionType
Definition: otbDrawPathListFilter.h:83
otb::DrawPathListFilter
This class can be used to draw a list of path on an image.
Definition: otbDrawPathListFilter.h:50
otb::DrawPathListFilter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbDrawPathListFilter.h:57
otb::ObjectList::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbObjectList.h:47
otb::DrawPathListFilter::OutputImageSizeType
OutputImageType::SizeType OutputImageSizeType
Definition: otbDrawPathListFilter.h:85
otb::DrawPathListFilter::ProcessObjectType
itk::ProcessObject ProcessObjectType
Definition: otbDrawPathListFilter.h:89
otb::ObjectList
This class is a generic all-purpose wrapping around an std::vector<itk::SmartPointer<ObjectType> >.
Definition: otbObjectList.h:40
otb::DrawPathListFilter::InputImagePixelType
InputImageType::PixelType InputImagePixelType
Definition: otbDrawPathListFilter.h:70
otb::DrawPathListFilter::Self
DrawPathListFilter Self
Definition: otbDrawPathListFilter.h:54