OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::AtmosphericCorrectionParameters Class Reference
Thematic modules » Radiometry modulesGroup Core » | Module OTBOpticalCalibration

#include <otbAtmosphericCorrectionParameters.h>

+ Inheritance diagram for otb::AtmosphericCorrectionParameters:
+ Collaboration diagram for otb::AtmosphericCorrectionParameters:

Public Types

enum  AerosolModelType {
  NO_AEROSOL = 0,
  CONTINENTAL = 1,
  MARITIME = 2,
  URBAN = 3,
  DESERTIC = 4
}
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef ObjectList< FilterFunctionValues > InternalWavelengthSpectralBandVectorType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef AtmosphericCorrectionParameters Self
 
typedef itk::Object Superclass
 
typedef InternalWavelengthSpectralBandVectorType::Pointer WavelengthSpectralBandVectorType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
std::string m_AeronetFileName
 
int m_Day
 
int m_Month
 
double m_AtmosphericPressure
 
double m_WaterVaporAmount
 
double m_OzoneAmount
 
AerosolModelType m_AerosolModel
 
double m_AerosolOptical
 
virtual void SetAtmosphericPressure (double _arg)
 
virtual double GetAtmosphericPressure ()
 
virtual void SetWaterVaporAmount (double _arg)
 
virtual double GetWaterVaporAmount ()
 
virtual void SetOzoneAmount (double _arg)
 
virtual double GetOzoneAmount ()
 
virtual void SetAerosolModel (const AerosolModelType _arg)
 
virtual AerosolModelType GetAerosolModel () const
 
virtual void SetAerosolOptical (double _arg)
 
virtual double GetAerosolOptical ()
 
virtual void SetAeronetFileName (std::string _arg)
 
virtual std::string GetAeronetFileName ()
 
void ReadAeronetData (const std::string &file, int year, int month, int day, int hour, int minute, double epsi)
 
void UpdateAeronetData (const std::string &file, int year, int month, int day, int hour, int minute, double epsi)
 
void UpdateAeronetData (const std::string &file, int year, int month, int day, int hour, int minute)
 
void UpdateAeronetData (int year, int month, int day, int hour, int minute, double epsi)
 
void UpdateAeronetData (int year, int month, int day, int hour, int minute)
 
void UpdateAeronetData (const std::string &file, int year, int hour, int minute)
 
void UpdateAeronetData (int year, int hour, int minute)
 
 AtmosphericCorrectionParameters ()
 
 ~AtmosphericCorrectionParameters () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 AtmosphericCorrectionParameters (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

This class contains all atmospheric correction parameters.

Each value can be read in the metadata of an image (ex: SPOT5, ...) or directly set by the user.

Examples
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 46 of file otbAtmosphericCorrectionParameters.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> otb::AtmosphericCorrectionParameters::ConstPointer

Definition at line 53 of file otbAtmosphericCorrectionParameters.h.

◆ InternalWavelengthSpectralBandVectorType

typedef ObjectList<FilterFunctionValues> otb::AtmosphericCorrectionParameters::InternalWavelengthSpectralBandVectorType

Definition at line 63 of file otbAtmosphericCorrectionParameters.h.

◆ Pointer

typedef itk::SmartPointer<Self> otb::AtmosphericCorrectionParameters::Pointer

Definition at line 52 of file otbAtmosphericCorrectionParameters.h.

◆ Self

typedef AtmosphericCorrectionParameters otb::AtmosphericCorrectionParameters::Self

Standard typedefs

Definition at line 50 of file otbAtmosphericCorrectionParameters.h.

◆ Superclass

typedef itk::Object otb::AtmosphericCorrectionParameters::Superclass

Definition at line 51 of file otbAtmosphericCorrectionParameters.h.

◆ WavelengthSpectralBandVectorType

typedef InternalWavelengthSpectralBandVectorType::Pointer otb::AtmosphericCorrectionParameters::WavelengthSpectralBandVectorType

Definition at line 64 of file otbAtmosphericCorrectionParameters.h.

Member Enumeration Documentation

◆ AerosolModelType

enum otb::AtmosphericCorrectionParameters::AerosolModelType
Enumerator
NO_AEROSOL 
CONTINENTAL 
MARITIME 
URBAN 
DESERTIC 

Definition at line 61 of file otbAtmosphericCorrectionParameters.h.

Constructor & Destructor Documentation

◆ AtmosphericCorrectionParameters() [1/2]

otb::AtmosphericCorrectionParameters::AtmosphericCorrectionParameters ( )

Constructor

◆ ~AtmosphericCorrectionParameters()

otb::AtmosphericCorrectionParameters::~AtmosphericCorrectionParameters ( )
inlineoverride

Destructor

Definition at line 147 of file otbAtmosphericCorrectionParameters.h.

◆ AtmosphericCorrectionParameters() [2/2]

otb::AtmosphericCorrectionParameters::AtmosphericCorrectionParameters ( const Self &  )
privatedelete

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer otb::AtmosphericCorrectionParameters::CreateAnother ( void  ) const

◆ GetAeronetFileName()

virtual std::string otb::AtmosphericCorrectionParameters::GetAeronetFileName ( )
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ GetAerosolModel()

virtual AerosolModelType otb::AtmosphericCorrectionParameters::GetAerosolModel ( ) const
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ GetAerosolOptical()

virtual double otb::AtmosphericCorrectionParameters::GetAerosolOptical ( )
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ GetAtmosphericPressure()

virtual double otb::AtmosphericCorrectionParameters::GetAtmosphericPressure ( )
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ GetNameOfClass()

virtual const char* otb::AtmosphericCorrectionParameters::GetNameOfClass ( ) const
virtual

Type macro

◆ GetOzoneAmount()

virtual double otb::AtmosphericCorrectionParameters::GetOzoneAmount ( )
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ GetWaterVaporAmount()

virtual double otb::AtmosphericCorrectionParameters::GetWaterVaporAmount ( )
virtual

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ New()

static Pointer otb::AtmosphericCorrectionParameters::New ( )
static

Creation through object factory macro

Referenced by otb::ReflectanceToSurfaceReflectanceImageFilter< TInputImage, TOutputImage >::ReflectanceToSurfaceReflectanceImageFilter(), otb::SurfaceAdjacencyEffectCorrectionSchemeFilter< TInputImage, TOutputImage >::SurfaceAdjacencyEffectCorrectionSchemeFilter(), and otb::SurfaceReflectanceToReflectanceFilter< TInputImage, TOutputImage >::SurfaceReflectanceToReflectanceFilter().

◆ operator=()

void otb::AtmosphericCorrectionParameters::operator= ( const Self &  )
privatedelete

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ PrintSelf()

void otb::AtmosphericCorrectionParameters::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

◆ ReadAeronetData()

void otb::AtmosphericCorrectionParameters::ReadAeronetData ( const std::string &  file,
int  year,
int  month,
int  day,
int  hour,
int  minute,
double  epsi 
)

Read the aeronet data and extract aerosol optical and water vapor amount.

◆ SetAeronetFileName()

virtual void otb::AtmosphericCorrectionParameters::SetAeronetFileName ( std::string  _arg)
virtual

Get/Set Aeronet file name.

◆ SetAerosolModel()

virtual void otb::AtmosphericCorrectionParameters::SetAerosolModel ( const AerosolModelType  _arg)
virtual

Set/Get the aerosol model.

◆ SetAerosolOptical()

virtual void otb::AtmosphericCorrectionParameters::SetAerosolOptical ( double  _arg)
virtual

Set/Get the aerosol optical.

◆ SetAtmosphericPressure()

virtual void otb::AtmosphericCorrectionParameters::SetAtmosphericPressure ( double  _arg)
virtual

Set/Get the atmospheric pressure.

◆ SetOzoneAmount()

virtual void otb::AtmosphericCorrectionParameters::SetOzoneAmount ( double  _arg)
virtual

Set/Get the ozone amount.

◆ SetWaterVaporAmount()

virtual void otb::AtmosphericCorrectionParameters::SetWaterVaporAmount ( double  _arg)
virtual

Set/Get the water vapor amount.

◆ UpdateAeronetData() [1/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( const std::string &  file,
int  year,
int  hour,
int  minute 
)
inline

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 125 of file otbAtmosphericCorrectionParameters.h.

◆ UpdateAeronetData() [2/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( const std::string &  file,
int  year,
int  month,
int  day,
int  hour,
int  minute 
)
inline

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 113 of file otbAtmosphericCorrectionParameters.h.

◆ UpdateAeronetData() [3/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( const std::string &  file,
int  year,
int  month,
int  day,
int  hour,
int  minute,
double  epsi 
)

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

◆ UpdateAeronetData() [4/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( int  year,
int  hour,
int  minute 
)
inline

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 129 of file otbAtmosphericCorrectionParameters.h.

◆ UpdateAeronetData() [5/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( int  year,
int  month,
int  day,
int  hour,
int  minute 
)
inline

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 121 of file otbAtmosphericCorrectionParameters.h.

◆ UpdateAeronetData() [6/6]

void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( int  year,
int  month,
int  day,
int  hour,
int  minute,
double  epsi 
)
inline

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 117 of file otbAtmosphericCorrectionParameters.h.

Member Data Documentation

◆ m_AeronetFileName

std::string otb::AtmosphericCorrectionParameters::m_AeronetFileName
private

Path to an Aeronet data file, allows computing aerosol optical and water vapor amounts.

Definition at line 159 of file otbAtmosphericCorrectionParameters.h.

◆ m_AerosolModel

AerosolModelType otb::AtmosphericCorrectionParameters::m_AerosolModel
private

The Aerosol model

Definition at line 177 of file otbAtmosphericCorrectionParameters.h.

◆ m_AerosolOptical

double otb::AtmosphericCorrectionParameters::m_AerosolOptical
private

The Aerosol optical (radiative impact of aerosol for the reference wavelength 550-nm)

Definition at line 180 of file otbAtmosphericCorrectionParameters.h.

◆ m_AtmosphericPressure

double otb::AtmosphericCorrectionParameters::m_AtmosphericPressure
private

The Atmospheric pressure (hPa

Definition at line 168 of file otbAtmosphericCorrectionParameters.h.

◆ m_Day

int otb::AtmosphericCorrectionParameters::m_Day
private

Day

Definition at line 162 of file otbAtmosphericCorrectionParameters.h.

◆ m_Month

int otb::AtmosphericCorrectionParameters::m_Month
private

Month

Definition at line 165 of file otbAtmosphericCorrectionParameters.h.

◆ m_OzoneAmount

double otb::AtmosphericCorrectionParameters::m_OzoneAmount
private

The Ozone amount (Stratospheric ozone layer content, in cm-atm)

Definition at line 174 of file otbAtmosphericCorrectionParameters.h.

◆ m_WaterVaporAmount

double otb::AtmosphericCorrectionParameters::m_WaterVaporAmount
private

The Water vapor amount (Total water vapor content over vertical atmospheric column, g/cm2)

Definition at line 171 of file otbAtmosphericCorrectionParameters.h.

The documentation for this class was generated from the following file:
Generated at Wed Feb 28 2024 15:24:54 for OTB with   doxygen 1.8.17