OTB  9.0.0
Orfeo Toolbox
otbWrapperInputImageListParameter.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 otbWrapperInputImageListParameter_h
22 #define otbWrapperInputImageListParameter_h
23 
24 
27 
28 
29 namespace otb
30 {
31 
32 
33 namespace Wrapper
34 {
35 
41 class OTBApplicationEngine_EXPORT InputImageListParameter : public ParameterList<InputImageParameter>
42 {
43 public:
47  typedef itk::SmartPointer<Self> Pointer;
48  typedef itk::SmartPointer<const Self> ConstPointer;
49 
51  itkNewMacro(Self);
52 
55 
59  const FloatVectorImageListType* GetImageList() const;
60  FloatVectorImageListType* GetImageList();
62 
64  const FloatVectorImageType* GetNthImage(std::size_t) const;
65  FloatVectorImageType* GetNthImage(std::size_t);
67 
69  void SetNthImage(std::size_t, ImageBaseType*);
70 
72  void SetImageList(FloatVectorImageListType*);
73 
75  void AddImage(ImageBaseType*);
76 
78  void ClearValue() override;
79 
82  Role GetDirection() const override;
83 
86  const std::string& GetFilenameFilter() const override;
87 
88  ParameterType GetType() const override
89  {
91  }
92 
93 protected:
96 
98  ~InputImageListParameter() override;
99 
100  //
101  // Private methods.
102 private:
103  InputImageListParameter(const Parameter&) = delete;
104  void operator=(const Parameter&) = delete;
105 
107 
109 
110  //
111  // Private attributes
112 private:
114 
115 
116 }; // End class InputImage Parameter
117 
118 } // End namespace Wrapper
119 
120 } // End namespace otb
121 
122 #endif
otb::Wrapper::InputImageListParameter::Superclass
ParameterList< InputImageParameter > Superclass
Definition: otbWrapperInputImageListParameter.h:46
otb::Wrapper::ParameterType_InputImageList
@ ParameterType_InputImageList
Definition: otbWrapperTypes.h:49
otb::Wrapper::Parameter
This class represent a parameter for the wrapper framework This class is a high level class represent...
Definition: otbWrapperParameter.h:49
otb::Wrapper::ParameterList
This class represents a InputImage parameter.
Definition: otbWrapperParameterList.h:42
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::Wrapper::StringListInterface::GetDirection
virtual Role GetDirection() const =0
otbWrapperParameterList.h
otb::ObjectList::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbObjectList.h:46
otb::Wrapper::InputImageListParameter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbWrapperInputImageListParameter.h:48
otb::Wrapper::Role
Role
Definition: otbWrapperTypes.h:126
otb::Wrapper::InputImageListParameter
This class represents a list of InputImage parameter.
Definition: otbWrapperInputImageListParameter.h:41
otb::Wrapper::StringListInterface::GetFilenameFilter
virtual const std::string & GetFilenameFilter() const
otb::Wrapper::InputImageListParameter::Self
InputImageListParameter Self
Definition: otbWrapperInputImageListParameter.h:45
otbWrapperInputImageParameter.h
otb::Wrapper::InputImageParameter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWrapperInputImageParameter.h:49
otb::Wrapper::ImageBaseType
itk::ImageBase< 2 > ImageBaseType
Definition: otbWrapperTypes.h:180
otb::Wrapper::InputImageListParameter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWrapperInputImageListParameter.h:47
otb::Wrapper::AbstractParameterList
This class is a base class for list-type parameters.
Definition: otbWrapperAbstractParameterList.h:41
otb::Wrapper::InputImageListParameter::m_ImageList
FloatVectorImageListType::Pointer m_ImageList
Definition: otbWrapperInputImageListParameter.h:113
otb::ObjectList
This class is a generic all-purpose wrapping around an std::vector<itk::SmartPointer<ObjectType> >.
Definition: otbObjectList.h:40
otb::Wrapper::InputImageListParameter::GetType
ParameterType GetType() const override
Definition: otbWrapperInputImageListParameter.h:88
otb::Wrapper::ParameterType
ParameterType
Definition: otbWrapperTypes.h:37
otb::VectorImage
Creation of an "otb" vector image which contains metadata.
Definition: otbVectorImage.h:45