OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::AtmosphericEffects< TSpectralResponse, TRSR > Class Template Reference

#include <otbAtmosphericEffects.h>

+ Inheritance diagram for otb::AtmosphericEffects< TSpectralResponse, TRSR >:
+ Collaboration diagram for otb::AtmosphericEffects< TSpectralResponse, TRSR >:

Public Types

typedef
AtmosphericRadiativeTermsType::Pointer 
AtmosphericRadiativeTermsPointerType
 
typedef
otb::AtmosphericRadiativeTerms 
AtmosphericRadiativeTermsType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputRSRType::Pointer InputRSRPointerType
 
typedef TRSR InputRSRType
 
typedef
InputSpectralResponseType::Pointer 
InputSpectralResponsePointerType
 
typedef TSpectralResponse InputSpectralResponseType
 
typedef
InputSpectralResponseType::PairType 
PairType
 
typedef itk::SmartPointer< SelfPointer
 
typedef InputRSRType::PrecisionType PrecisionType
 
typedef AtmosphericEffects Self
 
typedef itk::DataObject Superclass
 
typedef
InputRSRType::ValuePrecisionType 
ValuePrecisionType
 
- 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 const InputRSRTypeGetInputSatRSR () const
 
virtual const
InputSpectralResponseType
GetInputSpectralResponse () const
 
 itkGetObjectMacro (CorrectedSpectralResponse, InputSpectralResponseType)
 
void Process ()
 
virtual void SetInputSatRSR (InputRSRType *_arg)
 
virtual void SetInputSpectralResponse (InputSpectralResponseType *_arg)
 
void SetAtmosphericRadiativeTerms (AtmosphericRadiativeTermsPointerType atmoRadTerms)
 
virtual const
AtmosphericRadiativeTermsType
GetAtmosphericRadiativeTerms () 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
 

Protected Member Functions

 AtmosphericEffects ()
 
virtual ~AtmosphericEffects ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
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

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

Private Attributes

AtmosphericRadiativeTermsPointerType m_AtmosphericRadiativeTerms
 
InputSpectralResponsePointerType m_CorrectedSpectralResponse
 
InputRSRPointerType m_InputSatRSR
 
InputSpectralResponsePointerType m_InputSpectralResponse
 
bool m_IsSetAtmosphericRadiativeTerms
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Additional Inherited Members

- 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 Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

template<class TSpectralResponse, class TRSR>
class otb::AtmosphericEffects< TSpectralResponse, TRSR >

This class applies atmospheric effects, computed from otbAtmosphericCorrectionParametersTo6SRadiativeTerms to an input spectrum (otbSpectralResponse) using the otbSurfaceReflectanceToReflectanceFilter.

The two templates indicate:

See Also
itk::DataObject

Definition at line 37 of file otbAtmosphericEffects.h.

Member Typedef Documentation

template<class TSpectralResponse , class TRSR >
typedef AtmosphericRadiativeTermsType::Pointer otb::AtmosphericEffects< TSpectralResponse, TRSR >::AtmosphericRadiativeTermsPointerType

Definition at line 66 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef otb::AtmosphericRadiativeTerms otb::AtmosphericEffects< TSpectralResponse, TRSR >::AtmosphericRadiativeTermsType

Definition at line 65 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef itk::SmartPointer<const Self> otb::AtmosphericEffects< TSpectralResponse, TRSR >::ConstPointer

Definition at line 45 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef InputRSRType::Pointer otb::AtmosphericEffects< TSpectralResponse, TRSR >::InputRSRPointerType

Definition at line 57 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef TRSR otb::AtmosphericEffects< TSpectralResponse, TRSR >::InputRSRType

Template parameters typedef. The relatives spectral response of a sensor (RSR)

Definition at line 55 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef InputSpectralResponseType::Pointer otb::AtmosphericEffects< TSpectralResponse, TRSR >::InputSpectralResponsePointerType

Definition at line 58 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef TSpectralResponse otb::AtmosphericEffects< TSpectralResponse, TRSR >::InputSpectralResponseType

Template parameters typedef. Spectral response of a material (from the JPL ASTER spectral library for example)

Definition at line 50 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef InputSpectralResponseType::PairType otb::AtmosphericEffects< TSpectralResponse, TRSR >::PairType

Definition at line 62 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef itk::SmartPointer<Self> otb::AtmosphericEffects< TSpectralResponse, TRSR >::Pointer

Definition at line 44 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef InputRSRType::PrecisionType otb::AtmosphericEffects< TSpectralResponse, TRSR >::PrecisionType

Definition at line 60 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef AtmosphericEffects otb::AtmosphericEffects< TSpectralResponse, TRSR >::Self

