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

#include <otbWrapperCompositeApplication.h>

+ Inheritance diagram for otb::Wrapper::CompositeApplication:
+ Collaboration diagram for otb::Wrapper::CompositeApplication:

Classes

struct  InternalApplication
 

Public Types

typedef itk::MemberCommand< SelfAddProcessCommandType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef std::map< std::string,
InternalApplication
InternalAppContainer
 
typedef itk::SmartPointer< SelfPointer
 
typedef CompositeApplication Self
 
typedef Application Superclass
 
- Public Types inherited from otb::Wrapper::Application
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Application Self
 
typedef itk::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 char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::Wrapper::Application
void AddDocTag (const std::string &)
 
unsigned int AddExample (const std::string &comm="")
 
void AddImageToParameterInputImageList (std::string parameter, ImageBaseType *img)
 
void AddParameterStringList (std::string parameter, const std::string &str)
 
void ClearParameterInputImageList (std::string parameter)
 
void ClearValue (std::string paramKey)
 
void DisableParameter (std::string paramKey)
 
void EnableParameter (std::string paramKey)
 
int Execute ()
 
int ExecuteAndWriteOutput ()
 
void FreeRessources ()
 
std::vector< std::string > GetChoiceKeys (std::string paramKey)
 
std::vector< std::string > GetChoiceNames (std::string paramKey)
 
std::string GetCLExample ()
 
float GetDefaultParameterFloat (std::string parameter)
 
int GetDefaultParameterInt (std::string parameter)
 
virtual const char * GetDescription () const
 
virtual const char * GetDocAuthors () const
 
DocExampleStructure::Pointer GetDocExample ()
 
virtual const char * GetDocLimitations () const
 
virtual const std::string & GetDocLink () const
 
virtual const char * GetDocLongDescription () const
 
virtual const char * GetDocSeeAlso () const
 
virtual std::vector< std::string > GetDocTags () const
 
std::string GetExampleComment (unsigned int id)
 
unsigned int GetExampleNumberOfParameters (unsigned int id)
 
std::string GetExampleParameterKey (unsigned int exId, unsigned int paramId)
 
std::string GetExampleParameterValue (unsigned int exId, unsigned int paramId)
 
std::string GetHtmlExample ()
 
ImagePixelType GetImageBasePixelType (const std::string &key, unsigned int idx=0)
 
otb::ImageKeywordlist GetImageKeywordlist (const std::string &key, unsigned int idx=0)
 
itk::MetaDataDictionary GetImageMetaData (const std::string &key, unsigned int idx=0)
 
unsigned int GetImageNbBands (const std::string &key, unsigned int idx=0)
 
ImageBaseType::PointType GetImageOrigin (const std::string &key, unsigned int idx=0)
 
std::string GetImageProjection (const std::string &key, unsigned int idx=0)
 
ImageBaseType::RegionType GetImageRequestedRegion (const std::string &key, unsigned int idx=0)
 
ImageBaseType::SizeType GetImageSize (const std::string &key, unsigned int idx=0)
 
ImageBaseType::SpacingType GetImageSpacing (const std::string &key, unsigned int idx=0)
 
double GetLastExecutionTiming () const
 
bool GetListViewSingleSelectionMode (const std::string &parameter)
 
otb::LoggerGetLogger () const
 
virtual const char * GetName () const
 
unsigned int GetNumberOfElementsInParameterInputImageList (std::string parameter)
 
unsigned int GetNumberOfExamples ()
 
std::vector< std::pair
< std::string, std::string > > 
GetOutputParametersSumUp ()
 
std::string GetParameterAsString (std::string paramKey)
 
ParameterGetParameterByKey (std::string parameter, bool follow=true)
 
const ParameterGetParameterByKey (std::string parameter, bool follow=true) const
 
ComplexDoubleImageTypeGetParameterComplexDoubleImage (std::string)
 
ComplexDoubleVectorImageTypeGetParameterComplexDoubleVectorImage (std::string)
 
ComplexFloatImageTypeGetParameterComplexFloatImage (std::string)
 
ComplexFloatVectorImageTypeGetParameterComplexFloatVectorImage (std::string)
 
ComplexInt16ImageTypeGetParameterComplexInt16Image (std::string)
 
ComplexInt16VectorImageTypeGetParameterComplexInt16VectorImage (std::string)
 
