otb::ExtendedFilenameToReaderOptions Class Reference

#include <otbExtendedFilenameToReaderOptions.h>

Inheritance diagram for otb::ExtendedFilenameToReaderOptions:

Collaboration diagram for otb::ExtendedFilenameToReaderOptions:

Classes
struct	OptionType

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass	FNameHelperType
typedef MapType::iterator	MapIteratorType
typedef FNameHelperType::OptionMapType	MapType
typedef itk::SmartPointer< Self >	Pointer
typedef ExtendedFilenameToReaderOptions	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
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
bool	ExtGEOMFileNameIsSet () const
std::string	GetBandRange () const
const char *	GetExtGEOMFileName () const
virtual const char *	GetNameOfClass () const
unsigned int	GetResolutionFactor () const
bool	GetSkipCarto () const
bool	GetSkipGeom () const
bool	GetSkipRpcTag () const
unsigned int	GetSubDatasetIndex () const
bool	ResolutionFactorIsSet () const
void	SetExtendedFileName (const char *extFname) override
void	SetExtendedFileName (const std::string &extFname) override
bool	SimpleFileNameIsSet () const
bool	SkipCartoIsSet () const
bool	SkipGeomIsSet () const
bool	SkipRpcTagIsSet () const
bool	SubDatasetIndexIsSet () 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 ()

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

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

Private Attributes
OptionType	m_Options

Detailed Description

Converts an extended filename to reader options.

Available options for extended file name are:

• &geom : to specify an external geom file
• &sdataidx : sub-dataset index for composite files
• &resol : resolution factor for jpeg200 files
• &skipcarto : switch to skip the cartographic information
• &skipgeom : switch to skip the geometric information

• &bands : select a band composition different from the input image, syntax is bands=r1,r2,r3,...,rn where each ri is a band range that can be :

  • a single index (1-based) : '2' means 2nd band, '-1' means last band
  • a range of bands : '3:' means 3rd band until the last one ':-2' means the first bands until the second to last '2:4' means bands 2,3 and 4

  See also

  ImageFileReader

Definition at line 52 of file otbExtendedFilenameToReaderOptions.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 58 of file otbExtendedFilenameToReaderOptions.h.

FNameHelperType

typedef Superclass otb::ExtendedFilenameToReaderOptions::FNameHelperType

Definition at line 62 of file otbExtendedFilenameToReaderOptions.h.

MapIteratorType

typedef MapType::iterator otb::ExtendedFilenameToReaderOptions::MapIteratorType

Definition at line 66 of file otbExtendedFilenameToReaderOptions.h.

MapType

typedef FNameHelperType::OptionMapType otb::ExtendedFilenameToReaderOptions::MapType

Definition at line 65 of file otbExtendedFilenameToReaderOptions.h.

Pointer

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

Definition at line 57 of file otbExtendedFilenameToReaderOptions.h.

Self

typedef ExtendedFilenameToReaderOptions otb::ExtendedFilenameToReaderOptions::Self

Standard class typedefs.

Definition at line 56 of file otbExtendedFilenameToReaderOptions.h.

Superclass

typedef ExtendedFilenameHelper otb::ExtendedFilenameToReaderOptions::Superclass

Definition at line 59 of file otbExtendedFilenameToReaderOptions.h.

Constructor & Destructor Documentation

ExtendedFilenameToReaderOptions() [1/2]

otb::ExtendedFilenameToReaderOptions::ExtendedFilenameToReaderOptions ( )

protected

~ExtendedFilenameToReaderOptions()

otb::ExtendedFilenameToReaderOptions::~ExtendedFilenameToReaderOptions ( )

inlineoverrideprotected

Definition at line 108 of file otbExtendedFilenameToReaderOptions.h.

ExtendedFilenameToReaderOptions() [2/2]

otb::ExtendedFilenameToReaderOptions::ExtendedFilenameToReaderOptions ( const Self &  )

privatedelete

Member Function Documentation

BandRangeIsSet()

bool otb::ExtendedFilenameToReaderOptions::BandRangeIsSet

(

)

const

Test if band range extended filename is set

CreateAnother()

virtual::itk::LightObject::Pointer otb::ExtendedFilenameToReaderOptions::CreateAnother

(

void

)

const

ExtGEOMFileNameIsSet()

bool otb::ExtendedFilenameToReaderOptions::ExtGEOMFileNameIsSet

(

)

const

GetBandRange()

std::string otb::ExtendedFilenameToReaderOptions::GetBandRange

(

)

const

GetExtGEOMFileName()

const char* otb::ExtendedFilenameToReaderOptions::GetExtGEOMFileName

(

)

const

GetNameOfClass()

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

virtual

Reimplemented from otb::ExtendedFilenameHelper.

GetResolutionFactor()

unsigned int otb::ExtendedFilenameToReaderOptions::GetResolutionFactor

(

)

const

GetSkipCarto()

bool otb::ExtendedFilenameToReaderOptions::GetSkipCarto

(

)

const

GetSkipGeom()

bool otb::ExtendedFilenameToReaderOptions::GetSkipGeom

(

)

const

GetSkipRpcTag()

bool otb::ExtendedFilenameToReaderOptions::GetSkipRpcTag

(

)

const

GetSubDatasetIndex()

unsigned int otb::ExtendedFilenameToReaderOptions::GetSubDatasetIndex

(

)

const

New()

static Pointer otb::ExtendedFilenameToReaderOptions::New ( )

static

operator=()

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

privatedelete

ResolutionFactorIsSet()

bool otb::ExtendedFilenameToReaderOptions::ResolutionFactorIsSet

(

)

const

SetExtendedFileName() [1/2]

void otb::ExtendedFilenameToReaderOptions::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::ExtendedFilenameToReaderOptions::SetExtendedFileName ( const std::string &  extFname )

overridevirtual

Reimplemented from otb::ExtendedFilenameHelper.

SimpleFileNameIsSet()

bool otb::ExtendedFilenameToReaderOptions::SimpleFileNameIsSet

(

)

const

SkipCartoIsSet()

bool otb::ExtendedFilenameToReaderOptions::SkipCartoIsSet

(

)

const

SkipGeomIsSet()

bool otb::ExtendedFilenameToReaderOptions::SkipGeomIsSet

(

)

const

SkipRpcTagIsSet()

bool otb::ExtendedFilenameToReaderOptions::SkipRpcTagIsSet

(

)

const

SubDatasetIndexIsSet()

bool otb::ExtendedFilenameToReaderOptions::SubDatasetIndexIsSet

(

)

const

Member Data Documentation

m_Options

OptionType otb::ExtendedFilenameToReaderOptions::m_Options

private

Definition at line 116 of file otbExtendedFilenameToReaderOptions.h.

---

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

• otbExtendedFilenameToReaderOptions.h