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

#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 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
 
DataVectorType GetUpwardDiffuseTransmittances () const
 
DataVectorType GetUpwardDiffuseTransmittancesForAerosol () const
 
DataVectorType GetUpwardDiffuseTransmittancesForRayleigh () const
 
DataVectorType GetUpwardDirectTransmittances () const
 
const ValueType GetValueByIndex (unsigned int id) const
 
DataVectorType GetWavelengthSpectralBand () const
 
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 SetWavelengthSpectralBand (const DataVectorType &vect)
 
void SetWavelengthSpectralBand (unsigned int id, const double &val)
 
void ValuesInitialization (unsigned int nbChannel)
 
void SetValues (const VectorValueType &val)
 
VectorValueTypeGetValues ()
 
const VectorValueTypeGetValues () 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 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)
 
DataVectorType GetIntrinsicAtmosphericReflectances () const
 
DataVectorType GetSphericalAlbedos () const
 
DataVectorType GetTotalGaseousTransmissions () const
 
DataVectorType GetDownwardTransmittances () const
 
DataVectorType GetUpwardTransmittances () 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
 
- 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

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

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

Private Attributes

bool m_IsInitialized
 
VectorValueType m_Values
 

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 is a vector of AtmosphericRadiativeTermsSingleChannel, it contains all atmospheric radiative terms for each studied channel.

Examples:
Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 179 of file otbAtmosphericRadiativeTerms.h.

Member Typedef Documentation

Definition at line 186 of file otbAtmosphericRadiativeTerms.h.

Definition at line 196 of file otbAtmosphericRadiativeTerms.h.

Definition at line 185 of file otbAtmosphericRadiativeTerms.h.

Standard typedefs

Definition at line 183 of file otbAtmosphericRadiativeTerms.h.

Definition at line 184 of file otbAtmosphericRadiativeTerms.h.

Definition at line 192 of file otbAtmosphericRadiativeTerms.h.

Definition at line 195 of file otbAtmosphericRadiativeTerms.h.

Constructor & Destructor Documentation

otb::AtmosphericRadiativeTerms::AtmosphericRadiativeTerms ( )
protected

Constructor

otb::AtmosphericRadiativeTerms::~AtmosphericRadiativeTerms ( )
inlineprotected

Destructor

Definition at line 283 of file otbAtmosphericRadiativeTerms.h.

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

Member Function Documentation

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

Reimplemented from itk::Object.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetDownwardTransmittances ( ) const

Get methods with vectors.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetIntrinsicAtmosphericReflectances ( ) const

Get methods with vectors.

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

Type macro

Reimplemented from itk::DataObject.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetSphericalAlbedos ( ) const

Get methods with vectors.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetTotalGaseousTransmissions ( ) const

Get methods with vectors.

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

Get methods with index.

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

Get methods with index.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittances ( ) const
DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForAerosol ( ) const
DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardDiffuseTransmittancesForRayleigh ( ) const
double otb::AtmosphericRadiativeTerms::GetUpwardDirectTransmittance ( unsigned int  id) const

Get methods with index.

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

Get methods with index.

DataVectorType otb::AtmosphericRadiativeTerms::GetUpwardTransmittances ( ) const

Get methods with vectors.

const ValueType otb::AtmosphericRadiativeTerms::GetValueByIndex ( unsigned int  id) const
VectorValueType& otb::AtmosphericRadiativeTerms::GetValues ( )
inline

Set/Get the values.

Definition at line 205 of file otbAtmosphericRadiativeTerms.h.

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

Set/Get the values.

Definition at line 209 of file otbAtmosphericRadiativeTerms.h.

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

Get methods with index.

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.

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

Set methods with index.

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

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

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

Set methods with index.

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

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

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

Set methods with index.

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

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

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

Set methods with index.

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

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

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)
void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittancesForAerosol ( const DataVectorType vect)
void otb::AtmosphericRadiativeTerms::SetUpwardDiffuseTransmittancesForRayleigh ( const DataVectorType vect)
void otb::AtmosphericRadiativeTerms::SetUpwardDirectTransmittance ( unsigned int  id,
const double &  val 
)
void otb::AtmosphericRadiativeTerms::SetUpwardDirectTransmittances ( const DataVectorType vect)
void otb::AtmosphericRadiativeTerms::SetUpwardTransmittance ( unsigned int  id,
const double &  val 
)

Set methods with index.

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

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

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

Set methods with index.

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

Set/Get the values.

Definition at line 200 of file otbAtmosphericRadiativeTerms.h.

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

Initialization method.

Member Data Documentation

bool otb::AtmosphericRadiativeTerms::m_IsInitialized
private

Boolean to know if m_Values has been initialized.

Definition at line 296 of file otbAtmosphericRadiativeTerms.h.

VectorValueType otb::AtmosphericRadiativeTerms::m_Values
private

The vector containing each channel information.

Definition at line 293 of file otbAtmosphericRadiativeTerms.h.


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