otb::ExtendedFilenameToWriterOptions Class Reference

#include <otbExtendedFilenameToWriterOptions.h>

Inheritance diagram for otb::ExtendedFilenameToWriterOptions:

Collaboration diagram for otb::ExtendedFilenameToWriterOptions:

Classes
struct	OptionType

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass	FNameHelperType
typedef GDALImageIO::GDALCreationOptionsType	GDALCOType
typedef MapType::iterator	MapIteratorType
typedef FNameHelperType::OptionMapType	MapType
typedef std::vector< NoDataPairType >	NoDataListType
typedef std::pair< int, double >	NoDataPairType
typedef itk::SmartPointer< Self >	Pointer
typedef ExtendedFilenameToWriterOptions	Self
typedef ExtendedFilenameHelper	Superclass
Public Types inherited from otb::ExtendedFilenameHelper
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::map< std::string, std::string >	OptionMapType
typedef itk::SmartPointer< Self >	Pointer
typedef ExtendedFilenameHelper	Self
typedef itk::Object	Superclass

Public Member Functions
bool	BandRangeIsSet () const
bool	BoxIsSet () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
bool	gdalCreationOptionsIsSet () const
std::string	GetBandRange () const
std::string	GetBox () const
GDALCOType	GetgdalCreationOptions () const
bool	GetMultiWrite () const
virtual const char *	GetNameOfClass () const
NoDataListType	GetNoDataList () const
unsigned int	GetSrsValue () const
std::string	GetStreamingSizeMode () const
double	GetStreamingSizeValue () const
std::string	GetStreamingType () const
bool	GetWriteGEOMFile () const
bool	GetWriteRPCTags () const
bool	NoDataValueIsSet () const
void	SetExtendedFileName (const char *extFname) override
void	SetExtendedFileName (const std::string &extFname) override
bool	SimpleFileNameIsSet () const
bool	SrsValueIsSet () const
bool	StreamingSizeModeIsSet () const
bool	StreamingSizeValueIsSet () const
bool	StreamingTypeIsSet () const
bool	WriteGEOMFileIsSet () const
bool	WriteRPCTagsIsSet () const
Public Member Functions inherited from otb::ExtendedFilenameHelper
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetExtendedFileName () const
std::vector< ExtendedFilenameHelper::GenericBandRange >	GetGenericBandRange (const std::string &bandRange) const
const OptionMapType &	GetOptionMap (void) const
virtual const char *	GetSimpleFileName () const
bool	ResolveBandRange (const std::string &bandRange, const unsigned int &nbBands, std::vector< unsigned int > &output) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::ExtendedFilenameHelper
static Pointer	New ()

Public Attributes
bool	has_noDataValue
NoDataListType	m_NoDataList

Protected Member Functions
	ExtendedFilenameToWriterOptions ()
	~ExtendedFilenameToWriterOptions () override
Protected Member Functions inherited from otb::ExtendedFilenameHelper
	ExtendedFilenameHelper ()
	~ExtendedFilenameHelper () override

Private Member Functions
	ExtendedFilenameToWriterOptions (const Self &)=delete
void	operator= (const Self &)=delete

Private Attributes
OptionType	m_Options

Detailed Description

Converts an extended filename to writer options.

Available options for extended file name are:

• &writegeom=ON : to activate the creation of an external geom file
• &gdal:co:<KEY>=

: the gdal creation option <KEY>

• streaming modes
• box
• &bands=<BANDS_LIST> : to select a subset of bands from the output image
• &nodata=

/<VALUE:VALUE...> : to set specific nodata values

• &multiwrite=<(bool)false> : to deactivate multi-writing
• &epsg=

: to set the spatial reference system

See http://wiki.orfeo-toolbox.org/index.php/ExtendedFileName for more information

See also

ImageFileWriter

Definition at line 53 of file otbExtendedFilenameToWriterOptions.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::ExtendedFilenameToWriterOptions::ConstPointer

Definition at line 59 of file otbExtendedFilenameToWriterOptions.h.

FNameHelperType

typedef Superclass otb::ExtendedFilenameToWriterOptions::FNameHelperType

Definition at line 63 of file otbExtendedFilenameToWriterOptions.h.

GDALCOType

typedef GDALImageIO::GDALCreationOptionsType otb::ExtendedFilenameToWriterOptions::GDALCOType

The writer option structure.

Definition at line 70 of file otbExtendedFilenameToWriterOptions.h.

MapIteratorType

typedef MapType::iterator otb::ExtendedFilenameToWriterOptions::MapIteratorType

Definition at line 67 of file otbExtendedFilenameToWriterOptions.h.

MapType

typedef FNameHelperType::OptionMapType otb::ExtendedFilenameToWriterOptions::MapType

Definition at line 66 of file otbExtendedFilenameToWriterOptions.h.

NoDataListType

typedef std::vector<NoDataPairType> otb::ExtendedFilenameToWriterOptions::NoDataListType

Definition at line 90 of file otbExtendedFilenameToWriterOptions.h.

NoDataPairType

typedef std::pair<int, double> otb::ExtendedFilenameToWriterOptions::NoDataPairType

Definition at line 89 of file otbExtendedFilenameToWriterOptions.h.

Pointer

typedef itk::SmartPointer<Self> otb::ExtendedFilenameToWriterOptions::Pointer

Definition at line 58 of file otbExtendedFilenameToWriterOptions.h.

Self

typedef ExtendedFilenameToWriterOptions otb::ExtendedFilenameToWriterOptions::Self

Standard class typedefs.

Definition at line 57 of file otbExtendedFilenameToWriterOptions.h.

Superclass

typedef ExtendedFilenameHelper otb::ExtendedFilenameToWriterOptions::Superclass

Definition at line 60 of file otbExtendedFilenameToWriterOptions.h.

Constructor & Destructor Documentation

ExtendedFilenameToWriterOptions() [1/2]

otb::ExtendedFilenameToWriterOptions::ExtendedFilenameToWriterOptions ( )

protected

~ExtendedFilenameToWriterOptions()

otb::ExtendedFilenameToWriterOptions::~ExtendedFilenameToWriterOptions ( )

inlineoverrideprotected

Definition at line 132 of file otbExtendedFilenameToWriterOptions.h.

ExtendedFilenameToWriterOptions() [2/2]

otb::ExtendedFilenameToWriterOptions::ExtendedFilenameToWriterOptions ( const Self &  )

privatedelete

Member Function Documentation

BandRangeIsSet()

bool otb::ExtendedFilenameToWriterOptions::BandRangeIsSet

(

)

const

Test if band range extended filename is set

BoxIsSet()

bool otb::ExtendedFilenameToWriterOptions::BoxIsSet

(

)

const

CreateAnother()

virtual::itk::LightObject::Pointer otb::ExtendedFilenameToWriterOptions::CreateAnother

(

void

)

const

gdalCreationOptionsIsSet()

bool otb::ExtendedFilenameToWriterOptions::gdalCreationOptionsIsSet

(

)

const

GetBandRange()

std::string otb::ExtendedFilenameToWriterOptions::GetBandRange

(

)

const

GetBox()

std::string otb::ExtendedFilenameToWriterOptions::GetBox

(

)

const

GetgdalCreationOptions()

GDALCOType otb::ExtendedFilenameToWriterOptions::GetgdalCreationOptions

(

)

const

GetMultiWrite()

bool otb::ExtendedFilenameToWriterOptions::GetMultiWrite

(

)

const

GetNameOfClass()

virtual const char* otb::ExtendedFilenameToWriterOptions::GetNameOfClass ( ) const

virtual

Reimplemented from otb::ExtendedFilenameHelper.

GetNoDataList()

NoDataListType otb::ExtendedFilenameToWriterOptions::GetNoDataList ( ) const

inline

Definition at line 105 of file otbExtendedFilenameToWriterOptions.h.

GetSrsValue()

unsigned int otb::ExtendedFilenameToWriterOptions::GetSrsValue

(

)

const

GetStreamingSizeMode()

std::string otb::ExtendedFilenameToWriterOptions::GetStreamingSizeMode

(

)

const

GetStreamingSizeValue()

double otb::ExtendedFilenameToWriterOptions::GetStreamingSizeValue

(

)

const

GetStreamingType()

std::string otb::ExtendedFilenameToWriterOptions::GetStreamingType

(

)

const

GetWriteGEOMFile()

bool otb::ExtendedFilenameToWriterOptions::GetWriteGEOMFile

(

)

const

GetWriteRPCTags()

bool otb::ExtendedFilenameToWriterOptions::GetWriteRPCTags

(

)

const

New()

static Pointer otb::ExtendedFilenameToWriterOptions::New ( )

static

NoDataValueIsSet()

bool otb::ExtendedFilenameToWriterOptions::NoDataValueIsSet

(

)

const

operator=()

void otb::ExtendedFilenameToWriterOptions::operator= ( const Self &  )

privatedelete

SetExtendedFileName() [1/2]

void otb::ExtendedFilenameToWriterOptions::SetExtendedFileName ( const char *  extFname )

overridevirtual

Deprecated:

const char* overload of SetExtendedFileName is deprecated, use std::string instead

Reimplemented from otb::ExtendedFilenameHelper.

SetExtendedFileName() [2/2]

void otb::ExtendedFilenameToWriterOptions::SetExtendedFileName ( const std::string &  extFname )

overridevirtual

Reimplemented from otb::ExtendedFilenameHelper.

SimpleFileNameIsSet()

bool otb::ExtendedFilenameToWriterOptions::SimpleFileNameIsSet

(

)

const

SrsValueIsSet()

bool otb::ExtendedFilenameToWriterOptions::SrsValueIsSet

(

)

const

StreamingSizeModeIsSet()

bool otb::ExtendedFilenameToWriterOptions::StreamingSizeModeIsSet

(

)

const

StreamingSizeValueIsSet()

bool otb::ExtendedFilenameToWriterOptions::StreamingSizeValueIsSet

(

)

const

StreamingTypeIsSet()

bool otb::ExtendedFilenameToWriterOptions::StreamingTypeIsSet

(

)

const

WriteGEOMFileIsSet()

bool otb::ExtendedFilenameToWriterOptions::WriteGEOMFileIsSet

(

)

const

WriteRPCTagsIsSet()

bool otb::ExtendedFilenameToWriterOptions::WriteRPCTagsIsSet

(

)

const

Member Data Documentation

has_noDataValue

bool otb::ExtendedFilenameToWriterOptions::has_noDataValue

Definition at line 92 of file otbExtendedFilenameToWriterOptions.h.

m_NoDataList

NoDataListType otb::ExtendedFilenameToWriterOptions::m_NoDataList

Definition at line 91 of file otbExtendedFilenameToWriterOptions.h.

m_Options

OptionType otb::ExtendedFilenameToWriterOptions::m_Options

private

Definition at line 140 of file otbExtendedFilenameToWriterOptions.h.

---

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

• otbExtendedFilenameToWriterOptions.h