SPATMOD::IMAGE::TARGET_RVC_MULTIFILE Class Reference

RVC multi-raster (tiled) target. More...

#include <spatmod/imagetargetrvcmultifile.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_RVC_MULTIFILE:

Public Types
typedef fastdelegate::FastDelegate < ERRVALUE(INT32, INT32, const FILEPATH &, const LRECT2D &)>	DELEGATE_TILE_ADD
enum	FORMAT { FORMAT_TIFF = 2, FORMAT_MrSID = 4, FORMAT_ECW = 5, FORMAT_JP2 = 6, FORMAT_PNG = 8, FORMAT_JPEG = 9 }
enum	PROFILE { PROFILE_None, PROFILE_Global_Geodetic, PROFILE_Global_Mercator }
enum	STRUCTURE { STRUCTURE_General_SingleFolder, STRUCTURE_General_TreeTileRow, STRUCTURE_General_TreeTileColumn, STRUCTURE_OSGEO_TileMapService }
Public Member Functions
	TARGET_RVC_MULTIFILE (STAGE pInputStage, FORMAT format, const RVC::OBJITEMLIST &ObjItemList, INT32 ResLevel, INT32 ColumnsPerTile, INT32 RowsPerTile, const RVC::CREDENTIALS pCredentials=0)
	TARGET_RVC_MULTIFILE (STAGE pInputStage, FORMAT format, const RVC::OBJITEM &ObjItem, INT32 ResLevel, INT32 ColumnsPerTile, INT32 RowsPerTile, const RVC::CREDENTIALS pCredentials=0)
virtual	~TARGET_RVC_MULTIFILE ()
ERRVALUE	SetActualDimensions (INT32 ActualColumns, INT32 ActualRows)
void	SetDelegateOnTileAdd (DELEGATE_TILE_ADD delegate)
void	SetDelegateOnTileEnd (DELEGATE_ERRVALUE_NOPARMS delegate)
void	SetGeoFormats (TARGET_FILE::GEOFORMATS GeoFormats)
void	SetOutputStructure (STRUCTURE structure)
void	SetParmsJP2 (const TARGETPARM_J2K &parm)
void	SetParmsJPEG (INT16 quality)
void	SetParmsTIFF (const TARGETPARM_TIFF &Parm)
void	SetProfile (PROFILE profile)
void	SetTileFolderBasePath (const FILEPATH &filepath)
void	SetTileNamePrefix (const MISTRING &NamePrefix)

Detailed Description

RVC multi-raster (tiled) target.

Member Typedef Documentation

typedef fastdelegate::FastDelegate<ERRVALUE(INT32, INT32, const FILEPATH&, const LRECT2D&)> SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::DELEGATE_TILE_ADD

Delegate type for notifying when tile to be added.

Member Enumeration Documentation

enum SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::FORMAT

Format of external tiles.

Values are chosen to match RVC::RASTER::LINKTYPE values, be sure additions match also

Enumerator:

FORMAT_TIFF	TIFF file.
FORMAT_MrSID	LizardTech MrSID file.
FORMAT_ECW	ERMapper ECW file.
FORMAT_JP2	JPEG2000 JP2 file.
FORMAT_PNG	PNG file.
FORMAT_JPEG	JPEG file.

enum SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::PROFILE

Enumerator:

PROFILE_None
PROFILE_Global_Geodetic
PROFILE_Global_Mercator

enum SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::STRUCTURE

Directory structure to use when storing tile files.

Enumerator:

STRUCTURE_General_SingleFolder	All tiles in one folder for each resolution level.
STRUCTURE_General_TreeTileRow	Tiles in folders by row, folder name is row index.
STRUCTURE_General_TreeTileColumn	Tiles in folders by column, folder name is column index.
STRUCTURE_OSGEO_TileMapService	OSGEO Tile Map Service structure and naming.

Constructor & Destructor Documentation

SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::TARGET_RVC_MULTIFILE	(	STAGE *	pInputStage,
		FORMAT	format,
		const RVC::OBJITEM &	ObjItem,
		INT32	ResLevel,
		INT32	ColumnsPerTile,
		INT32	RowsPerTile,
		const RVC::CREDENTIALS *	pCredentials = `0`
	)

Construct target with single output object.

If source image cannot be written to single object an error will occur when Initialize() is called.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	format	Image tile file format
	ObjItem	Object location and descriptor
	pCredentials	Optional credentials

SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::TARGET_RVC_MULTIFILE	(	STAGE *	pInputStage,
		FORMAT	format,
		const RVC::OBJITEMLIST &	ObjItemList,
		INT32	ResLevel,
		INT32	ColumnsPerTile,
		INT32	RowsPerTile,
		const RVC::CREDENTIALS *	pCredentials = `0`
	)

Construct target with multiple output objects.

If source image cannot be written to multiple objects an error will occur when Initialize() is called.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	format	Image tile file format
	ObjItemList	Object locations and descriptors
	pCredentials	Optional credentials

virtual SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::~TARGET_RVC_MULTIFILE ( ) [virtual]

Destructor.

Member Function Documentation

ERRVALUE SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetActualDimensions	(	INT32	ActualColumns,
		INT32	ActualRows
	)

Set actual dimensions of RVC raster itself.

This allows for exclusion of part of last column/row of tiles. Must be done before initialize. If not used, will match input stage dimensions.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetDelegateOnTileAdd ( DELEGATE_TILE_ADD delegate ) [inline]

Set delegate to call when new tile is to be added.

Will not be called for entirely empty tiles. Can be used to keep track of when new step has begun.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetDelegateOnTileEnd ( DELEGATE_ERRVALUE_NOPARMS delegate ) [inline]

Set delegate to call at end of tile.

Will not be called for entirely empty tiles. Can be used to keep track of when step has completed.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetGeoFormats ( TARGET_FILE::GEOFORMATS GeoFormats ) [inline]

Set external georeference formats to save with each tile.

Default is to not save georeference in file separate from tile.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetOutputStructure ( STRUCTURE structure ) [inline]

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetParmsJP2 ( const TARGETPARM_J2K & parm )

Set parameters specific to JP2 format.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetParmsJPEG ( INT16 quality ) [inline]

Set parameters specific to JPEG format.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetParmsTIFF ( const TARGETPARM_TIFF & Parm )

Set parameters specific to TIFF format.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetProfile ( PROFILE profile ) [inline]

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetTileFolderBasePath ( const FILEPATH & filepath ) [inline]

Set tile folder base path.

If not set will be derived from RVC file and raster name.

void SPATMOD::IMAGE::TARGET_RVC_MULTIFILE::SetTileNamePrefix ( const MISTRING & NamePrefix ) [inline]

Set prefix for tile file names.

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

spatmod/imagetargetrvcmultifile.h

SPATMOD::IMAGE::TARGET_RVC_MULTIFILE Class Reference

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation