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

#include <otbLabelToSimulationParametersBase.h>

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

Public Types

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 LabelType GetLabel ()
 
virtual const char * GetNameOfClass () const
 
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 LightObject::Pointer CreateAnother () const override
 
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

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

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

Private Attributes

LabelType m_Label
 
ParametersType m_Step1Parameters
 
ParametersType m_Step2Parameters
 

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

template<class TLabel>
class otb::LabelToSimulationParametersBase< TLabel >

Base class for all classes that take a label and outputs two set of parameters for two steps (step1, step2)

step1 and 2 refers to PROSPECT and SAIL parameters.

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)

See Also
ProcessObject

Definition at line 64 of file otbLabelToSimulationParametersBase.h.

Member Typedef Documentation

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

Definition at line 72 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
typedef TLabel otb::LabelToSimulationParametersBase< TLabel >::LabelType

Some convenient typedefs.

Definition at line 75 of file otbLabelToSimulationParametersBase.h.

Definition at line 77 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
typedef double otb::LabelToSimulationParametersBase< TLabel >::ParametersValueType

Definition at line 76 of file otbLabelToSimulationParametersBase.h.

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

Definition at line 71 of file otbLabelToSimulationParametersBase.h.

Standard "Self" & Superclass typedef

Definition at line 69 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
typedef itk::ProcessObject otb::LabelToSimulationParametersBase< TLabel >::Superclass

Definition at line 70 of file otbLabelToSimulationParametersBase.h.

Constructor & Destructor Documentation

template<class TLabel >
otb::LabelToSimulationParametersBase< TLabel >::LabelToSimulationParametersBase ( )
inlineprotected

Definition at line 96 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
otb::LabelToSimulationParametersBase< TLabel >::~LabelToSimulationParametersBase ( )
inlineoverrideprotected

Definition at line 97 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
otb::LabelToSimulationParametersBase< TLabel >::LabelToSimulationParametersBase ( const Self )
privatedelete

Member Function Documentation

template<class TLabel >
virtual LabelType otb::LabelToSimulationParametersBase< TLabel >::GetLabel ( )
virtual
template<class TLabel >
virtual const char* otb::LabelToSimulationParametersBase< TLabel >::GetNameOfClass ( ) const
virtual

Standard Macro

Reimplemented from itk::ProcessObject.

Reimplemented in otb::LabelToProSailParameters< TLabel >.

template<class TLabel >
virtual ParametersType otb::LabelToSimulationParametersBase< TLabel >::GetStep1Parameters ( )
virtual
template<class TLabel >
virtual ParametersType otb::LabelToSimulationParametersBase< TLabel >::GetStep2Parameters ( )
virtual
template<class TLabel >
void otb::LabelToSimulationParametersBase< TLabel >::operator= ( const Self )
privatedelete
template<class TLabel >
virtual void otb::LabelToSimulationParametersBase< TLabel >::SetLabel ( LabelType  _arg)
virtual
template<class TLabel >
virtual void otb::LabelToSimulationParametersBase< TLabel >::SetStep1Parameters ( ParametersType  _arg)
virtual
template<class TLabel >
virtual void otb::LabelToSimulationParametersBase< TLabel >::SetStep2Parameters ( ParametersType  _arg)
virtual

Member Data Documentation

template<class TLabel >
LabelType otb::LabelToSimulationParametersBase< TLabel >::m_Label
private

Definition at line 106 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
ParametersType otb::LabelToSimulationParametersBase< TLabel >::m_Step1Parameters
private

Definition at line 104 of file otbLabelToSimulationParametersBase.h.

template<class TLabel >
ParametersType otb::LabelToSimulationParametersBase< TLabel >::m_Step2Parameters
private

Definition at line 105 of file otbLabelToSimulationParametersBase.h.


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