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::AtmosphericRadiativeTerms Class Reference

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

#include <otbAtmosphericRadiativeTerms.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::vector< double > DataVectorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef AtmosphericRadiativeTerms Self
 
typedef itk::DataObject Superclass
 
typedef
AtmosphericRadiativeTermsSingleChannel::Pointer 
ValueType
 
typedef std::vector< ValueTypeVectorValueType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
double GetDownwardTransmittance (unsigned int id) const
 
DataVectorType GetDownwardTransmittances () const
 
double GetIntrinsicAtmosphericReflectance (unsigned int id) const
 
DataVectorType GetIntrinsicAtmosphericReflectances () const
 
virtual const char * GetNameOfClass () const
 
double GetSphericalAlbedo (unsigned int id) const
 
DataVectorType GetSphericalAlbedos () const
 
double GetTotalGaseousTransmission (unsigned int id) const
 
DataVectorType GetTotalGaseousTransmissions () const
 
double GetUpwardDiffuseTransmittance (unsigned int id) const
 
double GetUpwardDiffuseTransmittanceForAerosol (unsigned int id) const
 
double GetUpwardDiffuseTransmittanceForRayleigh (unsigned int id) const
 
DataVectorType GetUpwardDiffuseTransmittances () const
 
DataVectorType GetUpwardDiffuseTransmittancesForAerosol () const
 
DataVectorType GetUpwardDiffuseTransmittancesForRayleigh () const
 
double GetUpwardDirectTransmittance (unsigned int id) const
 
DataVectorType GetUpwardDirectTransmittances () const
 
double GetUpwardTransmittance (unsigned int id) const
 
DataVectorType GetUpwardTransmittances () const
 
const ValueType GetValueByIndex (unsigned int id) const
 
VectorValueTypeGetValues ()
 
const VectorValueTypeGetValues () const
 
DataVectorType GetWavelengthSpectralBand () const
 
double GetWavelengthSpectralBand (unsigned int id) const
 
void SetDownwardTransmittance (unsigned int id, const double &val)
 
void SetDownwardTransmittances (const DataVectorType &vect)
 
void SetIntrinsicAtmosphericReflectance (unsigned int id, const double &val)
 
void SetIntrinsicAtmosphericReflectances (const DataVectorType &vect)
 
void SetSphericalAlbedo (unsigned int id, const double &val)
 
void SetSphericalAlbedos (const DataVectorType &vect)
 
void SetTotalGaseousTransmission (unsigned int id, const double &val)
 
void SetTotalGaseousTransmissions (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittance (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittanceForAerosol (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittanceForRayleigh (unsigned int id, const double &val)
 
void SetUpwardDiffuseTransmittances (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittancesForAerosol (const DataVectorType &vect)
 
void SetUpwardDiffuseTransmittancesForRayleigh (const DataVectorType &vect)
 
void SetUpwardDirectTransmittance (unsigned int id, const double &val)
 
void SetUpwardDirectTransmittances (const DataVectorType &vect)
 
void SetUpwardTransmittance (unsigned int id, const double &val)
 
void SetUpwardTransmittances (const DataVectorType &vect)
 
void SetValueByIndex (unsigned int id, const ValueType &val)
 
void SetValues (const VectorValueType &val)
 
void SetWavelengthSpectralBand (const DataVectorType &vect)
 
void SetWavelengthSpectralBand (unsigned int id, const double &val)
 
void ValuesInitialization (unsigned int nbChannel)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

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

Private Member Functions

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

Private Attributes

bool m_IsInitialized
 
VectorValueType m_Values
 

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 163 of file otbAtmosphericRadiativeTerms.h.

Member Typedef Documentation

Definition at line 170 of file otbAtmosphericRadiativeTerms.h.

Definition at line 180 of file otbAtmosphericRadiativeTerms.h.

Definition at line 169 of file otbAtmosphericRadiativeTerms.h.

Standard typedefs

Definition at line 167 of file otbAtmosphericRadiativeTerms.h.

Definition at line 168 of file otbAtmosphericRadiativeTerms.h.

Definition at line 176 of file otbAtmosphericRadiativeTerms.h.

Definition at line 179 of file otbAtmosphericRadiativeTerms.h.

Constructor & Destructor Documentation

otb::AtmosphericRadiativeTerms::AtmosphericRadiativeTerms ( )
protected

Constructor

CONSTRUCTOR.

Definition at line 59 of file otbAtmosphericRadiativeTerms.cxx.

otb::AtmosphericRadiativeTerms::~AtmosphericRadiativeTerms ( )
inlineprotected

Destructor

Definition at line 260 of file otbAtmosphericRadiativeTerms.h.

otb::AtmosphericRadiativeTerms::AtmosphericRadiativeTerms ( const Self )
private

Member Function Documentation

virtual::itk::LightObject::Pointer otb::AtmosphericRadiativeTerms::CreateAnother ( void  ) const
double otb::AtmosphericRadiativeTerms::GetDownwardTransmittance ( unsigned int  id) const

Definition at line 513 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetDownwardTransmittances ( ) const

Definition at line 410 of file otbAtmosphericRadiativeTerms.cxx.

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

Get methods with index.

GET ACCESSORS WITH INDEX.

Definition at line 489 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetIntrinsicAtmosphericReflectances ( ) const

Get methods with vectors.

GET ACCESSORS WITH VECTORS.

Definition at line 377 of file otbAtmosphericRadiativeTerms.cxx.

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

Type macro

Reimplemented from itk::DataObject.

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

Definition at line 497 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetSphericalAlbedos ( ) const

Definition at line 388 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 505 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetTotalGaseousTransmissions ( ) const

Definition at line 399 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 529 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 553 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 545 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittances ( ) const

Definition at line 432 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForAerosol ( ) const

Definition at line 465 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForRayleigh ( ) const

Definition at line 454 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 537 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDirectTransmittances ( ) const

Definition at line 443 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 521 of file otbAtmosphericRadiativeTerms.cxx.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardTransmittances ( ) const

Definition at line 421 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 570 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 189 of file otbAtmosphericRadiativeTerms.h.

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

Definition at line 193 of file otbAtmosphericRadiativeTerms.h.

AtmosphericRadiativeTerms::DataVectorType otb::AtmosphericRadiativeTerms::GetWavelengthSpectralBand ( ) const

Definition at line 476 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 561 of file otbAtmosphericRadiativeTerms.cxx.

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

Creation through object factory macro

Referenced by otb::RadiometryCorrectionParametersToAtmosphericRadiativeTerms::Compute().

void otb::AtmosphericRadiativeTerms::operator= ( const Self )
private
void otb::AtmosphericRadiativeTerms::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

Definition at line 580 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 121 of file otbAtmosphericRadiativeTerms.cxx.

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

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

SET ACCESSORS WITH VECTORS.

Definition at line 80 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 94 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 107 of file otbAtmosphericRadiativeTerms.cxx.

void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittance ( unsigned int  id,
const double &  val 
)
void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittanceForAerosol ( unsigned int  id,
const double &  val 
)
void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittanceForRayleigh ( unsigned int  id,
const double &  val 
)
void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittances ( const DataVectorType vect)

Definition at line 147 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 186 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 173 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 160 of file otbAtmosphericRadiativeTerms.cxx.

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

Definition at line 134 of file otbAtmosphericRadiativeTerms.cxx.

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

Set methods with index.

SET ACCESSORS WITH INDEX.

Definition at line 214 of file otbAtmosphericRadiativeTerms.cxx.

References otb::AtmosphericRadiativeTermsSingleChannel::New().

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

Set/Get the values.

Definition at line 184 of file otbAtmosphericRadiativeTerms.h.

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

Definition at line 199 of file otbAtmosphericRadiativeTerms.cxx.

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

Initialization method.

Definition at line 67 of file otbAtmosphericRadiativeTerms.cxx.

References otb::AtmosphericRadiativeTermsSingleChannel::New().

Member Data Documentation

bool otb::AtmosphericRadiativeTerms::m_IsInitialized
private

Boolean to know if m_Values has been initialized.

Definition at line 271 of file otbAtmosphericRadiativeTerms.h.

VectorValueType otb::AtmosphericRadiativeTerms::m_Values
private

The vector containing each channel information.

Definition at line 269 of file otbAtmosphericRadiativeTerms.h.


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