OTB  5.0.0
Orfeo Toolbox
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

#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 Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

 AtmosphericCorrectionParameters ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
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 ()
 
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 ()
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

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
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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

otb::AtmosphericCorrectionParameters::~AtmosphericCorrectionParameters ( )
inline

Destructor

Definition at line 143 of file otbAtmosphericCorrectionParameters.h.

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

Member Function Documentation

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

Reimplemented from itk::Object.

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

Get/Set Aeronet file name.

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

Set/Get the aerosol model.

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

Set/Get the aerosol optical.

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

Set/Get the atmospheric pressure.

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

Type macro

Reimplemented from itk::DataObject.

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

Set/Get the ozone amount.

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

Set/Get the water vapor amount.

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

Creation through object factory macro

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.

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 
)
void otb::AtmosphericCorrectionParameters::UpdateAeronetData ( const std::string &  file,
int  year,
int  month,
int  day,
int  hour,
int  minute 
)
inline

Definition at line 109 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 113 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 117 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 121 of file otbAtmosphericCorrectionParameters.h.

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

Definition at line 125 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 154 of file otbAtmosphericCorrectionParameters.h.

AerosolModelType otb::AtmosphericCorrectionParameters::m_AerosolModel
private

The Aerosol model

Definition at line 172 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 175 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_AtmosphericPressure
private

The Atmospheric pressure

Definition at line 163 of file otbAtmosphericCorrectionParameters.h.

int otb::AtmosphericCorrectionParameters::m_Day
private

Day

Definition at line 157 of file otbAtmosphericCorrectionParameters.h.

int otb::AtmosphericCorrectionParameters::m_Month
private

Month

Definition at line 160 of file otbAtmosphericCorrectionParameters.h.

double otb::AtmosphericCorrectionParameters::m_OzoneAmount
private

The Ozone amount (Stratospheric ozone layer content)

Definition at line 169 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 166 of file otbAtmosphericCorrectionParameters.h.


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