OTB  5.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::LabelToProSailParameters< TLabel > Class Template Reference

#include <otbLabelToProSailParameters.h>

+ Inheritance diagram for otb::LabelToProSailParameters< TLabel >:
+ Collaboration diagram for otb::LabelToProSailParameters< TLabel >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef Superclass::LabelType LabelType
 
typedef Superclass::ParametersType ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef LabelToProSailParameters Self
 
typedef
LabelToSimulationParametersBase
< TLabel > 
Superclass
 
- Public Types inherited from otb::LabelToSimulationParametersBase< TLabel >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TLabel LabelType
 
typedef itk::Array
< ParametersValueType
ParametersType
 
typedef double ParametersValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
LabelToSimulationParametersBase 
Self
 
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

virtual void GenerateData ()
 
- Public Member Functions inherited from otb::LabelToSimulationParametersBase< TLabel >
virtual LabelType GetLabel ()
 
virtual ParametersType GetStep1Parameters ()
 
virtual ParametersType GetStep2Parameters ()
 
virtual void SetLabel (LabelType _arg)
 
virtual void SetStep1Parameters (ParametersType _arg)
 
virtual void SetStep2Parameters (ParametersType _arg)
 
- 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 DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
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 (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

 LabelToProSailParameters ()
 
virtual ~LabelToProSailParameters ()
 
- Protected Member Functions inherited from otb::LabelToSimulationParametersBase< TLabel >
 LabelToSimulationParametersBase ()
 
virtual ~LabelToSimulationParametersBase ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
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 RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(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 ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 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

 LabelToProSailParameters (const Self &)
 
void operator= (const Self &)
 
virtual const char * GetNameOfClass () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
static Pointer New ()
 

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

Detailed Description

template<class TLabel>
class otb::LabelToProSailParameters< TLabel >

Take a label corresponding to a spectrum type for vegetation and outputs the ProSail parameters needed to get a spectrum of that type.

Output parameters concerns:

WARNING: an only set of parameters is defined for all vegetation types.

Prospect Parameters Cab = 30; % chlorophyll content (ug.cm-2) Car = 10; % carotenoid content (ug.cm-2) Cbrown = 0.0; % brown pigment content (arbitrary units) Cw = 0.015; % EWT (cm) Cm = 0.009; % LMA (g.cm-2) N = 1.2; % structure coefficient

Sail Parameters lai = 2; % leaf area index angl = 50; % average leaf angle (deg) psoil = 1; % soil coefficient skyl = 70; % % diffuse/direct radiation hspot = 0.2; % hot spot ihot = 1.0; % tts = 30; % solar zenith angle (deg) tto = 0; % observer zenith angle (deg) psi = 0; % azimuth (deg)

TODO : define different vegetation types and ProSail parameters associated.

See Also
LabelToSimulationParametersBase

Definition at line 66 of file otbLabelToProSailParameters.h.

Member Typedef Documentation

template<class TLabel >
typedef itk::SmartPointer<const Self> otb::LabelToProSailParameters< TLabel >::ConstPointer

Definition at line 74 of file otbLabelToProSailParameters.h.

template<class TLabel >
typedef Superclass::LabelType otb::LabelToProSailParameters< TLabel >::LabelType

Definition at line 78 of file otbLabelToProSailParameters.h.

template<class TLabel >
typedef Superclass::ParametersType otb::LabelToProSailParameters< TLabel >::ParametersType

Some convenient typedefs.

Definition at line 77 of file otbLabelToProSailParameters.h.

template<class TLabel >
typedef itk::SmartPointer<Self> otb::LabelToProSailParameters< TLabel >::Pointer

Definition at line 73 of file otbLabelToProSailParameters.h.

template<class TLabel >
typedef LabelToProSailParameters otb::LabelToProSailParameters< TLabel >::Self

Standard "Self" & Superclass typedef

Definition at line 71 of file otbLabelToProSailParameters.h.

template<class TLabel >
typedef LabelToSimulationParametersBase<TLabel> otb::LabelToProSailParameters< TLabel >::Superclass

Definition at line 72 of file otbLabelToProSailParameters.h.

Constructor & Destructor Documentation

template<class TLabel >
otb::LabelToProSailParameters< TLabel >::LabelToProSailParameters ( )
protected

Definition at line 31 of file otbLabelToProSailParameters.txx.

template<class TLabel >
virtual otb::LabelToProSailParameters< TLabel >::~LabelToProSailParameters ( )
inlineprotectedvirtual

Definition at line 92 of file otbLabelToProSailParameters.h.

template<class TLabel >
otb::LabelToProSailParameters< TLabel >::LabelToProSailParameters ( const Self )
private

Member Function Documentation

template<class TLabel >
virtual::itk::LightObject::Pointer otb::LabelToProSailParameters< TLabel >::CreateAnother ( void  ) const
virtual

Standard Macro

Reimplemented from itk::Object.

template<class TLabel >
void otb::LabelToProSailParameters< TLabel >::GenerateData ( void  )
virtual

Reimplemented from itk::ProcessObject.

Definition at line 80 of file otbLabelToProSailParameters.txx.

References otbMsgDevMacro.

template<class TLabel >
virtual const char* otb::LabelToProSailParameters< TLabel >::GetNameOfClass ( ) const
virtual

Standard Macro

Reimplemented from otb::LabelToSimulationParametersBase< TLabel >.

template<class TLabel >
static Pointer otb::LabelToProSailParameters< TLabel >::New ( )
static

Standard Macro

template<class TLabel >
void otb::LabelToProSailParameters< TLabel >::operator= ( const Self )
private

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