SPATMOD::IMAGE::TARGET_RVC Class Reference

RVC raster/image target. More...

#include <spatmod/imagetargetrvc.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_RVC:

[legend]

List of all members.

Public Types
enum	HISTOGRAM { HISTOGRAM_None, HISTOGRAM_Default, HISTOGRAM_AutoSample, HISTOGRAM_Full }
Public Member Functions
	TARGET_RVC (STAGE *pInputStage, const RVC::OBJITEMLIST &ObjItemList, const RVC::CREDENTIALS *pCredentials=0)
	TARGET_RVC (STAGE *pInputStage, const RVC::OBJITEM &ObjItem, const RVC::CREDENTIALS *pCredentials=0)
virtual	~TARGET_RVC ()
const RVC::OBJITEMLIST &	GetObjItemList () const
void	SetCompression (RVC::RASTER::COMPTYPE type, UINT16 quality)
void	SetHistogramMode (HISTOGRAM HistogramMode)
void	SetPyramidMode (RVC::IMAGE::PYRAMID PyramidMode)
void	SetTileSizeOverride (UINT32 ColumnsPerTile, UINT32 RowsPerTile=0)

---

Detailed Description

RVC raster/image target.

---

Member Enumeration Documentation

enum SPATMOD::IMAGE::TARGET_RVC::HISTOGRAM

Histogram modes.

Enumerator:

HISTOGRAM_None	Don't compute histograms.
HISTOGRAM_Default	Default sample/full based on user preference setting.
HISTOGRAM_AutoSample	Auto-sample using pyramid tier if available.
HISTOGRAM_Full	Compute full histogram.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::TARGET_RVC::TARGET_RVC	(	STAGE *	pInputStage,
		const RVC::OBJITEM &	ObjItem,
		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, use constructor with OBJITEMLIST if multiple objects are to be created.

Parameters:

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

SPATMOD::IMAGE::TARGET_RVC::TARGET_RVC	(	STAGE *	pInputStage,
		const RVC::OBJITEMLIST &	ObjItemList,
		const RVC::CREDENTIALS *	pCredentials = 0
	)

Construct target with single output object.

Number of items objects in list must be appropriate for input image or an error will be returned from Initialize().

Parameters:

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

virtual SPATMOD::IMAGE::TARGET_RVC::~TARGET_RVC

(

)

[virtual]

Destructor.

---

Member Function Documentation

const RVC::OBJITEMLIST& SPATMOD::IMAGE::TARGET_RVC::GetObjItemList

(

)

const [inline]

Get object item list.

Can be used after Initialize() to determine the actual locations of the objects created.

void SPATMOD::IMAGE::TARGET_RVC::SetCompression	(	RVC::RASTER::COMPTYPE	type,
		UINT16	quality
	)			[inline]

Set compression type and quality.

If used, must be called before Initialize().

void SPATMOD::IMAGE::TARGET_RVC::SetHistogramMode

(

HISTOGRAM

HistogramMode

)

[inline]

Set histogram creation mode.

Histogram will be created at end of Process() only if entire extent of target image is specified. If used, must be called before Process().

void SPATMOD::IMAGE::TARGET_RVC::SetPyramidMode

(

RVC::IMAGE::PYRAMID

PyramidMode

)

[inline]

Set pyramiding mode.

Pyramiding will be done at end of Process() only if entire extent of target image is specified. If used, must be called before Process(). By default pyramids are generated with user's preferred Full/Partial setting and pixel sampling. Using PYRAMID_Disable will also disable embedded tier creation for JPEG2000 compression.

void SPATMOD::IMAGE::TARGET_RVC::SetTileSizeOverride	(	UINT32	ColumnsPerTile,
		UINT32	RowsPerTile = 0
	)

Override default tile size.

Parameters:

	ColumnsPerTile	Columsn per tile
	RowsPerTile	Rows per tile, will use same as columns if 0

---

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

• spatmod/imagetargetrvc.h