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

#include <otbWrapperOutputImageParameter.h>

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

Public Types

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

std::string CheckFileName (bool fixMissingExtension=false)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
void FromString (const std::string &value) override
virtual const char * GetFileName () const
virtual const char * GetNameOfClass () const
ParameterType GetType () const override
ImageBaseTypeGetValue (void)
itk::ProcessObjectGetWriter ()
bool HasValue () const override
void InitializeWriters ()
 itkGetObjectMacro (Image, ImageBaseType)
void Reset () override
void SetFileName (const char *filename)
void SetFileName (const std::string &filename)
virtual void SetImage (ImageBaseType *_arg)
void SetValue (ImageBaseType *image)
std::string ToString () const override
void Write ()
virtual void SetPixelType (ImagePixelType _arg)
virtual ImagePixelType GetPixelType ()
virtual void SetDefaultPixelType (ImagePixelType _arg)
virtual ImagePixelType GetDefaultPixelType ()
virtual void SetRAMValue (unsigned int _arg)
virtual unsigned int GetRAMValue ()
- Public Member Functions inherited from otb::Wrapper::Parameter
virtual void AddChild (Parameter::Pointer child)
void AutomaticValueOff ()
void AutomaticValueOn ()
virtual void ClearValue ()
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 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 std::string ConvertPixelTypeToString (ImagePixelType type)
static bool ConvertStringToPixelType (const std::string &value, ImagePixelType &type)
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

 OutputImageParameter ()
 ~OutputImageParameter () 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 Member Functions

template<typename TOutputImage , typename TInputImage >
void ClampAndWriteVectorImage (TInputImage *)
void operator= (const Parameter &)=delete
 OutputImageParameter (const Parameter &)=delete
template<typename TInputImage >
void SwitchInput (TInputImage *)

Private Attributes

ImagePixelType m_DefaultPixelType
std::string m_FileName
ImageBaseType::Pointer m_Image
itk::ProcessObject::Pointer m_InputCaster
itk::ProcessObject::Pointer m_OutputCaster
ImagePixelType m_PixelType
unsigned int m_RAMValue
itk::ProcessObject::Pointer m_Writer

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 OutputImage parameter.

Definition at line 41 of file otbWrapperOutputImageParameter.h.

Member Typedef Documentation

Definition at line 48 of file otbWrapperOutputImageParameter.h.

Definition at line 47 of file otbWrapperOutputImageParameter.h.

Standard class typedef

Definition at line 45 of file otbWrapperOutputImageParameter.h.

Definition at line 46 of file otbWrapperOutputImageParameter.h.

Constructor & Destructor Documentation

otb::Wrapper::OutputImageParameter::OutputImageParameter ( )


otb::Wrapper::OutputImageParameter::~OutputImageParameter ( )


otb::Wrapper::OutputImageParameter::OutputImageParameter ( const Parameter )

Member Function Documentation

std::string otb::Wrapper::OutputImageParameter::CheckFileName ( bool  fixMissingExtension = false)
template<typename TOutputImage , typename TInputImage >
void otb::Wrapper::OutputImageParameter::ClampAndWriteVectorImage ( TInputImage *  )
static std::string otb::Wrapper::OutputImageParameter::ConvertPixelTypeToString ( ImagePixelType  type)

Static method to convert pixel type into string

static bool otb::Wrapper::OutputImageParameter::ConvertStringToPixelType ( const std::string &  value,
ImagePixelType type 

Converts a string into a pixel type (returns false if the conversion fails)

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

Reimplemented from itk::Object.

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 122 of file otbWrapperOutputImageParameter.h.

virtual ImagePixelType otb::Wrapper::OutputImageParameter::GetDefaultPixelType ( )

Set/Get DefaultPixelType

virtual const char* otb::Wrapper::OutputImageParameter::GetFileName ( ) const
virtual const char* otb::Wrapper::OutputImageParameter::GetNameOfClass ( ) const

RTTI support

Reimplemented from otb::Wrapper::Parameter.

virtual ImagePixelType otb::Wrapper::OutputImageParameter::GetPixelType ( )

Set/Get PixelType to be used when saving

virtual unsigned int otb::Wrapper::OutputImageParameter::GetRAMValue ( )

Set/Get available RAM value

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

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 112 of file otbWrapperOutputImageParameter.h.

References otb::Wrapper::ParameterType_OutputImage.

ImageBaseType* otb::Wrapper::OutputImageParameter::GetValue ( void  )

Return any value

itk::ProcessObject* otb::Wrapper::OutputImageParameter::GetWriter ( )
bool otb::Wrapper::OutputImageParameter::HasValue ( ) const

Return true if a filename is set

Implements otb::Wrapper::Parameter.

void otb::Wrapper::OutputImageParameter::InitializeWriters ( )
otb::Wrapper::OutputImageParameter::itkGetObjectMacro ( Image  ,

Get the value

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

Defining ::New() static method

void otb::Wrapper::OutputImageParameter::operator= ( const Parameter )
void otb::Wrapper::OutputImageParameter::Reset ( void  )

Implement the reset method (replace pixel type by default type)

Reimplemented from otb::Wrapper::Parameter.

Definition at line 84 of file otbWrapperOutputImageParameter.h.

virtual void otb::Wrapper::OutputImageParameter::SetDefaultPixelType ( ImagePixelType  _arg)

Set/Get DefaultPixelType

void otb::Wrapper::OutputImageParameter::SetFileName ( const char *  filename)
void otb::Wrapper::OutputImageParameter::SetFileName ( const std::string &  filename)
virtual void otb::Wrapper::OutputImageParameter::SetImage ( ImageBaseType _arg)

Set the value

virtual void otb::Wrapper::OutputImageParameter::SetPixelType ( ImagePixelType  _arg)

Set/Get PixelType to be used when saving

virtual void otb::Wrapper::OutputImageParameter::SetRAMValue ( unsigned int  _arg)

Set/Get available RAM value

void otb::Wrapper::OutputImageParameter::SetValue ( ImageBaseType image)
template<typename TInputImage >
void otb::Wrapper::OutputImageParameter::SwitchInput ( TInputImage *  )

Switch TInputImage according to expected output type.

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

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 117 of file otbWrapperOutputImageParameter.h.

void otb::Wrapper::OutputImageParameter::Write ( )

Member Data Documentation

ImagePixelType otb::Wrapper::OutputImageParameter::m_DefaultPixelType

Definition at line 157 of file otbWrapperOutputImageParameter.h.

std::string otb::Wrapper::OutputImageParameter::m_FileName

Definition at line 154 of file otbWrapperOutputImageParameter.h.

ImageBaseType::Pointer otb::Wrapper::OutputImageParameter::m_Image

Definition at line 147 of file otbWrapperOutputImageParameter.h.

itk::ProcessObject::Pointer otb::Wrapper::OutputImageParameter::m_InputCaster

Definition at line 149 of file otbWrapperOutputImageParameter.h.

itk::ProcessObject::Pointer otb::Wrapper::OutputImageParameter::m_OutputCaster

Definition at line 150 of file otbWrapperOutputImageParameter.h.

ImagePixelType otb::Wrapper::OutputImageParameter::m_PixelType

Definition at line 156 of file otbWrapperOutputImageParameter.h.

unsigned int otb::Wrapper::OutputImageParameter::m_RAMValue

Definition at line 159 of file otbWrapperOutputImageParameter.h.

itk::ProcessObject::Pointer otb::Wrapper::OutputImageParameter::m_Writer

Definition at line 152 of file otbWrapperOutputImageParameter.h.

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