OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SailModel Class Reference

#include <otbSailModel.h>

+ Inheritance diagram for otb::SailModel:
+ Collaboration diagram for otb::SailModel:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
itk::ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef Superclass::ParametersType ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SailModel Self
 
typedef
Superclass::SpectralResponseType 
SpectralResponseType
 
typedef SimulationStep2Base Superclass
 
typedef std::vector< double > VectorType
 
- Public Types inherited from otb::SimulationStep2Base
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::Array
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SimulationStep2Base Self
 
typedef SpectralResponse
< double, double > 
SpectralResponseType
 
typedef itk::ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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

void GenerateData () override
 
virtual double GetFCoverView ()
 
const ParametersType GetInput ()
 
SpectralResponseTypeGetTransmittance ()
 
void SetInput (const ParametersType &)
 
void SetTransmittance (const SpectralResponseType *object) override
 
void UseExternalSoilDB (std::shared_ptr< SoilDataBase > SoilDB, vcl_size_t SoilIndex)
 
void SetReflectance (const SpectralResponseType *object) override
 
SpectralResponseTypeGetReflectance ()
 
virtual void SetLAI (double _arg)
 
virtual double GetLAI ()
 
virtual void SetAngl (double _arg)
 
virtual double GetAngl ()
 
virtual void SetPSoil (double _arg)
 
virtual double GetPSoil ()
 
virtual void SetSkyl (double _arg)
 
virtual double GetSkyl ()
 
virtual void SetHSpot (double _arg)
 
virtual double GetHSpot ()
 
virtual void SetTTS (double _arg)
 
virtual double GetTTS ()
 
virtual void SetTTO (double _arg)
 
virtual double GetTTO ()
 
virtual void SetPSI (double _arg)
 
virtual double GetPSI ()
 
virtual SpectralResponseTypeGetViewingReflectance ()
 
virtual SpectralResponseTypeGetHemisphericalReflectance ()
 
virtual SpectralResponseTypeGetViewingAbsorptance ()
 
virtual SpectralResponseTypeGetHemisphericalAbsorptance ()
 
- Public Member Functions inherited from otb::SimulationStep2Base
virtual ParametersType GetParameters ()
 
virtual void SetParameters (ParametersType _arg)
 
virtual void SetReflectance (const SpectralResponseType *)=0
 
virtual void SetTransmittance (const SpectralResponseType *)=0
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- 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 () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
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 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) override
 
virtual void UnRegister () const noexceptoverride
 
- 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

double Jfunc1 (const double k, const double l, const double t) const
 
double Jfunc2 (const double k, const double l, const double t) const
 
double Jfunc3 (const double k, const double l, const double t) const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SailModel ()
 
void Volscatt (const double tts, const double tto, const double psi, const double ttl, VectorType &result) const
 
 ~SailModel () override
 
void Calc_LIDF (const double a, VectorType &lidf) const
 
void Campbell (const double ala, VectorType &freq) const
 
- Protected Member Functions inherited from otb::SimulationStep2Base
 SimulationStep2Base ()
 
 ~SimulationStep2Base () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- 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

void operator= (const Self &)=delete
 
 SailModel (const Self &)=delete
 

Private Attributes

double m_Angl
 
double m_FCoverView
 
double m_HSpot
 
double m_LAI
 
double m_PSI
 
double m_PSoil
 
double m_Skyl
 
std::shared_ptr< SoilDataBasem_SoilDataBase
 
vcl_size_t m_SoilIndex
 
double m_TTO
 
double m_TTS
 
bool m_UseSoilFile
 
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::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 Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

