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

#include <otbAtmosphericRadiativeTerms.h>

+ Inheritance diagram for otb::AtmosphericRadiativeTerms:
+ Collaboration diagram for otb::AtmosphericRadiativeTerms:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef DataVectorType::size_type DataVectorSizeType
 
typedef std::vector< double > DataVectorType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef AtmosphericRadiativeTerms Self
 
typedef itk::DataObject Superclass
 
typedef AtmosphericRadiativeTermsSingleChannel::Pointer ValueType
 
typedef std::vector< ValueType > VectorValueType
 

Public Member Functions

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

Static Public Member Functions

static Pointer New ()
 
VectorValueType m_Values
 
bool m_IsInitialized
 
void SetValues (const VectorValueType &val)
 
VectorValueType & GetValues ()
 
const VectorValueType & GetValues () const
 
void SetIntrinsicAtmosphericReflectances (const DataVectorType &vect)
 
void SetSphericalAlbedos (const DataVectorType &vect)
 
void SetTotalGaseousTransmissions (const DataVectorType &vect)
 
void SetDownwardTransmittances (const DataVectorType &vect)
 
void SetUpwardTransmittances (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittances (const DataVectorType &vect)
 
void SetUpwardDirectTransmittances (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittancesForRayleigh (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittancesForAerosol (const DataVectorType &vect)
 
void SetWavelengthSpectralBand (const DataVectorType &vect)
 
void SetValueByIndex (unsigned int id, const ValueType &val)
 
void SetIntrinsicAtmosphericReflectance (unsigned int id, const double &val)
 
void SetSphericalAlbedo (unsigned int id, const double &val)
 
void SetTotalGaseousTransmission (unsigned int id, const double &val)
 
void SetDownwardTransmittance (unsigned int id, const double &val)
 
void SetUpwardTransmittance (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittance (unsigned int id, const double &val)
 
void SetUpwardDirectTransmittance (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittanceForRayleigh (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittanceForAerosol (unsigned int id, const double &val)
 
void SetWavelengthSpectralBand (unsigned int id, const double &val)
 
DataVectorType GetIntrinsicAtmosphericReflectances () const
 
DataVectorType GetSphericalAlbedos () const
 
DataVectorType GetTotalGaseousTransmissions () const
 
DataVectorType GetDownwardTransmittances () const
 
DataVectorType GetUpwardTransmittances () const
 
DataVectorType GetUpwardDiffuseTransmittances () const
 
DataVectorType GetUpwardDirectTransmittances () const
 
DataVectorType GetUpwardDiffuseTransmittancesForRayleigh () const
 
DataVectorType GetUpwardDiffuseTransmittancesForAerosol () const
 
DataVectorType GetWavelengthSpectralBand () const
 
double GetIntrinsicAtmosphericReflectance (unsigned int id) const
 
double GetSphericalAlbedo (unsigned int id) const
 
double GetTotalGaseousTransmission (unsigned int id) const
 
double GetDownwardTransmittance (unsigned int id) const
 
double GetUpwardTransmittance (unsigned int id) const
 
double GetUpwardDiffuseTransmittance (unsigned int id) const
 
double GetUpwardDirectTransmittance (unsigned int id) const
 
double GetUpwardDiffuseTransmittanceForRayleigh (unsigned int id) const
 
double GetUpwardDiffuseTransmittanceForAerosol (unsigned int id) const
 
double GetWavelengthSpectralBand (unsigned int id) const
 
const ValueType GetValueByIndex (unsigned int id) const
 
void ValuesInitialization (DataVectorSizeType nbChannel)
 
 AtmosphericRadiativeTerms ()
 
 ~AtmosphericRadiativeTerms () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 AtmosphericRadiativeTerms (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

This class is a vector of AtmosphericRadiativeTermsSingleChannel, it contains all atmospheric radiative terms for each studied channel.

Examples
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 185 of file otbAtmosphericRadiativeTerms.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 192 of file otbAtmosphericRadiativeTerms.h.

◆ DataVectorSizeType

typedef DataVectorType::size_type otb::AtmosphericRadiativeTerms::DataVectorSizeType

Definition at line 203 of file otbAtmosphericRadiativeTerms.h.

◆ DataVectorType

typedef std::vector<double> otb::AtmosphericRadiativeTerms::DataVectorType

Definition at line 202 of file otbAtmosphericRadiativeTerms.h.

◆ Pointer

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

Definition at line 191 of file otbAtmosphericRadiativeTerms.h.

◆ Self

typedef AtmosphericRadiativeTerms otb::AtmosphericRadiativeTerms::Self

Standard typedefs

Definition at line 189 of file otbAtmosphericRadiativeTerms.h.

◆ Superclass

typedef itk::DataObject otb::AtmosphericRadiativeTerms::Superclass

Definition at line 190 of file otbAtmosphericRadiativeTerms.h.

◆ ValueType

typedef AtmosphericRadiativeTermsSingleChannel::Pointer otb::AtmosphericRadiativeTerms::ValueType

Definition at line 198 of file otbAtmosphericRadiativeTerms.h.

◆ VectorValueType

typedef std::vector<ValueType> otb::AtmosphericRadiativeTerms::VectorValueType

Definition at line 201 of file otbAtmosphericRadiativeTerms.h.

Constructor & Destructor Documentation

◆ AtmosphericRadiativeTerms() [1/2]

otb::AtmosphericRadiativeTerms::AtmosphericRadiativeTerms ( )
protected

Constructor

◆ ~AtmosphericRadiativeTerms()

otb::AtmosphericRadiativeTerms::~AtmosphericRadiativeTerms ( )
inlineoverrideprotected

Destructor

Definition at line 290 of file otbAtmosphericRadiativeTerms.h.

◆ AtmosphericRadiativeTerms() [2/2]

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

The vector containing each channel information.

Member Function Documentation

◆ CreateAnother()

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

◆ GetDownwardTransmittance()

double otb::AtmosphericRadiativeTerms::GetDownwardTransmittance ( unsigned int  id) const

The vector containing each channel information.

◆ GetDownwardTransmittances()

DataVectorType otb::AtmosphericRadiativeTerms::GetDownwardTransmittances ( ) const

The vector containing each channel information.

◆ GetIntrinsicAtmosphericReflectance()

double otb::AtmosphericRadiativeTerms::GetIntrinsicAtmosphericReflectance ( unsigned int  id) const

Get methods with index.

◆ GetIntrinsicAtmosphericReflectances()

DataVectorType otb::AtmosphericRadiativeTerms::GetIntrinsicAtmosphericReflectances ( ) const

Get methods with vectors.

◆ GetNameOfClass()

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

Type macro

◆ GetSphericalAlbedo()

double otb::AtmosphericRadiativeTerms::GetSphericalAlbedo ( unsigned int  id) const

The vector containing each channel information.

◆ GetSphericalAlbedos()

DataVectorType otb::AtmosphericRadiativeTerms::GetSphericalAlbedos ( ) const

The vector containing each channel information.

◆ GetTotalGaseousTransmission()

double otb::AtmosphericRadiativeTerms::GetTotalGaseousTransmission ( unsigned int  id) const

The vector containing each channel information.

◆ GetTotalGaseousTransmissions()

DataVectorType otb::AtmosphericRadiativeTerms::GetTotalGaseousTransmissions ( ) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittance()

double otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittance ( unsigned int  id) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittanceForAerosol()

double otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittanceForAerosol ( unsigned int  id) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittanceForRayleigh()

double otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittanceForRayleigh ( unsigned int  id) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittances()

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittances ( ) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittancesForAerosol()

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForAerosol ( ) const

The vector containing each channel information.

◆ GetUpwardDiffuseTransmittancesForRayleigh()

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForRayleigh ( ) const

The vector containing each channel information.

◆ GetUpwardDirectTransmittance()

double otb::AtmosphericRadiativeTerms::GetUpwardDirectTransmittance ( unsigned int  id) const

The vector containing each channel information.

◆ GetUpwardDirectTransmittances()

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDirectTransmittances ( ) const

The vector containing each channel information.

◆ GetUpwardTransmittance()

double otb::AtmosphericRadiativeTerms::GetUpwardTransmittance ( unsigned int  id) const

The vector containing each channel information.

◆ GetUpwardTransmittances()

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardTransmittances ( ) const

The vector containing each channel information.

◆ GetValueByIndex()

const ValueType otb::AtmosphericRadiativeTerms::GetValueByIndex ( unsigned int  id) const

The vector containing each channel information.

◆ GetValues() [1/2]

VectorValueType& otb::AtmosphericRadiativeTerms::GetValues ( )
inline

The vector containing each channel information.

Definition at line 212 of file otbAtmosphericRadiativeTerms.h.

◆ GetValues() [2/2]

const VectorValueType& otb::AtmosphericRadiativeTerms::GetValues ( ) const
inline

The vector containing each channel information.

Definition at line 216 of file otbAtmosphericRadiativeTerms.h.

◆ GetWavelengthSpectralBand() [1/2]

DataVectorType otb::AtmosphericRadiativeTerms::GetWavelengthSpectralBand ( ) const

The vector containing each channel information.

◆ GetWavelengthSpectralBand() [2/2]

double otb::AtmosphericRadiativeTerms::GetWavelengthSpectralBand ( unsigned int  id) const

The vector containing each channel information.

◆ New()

static Pointer otb::AtmosphericRadiativeTerms::New ( )
static

Creation through object factory macro

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

◆ operator=()

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

The vector containing each channel information.

◆ PrintSelf()

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

PrintSelf method

◆ SetDownwardTransmittance()

void otb::AtmosphericRadiativeTerms::SetDownwardTransmittance ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetDownwardTransmittances()

void otb::AtmosphericRadiativeTerms::SetDownwardTransmittances ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetIntrinsicAtmosphericReflectance()

void otb::AtmosphericRadiativeTerms::SetIntrinsicAtmosphericReflectance ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetIntrinsicAtmosphericReflectances()

void otb::AtmosphericRadiativeTerms::SetIntrinsicAtmosphericReflectances ( const DataVectorType &  vect)

Set/Get the data classified by channel. Set methods with vectors.

◆ SetSphericalAlbedo()

void otb::AtmosphericRadiativeTerms::SetSphericalAlbedo ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetSphericalAlbedos()

void otb::AtmosphericRadiativeTerms::SetSphericalAlbedos ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetTotalGaseousTransmission()

void otb::AtmosphericRadiativeTerms::SetTotalGaseousTransmission ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetTotalGaseousTransmissions()

void otb::AtmosphericRadiativeTerms::SetTotalGaseousTransmissions ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittance()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittance ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittanceForAerosol()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittanceForAerosol ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittanceForRayleigh()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittanceForRayleigh ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittances()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittances ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittancesForAerosol()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittancesForAerosol ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetUpwardDiffuseTransmittancesForRayleigh()

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittancesForRayleigh ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetUpwardDirectTransmittance()

void otb::AtmosphericRadiativeTerms::SetUpwardDirectTransmittance ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetUpwardDirectTransmittances()

void otb::AtmosphericRadiativeTerms::SetUpwardDirectTransmittances ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetUpwardTransmittance()

void otb::AtmosphericRadiativeTerms::SetUpwardTransmittance ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ SetUpwardTransmittances()

void otb::AtmosphericRadiativeTerms::SetUpwardTransmittances ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetValueByIndex()

void otb::AtmosphericRadiativeTerms::SetValueByIndex ( unsigned int  id,
const ValueType &  val 
)

Set methods with index.

◆ SetValues()

void otb::AtmosphericRadiativeTerms::SetValues ( const VectorValueType &  val)
inline

Set/Get the values.

Definition at line 207 of file otbAtmosphericRadiativeTerms.h.

◆ SetWavelengthSpectralBand() [1/2]

void otb::AtmosphericRadiativeTerms::SetWavelengthSpectralBand ( const DataVectorType &  vect)

The vector containing each channel information.

◆ SetWavelengthSpectralBand() [2/2]

void otb::AtmosphericRadiativeTerms::SetWavelengthSpectralBand ( unsigned int  id,
const double &  val 
)

The vector containing each channel information.

◆ ValuesInitialization()

void otb::AtmosphericRadiativeTerms::ValuesInitialization ( DataVectorSizeType  nbChannel)

Initialization method.

Member Data Documentation

◆ m_IsInitialized

bool otb::AtmosphericRadiativeTerms::m_IsInitialized
private

Boolean to know if m_Values has been initialized.

Definition at line 305 of file otbAtmosphericRadiativeTerms.h.

◆ m_Values

VectorValueType otb::AtmosphericRadiativeTerms::m_Values
private

The vector containing each channel information.

Definition at line 302 of file otbAtmosphericRadiativeTerms.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