Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::AtmosphericCorrectionParameters Class Reference

This class contains all atmospheric correction parameters. More...

#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< SelfPointer
 
typedef
AtmosphericCorrectionParameters 
Self
 
typedef itk::Object Superclass
 
typedef
InternalWavelengthSpectralBandVectorType::Pointer 
WavelengthSpectralBandVectorType
 

Public Member Functions

 AtmosphericCorrectionParameters ()
 
 ~AtmosphericCorrectionParameters ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual std::string GetAeronetFileName ()
 
virtual AerosolModelType GetAerosolModel () const
 
virtual double GetAerosolOptical ()
 
virtual double GetAtmosphericPressure ()
 
virtual const char * GetNameOfClass () const
 
virtual double GetOzoneAmount ()
 
virtual double GetWaterVaporAmount ()
 
void ReadAeronetData (const std::string &file, int year, int month, int day, int hour, int minute, double epsi)
 
virtual void SetAeronetFileName (std::string _arg)
 
virtual void SetAerosolModel (const AerosolModelType _arg)
 
virtual void SetAerosolOptical (double _arg)
 
virtual void SetAtmosphericPressure (double _arg)
 
virtual void SetOzoneAmount (double _arg)
 
virtual void SetWaterVaporAmount (double _arg)
 
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)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

 AtmosphericCorrectionParameters (const Self &)
 
void operator= (const Self &)
 

Private Attributes

std::string m_AeronetFileName
 
AerosolModelType m_AerosolModel
 
double m_AerosolOptical
 
double m_AtmosphericPressure
 
int m_Day
 
int m_Month
 
double m_OzoneAmount
 
double m_WaterVaporAmount
 

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 42 of file otbAtmosphericCorrectionParameters.h.

Member Typedef Documentation

Definition at line 49 of file otbAtmosphericCorrectionParameters.h.

Definition at line 59 of file otbAtmosphericCorrectionParameters.h.

Definition at line 48 of file otbAtmosphericCorrectionParameters.h.

Standard typedefs

Definition at line 46 of file otbAtmosphericCorrectionParameters.h.

Definition at line 47 of file otbAtmosphericCorrectionParameters.h.

Definition at line 60 of file otbAtmosphericCorrectionParameters.h.

Member Enumeration Documentation

Enumerator
NO_AEROSOL 
CONTINENTAL 
MARITIME 
URBAN 
DESERTIC 

Definition at line 57 of file otbAtmosphericCorrectionParameters.h.

Constructor & Destructor Documentation

otb::AtmosphericCorrectionParameters::AtmosphericCorrectionParameters ( )

Constructor

Definition at line 32 of file otbAtmosphericCorrectionParameters.cxx.

otb::AtmosphericCorrectionParameters::~AtmosphericCorrectionParameters ( )
inline

Destructor

Definition at line 136 of file otbAtmosphericCorrectionParameters.h.

otb::AtmosphericCorrectionParameters::AtmosphericCorrectionParameters ( const Self )
private

Member Function Documentation

virtual::itk::LightObject::Pointer otb::AtmosphericCorrectionParameters::CreateAnother ( void  ) const
virtual std::string otb::AtmosphericCorrectionParameters::GetAeronetFileName ( )
virtual
virtual AerosolModelType otb::AtmosphericCorrectionParameters::GetAerosolModel ( ) const
virtual
virtual double otb::AtmosphericCorrectionParameters::GetAerosolOptical ( )
virtual
virtual double otb::AtmosphericCorrectionParameters::GetAtmosphericPressure ( )
virtual
virtual const char* otb::AtmosphericCorrectionParameters::GetNameOfClass ( ) const
virtual

Type macro

Reimplemented from itk::DataObject.

virtual double otb::AtmosphericCorrectionParameters::GetOzoneAmount ( )
virtual
virtual double otb::AtmosphericCorrectionParameters::GetWaterVaporAmount ( )
virtual
static Pointer otb::AtmosphericCorrectionParameters::New ( )
static
void otb::AtmosphericCorrectionParameters::operator= ( const Self )
private
void otb::AtmosphericCorrectionParameters::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

Definition at line 72 of file otbAtmosphericCorrectionParameters.cxx.

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.

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

Get/Set Aeronet file name.

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

Set/Get the aerosol model.

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

Set/Get the aerosol optical.

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

Set/Get the atmospheric pressure.

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

Set/Get the ozone amount.

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

Set/Get the water vapor amount.

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

Get data from aeronet file

Definition at line 49 of file otbAtmosphericCorrectionParameters.cxx.

References otb::AeronetFileReader::New().

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

Definition at line 103 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 107 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 111 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 115 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 119 of file otbAtmosphericCorrectionParameters.h.

Member Data Documentation

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

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

Definition at line 147 of file otbAtmosphericCorrectionParameters.h.

AerosolModelType otb::AtmosphericCorrectionParameters::m_AerosolModel
private

The Aerosol model

Definition at line 159 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_AerosolOptical
private

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

Definition at line 161 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_AtmosphericPressure
private

The Atmospheric pressure

Definition at line 153 of file otbAtmosphericCorrectionParameters.h.

int otb::AtmosphericCorrectionParameters::m_Day
private

Day

Definition at line 149 of file otbAtmosphericCorrectionParameters.h.

int otb::AtmosphericCorrectionParameters::m_Month
private

Month

Definition at line 151 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_OzoneAmount
private

The Ozone amount (Stratospheric ozone layer content)

Definition at line 157 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_WaterVaporAmount
private

The Water vapor amount (Total water vapor content over vertical atmospheric column)

Definition at line 155 of file otbAtmosphericCorrectionParameters.h.


The documentation for this class was generated from the following files: