RVC::OPACITYMASK Class Reference

Manages RVC::OBJTYPE_Raster RVC::RASTER::USAGE_Opacity child 1-bit, 4-bit or 8-bit raster objects. More...

#include <rvc/opacitymask.h>

Inheritance diagram for RVC::OPACITYMASK:

[legend]

List of all members.

Classes
class	GETOBJFILTER_ISVALIDOPACITYMASK
	Convenience filter for raster null mask selection. More...
class	MAKEPARMS
	Class to handle values needed to define the characteristics of a opacity mask. More...
class	OBJECT_FILTER
	Object filter for finding OPACITYMASK raster objects. More...
Public Member Functions
	OPACITYMASK (const RVC::OPACITYMASK &rhs)
	OPACITYMASK ()
virtual	~OPACITYMASK ()
INT32	GetNumTileColumns () const
INT32	GetNumTileLines () const
INT32	GetNumXTiles () const
INT32	GetNumYTiles () const
ERRVALUE	GetPyramidList (SIMPLE_ARRAY< INT32 > &SampleList, RVC::OBJITEMLIST &PyramidList)
INT32	GetTileSizeBytes () const
bool	HasOpacityValues () const
ERRVALUE	Make (RVC::OBJITEM &OpacityItem, const MAKEPARMS &MakeParms, const char *Source=0, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (const RVC::IMAGE &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	MakePyramidSet (IMAGE::PYRAMID flags=IMAGE::PYRAMID_Default, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Open (const RVC::IMAGE &parent, const RVC::OBJITEM &OpacityMaskItem, OBJECT::OPENMODE OpenMode=OBJECT::OPENMODE_Read, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Open (const RVC::IMAGE &parent, OBJECT::OPENMODE OpenMode=OBJECT::OPENMODE_Read, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::OPACITYMASK &	operator= (const RVC::OPACITYMASK &rhs)
int	Read (INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1) const
int	ReadColumn (INT32 StartLine, INT32 Column, UINT8 *data, INT32 Length=1) const
ERRVALUE	SetColorMap (const COLOR_ARRAY &ColorMap)
ERRVALUE	Write (INT32 Line, INT32 StartColumn, const UINT8 *data, INT32 Length=1)

---

Detailed Description

Manages RVC::OBJTYPE_Raster RVC::RASTER::USAGE_Opacity child 1-bit, 4-bit or 8-bit raster objects.

RVC Object Types that this class supports: RVC::OBJTYPE_Raster (RVC::RASTER::USAGE_Opacity).

Valid parents for this class:

• RVC::OBJTYPE_Raster
• RVC::OBJTYPE_Hyperspectral
• RVC::OBJTYPE_RasterSet
• RVC::OBJTYPE_Thumbnail

---

Constructor & Destructor Documentation

RVC::OPACITYMASK::OPACITYMASK

(

)

Default constructor.

RVC::OPACITYMASK::OPACITYMASK

(

const RVC::OPACITYMASK &

rhs

)

Copy constructor.

virtual RVC::OPACITYMASK::~OPACITYMASK

(

)

[virtual]

Destructor.

---

Member Function Documentation

INT32 RVC::OPACITYMASK::GetNumTileColumns

(

)

const

Obtain number of columns in a opacity mask tile.

Returns:

number of columns in the opacity mask tile

INT32 RVC::OPACITYMASK::GetNumTileLines

(

)

const

Obtain number of lines in a opacity mask tile.

Returns:

number of lines in the opacity mask tile

INT32 RVC::OPACITYMASK::GetNumXTiles

(

)

const

Obtain number of tiles in a opacity mask row.

Returns:

number of row tiles

INT32 RVC::OPACITYMASK::GetNumYTiles

(

)

const

Obtain number of tiles in a opacity mask column.

Returns:

number of column tiles

ERRVALUE RVC::OPACITYMASK::GetPyramidList	(	SIMPLE_ARRAY< INT32 > &	SampleList,
		RVC::OBJITEMLIST &	PyramidList
	)

Return list of available raster pyramid sub-rasters.

The sample rate list will be sorted in ascending order and the array and list are aligned.

Parameters:

	SampleList	Simple array of available sample rates RETURNED
	PyramidList	List of pyramid raster NullMask ObjItem's RETURNED

INT32 RVC::OPACITYMASK::GetTileSizeBytes

(

)

const

Obtain number of bytes in a opacity mask tile.

Returns:

size of opacity mask tile in bytes

bool RVC::OPACITYMASK::HasOpacityValues

(

)

const

Determine if a mask is present or the image has opacity values defined.

Returns:

'True' if meaningful opacity values or mask exists, 'false' otherwise

ERRVALUE RVC::OPACITYMASK::Make	(	RVC::OBJITEM &	OpacityItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = 0,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create an opacity mask object under the RVC::IMAGE parent.

CellType == RVC::IMAGE::CELLTYPE_Binary, RVC::IMAGE::CELLTYPE_Unsigned_4 or RVC::IMAGE::CELLTYPE_Unsigned_8 Compression type == RVC::RASTER::COMPTYPE_RLE or RVC::RASTER::COMPTYPE_DCPM Tile Size == Same as parent Scale == Same as parent

Parameters:

	OpacityItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of opacity mask creation, default is GetAppName()
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::OPACITYMASK::Make	(	const RVC::IMAGE &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const MAKEPARMS &	MakeParms,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create an opacity mask object under the RVC::IMAGE parent.

CellType == RVC::IMAGE::CELLTYPE_Binary, RVC::IMAGE::CELLTYPE_Unsigned_4 or RVC::IMAGE::CELLTYPE_Unsigned_8 Tile Size == Same as parent Scale == Same as parent

Parameters:

	parent	Parent object to create opacity mask under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::OPACITYMASK::MakePyramidSet	(	IMAGE::PYRAMID	flags = IMAGE::PYRAMID_Default,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create pyramid opacity mask set under the existing raster pyramids.

Parameters:

RVC_DEFAULT_CREDENTIALS

User credentials passed in, NULL for default behavior

ERRVALUE RVC::OPACITYMASK::Open	(	const RVC::IMAGE &	parent,
		const RVC::OBJITEM &	OpacityMaskItem,
		OBJECT::OPENMODE	OpenMode = OBJECT::OPENMODE_Read,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Open an opacity mask specified by 'OpacityMaskItem'.

Parameters:

	parent	Parent image object
	OpacityMaskItem	Specfic opacity mask to open
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::OPACITYMASK::Open	(	const RVC::IMAGE &	parent,
		OBJECT::OPENMODE	OpenMode = OBJECT::OPENMODE_Read,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Open the last used opacity mask under the RVC::IMAGE parent.

If an opacity mask cannot be found, it will use the opacity value from the parent and treat it like an opacity mask

Parameters:

	parent	Parent image object to open opacity mask under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::OPACITYMASK& RVC::OPACITYMASK::operator=

(

const RVC::OPACITYMASK &

rhs

)

Assignment.

Reimplemented from RVC::OBJECT.

int RVC::OPACITYMASK::Read	(	INT32	Line,
		INT32	StartColumn,
		UINT8 *	data,
		INT32	Length = 1
	)			const

Read a line of opacity mask cells up to a certain length If there is more than one opacity component (null mask, colormap, opacity mask) the order of opacity mask combinations are as follows 1.

Null mask, 2. Colormap, 3. Opacity mask / Alpha band

Returns:

'>0' if there can exist opacity values other than 255, '0' if all values are known to be == 255, '<0' error

Parameters:

	Line	Raster line to read
	StartColumn	Raster column to start reading on
	data	Buffer to read into
	Length	Number of columns to read

int RVC::OPACITYMASK::ReadColumn	(	INT32	StartLine,
		INT32	Column,
		UINT8 *	data,
		INT32	Length = 1
	)			const

Read a column of opacity mask cells up to a certain length If there is more than one opacity component (null mask, colormap, opacity mask) the order of opacity mask combinations are as follows 1.

Null mask, 2. Colormap, 3. Opacity mask / Alpha band

Returns:

'>0' if there can exist opacity values other than 255, '0' if all values are known to be == 255, '<0' error

Parameters:

	StartLine	Raster line to start reading on
	Column	Raster column to read
	data	Buffer to read into
	Length	Number of lines to read

ERRVALUE RVC::OPACITYMASK::SetColorMap

(

const COLOR_ARRAY &

ColorMap

)

ERRVALUE RVC::OPACITYMASK::Write	(	INT32	Line,
		INT32	StartColumn,
		const UINT8 *	data,
		INT32	Length = 1
	)

Write a line of opacity mask cells up to a certain length.

If the opacity values are from the parent image, a OpacityMask raster will be created under the parent image with a celltype of IMAGE::CELLTYPE_Unsigned_8, the current opacity values setup in the new object, then the buffer will be written

Parameters:

	Line	Raster line to write
	StartColumn	Raster column to start writing on
	data	Buffer to write from
	Length	Number of columns to write

---

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

• rvc/opacitymask.h