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

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::ProcessObject * GetWriter ()
 
bool HasValue () const override
 
void InitializeWriters (otb::MultiImageFileWriter::Pointer multi=otb::MultiImageFileWriter::Pointer())
 
bool IsMultiWritingEnabled ()
 
 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 FromDouble (double)
 
virtual void FromFloat (float)
 
virtual void FromInt (int)
 
virtual void FromStringList (const std::vector< std::string > &)
 
virtual bool GetAutomaticValue () const
 
virtual std::vector< Parameter::PointerGetChildrenList ()
 
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 double ToDouble () const
 
virtual std::vector< std::string > ToStringList () const
 

Static Public Member Functions

static std::string ConvertPixelTypeToString (ImagePixelType type)
 
static bool ConvertStringToPixelType (const std::string &value, ImagePixelType &type)
 
static Pointer New ()
 

Protected Member Functions

 OutputImageParameter ()
 
 ~OutputImageParameter () override
 
- Protected Member Functions inherited from otb::Wrapper::Parameter
 Parameter ()
 

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
 
otb::MultiImageFileWriter::Pointer m_MultiWriter
 
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
 

Detailed Description

This class represents a OutputImage parameter.

Definition at line 41 of file otbWrapperOutputImageParameter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 48 of file otbWrapperOutputImageParameter.h.

◆ Pointer

Definition at line 47 of file otbWrapperOutputImageParameter.h.

◆ Self

Standard class typedef

Definition at line 45 of file otbWrapperOutputImageParameter.h.

◆ Superclass

Definition at line 46 of file otbWrapperOutputImageParameter.h.

Constructor & Destructor Documentation

◆ OutputImageParameter() [1/2]

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

Constructor

◆ ~OutputImageParameter()

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

Destructor

◆ OutputImageParameter() [2/2]

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

Member Function Documentation

◆ CheckFileName()

std::string otb::Wrapper::OutputImageParameter::CheckFileName ( bool  fixMissingExtension = false)

◆ ClampAndWriteVectorImage()

template<typename TOutputImage , typename TInputImage >
void otb::Wrapper::OutputImageParameter::ClampAndWriteVectorImage ( TInputImage *  )
private

◆ ConvertPixelTypeToString()

static std::string otb::Wrapper::OutputImageParameter::ConvertPixelTypeToString ( ImagePixelType  type)
static

Static method to convert pixel type into string

◆ ConvertStringToPixelType()

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

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

◆ CreateAnother()

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

◆ FromString()

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 126 of file otbWrapperOutputImageParameter.h.

◆ GetDefaultPixelType()

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

Set/Get DefaultPixelType

◆ GetFileName()

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

◆ GetNameOfClass()

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

RTTI support

Reimplemented from otb::Wrapper::Parameter.

◆ GetPixelType()

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

Set/Get PixelType to be used when saving

◆ GetRAMValue()

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

Set/Get available RAM value

◆ GetType()

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

Get the dynamic type as declared in WrapperTypes.h

Implements otb::Wrapper::Parameter.

Definition at line 116 of file otbWrapperOutputImageParameter.h.

References otb::Wrapper::ParameterType_OutputImage.

◆ GetValue()

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

Return any value

◆ GetWriter()

itk::ProcessObject* otb::Wrapper::OutputImageParameter::GetWriter ( )

◆ HasValue()

bool otb::Wrapper::OutputImageParameter::HasValue ( ) const
overridevirtual

Return true if a filename is set

Implements otb::Wrapper::Parameter.

◆ InitializeWriters()

void otb::Wrapper::OutputImageParameter::InitializeWriters ( otb::MultiImageFileWriter::Pointer  multi = otb::MultiImageFileWriter::Pointer())

Initialize internal writers, plus the multi-writer

◆ IsMultiWritingEnabled()

bool otb::Wrapper::OutputImageParameter::IsMultiWritingEnabled ( )

Check if multi-writing is enabled (several output images written together)

◆ itkGetObjectMacro()

otb::Wrapper::OutputImageParameter::itkGetObjectMacro ( Image  ,
ImageBaseType   
)

Get the value

◆ New()

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

Defining ::New() static method

◆ operator=()

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

◆ Reset()

void otb::Wrapper::OutputImageParameter::Reset ( void  )
inlineoverridevirtual

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 87 of file otbWrapperOutputImageParameter.h.

References value(), and otb::Wrapper::XML::Write().

◆ SetDefaultPixelType()

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

Set/Get DefaultPixelType

◆ SetFileName() [1/2]

void otb::Wrapper::OutputImageParameter::SetFileName ( const char *  filename)

◆ SetFileName() [2/2]

void otb::Wrapper::OutputImageParameter::SetFileName ( const std::string &  filename)

◆ SetImage()

virtual void otb::Wrapper::OutputImageParameter::SetImage ( ImageBaseType _arg)
virtual

Set the value

◆ SetPixelType()

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

Set/Get PixelType to be used when saving

◆ SetRAMValue()

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

Set/Get available RAM value

◆ SetValue()

void otb::Wrapper::OutputImageParameter::SetValue ( ImageBaseType image)

◆ SwitchInput()

template<typename TInputImage >
void otb::Wrapper::OutputImageParameter::SwitchInput ( TInputImage *  )
private

Switch TInputImage according to expected output type.

◆ ToString()

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

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

Reimplemented from otb::Wrapper::Parameter.

Definition at line 121 of file otbWrapperOutputImageParameter.h.

◆ Write()

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

Member Data Documentation

◆ m_DefaultPixelType

ImagePixelType otb::Wrapper::OutputImageParameter::m_DefaultPixelType
private

Definition at line 161 of file otbWrapperOutputImageParameter.h.

◆ m_FileName

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

Definition at line 158 of file otbWrapperOutputImageParameter.h.

◆ m_Image

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

Definition at line 151 of file otbWrapperOutputImageParameter.h.

◆ m_InputCaster

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

Definition at line 153 of file otbWrapperOutputImageParameter.h.

◆ m_MultiWriter

otb::MultiImageFileWriter::Pointer otb::Wrapper::OutputImageParameter::m_MultiWriter
private

Multi-writer, used in case several OutputImageParameter are written at once

Definition at line 166 of file otbWrapperOutputImageParameter.h.

◆ m_OutputCaster

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

Definition at line 154 of file otbWrapperOutputImageParameter.h.

◆ m_PixelType

ImagePixelType otb::Wrapper::OutputImageParameter::m_PixelType
private

Definition at line 160 of file otbWrapperOutputImageParameter.h.

◆ m_RAMValue

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

Definition at line 163 of file otbWrapperOutputImageParameter.h.

◆ m_Writer

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

Definition at line 156 of file otbWrapperOutputImageParameter.h.


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