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

#include <otbAtmosphericRadiativeTerms.h>

+ Inheritance diagram for otb::AtmosphericRadiativeTermsSingleChannel:
+ Collaboration diagram for otb::AtmosphericRadiativeTermsSingleChannel:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef
AtmosphericRadiativeTermsSingleChannel 
Self
 
typedef itk::DataObject Superclass
 
- 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

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual double GetSphericalAlbedo ()
 
virtual void SetSphericalAlbedo (double _arg)
 
virtual void SetIntrinsicAtmosphericReflectance (double _arg)
 
virtual double GetIntrinsicAtmosphericReflectance ()
 
virtual void SetTotalGaseousTransmission (double _arg)
 
virtual double GetTotalGaseousTransmission ()
 
virtual void SetDownwardTransmittance (double _arg)
 
virtual double GetDownwardTransmittance ()
 
virtual void SetUpwardTransmittance (double _arg)
 
virtual double GetUpwardTransmittance ()
 
virtual void SetUpwardDiffuseTransmittance (double _arg)
 
virtual double GetUpwardDiffuseTransmittance ()
 
virtual void SetUpwardDirectTransmittance (double _arg)
 
virtual double GetUpwardDirectTransmittance ()
 
virtual void SetUpwardDiffuseTransmittanceForRayleigh (double _arg)
 
virtual double GetUpwardDiffuseTransmittanceForRayleigh ()
 
virtual void SetUpwardDiffuseTransmittanceForAerosol (double _arg)
 
virtual double GetUpwardDiffuseTransmittanceForAerosol ()
 
virtual void SetWavelengthSpectralBand (double _arg)
 
virtual double GetWavelengthSpectralBand ()
 
- 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

 AtmosphericRadiativeTermsSingleChannel ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 ~AtmosphericRadiativeTermsSingleChannel ()
 
- 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

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

Private Attributes

double m_DownwardTransmittance
 
double m_IntrinsicAtmosphericReflectance
 
double m_SphericalAlbedo
 
double m_TotalGaseousTransmission
 
double m_UpwardDiffuseTransmittance
 
double m_UpwardDiffuseTransmittanceForAerosol
 
double m_UpwardDiffuseTransmittanceForRayleigh
 
double m_UpwardDirectTransmittance
 
double m_UpwardTransmittance
 
double m_WavelengthSpectralBand
 

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 radiative terms for one channel.

Each value can be deducted from the atmospheric correction parameters (using 6S) or directly set by the user.

Definition at line 40 of file otbAtmosphericRadiativeTerms.h.

Member Typedef Documentation

Definition at line 47 of file otbAtmosphericRadiativeTerms.h.

Definition at line 46 of file otbAtmosphericRadiativeTerms.h.

Standard typedefs

Definition at line 44 of file otbAtmosphericRadiativeTerms.h.

Definition at line 45 of file otbAtmosphericRadiativeTerms.h.

Constructor & Destructor Documentation

otb::AtmosphericRadiativeTermsSingleChannel::AtmosphericRadiativeTermsSingleChannel ( )
protected

Constructor

otb::AtmosphericRadiativeTermsSingleChannel::~AtmosphericRadiativeTermsSingleChannel ( )
inlineprotected

Destructor

Definition at line 129 of file otbAtmosphericRadiativeTerms.h.

otb::AtmosphericRadiativeTermsSingleChannel::AtmosphericRadiativeTermsSingleChannel ( const Self )
private

Member Function Documentation

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

Reimplemented from itk::Object.

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetDownwardTransmittance ( )
virtual

Set/Get the downward transmittance of the atmosphere.

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetIntrinsicAtmosphericReflectance ( )
virtual

Set/Get the intrinsic atmospheric reflectance.

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

Type macro

Reimplemented from itk::DataObject.

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetSphericalAlbedo ( )
virtual
virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetTotalGaseousTransmission ( )
virtual

Set/Get the total gaseous transmission.

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetUpwardDiffuseTransmittance ( )
virtual

Set/Get the upward diffuse transmittance

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetUpwardDiffuseTransmittanceForAerosol ( )
virtual

Set/Get the upward diffuse transmittance for aerosols

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetUpwardDiffuseTransmittanceForRayleigh ( )
virtual

Set/Get the upward diffuse transmittance for rayleigh

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetUpwardDirectTransmittance ( )
virtual

Set/Get the upward direct transmittance

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetUpwardTransmittance ( )
virtual

Set/Get the upward transmittance of the atmosphere.

virtual double otb::AtmosphericRadiativeTermsSingleChannel::GetWavelengthSpectralBand ( )
virtual

Set/Get the wavelength

static Pointer otb::AtmosphericRadiativeTermsSingleChannel::New ( )
static

Creation through object factory macro

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

PrintSelf method

Reimplemented from itk::DataObject.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetDownwardTransmittance ( double  _arg)
virtual

Set/Get the downward transmittance of the atmosphere.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetIntrinsicAtmosphericReflectance ( double  _arg)
virtual

Set/Get the intrinsic atmospheric reflectance.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetSphericalAlbedo ( double  _arg)
virtual

Set/Get the spherical albedo of the atmosphere.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetTotalGaseousTransmission ( double  _arg)
virtual

Set/Get the total gaseous transmission.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetUpwardDiffuseTransmittance ( double  _arg)
virtual

Set/Get the upward diffuse transmittance

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetUpwardDiffuseTransmittanceForAerosol ( double  _arg)
virtual

Set/Get the upward diffuse transmittance for aerosols

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetUpwardDiffuseTransmittanceForRayleigh ( double  _arg)
virtual

Set/Get the upward diffuse transmittance for rayleigh

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetUpwardDirectTransmittance ( double  _arg)
virtual

Set/Get the upward direct transmittance

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetUpwardTransmittance ( double  _arg)
virtual

Set/Get the upward transmittance of the atmosphere.

virtual void otb::AtmosphericRadiativeTermsSingleChannel::SetWavelengthSpectralBand ( double  _arg)
virtual

Set/Get the wavelength

Member Data Documentation

double otb::AtmosphericRadiativeTermsSingleChannel::m_DownwardTransmittance
private

The downward transmittance.

Definition at line 148 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_IntrinsicAtmosphericReflectance
private

The intrinsic atmospheric reflectance.

Definition at line 139 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_SphericalAlbedo
private

The spherical albedo of the atmosphere.

Definition at line 142 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_TotalGaseousTransmission
private

The total gaseous transmission (for all species).

Definition at line 145 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_UpwardDiffuseTransmittance
private

The upward diffuse transmittance.

Definition at line 154 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_UpwardDiffuseTransmittanceForAerosol
private

The upward diffuse transmittance for aerosols.

Definition at line 163 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_UpwardDiffuseTransmittanceForRayleigh
private

The upward diffuse transmittance for rayleigh.

Definition at line 160 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_UpwardDirectTransmittance
private

The upward direct transmittance.

Definition at line 157 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_UpwardTransmittance
private

The upward transmittance.

Definition at line 151 of file otbAtmosphericRadiativeTerms.h.

double otb::AtmosphericRadiativeTermsSingleChannel::m_WavelengthSpectralBand
private

Wavelength associated with the data: not used in the computation, for reference only

Definition at line 166 of file otbAtmosphericRadiativeTerms.h.


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