ComplexInt32ImageTypeGetParameterComplexInt32Image (std::string)
 
ComplexInt32VectorImageTypeGetParameterComplexInt32VectorImage (std::string)
 
std::string GetParameterDescription (std::string paramKey)
 
DoubleImageTypeGetParameterDoubleImage (std::string)
 
DoubleVectorImageTypeGetParameterDoubleVectorImage (std::string)
 
float GetParameterFloat (std::string parameter)
 
FloatImageTypeGetParameterFloatImage (std::string)
 
FloatVectorImageTypeGetParameterFloatVectorImage (std::string)
 
FloatVectorImageTypeGetParameterImage (std::string parameter)
 
ImageBaseTypeGetParameterImageBase (const std::string &key, unsigned int idx=0)
 
FloatVectorImageListTypeGetParameterImageList (std::string parameter)
 
int GetParameterInt (std::string parameter)
 
Int16ImageTypeGetParameterInt16Image (std::string)
 
Int16VectorImageTypeGetParameterInt16VectorImage (std::string)
 
Int32ImageTypeGetParameterInt32Image (std::string)
 
Int32VectorImageTypeGetParameterInt32VectorImage (std::string)
 
ParameterGroupGetParameterList ()
 
std::string GetParameterName (std::string paramKey)
 
ImageBaseTypeGetParameterOutputImage (std::string parameter)
 
ImagePixelType GetParameterOutputImagePixelType (std::string parameter)
 
Role GetParameterRole (std::string paramKey) const
 
std::vector< std::string > GetParametersKeys (bool recursive=true)
 
std::string GetParameterString (std::string parameter)
 
std::vector< std::string > GetParameterStringList (const std::string &parameter)
 
ParameterType GetParameterType (std::string paramKey) const
 
UInt16ImageTypeGetParameterUInt16Image (std::string)
 
UInt16VectorImageTypeGetParameterUInt16VectorImage (std::string)
 
UInt32ImageTypeGetParameterUInt32Image (std::string)
 
UInt32VectorImageTypeGetParameterUInt32VectorImage (std::string)
 
UInt8ImageTypeGetParameterUInt8Image (std::string)
 
UInt8RGBAImageTypeGetParameterUInt8RGBAImage (std::string)
 
UInt8RGBImageTypeGetParameterUInt8RGBImage (std::string)
 
UInt8VectorImageTypeGetParameterUInt8VectorImage (std::string)
 
UserLevel GetParameterUserLevel (std::string paramKey) const
 
VectorDataTypeGetParameterVectorData (std::string parameter)
 
VectorDataListTypeGetParameterVectorDataList (std::string parameter)
 
std::string GetProgressDescription () const
 
itk::ProcessObjectGetProgressSource () const
 
bool HasAutomaticValue (std::string paramKey) const
 
bool HasUserValue (std::string paramKey) const
 
bool HasValue (std::string paramKey) const
 
void Init ()
 
bool IsApplicationReady ()
 
bool IsDeprecated ()
 
bool IsInitialized () const
 
bool IsMandatory (std::string paramKey) const
 
bool IsParameterEnabled (std::string paramKey, bool recurseParents=false) const
 
bool IsParameterMissing (const std::string &key) const
 
void LoadParametersFromXML (const std::string &filename)
 
unsigned long PropagateRequestedRegion (const std::string &key, ImageBaseType::RegionType region, unsigned int idx=0)
 
void RegisterPipeline ()
 
void SaveParametersToXML (const std::string &filename)
 
void SetDefaultOutputComplexPixelType (std::string parameter, ComplexImagePixelType type)
 
void SetDefaultOutputPixelType (std::string parameter, ImagePixelType type)
 
void SetDefaultParameterFloat (std::string parameter, float value)
 
void SetDefaultParameterInt (std::string parameter, int value)
 
void SetDescription (const std::string &)
 
virtual void SetDocAuthors (const std::string &)
 
void SetDocExampleParameterValue (const std::string key, const std::string value, unsigned int exId=0)
 
virtual void SetDocLimitations (const std::string &)
 
virtual void SetDocLink (const std::string &link)
 
virtual void SetDocLongDescription (const std::string &)
 
virtual void SetDocSeeAlso (const std::string &)
 
virtual void SetDocTags (std::vector< std::string >)
 
void SetExampleComment (const std::string &comm, unsigned int i)
 
void SetListViewSingleSelectionMode (std::string parameter, bool status)
 
void SetLogger (otb::Logger *logger)
 
void SetMaximumParameterFloatValue (std::string parameter, float value)
 
void SetMaximumParameterIntValue (std::string parameter, int value)
 
void SetMinimumParameterFloatValue (std::string parameter, float value)
 
void SetMinimumParameterIntValue (std::string parameter, int value)
 
virtual void SetName (const std::string &)
 
void SetNthParameterInputImageList (std::string parameter, const unsigned int &id, ImageBaseType *img)
 
void SetNthParameterStringList (std::string parameter, const unsigned int &id, const std::string &str)
 
void SetOfficialDocLink ()
 
void SetParameterDescription (std::string paramKey, std::string dec)
 
void SetParameterFloat (std::string parameter, float value, bool hasUserValueFlag=true)
 
void SetParameterImageBase (const std::string &key, ImageBaseType *img, unsigned int idx=0)
 
void SetParameterInputImage (std::string parameter, ImageBaseType *inputImage)
 
void SetParameterInt (std::string parameter, int value, bool hasUserValueFlag=true)
 
void SetParameterList (ParameterGroup::Pointer paramGroup)
 
void SetParameterOutputImage (std::string parameter, FloatVectorImageType *value)
 
void SetParameterOutputImagePixelType (std::string parameter, ImagePixelType pixelType)
 
void SetParameterOutputVectorData (std::string parameter, VectorDataType *value)
 
void SetParameterString (std::string parameter, std::string value, bool hasUserValueFlag=true)
 
void SetParameterStringList (std::string parameter, std::vector< std::string > values, bool hasUserValueFlag=true)
 
void SetParameterUserValue (std::string paramKey, bool value)
 
void Stop ()
 
void UpdateParameters ()
 
- 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

bool AddApplication (std::string appType, std::string key, std::string desc)
 
void ClearApplications ()
 
 CompositeApplication ()
 
bool Connect (std::string fromKey, std::string toKey)
 
ApplicationDecodeKey (std::string &key)
 
void ExecuteInternal (std::string key)
 
std::string GetInternalAppDescription (std::string id)
 
ApplicationGetInternalApplication (std::string id)
 
void LinkWatchers (itk::Object *, const itk::EventObject &event)
 
bool ShareParameter (std::string localKey, std::string internalKey, std::string name=std::string(), std::string desc=std::string())
 
void UpdateInternalParameters (std::string key)
 
 ~CompositeApplication () override
 
- Protected Member Functions inherited from otb::Wrapper::Application
void AddChoice (std::string paramKey, std::string paramName)
 
void AddParameter (ParameterType type, std::string paramKey, std::string paramName)
 
void AddProcess (itk::ProcessObject *object, std::string description)
 
void AddRAMParameter (std::string paramKey="ram")
 
void AddRAMParameter (std::string paramKey, std::string paramName, unsigned int defaultValue)
 
void AddRANDParameter (std::string paramKey="rand")
 
void AddRANDParameter (std::string paramKey, std::string paramName, unsigned int defaultValue)
 
 Application ()
 
void AutomaticValueOff (std::string paramKey)
 
void AutomaticValueOn (std::string paramKey)
 
void ClearChoices (std::string key)
 
template<class TImageType >
TImageType * GetParameterImage (std::string parameter)
 
std::vector< int > GetSelectedItems (std::string paramKey)
 
void MandatoryOff (std::string paramKey)
 
void MandatoryOn (std::string paramKey)
 
template<class TImageType >
void SetParameterOutputImage (std::string parameter, TImageType *value)
 
void SetParameterRole (std::string paramKey, Role role)
 
void SetParameterUserLevel (std::string paramKey, UserLevel level)
 
 ~Application () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
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

 CompositeApplication (const CompositeApplication &)=delete
 
void operator= (const CompositeApplication &)=delete
 

Private Attributes

AddProcessCommandType::Pointer m_AddProcessCommand
 
InternalAppContainer m_AppContainer
 

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::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

This class is a base class for composite applications.

This class allows creating & storing internal applications with the same logic as parameters. You choose the application type to create, you choose an identifier (alphanumeric string), and you can give a short description. Later, you will refer to this application using the identifier. In the functions of this class, you can refer to parameters from internal applications by using their identifier as prefix. For instance, "app1.in" will refer to parameter "in" from internal application named "app1" (if such application exists, if not it will refer to a parameter of this composite application).

