RVC::NULLMASK Class Reference

Manages RVC::OBJTYPE_Raster RVC::RASTER::USAGE_NullBand child 1-bit raster objects. More...

#include <rvc/nullmask.h>

Inheritance diagram for RVC::NULLMASK:

[legend]

Classes
class	GETOBJFILTER_ISVALIDNULLMASK
	Convenience filter for raster null mask selection. More...
class	OBJECT_FILTER
	Object filter for finding NULLMASK raster objects. More...
Public Member Functions
	NULLMASK (const RVC::NULLMASK &rhs)
	NULLMASK ()
virtual	~NULLMASK ()
ERRVALUE	CopyMaskTo (const RASTER &TgtParentRastObj, const RASTER &SrcBinaryRastObj, const CREDENTIALS *Credentials=0)
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	HasNullValues () const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, bool initvalid, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (const RVC::IMAGE &parent, bool initvalid, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	MakePyramidSet (IMAGE::PYRAMID flags=IMAGE::PYRAMID_Default, const CREDENTIALS *Credentials=0)
ERRVALUE	Open (const RVC::IMAGE &parent, OBJECT::OPENMODE OpenMode=OBJECT::OPENMODE_Read, const CREDENTIALS *Credentials=0)
RVC::NULLMASK &	operator= (const RVC::NULLMASK &rhs)
int	Read (INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1) const
int	Read (INT32 Line, INT32 StartColumn, BITSET_UNOWNED &data, INT32 Length=1) const
int	ReadColumn (INT32 StartLine, INT32 Column, UINT8 *data, INT32 Length=1) const
int	ReadColumn (INT32 StartLine, INT32 Column, BITSET_UNOWNED &data, INT32 Length=1) const
ERRVALUE	Write (INT32 Line, INT32 StartColumn, bool valid, INT32 Length=1)
ERRVALUE	Write (INT32 Line, INT32 StartColumn, const UINT8 *data, INT32 Length=1)
ERRVALUE	Write (INT32 Line, INT32 StartColumn, const BITSET_UNOWNED &data, INT32 Length=1)
Static Public Member Functions
static bool	IsNullMask (const OBJITEM &ObjItem, const CREDENTIALS *Credentials=0)

Detailed Description

Manages RVC::OBJTYPE_Raster RVC::RASTER::USAGE_NullBand child 1-bit raster objects.

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

Default RVC Object Type for this class: RVC::OBJTYPE_Raster.

Valid parents for this class:

Constructor & Destructor Documentation

RVC::NULLMASK::NULLMASK ( )

Default constructor.

RVC::NULLMASK::NULLMASK ( const RVC::NULLMASK & rhs )

Copy constructor.

virtual RVC::NULLMASK::~NULLMASK ( ) [virtual]

Destructor.

Member Function Documentation

ERRVALUE RVC::NULLMASK::CopyMaskTo	(	const RASTER &	TgtParentRastObj,
		const RASTER &	SrcBinaryRastObj,
		const CREDENTIALS *	Credentials = `0`
	)

Copy the source binary raster under the target parent raster object and make it the nullmask for the target raster.

This method will store the nullmask more efficiently and create it faster than using CopyObject or CopyRaster methods. This instance will then be opened to that new nullmask. This does not create nullmask pyramids.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

INT32 RVC::NULLMASK::GetNumTileColumns ( ) const

Obtain number of columns in a nullmask tile.

Returns:: number of columns in the nullmask tile

INT32 RVC::NULLMASK::GetNumTileLines ( ) const

Obtain number of lines in a nullmask tile.

Returns:: number of lines in the nullmask tile

INT32 RVC::NULLMASK::GetNumXTiles ( ) const

Obtain number of tiles in a nullmask row.

Returns:: number of row tiles

INT32 RVC::NULLMASK::GetNumYTiles ( ) const

Obtain number of tiles in a nullmask column.

Returns:: number of column tiles

ERRVALUE RVC::NULLMASK::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::NULLMASK::GetTileSizeBytes ( ) const

Obtain number of bytes in a nullmask tile.

Returns:: size of nullmask tile in bytes

bool RVC::NULLMASK::HasNullValues ( ) const

Determine if a mask is present or the image has a null value defined.

Returns:: 'True' if a meaningful null value or mask exists, 'false' otherwise

static bool RVC::NULLMASK::IsNullMask	(	const OBJITEM &	ObjItem,
		const CREDENTIALS *	Credentials = `0`
	)			`[static]`

Determine if the OBJITEM given refers to a null mask raster object.

Returns:: 'True' if the object is a null mask, 'false' if not.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

ERRVALUE RVC::NULLMASK::Make	(	RVC::OBJITEM &	ObjItem,
		bool	initvalid,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a null mask object under the RVC::IMAGE parent.

If a null mask raster already exists, it will perform an Open(*this, OBJECT::OPENMODE_Write). If the parent raster has a null value set it will be used to initialize the mask, otherwise the initvalue parameter will determine the initial mask state. CellType == RVC::IMAGE::CELLTYPE_Binary Compression type == RVC::RASTER::COMPTYPE_RLE Tile Size == Same as parent Scale == Same as parent

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	initvalid	Initialize to be all 'valid' if cannot determine from parent
	Source	Source of nullmask creation, default is GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::NULLMASK::Make	(	const RVC::IMAGE &	parent,
		bool	initvalid,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a null mask object under the RVC::IMAGE parent.

If a null mask raster already exists, it will perform an Open(*this, OBJECT::OPENMODE_Write). If the parent raster has a null value set it will be used to initialize the mask, otherwise the initvalue parameter will determine the initial mask state. CellType == RVC::IMAGE::CELLTYPE_Binary Compression type == RVC::RASTER::COMPTYPE_RLE Tile Size == Same as parent Scale == Same as parent

Parameters:

	parent	Parent object to create nullmask under
	initvalid	Initialize to be all 'valid' if cannot determine from parent
	Source	Source of nullmask creation, default is GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::NULLMASK::MakePyramidSet	(	IMAGE::PYRAMID	flags = `IMAGE::PYRAMID_Default`,
		const CREDENTIALS *	Credentials = `0`
	)

Create pyramid null mask set under the existing raster pyramids.

Parameters:

Credentials

User credentials passed in, NULL for default behavior

ERRVALUE RVC::NULLMASK::Open	(	const RVC::IMAGE &	parent,
		OBJECT::OPENMODE	OpenMode = `OBJECT::OPENMODE_Read`,
		const CREDENTIALS *	Credentials = `0`
	)

Open a null mask under the RVC::IMAGE parent.

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

Parameters:

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

RVC::NULLMASK& RVC::NULLMASK::operator= ( const RVC::NULLMASK & rhs )

Assignment.

Reimplemented from RVC::OBJECT.

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

Read a line of nullmask cells up to a certain length Values == 0 are nulls, values == 255 are not.

Returns:: '>0' if there can exist null values, '0' if all values are known to be not null, '<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::NULLMASK::Read	(	INT32	Line,
		INT32	StartColumn,
		BITSET_UNOWNED &	data,
		INT32	Length = `1`
	)			const

Read a line of nullmask cells up to a certain length False values in the bitset are nulls.

Returns:: '>0' if there can exist null values, '0' if all values are known to be not null, '<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::NULLMASK::ReadColumn	(	INT32	StartLine,
		INT32	Column,
		UINT8 *	data,
		INT32	Length = `1`
	)			const

Read a column of nullmask cells up to a certain length Values == 0 are nulls, values == 255 are not.

Returns:: '>0' if there can exist null values, '0' if all values are known to be not null, '<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

int RVC::NULLMASK::ReadColumn	(	INT32	StartLine,
		INT32	Column,
		BITSET_UNOWNED &	data,
		INT32	Length = `1`
	)			const

Read a column of nullmask cells up to a certain length False values in the bitset are nulls.

Returns:: '>0' if there can exist null values, '0' if all values are known to be not null, '<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::NULLMASK::Write	(	INT32	Line,
		INT32	StartColumn,
		bool	valid,
		INT32	Length = `1`
	)

Write a line of nullmask values up to a certain length If the null values are from the parent image, a NullMask raster will be created under the parent image with a celltype of IMAGE::CELLTYPE_Binary, the current null 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
	valid	Value to write, 'true' for valid, 'false' for not valid
	Length	Number of columns to write

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

Write a line of nullmask cells up to a certain length.

If the null values are from the parent image, a NullMask raster will be created under the parent image with a celltype of IMAGE::CELLTYPE_Binary, the current null 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

ERRVALUE RVC::NULLMASK::Write	(	INT32	Line,
		INT32	StartColumn,
		const BITSET_UNOWNED &	data,
		INT32	Length = `1`
	)

Write a line of nullmask cells up to a certain length If the null values are from the parent image, a NullMask raster will be created under the parent image with a celltype of IMAGE::CELLTYPE_Binary, the current null 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/nullmask.h

RVC::NULLMASK Class Reference

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation