OTB  9.0.0
Orfeo Toolbox
otbDrawPathFilter.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 otbDrawPathFilter_h
22 #define otbDrawPathFilter_h
23 
24 #include "itkImageAndPathToImageFilter.h"
25 
26 namespace otb
27 {
45 template <class TInputImage, class TInputPath, class TOutputImage>
46 class ITK_EXPORT DrawPathFilter : public itk::ImageAndPathToImageFilter<TInputImage, TInputPath, TOutputImage>
47 {
48 public:
51  typedef itk::ImageAndPathToImageFilter<TInputImage, TInputPath, TOutputImage> Superclass;
52  typedef itk::SmartPointer<Self> Pointer;
53  typedef itk::SmartPointer<const Self> ConstPointer;
54 
56  itkNewMacro(Self);
57 
59  itkTypeMacro(DrawPathFilter, itk::ImageAndPathToImageFilter);
60 
62  typedef TInputImage InputImageType;
63  typedef typename InputImageType::Pointer InputImagePointer;
64  typedef typename InputImageType::ConstPointer InputImageConstPointer;
65  typedef typename InputImageType::RegionType InputImageRegionType;
66  typedef typename InputImageType::PixelType InputImagePixelType;
67  typedef TInputPath InputPathType;
68  typedef typename InputPathType::Pointer InputPathPointer;
69  typedef typename InputPathType::ConstPointer InputPathConstPointer;
70  typedef typename InputPathType::InputType InputPathInputType;
71  typedef typename InputPathType::OutputType InputPathOutputType;
72  typedef typename InputPathType::IndexType InputPathIndexType;
73  typedef typename InputPathType::OffsetType InputPathOffsetType;
74  typedef TOutputImage OutputImageType;
75  typedef typename OutputImageType::Pointer OutputImagePointer;
76  typedef typename OutputImageType::ConstPointer OutputImageConstPointer;
77 
78  typedef typename OutputImageType::RegionType OutputImageRegionType;
79  typedef typename OutputImageType::PixelType OutputImagePixelType;
80  typedef typename OutputImageType::ValueType OutputImageValueType;
81 
82  itkSetMacro(Value, OutputImagePixelType);
83  itkGetConstReferenceMacro(Value, OutputImagePixelType);
84 
87  void SetInputPath(const TInputPath* path);
88 
89  const TInputPath* GetInputPath(void);
90 
91 protected:
93  ~DrawPathFilter() override
94  {
95  }
96 
97  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
98  void GenerateData() override;
99 
100 private:
101  DrawPathFilter(const Self&) = delete;
102  void operator=(const Self&) = delete;
103 
105 };
106 
107 } // end namespace otb
108 
109 #ifndef OTB_MANUAL_INSTANTIATION
110 #include "otbDrawPathFilter.hxx"
111 #endif
112 
113 #endif
otb::DrawPathFilter::InputPathPointer
InputPathType::Pointer InputPathPointer
Definition: otbDrawPathFilter.h:68
otb::DrawPathFilter::OutputImageRegionType
OutputImageType::RegionType OutputImageRegionType
Definition: otbDrawPathFilter.h:78
otb::DrawPathFilter::InputPathOutputType
InputPathType::OutputType InputPathOutputType
Definition: otbDrawPathFilter.h:71
otb::DrawPathFilter::OutputImagePointer
OutputImageType::Pointer OutputImagePointer
Definition: otbDrawPathFilter.h:75
otb::DrawPathFilter::InputImageType
TInputImage InputImageType
Definition: otbDrawPathFilter.h:59
otb::DrawPathFilter::InputPathOffsetType
InputPathType::OffsetType InputPathOffsetType
Definition: otbDrawPathFilter.h:73
otb::DrawPathFilter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbDrawPathFilter.h:53
otb::DrawPathFilter::OutputImageConstPointer
OutputImageType::ConstPointer OutputImageConstPointer
Definition: otbDrawPathFilter.h:76
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::DrawPathFilter::InputImagePointer
InputImageType::Pointer InputImagePointer
Definition: otbDrawPathFilter.h:63
otb::DrawPathFilter::InputImageConstPointer
InputImageType::ConstPointer InputImageConstPointer
Definition: otbDrawPathFilter.h:64
otb::DrawPathFilter::OutputImageType
TOutputImage OutputImageType
Definition: otbDrawPathFilter.h:74
otb::DrawPathFilter::InputPathInputType
InputPathType::InputType InputPathInputType
Definition: otbDrawPathFilter.h:70
otb::DrawPathFilter::OutputImageValueType
OutputImageType::ValueType OutputImageValueType
Definition: otbDrawPathFilter.h:80
otb::DrawPathFilter::InputPathConstPointer
InputPathType::ConstPointer InputPathConstPointer
Definition: otbDrawPathFilter.h:69
otb::DrawPathFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbDrawPathFilter.h:52
otb::DrawPathFilter::InputImageRegionType
InputImageType::RegionType InputImageRegionType
Definition: otbDrawPathFilter.h:65
otb::DrawPathFilter::Self
DrawPathFilter Self
Definition: otbDrawPathFilter.h:50
otb::DrawPathFilter
This class can be used to draw a single path on an image.
Definition: otbDrawPathFilter.h:46
otb::DrawPathFilter::InputImagePixelType
InputImageType::PixelType InputImagePixelType
Definition: otbDrawPathFilter.h:66
otb::DrawPathFilter::m_Value
OutputImagePixelType m_Value
Definition: otbDrawPathFilter.h:104
otb::DrawPathFilter::~DrawPathFilter
~DrawPathFilter() override
Definition: otbDrawPathFilter.h:93
otb::DrawPathFilter::OutputImagePixelType
OutputImageType::PixelType OutputImagePixelType
Definition: otbDrawPathFilter.h:79
otb::DrawPathFilter::InputPathIndexType
InputPathType::IndexType InputPathIndexType
Definition: otbDrawPathFilter.h:72
otbDrawPathFilter.hxx
otb::DrawPathFilter::InputPathType
TInputPath InputPathType
Definition: otbDrawPathFilter.h:67
otb::DrawPathFilter::Superclass
itk::ImageAndPathToImageFilter< TInputImage, TInputPath, TOutputImage > Superclass
Definition: otbDrawPathFilter.h:51