This class implements the SAIL model (see http://teledetection.ipgp.jussieu.fr/prosail/).

Hemispherical and viewing reflectances and absorptances are computed from 400 to 2500 nm (step 1nm). Input Reflectance and transmittance must be spectrum (otbSpectralResponse) from 400 nm to 2500 nm with step 1nm.

See Also
itk::ProcessObject
SimulationStep2Base

Definition at line 46 of file otbSailModel.h.

Member Typedef Documentation

Definition at line 53 of file otbSailModel.h.

Definition at line 59 of file otbSailModel.h.

typedef Superclass::ParametersType otb::SailModel::ParametersType

Definition at line 57 of file otbSailModel.h.

Definition at line 52 of file otbSailModel.h.

Standard class typedefs

Definition at line 50 of file otbSailModel.h.

typedef Superclass::SpectralResponseType otb::SailModel::SpectralResponseType

Definition at line 55 of file otbSailModel.h.

Definition at line 51 of file otbSailModel.h.

typedef std::vector<double> otb::SailModel::VectorType

Definition at line 56 of file otbSailModel.h.

Constructor & Destructor Documentation

otb::SailModel::SailModel ( )
protected

Constructor

otb::SailModel::~SailModel ( )
overrideprotected

Destructor

otb::SailModel::SailModel ( const Self )
privatedelete

Member Function Documentation

void otb::SailModel::Calc_LIDF ( const double  a,
VectorType lidf 
) const
protected

Compute Leaf Angle Distribution

void otb::SailModel::Campbell ( const double  ala,
VectorType freq 
) const
protected

Compute Leaf Angle Distribution

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

Standard macros

Reimplemented from itk::Object.

void otb::SailModel::GenerateData ( )
overridevirtual

GenerateData

Reimplemented from itk::ProcessObject.

virtual double otb::SailModel::GetAngl ( )
virtual

Set/Get average leaf angle (deg)

virtual double otb::SailModel::GetFCoverView ( )
virtual

Get the computed fcover

virtual SpectralResponseType* otb::SailModel::GetHemisphericalAbsorptance ( )
virtual

Get Output

virtual SpectralResponseType* otb::SailModel::GetHemisphericalReflectance ( )
virtual

Get Output

virtual double otb::SailModel::GetHSpot ( )
virtual

Set/Get hot spot

const ParametersType otb::SailModel::GetInput ( )
virtual double otb::SailModel::GetLAI ( )
virtual

Set parameters Set/Get leaf area index

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

Standard macros

Reimplemented from otb::SimulationStep2Base.

virtual double otb::SailModel::GetPSI ( )
virtual

Set/Get azimuth(deg)

virtual double otb::SailModel::GetPSoil ( )
virtual

Set/Get soil coefficient

SpectralResponseType* otb::SailModel::GetReflectance ( )

Set Inputs

virtual double otb::SailModel::GetSkyl ( )
virtual

Set/Get diffuse/direct radiation

SpectralResponseType* otb::SailModel::GetTransmittance ( )
virtual double otb::SailModel::GetTTO ( )
virtual

Set/Get observer zenith angle (deg)

virtual double otb::SailModel::GetTTS ( )
virtual

Set/Get solar zenith angle (deg)

virtual SpectralResponseType* otb::SailModel::GetViewingAbsorptance ( )
virtual

Get Output

virtual SpectralResponseType* otb::SailModel::GetViewingReflectance ( )
virtual

Get Output

double otb::SailModel::Jfunc1 ( const double  k,
const double  l,
const double  t 
) const
protected

J functions

double otb::SailModel::Jfunc2 ( const double  k,
const double  l,
const double  t 
) const
protected
double otb::SailModel::Jfunc3 ( const double  k,
const double  l,
const double  t 
) const
protected
DataObjectPointer otb::SailModel::MakeOutput ( DataObjectPointerArraySizeType  )
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

static Pointer otb::SailModel::New ( )
static

Standard macros

void otb::SailModel::operator= ( const Self )
privatedelete
void otb::SailModel::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

PrintSelf method

Reimplemented from itk::ProcessObject.

virtual void otb::SailModel::SetAngl ( double  _arg)
virtual

Set/Get average leaf angle (deg)

virtual void otb::SailModel::SetHSpot ( double  _arg)
virtual

Set/Get hot spot

void otb::SailModel::SetInput ( const ParametersType )
virtual void otb::SailModel::SetLAI ( double  _arg)
virtual

Set parameters Set/Get leaf area index

virtual void otb::SailModel::SetPSI ( double  _arg)
virtual

Set/Get azimuth(deg)

virtual void otb::SailModel::SetPSoil ( double  _arg)
virtual

Set/Get soil coefficient

void otb::SailModel::SetReflectance ( const SpectralResponseType object)
override

Set Inputs

virtual void otb::SailModel::SetSkyl ( double  _arg)
virtual

Set/Get diffuse/direct radiation

void otb::SailModel::SetTransmittance ( const SpectralResponseType object)
override
virtual void otb::SailModel::SetTTO ( double  _arg)
virtual

Set/Get observer zenith angle (deg)

virtual void otb::SailModel::SetTTS ( double  _arg)
virtual

Set/Get solar zenith angle (deg)

void otb::SailModel::UseExternalSoilDB ( std::shared_ptr< SoilDataBase SoilDB,
vcl_size_t  SoilIndex 
)

Use an external soil DB

void otb::SailModel::Volscatt ( const double  tts,
const double  tto,
const double  psi,
const double  ttl,
VectorType result 
) const
protected

Volscatt

Member Data Documentation

double otb::SailModel::m_Angl
private

Definition at line 169 of file otbSailModel.h.

double otb::SailModel::m_FCoverView
private

Definition at line 176 of file otbSailModel.h.

double otb::SailModel::m_HSpot
private

Definition at line 172 of file otbSailModel.h.

double otb::SailModel::m_LAI
private

Definition at line 168 of file otbSailModel.h.

double otb::SailModel::m_PSI
private

Definition at line 175 of file otbSailModel.h.

double otb::SailModel::m_PSoil
private

Definition at line 170 of file otbSailModel.h.

double otb::SailModel::m_Skyl
private

Definition at line 171 of file otbSailModel.h.

std::shared_ptr<SoilDataBase> otb::SailModel::m_SoilDataBase
private

Definition at line 179 of file otbSailModel.h.

vcl_size_t otb::SailModel::m_SoilIndex
private

Definition at line 178 of file otbSailModel.h.

double otb::SailModel::m_TTO
private

Definition at line 174 of file otbSailModel.h.

double otb::SailModel::m_TTS
private

Definition at line 173 of file otbSailModel.h.

bool otb::SailModel::m_UseSoilFile
private

Definition at line 177 of file otbSailModel.h.


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