otb::Wrapper::InputImageParameter Class Reference

#include <otbWrapperInputImageParameter.h>

Inheritance diagram for otb::Wrapper::InputImageParameter:

Collaboration diagram for otb::Wrapper::InputImageParameter:

Classes
struct	Connector

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef InputImageParameter	Self
typedef Parameter	Superclass
Public Types inherited from otb::Wrapper::Parameter
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef Parameter	Self
typedef itk::Object	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
template<>
OTBApplicationEngine_EXPORT ImageBaseType *	GetImage ()
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from otb::Wrapper::Parameter
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 void	SetAutomaticValue (bool flag)
virtual bool	GetAutomaticValue () const
void	AutomaticValueOn ()
void	AutomaticValueOff ()
virtual void	SetUserLevel (const UserLevel level)
virtual UserLevel	GetUserLevel () const
virtual void	SetRole (const Role role)
virtual Role	GetRole () const
virtual void	Reset ()
virtual bool	HasUserValue () const
virtual void	SetUserValue (bool isUserValue)
virtual void	SetRoot (const Parameter::Pointer root)
virtual const Parameter::Pointer	GetRoot () const
virtual bool	IsRoot () const
virtual void	AddChild (Parameter::Pointer child)
virtual std::vector< Parameter::Pointer >	GetChildrenList ()
void	TypeError (const std::string &target_type) const
virtual int	ToInt () const
virtual float	ToFloat () const
virtual double	ToDouble () const
virtual std::vector< std::string >	ToStringList () const
virtual void	FromInt (int)
virtual void	FromFloat (float)
virtual void	FromDouble (double)
virtual void	FromStringList (const std::vector< std::string > &)

Static Public Member Functions
static Pointer	New ()
std::string	m_FileName
itk::ProcessObject::Pointer	m_Reader = nullptr
ImageBaseType::Pointer	m_Image = nullptr
itk::ProcessObject::Pointer	m_OutputCaster = nullptr
itk::DataObject::Pointer	m_OutputCasted = nullptr
std::string	m_PreviousFileName
bool	m_UseFilename = true
Connector	m_Connection {}
bool	SetFromFileName (std::string filename)
virtual const std::string &	GetFileName () const
void	SetConnection (Connector c)
const Connector &	GetConnection () const
void	SetConnectionMode (bool isMem)
ImageBaseType const *	GetImage () const
ImageBaseType *	GetImage ()
UInt8ImageType *	GetUInt8Image ()
UInt16ImageType *	GetUInt16Image ()
Int16ImageType *	GetInt16Image ()
UInt32ImageType *	GetUInt32Image ()
Int32ImageType *	GetInt32Image ()
FloatImageType *	GetFloatImage ()
DoubleImageType *	GetDoubleImage ()
UInt8VectorImageType *	GetUInt8VectorImage ()
UInt16VectorImageType *	GetUInt16VectorImage ()
Int16VectorImageType *	GetInt16VectorImage ()
UInt32VectorImageType *	GetUInt32VectorImage ()
Int32VectorImageType *	GetInt32VectorImage ()
FloatVectorImageType *	GetFloatVectorImage ()
DoubleVectorImageType *	GetDoubleVectorImage ()
UInt8RGBImageType *	GetUInt8RGBImage ()
UInt8RGBAImageType *	GetUInt8RGBAImage ()
ComplexInt16ImageType *	GetComplexInt16Image ()
ComplexInt32ImageType *	GetComplexInt32Image ()
ComplexFloatImageType *	GetComplexFloatImage ()
ComplexDoubleImageType *	GetComplexDoubleImage ()
ComplexInt16VectorImageType *	GetComplexInt16VectorImage ()
ComplexInt32VectorImageType *	GetComplexInt32VectorImage ()
ComplexFloatVectorImageType *	GetComplexFloatVectorImage ()
ComplexDoubleVectorImageType *	GetComplexDoubleVectorImage ()
template<class TImageType >
TImageType *	GetImage ()
void	SetImage (ImageBaseType *image)
template<class TInputImage , class TOutputImage >
TOutputImage *	CastImage ()
bool	HasValue () const override
void	ClearValue () override
ParameterType	GetType () const override
std::string	ToString () const override
void	FromString (const std::string &value) override
	InputImageParameter ()
	~InputImageParameter () override=default
	InputImageParameter (const Parameter &)=delete
void	operator= (const Parameter &)=delete
template<typename TOutputImage , typename TInputImage >
TOutputImage *	Cast (TInputImage *)

Additional Inherited Members
Protected Member Functions inherited from otb::Wrapper::Parameter
	Parameter ()
Protected Attributes inherited from otb::Wrapper::Parameter
std::string	m_Name
std::string	m_Description
std::string	m_Key
bool	m_Mandatory
bool	m_Active
bool	m_UserValue
UserLevel	m_UserLevel
Role	m_Role
itk::WeakPointer< Parameter >	m_Root
std::vector< Parameter::Pointer >	m_ChildrenList

