Orfeo Toolbox  4.2
Public Types | Static Public Member Functions | List of all members
otb::SIXSTraits Class Reference

SIXSTraits operations. More...

#include <otbSIXSTraits.h>

Public Types

typedef
AtmosphericCorrectionParameters::AerosolModelType 
AerosolModelType
 
typedef SIXSTraits Self
 
typedef
WavelengthSpectralType::ValuesVectorType 
ValuesVectorType
 
typedef
WavelengthSpectralType::WavelengthSpectralBandType 
WavelengthSpectralBandType
 
typedef FilterFunctionValues WavelengthSpectralType
 

Static Public Member Functions

static void ComputeAtmosphericParameters (const double SolarZenithalAngle, const double SolarAzimutalAngle, const double ViewingZenithalAngle, const double ViewingAzimutalAngle, const unsigned int Month, const unsigned int Day, const double AtmosphericPressure, const double WaterVaporAmount, const double OzoneAmount, const AerosolModelType &AerosolModel, const double AerosolOptical, WavelengthSpectralType *WavelengthSpectralBand, double &AtmosphericReflectance, double &AtmosphericSphericalAlbedo, double &TotalGaseousTransmission, double &DownwardTransmittance, double &UpwardTransmittance, double &UpwardDiffuseTransmittance, double &UpwardDirectTransmittance, double &UpwardDiffuseTransmittanceForRayleigh, double &UpwardDiffuseTransmittanceForAerosol)
 
static void ComputeEnvironmentalContribution (const double diffuseTransmittanceForRayleighScattering, const double diffuseTransmittanceForAerosolScattering, const double radiusInKilometers, const double altitude, const double cosineOfViewingAngle, double &rayleighEstimation, double &aerosolEstimation, double &globalEstimation)
 
static void ComputeWavelengthSpectralBandValuesFor6S (const double SIXSStepOfWavelengthSpectralBandValues, WavelengthSpectralType *WavelengthSpectralBand)
 

Detailed Description

SIXSTraits operations.

Call 6S main function. The main method call 6S to calculate atmospheric correction parameters. It use by the OTB Atmospheric correction framework.

Definition at line 35 of file otbSIXSTraits.h.

Member Typedef Documentation

Definition at line 43 of file otbSIXSTraits.h.

Standard class typedefs.

Definition at line 40 of file otbSIXSTraits.h.

Definition at line 45 of file otbSIXSTraits.h.

Definition at line 44 of file otbSIXSTraits.h.

Definition at line 42 of file otbSIXSTraits.h.

Member Function Documentation

void otb::SIXSTraits::ComputeAtmosphericParameters ( const double  SolarZenithalAngle,
const double  SolarAzimutalAngle,
const double  ViewingZenithalAngle,
const double  ViewingAzimutalAngle,
const unsigned int  Month,
const unsigned int  Day,
const double  AtmosphericPressure,
const double  WaterVaporAmount,
const double  OzoneAmount,
const AerosolModelType AerosolModel,
const double  AerosolOptical,
WavelengthSpectralType WavelengthSpectralBand,
double &  AtmosphericReflectance,
double &  AtmosphericSphericalAlbedo,
double &  TotalGaseousTransmission,
double &  DownwardTransmittance,
double &  UpwardTransmittance,
double &  UpwardDiffuseTransmittance,
double &  UpwardDirectTransmittance,
double &  UpwardDiffuseTransmittanceForRayleigh,
double &  UpwardDiffuseTransmittanceForAerosol 
)
static

Call 6S main function

Parameters
SolarAzimutalAngleThe Solar zenithal angle
ViewingZenithalAngleThe Solar azimutal angle
ViewingAzimutalAngleThe Viewing zenithal angle
MonthThe Viewing azimutal angle
DayThe Month
AtmosphericPressureThe Day (in the month)
WaterVaporAmountThe Atmospheric pressure
OzoneAmountThe Water vapor amount (Total water vapor content over vertical atmospheric column)
AerosolModelThe Ozone amount (Stratospheric ozone layer content)
AerosolOpticalThe Aerosol model
WavelengthSpectralBandThe Aerosol optical (radiative impact of aerosol for the reference wavelength 550-nm)
AtmosphericReflectanceWavelength for the spectral band definition Note : The Max wavelength spectral band value must be updated !
AtmosphericSphericalAlbedoAtmospheric reflectance
TotalGaseousTransmissionatmospheric spherical albedo
DownwardTransmittanceTotal gaseous transmission
UpwardTransmittancedownward transmittance
UpwardDiffuseTransmittanceupward transmittance
UpwardDirectTransmittanceupward diffuse transmittance
UpwardDiffuseTransmittanceForRayleighUpward direct transmittance
UpwardDiffuseTransmittanceForAerosolupward diffuse transmittance for rayleigh upward diffuse transmittance for aerosols

Definition at line 30 of file otbSIXSTraits.cxx.

References ComputeWavelengthSpectralBandValuesFor6S(), otb::FilterFunctionValues::GetFilterFunctionValues6S(), otb::FilterFunctionValues::GetMaxSpectralValue(), otb::FilterFunctionValues::GetMinSpectralValue(), NULL, and otbMsgDevMacro.

Referenced by otb::RadiometryCorrectionParametersToAtmosphericRadiativeTerms::Compute(), and otb::AtmosphericCorrectionParametersTo6SAtmosphericRadiativeTerms::GenerateData().

void otb::SIXSTraits::ComputeEnvironmentalContribution ( const double  diffuseTransmittanceForRayleighScattering,
const double  diffuseTransmittanceForAerosolScattering,
const double  radiusInKilometers,
const double  altitude,
const double  cosineOfViewingAngle,
double &  rayleighEstimation,
double &  aerosolEstimation,
double &  globalEstimation 
)
static
void otb::SIXSTraits::ComputeWavelengthSpectralBandValuesFor6S ( const double  SIXSStepOfWavelengthSpectralBandValues,
WavelengthSpectralType WavelengthSpectralBand 
)
static

Check the correpondance between the vector value size and the interval number between min and max. If the vector step is not at 0.0025, the new values are computed. The output vector values is store in the m_FilterFunctionValues6S of WavelengthSpectralBand

Definition at line 155 of file otbSIXSTraits.cxx.

References otb::FilterFunctionValues::GetFilterFunctionValues(), otb::FilterFunctionValues::GetMaxSpectralValue(), otb::FilterFunctionValues::GetMinSpectralValue(), otb::FilterFunctionValues::GetUserStep(), otb::FilterFunctionValues::SetFilterFunctionValues6S(), and otb::FilterFunctionValues::SetMaxSpectralValue().

Referenced by ComputeAtmosphericParameters().


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

Generated at Sat Aug 23 2014 19:04:14 for Orfeo Toolbox with doxygen 1.8.3.1