OTB  9.0.0
Orfeo Toolbox
otbFilterFunctionValues.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 otbFilterFunctionValues_h
22 #define otbFilterFunctionValues_h
23 
24 #include <vector>
25 
26 #include "itkDataObject.h"
27 #include "itkObjectFactory.h"
28 #include "itkMacro.h"
29 
30 #include "OTBMetadataExport.h"
31 
32 namespace otb
33 {
44 class OTBMetadata_EXPORT FilterFunctionValues : public itk::DataObject
45 {
46 public:
49  typedef itk::DataObject Superclass;
50  typedef itk::SmartPointer<Self> Pointer;
51  typedef itk::SmartPointer<const Self> ConstPointer;
52 
54  itkTypeMacro(FilterFunctionValues, DataObject);
55 
57  itkNewMacro(Self);
58 
59  typedef float WavelengthSpectralBandType;
60  typedef std::vector<WavelengthSpectralBandType> ValuesVectorType;
61 
64  {
65  m_FilterFunctionValues = vect;
66  this->Modified();
67  }
68 
71  {
72  return m_FilterFunctionValues;
73  }
74 
77  {
78  m_FilterFunctionValues6S = vect;
79  this->Modified();
80  }
81 
84  {
85  return m_FilterFunctionValues6S;
86  }
87 
89  itkSetMacro(MinSpectralValue, WavelengthSpectralBandType);
90 
92  itkGetMacro(MinSpectralValue, WavelengthSpectralBandType);
93 
95  itkSetMacro(MaxSpectralValue, WavelengthSpectralBandType);
96 
98  itkGetMacro(MaxSpectralValue, WavelengthSpectralBandType);
99 
101  itkSetMacro(UserStep, WavelengthSpectralBandType);
102 
104  itkGetMacro(UserStep, WavelengthSpectralBandType);
105 
107  WavelengthSpectralBandType GetCenterSpectralValue() const;
108 
109 protected:
112 
115  {
116  }
117 
119  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
120 
121 private:
122  FilterFunctionValues(const Self&) = delete;
123  void operator=(const Self&) = delete;
124 
127 
132 
135 
138 
141 };
142 
143 } // end namespace
144 
145 #endif
otb::FilterFunctionValues::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbFilterFunctionValues.h:50
otb::FilterFunctionValues::GetFilterFunctionValues
const ValuesVectorType & GetFilterFunctionValues() const
Definition: otbFilterFunctionValues.h:70
otb::FilterFunctionValues::SetFilterFunctionValues6S
void SetFilterFunctionValues6S(const ValuesVectorType &vect)
Definition: otbFilterFunctionValues.h:76
otb::FilterFunctionValues::GetFilterFunctionValues6S
const ValuesVectorType & GetFilterFunctionValues6S() const
Definition: otbFilterFunctionValues.h:83
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::FilterFunctionValues::m_MaxSpectralValue
WavelengthSpectralBandType m_MaxSpectralValue
Definition: otbFilterFunctionValues.h:137
otb::FilterFunctionValues::Superclass
itk::DataObject Superclass
Definition: otbFilterFunctionValues.h:49
otb::FilterFunctionValues::m_UserStep
WavelengthSpectralBandType m_UserStep
Definition: otbFilterFunctionValues.h:140
otb::FilterFunctionValues
This class contains the values of the filter function for the processed spectral band.
Definition: otbFilterFunctionValues.h:44
otb::FilterFunctionValues::~FilterFunctionValues
~FilterFunctionValues() override
Definition: otbFilterFunctionValues.h:114
otb::FilterFunctionValues::WavelengthSpectralBandType
float WavelengthSpectralBandType
Definition: otbFilterFunctionValues.h:57
otb::FilterFunctionValues::m_FilterFunctionValues6S
ValuesVectorType m_FilterFunctionValues6S
Definition: otbFilterFunctionValues.h:131
otb::FilterFunctionValues::SetFilterFunctionValues
void SetFilterFunctionValues(const ValuesVectorType &vect)
Definition: otbFilterFunctionValues.h:63
otb::FilterFunctionValues::m_MinSpectralValue
WavelengthSpectralBandType m_MinSpectralValue
Definition: otbFilterFunctionValues.h:134
otb::FilterFunctionValues::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbFilterFunctionValues.h:51
otb::FilterFunctionValues::Self
FilterFunctionValues Self
Definition: otbFilterFunctionValues.h:48
otb::FilterFunctionValues::m_FilterFunctionValues
ValuesVectorType m_FilterFunctionValues
Definition: otbFilterFunctionValues.h:126
otb::FilterFunctionValues::ValuesVectorType
std::vector< WavelengthSpectralBandType > ValuesVectorType
Definition: otbFilterFunctionValues.h:60