Detailed Description

This class represents a InputImage parameter.

Definition at line 43 of file otbWrapperInputImageParameter.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::Wrapper::InputImageParameter::ConstPointer

Definition at line 50 of file otbWrapperInputImageParameter.h.

Pointer

typedef itk::SmartPointer<Self> otb::Wrapper::InputImageParameter::Pointer

Definition at line 49 of file otbWrapperInputImageParameter.h.

Self

typedef InputImageParameter otb::Wrapper::InputImageParameter::Self

Standard class typedef

Definition at line 47 of file otbWrapperInputImageParameter.h.

Superclass

typedef Parameter otb::Wrapper::InputImageParameter::Superclass

Definition at line 48 of file otbWrapperInputImageParameter.h.

Constructor & Destructor Documentation

InputImageParameter() [1/2]

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

protected

Constructor

~InputImageParameter()

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

overrideprotecteddefault

Destructor

InputImageParameter() [2/2]

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

privatedelete

Store the loaded image filename

Member Function Documentation

Cast()

template<typename TOutputImage , typename TInputImage >

TOutputImage * otb::Wrapper::InputImageParameter::Cast ( TInputImage *  image )

private

Store the loaded image filename

Definition at line 82 of file otbWrapperInputImageParameter.hxx.

References otb::clamp(), m_OutputCasted, and m_OutputCaster.

CastImage()

template<class TInputImage , class TOutputImage >

TOutputImage* otb::Wrapper::InputImageParameter::CastImage

(

)

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

ClearValue()

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

overridevirtual

Store the loaded image filename

Reimplemented from otb::Wrapper::Parameter.

CreateAnother()

virtual::itk::LightObject::Pointer otb::Wrapper::InputImageParameter::CreateAnother

(

void

)

const

FromString()

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

overridevirtual

Store the loaded image filename

Reimplemented from otb::Wrapper::Parameter.

GetComplexDoubleImage()

ComplexDoubleImageType* otb::Wrapper::InputImageParameter::GetComplexDoubleImage

(

)

Store the loaded image filename

GetComplexDoubleVectorImage()

ComplexDoubleVectorImageType* otb::Wrapper::InputImageParameter::GetComplexDoubleVectorImage

(

)

Store the loaded image filename

GetComplexFloatImage()

ComplexFloatImageType* otb::Wrapper::InputImageParameter::GetComplexFloatImage

(

)

Store the loaded image filename

GetComplexFloatVectorImage()

ComplexFloatVectorImageType* otb::Wrapper::InputImageParameter::GetComplexFloatVectorImage

(

)

Store the loaded image filename

GetComplexInt16Image()

ComplexInt16ImageType* otb::Wrapper::InputImageParameter::GetComplexInt16Image

(

)

Store the loaded image filename

GetComplexInt16VectorImage()

ComplexInt16VectorImageType* otb::Wrapper::InputImageParameter::GetComplexInt16VectorImage

(

)

Store the loaded image filename

GetComplexInt32Image()

ComplexInt32ImageType* otb::Wrapper::InputImageParameter::GetComplexInt32Image

(

)

Store the loaded image filename

GetComplexInt32VectorImage()

ComplexInt32VectorImageType* otb::Wrapper::InputImageParameter::GetComplexInt32VectorImage

(

)

Store the loaded image filename

GetConnection()

const Connector& otb::Wrapper::InputImageParameter::GetConnection ( ) const

inline

Store the loaded image filename

Definition at line 75 of file otbWrapperInputImageParameter.h.

GetDoubleImage()

DoubleImageType* otb::Wrapper::InputImageParameter::GetDoubleImage

(

)

Store the loaded image filename

GetDoubleVectorImage()

DoubleVectorImageType* otb::Wrapper::InputImageParameter::GetDoubleVectorImage

(

)

Store the loaded image filename

GetFileName()

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

virtual

Store the loaded image filename

GetFloatImage()

FloatImageType* otb::Wrapper::InputImageParameter::GetFloatImage

(

)

Store the loaded image filename

GetFloatVectorImage()

FloatVectorImageType* otb::Wrapper::InputImageParameter::GetFloatVectorImage

(

)

Store the loaded image filename

GetImage() [1/4]

ImageBaseType* otb::Wrapper::InputImageParameter::GetImage

(

)

Store the loaded image filename

GetImage() [2/4]

template<class TImageType >

TImageType * otb::Wrapper::InputImageParameter::GetImage

Get the input image as templated image type.

Definition at line 97 of file otbWrapperInputImageParameter.hxx.

References CLAMP_IMAGE_BASE, m_FileName, m_Image, m_OutputCasted, m_OutputCaster, m_PreviousFileName, m_Reader, and m_UseFilename.

GetImage() [3/4]

template<>

OTBApplicationEngine_EXPORT ImageBaseType* otb::Wrapper::InputImageParameter::GetImage

(

)

declare a specialization for ImageBaseType

GetImage() [4/4]

