SPATMOD::IMAGE::TARGET_RVC_BASE Class Reference

Base class for RVC image target implementations. More...

#include <spatmod/imagetargetrvcbase.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_RVC_BASE:

Public Types
enum	HISTOGRAM { HISTOGRAM_None, HISTOGRAM_Default, HISTOGRAM_AutoSample, HISTOGRAM_Full }
Public Member Functions
virtual	~TARGET_RVC_BASE ()
const RVC::OBJITEMLIST &	GetObjItemList () const
void	SetHistogramMode (HISTOGRAM HistogramMode)
void	SetPyramidMode (RVC::IMAGE::PYRAMID PyramidMode)
void	SetUsage (RVC::RASTER::USAGE Usage)
Protected Member Functions
	TARGET_RVC_BASE (STAGE pInputStage, const RVC::OBJITEMLIST &ObjItemList, const RVC::CREDENTIALS pCredentials=0)
	TARGET_RVC_BASE (STAGE pInputStage, const RVC::OBJITEM &ObjItem, const RVC::CREDENTIALS pCredentials=0)
const RVC::CREDENTIALS *	GetCredentials () const
RVC::OBJITEMLIST &	GetObjItemList ()
RVC::RASTER::USAGE	GetUsage () const
virtual ERRVALUE	v_PushBegin (const SECTION_ITERATOR &iterator)
virtual ERRVALUE	v_PushEnd ()
ERRVALUE	WriteGeoreference () const

Detailed Description

Base class for RVC image target implementations.

Member Enumeration Documentation

enum SPATMOD::IMAGE::TARGET_RVC_BASE::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

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

Destructor.

SPATMOD::IMAGE::TARGET_RVC_BASE::TARGET_RVC_BASE	(	STAGE *	pInputStage,
		const RVC::OBJITEM &	ObjItem,
		const RVC::CREDENTIALS *	pCredentials = `0`
	)			`[protected]`

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_BASE::TARGET_RVC_BASE	(	STAGE *	pInputStage,
		const RVC::OBJITEMLIST &	ObjItemList,
		const RVC::CREDENTIALS *	pCredentials = `0`
	)			`[protected]`

Construct target with multiple output objects (one per sample).

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

Member Function Documentation

const RVC::CREDENTIALS* SPATMOD::IMAGE::TARGET_RVC_BASE::GetCredentials ( ) const [inline, protected]

Get credentials pointer, if any specified in construction.

RVC::OBJITEMLIST& SPATMOD::IMAGE::TARGET_RVC_BASE::GetObjItemList ( ) [inline, protected]

Get object item list (non-const).

Should only be used during object creation to specify actual locations of objects created.

const RVC::OBJITEMLIST& SPATMOD::IMAGE::TARGET_RVC_BASE::GetObjItemList ( ) const [inline]

Get object item list.

Can be used after object creation to determine the actual locations of the objects created.

RVC::RASTER::USAGE SPATMOD::IMAGE::TARGET_RVC_BASE::GetUsage ( ) const [inline, protected]

Get usage value to store with created raster.

void SPATMOD::IMAGE::TARGET_RVC_BASE::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_BASE::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_BASE::SetUsage ( RVC::RASTER::USAGE Usage )

Set object usage.

If used, must be called before Process().

virtual ERRVALUE SPATMOD::IMAGE::TARGET_RVC_BASE::v_PushBegin ( const SECTION_ITERATOR & iterator ) [protected, virtual]