OTB  9.0.0
Orfeo Toolbox
otbAtmosphericEffects.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 otbAtmosphericEffects_h
22 #define otbAtmosphericEffects_h
23 
25 
26 namespace otb
27 {
40 template <class TSpectralResponse, class TRSR>
41 class AtmosphericEffects : public itk::DataObject
42 {
43 public:
46  typedef itk::DataObject Superclass;
47  typedef itk::SmartPointer<Self> Pointer;
48  typedef itk::SmartPointer<const Self> ConstPointer;
49 
53  typedef TSpectralResponse InputSpectralResponseType;
54 
58  typedef TRSR InputRSRType;
59 
60  typedef typename InputRSRType::Pointer InputRSRPointerType;
61  typedef typename InputSpectralResponseType::Pointer InputSpectralResponsePointerType;
62 
64  typedef typename InputRSRType::ValuePrecisionType ValuePrecisionType;
65  typedef typename InputSpectralResponseType::PairType PairType;
66 
67 
70 
72  itkNewMacro(Self);
73  itkTypeMacro(AtmosphericEffects, DataObject);
75 
76  itkGetConstObjectMacro(InputSatRSR, InputRSRType);
77  itkSetObjectMacro(InputSatRSR, InputRSRType);
78 
79  itkGetConstObjectMacro(InputSpectralResponse, InputSpectralResponseType);
80  itkSetObjectMacro(InputSpectralResponse, InputSpectralResponseType);
81 
84  {
85  m_AtmosphericRadiativeTerms = atmoRadTerms;
86  this->Modified();
87  }
89  // itkSetObjectMacro(AtmosphericRadiativeTerms, AtmosphericRadiativeTermsType);
91 
92  itkGetObjectMacro(CorrectedSpectralResponse, InputSpectralResponseType);
93 
94 
95  // void LoadFilterFunctionAtmosphericCorrectionParameters( double step = 0.0025);
96  void Process(/*const unsigned int numBand*/);
97 
98 protected:
101 
103  // AtmosphericEffects( const std::string & filename );
104 
106  ~AtmosphericEffects() override = default;;
107 
109  // void PrintSelf(std::ostream& os, itk::Indent indent) const;
110 
111 
112 private:
113  AtmosphericEffects(const Self&) = delete;
114  void operator=(const Self&) = delete;
115 
120 
122 };
123 } // end namespace otb
124 
125 
126 #ifndef OTB_MANUAL_INSTANTIATION
127 #include "otbAtmosphericEffects.hxx"
128 #endif
129 
130 #endif
otb::AtmosphericEffects::AtmosphericEffects
AtmosphericEffects()
Definition: otbAtmosphericEffects.hxx:31
otb::AtmosphericEffects::PrecisionType
InputRSRType::PrecisionType PrecisionType
Definition: otbAtmosphericEffects.h:63
otb::AtmosphericEffects::Superclass
itk::DataObject Superclass
Definition: otbAtmosphericEffects.h:46
otb::AtmosphericRadiativeTerms
This class is a vector of AtmosphericRadiativeTermsSingleChannel, it contains all atmospheric radiati...
Definition: otbAtmosphericRadiativeTerms.h:185
GapFilling::PrecisionType
double PrecisionType
Definition: otbDateUtils.h:29
otb::AtmosphericEffects::InputSpectralResponsePointerType
InputSpectralResponseType::Pointer InputSpectralResponsePointerType
Definition: otbAtmosphericEffects.h:61
otb::AtmosphericEffects::PairType
InputSpectralResponseType::PairType PairType
Definition: otbAtmosphericEffects.h:65
otbRadiometryCorrectionParametersToAtmosphericRadiativeTerms.h
otb::AtmosphericEffects::m_CorrectedSpectralResponse
InputSpectralResponsePointerType m_CorrectedSpectralResponse
Definition: otbAtmosphericEffects.h:118
otb::AtmosphericEffects::m_IsSetAtmosphericRadiativeTerms
bool m_IsSetAtmosphericRadiativeTerms
Definition: otbAtmosphericEffects.h:121
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::AtmosphericEffects::m_InputSatRSR
InputRSRPointerType m_InputSatRSR
Definition: otbAtmosphericEffects.h:119
otb::AtmosphericEffects::Self
AtmosphericEffects Self
Definition: otbAtmosphericEffects.h:45
otb::AtmosphericEffects::~AtmosphericEffects
~AtmosphericEffects() override=default
otb::AtmosphericEffects::itkGetObjectMacro
itkGetObjectMacro(CorrectedSpectralResponse, InputSpectralResponseType)
otb::AtmosphericEffects::SetAtmosphericRadiativeTerms
void SetAtmosphericRadiativeTerms(AtmosphericRadiativeTermsPointerType atmoRadTerms)
Definition: otbAtmosphericEffects.h:83
otb::AtmosphericEffects::ValuePrecisionType
InputRSRType::ValuePrecisionType ValuePrecisionType
Definition: otbAtmosphericEffects.h:64
otb::AtmosphericEffects::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbAtmosphericEffects.h:47
otb::AtmosphericEffects::AtmosphericRadiativeTermsType
otb::AtmosphericRadiativeTerms AtmosphericRadiativeTermsType
Definition: otbAtmosphericEffects.h:68
otb::AtmosphericEffects::InputRSRType
TRSR InputRSRType
Definition: otbAtmosphericEffects.h:58
otb::AtmosphericEffects::AtmosphericRadiativeTermsPointerType
AtmosphericRadiativeTermsType::Pointer AtmosphericRadiativeTermsPointerType
Definition: otbAtmosphericEffects.h:69
otb::AtmosphericEffects::m_InputSpectralResponse
InputSpectralResponsePointerType m_InputSpectralResponse
Definition: otbAtmosphericEffects.h:117
otb::AtmosphericRadiativeTerms::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbAtmosphericRadiativeTerms.h:191
otb::AtmosphericEffects::m_AtmosphericRadiativeTerms
AtmosphericRadiativeTermsPointerType m_AtmosphericRadiativeTerms
Definition: otbAtmosphericEffects.h:116
otb::AtmosphericEffects::Process
void Process()
Definition: otbAtmosphericEffects.hxx:53
otbAtmosphericEffects.hxx
otb::AtmosphericEffects::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbAtmosphericEffects.h:48
otb::AtmosphericEffects::InputSpectralResponseType
TSpectralResponse InputSpectralResponseType
Definition: otbAtmosphericEffects.h:53
otb::AtmosphericEffects
This class applies atmospheric effects, computed from otbAtmosphericCorrectionParametersTo6SRadiative...
Definition: otbAtmosphericEffects.h:41
otb::AtmosphericEffects::operator=
void operator=(const Self &)=delete
otb::AtmosphericEffects::InputRSRPointerType
InputRSRType::Pointer InputRSRPointerType
Definition: otbAtmosphericEffects.h:60