ImageBaseType const* otb::Wrapper::InputImageParameter::GetImage

(

)

const

Get input-image as ImageBaseType.

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

GetInt16Image()

Int16ImageType* otb::Wrapper::InputImageParameter::GetInt16Image

(

)

Store the loaded image filename

GetInt16VectorImage()

Int16VectorImageType* otb::Wrapper::InputImageParameter::GetInt16VectorImage

(

)

Store the loaded image filename

GetInt32Image()

Int32ImageType* otb::Wrapper::InputImageParameter::GetInt32Image

(

)

Store the loaded image filename

GetInt32VectorImage()

Int32VectorImageType* otb::Wrapper::InputImageParameter::GetInt32VectorImage

(

)

Store the loaded image filename

GetNameOfClass()

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

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

GetType()

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

overridevirtual

Store the loaded image filename

Implements otb::Wrapper::Parameter.

GetUInt16Image()

UInt16ImageType* otb::Wrapper::InputImageParameter::GetUInt16Image

(

)

Store the loaded image filename

GetUInt16VectorImage()

UInt16VectorImageType* otb::Wrapper::InputImageParameter::GetUInt16VectorImage

(

)

Store the loaded image filename

GetUInt32Image()

UInt32ImageType* otb::Wrapper::InputImageParameter::GetUInt32Image

(

)

Store the loaded image filename

GetUInt32VectorImage()

UInt32VectorImageType* otb::Wrapper::InputImageParameter::GetUInt32VectorImage

(

)

Store the loaded image filename

GetUInt8Image()

UInt8ImageType* otb::Wrapper::InputImageParameter::GetUInt8Image

(

)

Get the input image as XXXImageType

GetUInt8RGBAImage()

UInt8RGBAImageType* otb::Wrapper::InputImageParameter::GetUInt8RGBAImage

(

)

Store the loaded image filename

GetUInt8RGBImage()

UInt8RGBImageType* otb::Wrapper::InputImageParameter::GetUInt8RGBImage

(

)

Store the loaded image filename

GetUInt8VectorImage()

UInt8VectorImageType* otb::Wrapper::InputImageParameter::GetUInt8VectorImage

(

)

Store the loaded image filename

HasValue()

bool otb::Wrapper::InputImageParameter::HasValue ( ) const

overridevirtual

Store the loaded image filename

Implements otb::Wrapper::Parameter.

New()

static Pointer otb::Wrapper::InputImageParameter::New ( )

static

Defining ::New() static method

operator=()

void otb::Wrapper::InputImageParameter::operator= ( const Parameter &  )

privatedelete

Store the loaded image filename

SetConnection()

void otb::Wrapper::InputImageParameter::SetConnection ( Connector  c )

inline

Store the loaded image filename

Definition at line 70 of file otbWrapperInputImageParameter.h.

SetConnectionMode()

void otb::Wrapper::InputImageParameter::SetConnectionMode ( bool  isMem )

inline

Store the loaded image filename

Definition at line 80 of file otbWrapperInputImageParameter.h.

SetFromFileName()

bool otb::Wrapper::InputImageParameter::SetFromFileName

(

std::string

filename

)

Set value from filename

SetImage()

void otb::Wrapper::InputImageParameter::SetImage

(

ImageBaseType *

image

)

Set a templated image.

ToString()

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

overridevirtual

Store the loaded image filename

Reimplemented from otb::Wrapper::Parameter.

Member Data Documentation

m_Connection

Connector otb::Wrapper::InputImageParameter::m_Connection {}

private

Store the loaded image filename

Definition at line 171 of file otbWrapperInputImageParameter.h.

m_FileName

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

private

Store the loaded image filename

Definition at line 152 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

m_Image

ImageBaseType::Pointer otb::Wrapper::InputImageParameter::m_Image = nullptr

private

Store the loaded image filename

Definition at line 155 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

m_OutputCasted

itk::DataObject::Pointer otb::Wrapper::InputImageParameter::m_OutputCasted = nullptr

private

Store the loaded image filename

Definition at line 158 of file otbWrapperInputImageParameter.h.

Referenced by Cast(), and GetImage().

m_OutputCaster

itk::ProcessObject::Pointer otb::Wrapper::InputImageParameter::m_OutputCaster = nullptr

private

Store the loaded image filename

Definition at line 157 of file otbWrapperInputImageParameter.h.

Referenced by Cast(), and GetImage().

m_PreviousFileName

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

private

Store the loaded image filename

Definition at line 166 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

m_Reader

itk::ProcessObject::Pointer otb::Wrapper::InputImageParameter::m_Reader = nullptr

private

Store the loaded image filename

Definition at line 153 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

m_UseFilename

bool otb::Wrapper::InputImageParameter::m_UseFilename = true

private

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

Definition at line 169 of file otbWrapperInputImageParameter.h.

Referenced by GetImage().

---

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

• otbWrapperInputImageParameter.h
• otbWrapperInputImageParameter.hxx