Standard class typedefs

Definition at line 42 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef itk::DataObject otb::AtmosphericEffects< TSpectralResponse, TRSR >::Superclass

Definition at line 43 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
typedef InputRSRType::ValuePrecisionType otb::AtmosphericEffects< TSpectralResponse, TRSR >::ValuePrecisionType

Definition at line 61 of file otbAtmosphericEffects.h.

Constructor & Destructor Documentation

template<class TSpectralResponse , class TRSR >
otb::AtmosphericEffects< TSpectralResponse, TRSR >::AtmosphericEffects ( )
protected

Constructor

Definition at line 29 of file otbAtmosphericEffects.txx.

template<class TSpectralResponse , class TRSR >
virtual otb::AtmosphericEffects< TSpectralResponse, TRSR >::~AtmosphericEffects ( )
inlineprotectedvirtual

Constructor from a ASCII file Destructor

Definition at line 103 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
otb::AtmosphericEffects< TSpectralResponse, TRSR >::AtmosphericEffects ( const Self )
private

PrintSelf method

Member Function Documentation

template<class TSpectralResponse , class TRSR >
virtual::itk::LightObject::Pointer otb::AtmosphericEffects< TSpectralResponse, TRSR >::CreateAnother ( void  ) const
virtual

Standard macros

Reimplemented from itk::Object.

template<class TSpectralResponse , class TRSR >
virtual const AtmosphericRadiativeTermsType* otb::AtmosphericEffects< TSpectralResponse, TRSR >::GetAtmosphericRadiativeTerms ( ) const
virtual

Get/Set Atmospheric Radiative Terms.

template<class TSpectralResponse , class TRSR >
virtual const InputRSRType* otb::AtmosphericEffects< TSpectralResponse, TRSR >::GetInputSatRSR ( ) const
virtual
template<class TSpectralResponse , class TRSR >
virtual const InputSpectralResponseType* otb::AtmosphericEffects< TSpectralResponse, TRSR >::GetInputSpectralResponse ( ) const
virtual
template<class TSpectralResponse , class TRSR >
virtual const char* otb::AtmosphericEffects< TSpectralResponse, TRSR >::GetNameOfClass ( ) const
virtual

Standard macros

Reimplemented from itk::DataObject.

template<class TSpectralResponse , class TRSR >
otb::AtmosphericEffects< TSpectralResponse, TRSR >::itkGetObjectMacro ( CorrectedSpectralResponse  ,
InputSpectralResponseType   
)
template<class TSpectralResponse , class TRSR >
static Pointer otb::AtmosphericEffects< TSpectralResponse, TRSR >::New ( )
static

Standard macros

template<class TSpectralResponse , class TRSR >
void otb::AtmosphericEffects< TSpectralResponse, TRSR >::operator= ( const Self )
private
template<class TSpectralResponse , class TRSR >
void otb::AtmosphericEffects< TSpectralResponse, TRSR >::Process ( )

Definition at line 52 of file otbAtmosphericEffects.txx.

template<class TSpectralResponse , class TRSR >
void otb::AtmosphericEffects< TSpectralResponse, TRSR >::SetAtmosphericRadiativeTerms ( AtmosphericRadiativeTermsPointerType  atmoRadTerms)
inline

Get/Set Atmospheric Radiative Terms.

Definition at line 80 of file otbAtmosphericEffects.h.

References otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_AtmosphericRadiativeTerms, and itk::Object::Modified().

template<class TSpectralResponse , class TRSR >
virtual void otb::AtmosphericEffects< TSpectralResponse, TRSR >::SetInputSatRSR ( InputRSRType _arg)
virtual
template<class TSpectralResponse , class TRSR >
virtual void otb::AtmosphericEffects< TSpectralResponse, TRSR >::SetInputSpectralResponse ( InputSpectralResponseType _arg)
virtual

Member Data Documentation

template<class TSpectralResponse , class TRSR >
AtmosphericRadiativeTermsPointerType otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_AtmosphericRadiativeTerms
private
template<class TSpectralResponse , class TRSR >
InputSpectralResponsePointerType otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_CorrectedSpectralResponse
private

Definition at line 115 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
InputRSRPointerType otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_InputSatRSR
private

Definition at line 116 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
InputSpectralResponsePointerType otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_InputSpectralResponse
private

Definition at line 114 of file otbAtmosphericEffects.h.

template<class TSpectralResponse , class TRSR >
bool otb::AtmosphericEffects< TSpectralResponse, TRSR >::m_IsSetAtmosphericRadiativeTerms
private

Definition at line 118 of file otbAtmosphericEffects.h.


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