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

#include <otbWrapperInputImageParameter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef InputImageParameter Self
 
typedef Parameter Superclass
 
- Public Types inherited from otb::Wrapper::Parameter
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Parameter 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

template<class TInputImage , class TOutputImage >
TOutputImage * CastImage ()
 
void ClearValue () override
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FromString (const std::string &value) override
 
ComplexDoubleImageTypeGetComplexDoubleImage ()
 
ComplexDoubleVectorImageTypeGetComplexDoubleVectorImage ()
 
ComplexFloatImageTypeGetComplexFloatImage ()
 
ComplexFloatVectorImageTypeGetComplexFloatVectorImage ()
 
ComplexInt16ImageTypeGetComplexInt16Image ()
 
ComplexInt16VectorImageTypeGetComplexInt16VectorImage ()
 
ComplexInt32ImageTypeGetComplexInt32Image ()
 
ComplexInt32VectorImageTypeGetComplexInt32VectorImage ()
 
DoubleVectorImageTypeGetDoubleVectorImage ()
 
FloatVectorImageTypeGetFloatVectorImage ()
 
template<class TImageType >
TImageType * GetImage ()
 
template<>
OTBApplicationEngine_EXPORT
ImageBaseType
GetImage ()
 
Int16VectorImageTypeGetInt16VectorImage ()
 
Int32VectorImageTypeGetInt32VectorImage ()
 
virtual const char * GetNameOfClass () const
 
ParameterType GetType () const override
 
UInt16VectorImageTypeGetUInt16VectorImage ()
 
UInt32VectorImageTypeGetUInt32VectorImage ()
 
UInt8RGBAImageTypeGetUInt8RGBAImage ()
 
UInt8RGBImageTypeGetUInt8RGBImage ()
 
UInt8VectorImageTypeGetUInt8VectorImage ()
 
bool HasValue () const override
 
void SetImage (ImageBaseType *image)
 
std::string ToString () const override
 
bool SetFromFileName (const std::string &filename)
 
virtual const std::string & GetFileName () const
 
ImageBaseType const * GetImage () const
 
ImageBaseTypeGetImage ()
 
UInt8ImageTypeGetUInt8Image ()
 
UInt16ImageTypeGetUInt16Image ()
 
Int16ImageTypeGetInt16Image ()
 
UInt32ImageTypeGetUInt32Image ()
 
Int32ImageTypeGetInt32Image ()
 
FloatImageTypeGetFloatImage ()
 
DoubleImageTypeGetDoubleImage ()
 
- Public Member Functions inherited from otb::Wrapper::Parameter
virtual void AddChild (Parameter::Pointer child)
 
void AutomaticValueOff ()
 
void AutomaticValueOn ()
 
virtual void FromFloat (float)
 
virtual void FromInt (int)
 
virtual void FromStringList (const std::vector< std::string > &)
 
virtual bool GetAutomaticValue () const
 
virtual std::vector
< Parameter::Pointer
GetChildrenList ()
 
virtual Role GetRole () const
 
virtual const Parameter::Pointer GetRoot () const
 
virtual UserLevel GetUserLevel () const
 
virtual bool HasUserValue () const
 
virtual bool IsRoot () const
 
virtual void Reset ()
 
virtual void SetAutomaticValue (bool flag)
 
virtual void SetRole (const Role role)
 
virtual void SetRoot (const Parameter::Pointer root)
 
virtual void SetUserLevel (const UserLevel level)
 
virtual void SetUserValue (bool isUserValue)
 
void TypeError (const std::string &target_type) const
 
virtual void SetName (const std::string &)
 
virtual const char * GetName () const
 
virtual void SetDescription (const std::string &)
 
virtual const std::string & GetDescription () const
 
virtual void SetKey (const std::string &)
 
virtual const char * GetKey () const
 
virtual void SetActive (bool flag)
 
bool GetActive (bool recurseParents=false) const
 
virtual void SetMandatory (bool flag)
 
virtual bool GetMandatory () const
 
virtual void MandatoryOn ()
 
virtual void MandatoryOff ()
 
virtual int ToInt () const
 
virtual float ToFloat () const
 
virtual std::vector< std::string > ToStringList () const
 
- 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
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

 InputImageParameter ()
 
 ~InputImageParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::Parameter
 Parameter ()
 
- 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 Types

template<typename T >
using InputClampImageFilter = ClampImageFilter< T, otb::Wrapper::DoubleVectorImageType >
 
template<typename T >
using OutputClampImageFilter = ClampImageFilter< otb::Wrapper::DoubleVectorImageType, T >
 

Private Member Functions

template<typename TOutputImage , typename TInputImage >
TOutputImage * Cast (TInputImage *)
 
 InputImageParameter (const Parameter &)=delete
 
void operator= (const Parameter &)=delete
 

Private Attributes

std::string m_FileName
 
ImageBaseType::Pointer m_Image
 
itk::ProcessObject::Pointer m_InputCaster
 
itk::ProcessObject::Pointer m_OutputCaster
 
std::string m_PreviousFileName
 
itk::ProcessObject::Pointer m_Reader
 
bool m_UseFilename
 

Additional Inherited Members

- Protected Attributes inherited from otb::Wrapper::Parameter
bool m_Active
 
std::vector< Parameter::Pointerm_ChildrenList
 
std::string m_Description
 
std::string m_Key
 
bool m_Mandatory
 
std::string m_Name
 
Role m_Role
 
itk::WeakPointer< Parameterm_Root
 
UserLevel m_UserLevel
 
bool m_UserValue
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

This class represents a InputImage parameter.

Definition at line 43 of file otbWrapperInputImageParameter.h.

Member Typedef Documentation

Definition at line 50 of file otbWrapperInputImageParameter.h.

Definition at line 142 of file otbWrapperInputImageParameter.h.

Definition at line 146 of file otbWrapperInputImageParameter.h.

Definition at line 49 of file otbWrapperInputImageParameter.h.

Standard class typedef

Definition at line 47 of file otbWrapperInputImageParameter.h.

Definition at line 48 of file otbWrapperInputImageParameter.h.

Constructor & Destructor Documentation

otb::Wrapper::InputImageParameter::InputImageParameter ( )
protected

Constructor

otb::Wrapper::InputImageParameter::~InputImageParameter ( )
overrideprotected

Destructor

otb::Wrapper::InputImageParameter::InputImageParameter ( const Parameter )
privatedelete

Member Function Documentation

template<typename TOutputImage , typename TInputImage >
TOutputImage * otb::Wrapper::InputImageParameter::Cast ( TInputImage *  image)
private
template<class TInputImage , class TOutputImage >
TOutputImage* otb::Wrapper::InputImageParameter::CastImage ( )

Generic cast method that will be specified for each image type.

void otb::Wrapper::InputImageParameter::ClearValue ( )
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

virtual::itk::LightObject::Pointer otb::Wrapper::InputImageParameter::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

void otb::Wrapper::InputImageParameter::FromString ( const std::string &  value)
overridevirtual

Reimplemented from otb::Wrapper::Parameter.

ComplexDoubleImageType* otb::Wrapper::InputImageParameter::GetComplexDoubleImage ( )
ComplexDoubleVectorImageType* otb::Wrapper::InputImageParameter::GetComplexDoubleVectorImage ( )
ComplexFloatImageType* otb::Wrapper::InputImageParameter::GetComplexFloatImage ( )
ComplexFloatVectorImageType* otb::Wrapper::InputImageParameter::GetComplexFloatVectorImage ( )
ComplexInt16ImageType* otb::Wrapper::InputImageParameter::GetComplexInt16Image ( )
ComplexInt16VectorImageType* otb::Wrapper::InputImageParameter::GetComplexInt16VectorImage ( )
ComplexInt32ImageType* otb::Wrapper::InputImageParameter::GetComplexInt32Image ( )
ComplexInt32VectorImageType* otb::Wrapper::InputImageParameter::GetComplexInt32VectorImage ( )
DoubleImageType* otb::Wrapper::InputImageParameter::GetDoubleImage ( )

Get the input image as XXXImageType

DoubleVectorImageType* otb::Wrapper::InputImageParameter::GetDoubleVectorImage ( )
virtual const std::string& otb::Wrapper::InputImageParameter::GetFileName ( ) const
virtual

