SPATMOD::IMAGE::SOURCE_RVC Class Reference

Image source from RVC raster object. More...

#include <spatmod/imagesourcervc.h>

Inheritance diagram for SPATMOD::IMAGE::SOURCE_RVC:

[legend]

List of all members.

Public Member Functions
	SOURCE_RVC (const RVC::OBJITEM &ObjItem, const RVC::CREDENTIALS &Credentials, RVC::RASTER::COMPONENT component=RVC::RASTER::COMPONENT_Default, SAMPLE::TYPE SampleType=SAMPLE::TYPE_Invalid)
	SOURCE_RVC (const RVC::OBJITEM &ObjItem, RVC::RASTER::COMPONENT component=RVC::RASTER::COMPONENT_Default, SAMPLE::TYPE SampleType=SAMPLE::TYPE_Invalid)
virtual	~SOURCE_RVC ()
void	SetKeepOpen (bool KeepOpen)
void	SetSpreadToByte (bool SpreadToByte)
void	SetUseColorPalette (bool UseColorPalette, const MIUNICODE *ObjNamePalette=0)
void	SetUsePyramidTiers (bool UsePyramidTiers)
void	SetUseValidity (bool UseValidity)

---

Detailed Description

Image source from RVC raster object.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SOURCE_RVC::SOURCE_RVC	(	const RVC::OBJITEM &	ObjItem,
		RVC::RASTER::COMPONENT	component = RVC::RASTER::COMPONENT_Default,
		SAMPLE::TYPE	SampleType = SAMPLE::TYPE_Invalid
	)			[explicit]

Standard constructor with optional component and sample type override.

Parameters:

	ObjItem	Reference to object location
	component	Component, default uses all components
	SampleType	Sample type override

SPATMOD::IMAGE::SOURCE_RVC::SOURCE_RVC	(	const RVC::OBJITEM &	ObjItem,
		const RVC::CREDENTIALS &	Credentials,
		RVC::RASTER::COMPONENT	component = RVC::RASTER::COMPONENT_Default,
		SAMPLE::TYPE	SampleType = SAMPLE::TYPE_Invalid
	)

Construct with RVC credentials and optional component and sample type override.

Parameters:

	ObjItem	Reference to object location
	Credentials	Credentials
	component	Component, default uses all components
	SampleType	Sample type override

virtual SPATMOD::IMAGE::SOURCE_RVC::~SOURCE_RVC

(

)

[virtual]

Destructor.

---

Member Function Documentation

void SPATMOD::IMAGE::SOURCE_RVC::SetKeepOpen

(

bool

KeepOpen

)

[inline]

Set whether to keep open after initialize outside pull begin/end processing.

Must be done before Initialize(). Default is to keep open after initialize.

void SPATMOD::IMAGE::SOURCE_RVC::SetSpreadToByte

(

bool

SpreadToByte

)

[inline]

Set whether to spread < 8-bit values over byte range.

Must be done before Initialize(). Default is to not spread. Has no effect for images having >= 8 bits per sample

void SPATMOD::IMAGE::SOURCE_RVC::SetUseColorPalette	(	bool	UseColorPalette,
		const MIUNICODE *	ObjNamePalette = 0
	)

Set whether to use color palette if available and appropriate for data type.

Must be done before Initialize(). Default is to not use color palette. No processing of pixel values is done before using as index to palette, may only be used for unsigned data types.

Parameters:

	UseColorPalette	True to use palette, false (default) to not
	ObjNamePalette	Palette subobject name, default to last-used if NULL

void SPATMOD::IMAGE::SOURCE_RVC::SetUsePyramidTiers

(

bool

UsePyramidTiers

)

[inline]

Set whether to use pyramid tiers.

Default is to use pyramid tiers for zooming if available.

void SPATMOD::IMAGE::SOURCE_RVC::SetUseValidity

(

bool

UseValidity

)

[inline]

Set whether to use validity (null mask/value) if available.

Must be done before Initialize(). Default is to use validity.

---

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

• spatmod/imagesourcervc.h