Definition at line 48 of file otbWrapperCompositeApplication.h.

Member Typedef Documentation

Filters typedef

Definition at line 58 of file otbWrapperCompositeApplication.h.

Definition at line 55 of file otbWrapperCompositeApplication.h.

Definition at line 69 of file otbWrapperCompositeApplication.h.

Definition at line 54 of file otbWrapperCompositeApplication.h.

Standard class typedefs.

Definition at line 52 of file otbWrapperCompositeApplication.h.

Definition at line 53 of file otbWrapperCompositeApplication.h.

Constructor & Destructor Documentation

otb::Wrapper::CompositeApplication::CompositeApplication ( )
protected

Constructor

otb::Wrapper::CompositeApplication::~CompositeApplication ( )
overrideprotected

Destructor

otb::Wrapper::CompositeApplication::CompositeApplication ( const CompositeApplication )
privatedelete

Member Function Documentation

bool otb::Wrapper::CompositeApplication::AddApplication ( std::string  appType,
std::string  key,
std::string  desc 
)
protected

Method to instantiate and register a new internal application

Parameters
appTypeType of the application to instantiate
keyIdentifier associated to the created application
descDescription of the internal application

Referenced by otb::Wrapper::TrainImagesBase::InitClassification(), and otb::Wrapper::TrainImagesBase::InitSampling().

void otb::Wrapper::CompositeApplication::ClearApplications ( )
protected

Method to remove all internal applications. Application deriving from CompositeApplication should call this method at the beginning of their DoInit().

bool otb::Wrapper::CompositeApplication::Connect ( std::string  fromKey,
std::string  toKey 
)
protected

Connect two existing parameters together. The first parameter will point to the second parameter.

Referenced by otb::Wrapper::TrainImagesBase::ConnectClassificationParams(), and otb::Wrapper::TrainImagesBase::ConnectSamplingParameters().

Application* otb::Wrapper::CompositeApplication::DecodeKey ( std::string &  key)
protected

Decode a key to extract potential prefix for internal applications If a valid prefix (corresponding to an internal app) is found:

  • prefix is removed from the input key which is altered.
  • the function returns a pointer to the internal application If no valid prefix is found, the input key is not modified, and the function returns 'this'.
void otb::Wrapper::CompositeApplication::ExecuteInternal ( std::string  key)
protected
std::string otb::Wrapper::CompositeApplication::GetInternalAppDescription ( std::string  id)
protected

Get the description of an internal application

Application* otb::Wrapper::CompositeApplication::GetInternalApplication ( std::string  id)
protected
virtual const char* otb::Wrapper::CompositeApplication::GetNameOfClass ( ) const
virtual

RTTI support

Reimplemented from otb::Wrapper::Application.

Reimplemented in otb::Wrapper::TrainImagesBase.

void otb::Wrapper::CompositeApplication::LinkWatchers ( itk::Object ,
const itk::EventObject event 
)
protected

Callback function to retrieve the process watchers on internal filters

void otb::Wrapper::CompositeApplication::operator= ( const CompositeApplication )
privatedelete
bool otb::Wrapper::CompositeApplication::ShareParameter ( std::string  localKey,
std::string  internalKey,
std::string  name = std::string(),
std::string  desc = std::string() 
)
protected

Share a parameter between the composite application and an internal application The local parameter is created as a proxy to the internal parameter.

Parameters
localKeyNew parameter key in the composite application
internalKeyKey to the internal parameter to expose
nameName for the local parameter, if empty the target's name is used
descDescription for the local parameter, if empty the target's description is used

Referenced by otb::Wrapper::TrainImagesBase::ShareClassificationParams(), and otb::Wrapper::TrainImagesBase::ShareSamplingParameters().

void otb::Wrapper::CompositeApplication::UpdateInternalParameters ( std::string  key)
protected

Member Data Documentation

AddProcessCommandType::Pointer otb::Wrapper::CompositeApplication::m_AddProcessCommand
private

Definition at line 153 of file otbWrapperCompositeApplication.h.

InternalAppContainer otb::Wrapper::CompositeApplication::m_AppContainer
private

Definition at line 151 of file otbWrapperCompositeApplication.h.


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