Set value from filename

FloatImageType* otb::Wrapper::InputImageParameter::GetFloatImage ( )

Get the input image as XXXImageType

FloatVectorImageType* otb::Wrapper::InputImageParameter::GetFloatVectorImage ( )
ImageBaseType const* otb::Wrapper::InputImageParameter::GetImage ( ) const

Get input-image as ImageBaseType.

Referenced by otb::Wrapper::Application::GetParameterImage().

ImageBaseType* otb::Wrapper::InputImageParameter::GetImage ( )

Get input-image as ImageBaseType.

template<class TImageType >
TImageType * otb::Wrapper::InputImageParameter::GetImage ( )
template<>
OTBApplicationEngine_EXPORT ImageBaseType* otb::Wrapper::InputImageParameter::GetImage ( )

declare a specialization for ImageBaseType

Int16ImageType* otb::Wrapper::InputImageParameter::GetInt16Image ( )

Get the input image as XXXImageType

Int16VectorImageType* otb::Wrapper::InputImageParameter::GetInt16VectorImage ( )
Int32ImageType* otb::Wrapper::InputImageParameter::GetInt32Image ( )

Get the input image as XXXImageType

Int32VectorImageType* otb::Wrapper::InputImageParameter::GetInt32VectorImage ( )
virtual const char* otb::Wrapper::InputImageParameter::GetNameOfClass ( ) const
virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

ParameterType otb::Wrapper::InputImageParameter::GetType ( ) const
overridevirtual

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

UInt16ImageType* otb::Wrapper::InputImageParameter::GetUInt16Image ( )

Get the input image as XXXImageType

UInt16VectorImageType* otb::Wrapper::InputImageParameter::GetUInt16VectorImage ( )
UInt32ImageType* otb::Wrapper::InputImageParameter::GetUInt32Image ( )

Get the input image as XXXImageType

UInt32VectorImageType* otb::Wrapper::InputImageParameter::GetUInt32VectorImage ( )
UInt8ImageType* otb::Wrapper::InputImageParameter::GetUInt8Image ( )

Get the input image as XXXImageType

UInt8RGBAImageType* otb::Wrapper::InputImageParameter::GetUInt8RGBAImage ( )
UInt8RGBImageType* otb::Wrapper::InputImageParameter::GetUInt8RGBImage ( )
UInt8VectorImageType* otb::Wrapper::InputImageParameter::GetUInt8VectorImage ( )
bool otb::Wrapper::InputImageParameter::HasValue ( ) const
overridevirtual
static Pointer otb::Wrapper::InputImageParameter::New ( )
static

Defining ::New() static method

void otb::Wrapper::InputImageParameter::operator= ( const Parameter )
privatedelete
bool otb::Wrapper::InputImageParameter::SetFromFileName ( const std::string &  filename)

Set value from filename

void otb::Wrapper::InputImageParameter::SetImage ( ImageBaseType image)

Set a templated image.

std::string otb::Wrapper::InputImageParameter::ToString ( ) const
overridevirtual

Parameter conversion functions. They are used by WrapperApplication to provide functions like SetParameterInt, GetParameterString, etc.

Reimplemented from otb::Wrapper::Parameter.

Member Data Documentation

std::string otb::Wrapper::InputImageParameter::m_FileName
private

Definition at line 131 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

ImageBaseType::Pointer otb::Wrapper::InputImageParameter::m_Image
private

Definition at line 134 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

itk::ProcessObject::Pointer otb::Wrapper::InputImageParameter::m_InputCaster
private

Definition at line 136 of file otbWrapperInputImageParameter.h.

itk::ProcessObject::Pointer otb::Wrapper::InputImageParameter::m_OutputCaster
private

Definition at line 137 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

std::string otb::Wrapper::InputImageParameter::m_PreviousFileName
private

Store the loaded image filename

Definition at line 153 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

itk::ProcessObject::Pointer otb::Wrapper::InputImageParameter::m_Reader
private

Definition at line 132 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

bool otb::Wrapper::InputImageParameter::m_UseFilename
private

flag : are we using a filename or an image pointer as an input

Definition at line 156 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().


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