RVC::RASTER::MAKEPARMS Class Reference

Class to handle values needed to define the characteristics of a raster. More...

#include <rvc/raster.h>

List of all members.

Public Member Functions
	MAKEPARMS (const RASTER &Template, IMAGE::CELLTYPE CellType=CELLTYPE_Invalid)
	MAKEPARMS (INT32 NumLines, INT32 NumColumns, IMAGE::CELLTYPE CellType)
IMAGE::CELLTYPE	GetCellType () const
UINT16	GetCompressionQuality () const
COMPTYPE	GetCompressionType () const
IMAGE::DATATYPE	GetDataType () const
INT32	GetDftTileSize () const
const IMAGESCALE &	GetImageScale () const
bool	GetInitialValue (ANYRASTVALUE &value) const
UINT16	GetNumBits () const
INT32	GetNumColumns () const
INT32	GetNumLines () const
UINT16	GetNumUsedBits () const
void	GetTileSize (INT32 &TileLines, INT32 &TileColumns) const
void	GetValueMinMax (ANYRASTVALUE &min, ANYRASTVALUE &max) const
bool	IsLossyCompressed () const
bool	IsValidCompression (COMPTYPE CompType) const
void	SetCellType (CELLTYPE CellType)
ERRVALUE	SetCompression (COMPTYPE CompType, UINT16 CompQuality, bool FixCellType=false)
void	SetImageScale (const IMAGESCALE &ImageScale)
void	SetIncludeEmbeddedPyramidTiers (bool IncludeTiers)
void	SetInitialValue (const ANYRASTVALUE &value)
void	SetInverted ()
void	SetNumColumns (INT32 NumColumns)
void	SetNumLines (INT32 NumLines)
void	SetNumUsedBits (UINT16 UsedBits)
void	SetNumUsedBits (const RASTER &SrcRastObj)
void	SetPackOrder (PACKORDER PackOrder)
void	SetTileSize (INT32 TileLines, INT32 TileColumns)
void	SetUsage (USAGE usage)

---

Detailed Description

Class to handle values needed to define the characteristics of a raster.

---

Constructor & Destructor Documentation

RVC::RASTER::MAKEPARMS::MAKEPARMS	(	INT32	NumLines,
		INT32	NumColumns,
		IMAGE::CELLTYPE	CellType
	)			[inline]

Constructor, initialize with critical raster creation parameters.

RVC::RASTER::MAKEPARMS::MAKEPARMS	(	const RASTER &	Template,
		IMAGE::CELLTYPE	CellType = CELLTYPE_Invalid
	)			[inline]

Template constructor.

Parameters:

	Template	Raster template to determine NumLines, NumColumns, Usage, and scaling
	CellType	Optional cell type, default uses type from template

---

Member Function Documentation

IMAGE::CELLTYPE RVC::RASTER::MAKEPARMS::GetCellType

(

)

const [inline]

Obtain image cell type.

Returns:

RVC::IMAGE::CELLTYPE for the raster.

UINT16 RVC::RASTER::MAKEPARMS::GetCompressionQuality

(

)

const [inline]

Obtain raster compression quality.

Returns:

Compression quality for the raster.

COMPTYPE RVC::RASTER::MAKEPARMS::GetCompressionType

(

)

const [inline]

Obtain raster compression type.

Returns:

RVC::RASTER::COMPTYPE for the raster.

IMAGE::DATATYPE RVC::RASTER::MAKEPARMS::GetDataType

(

)

const [inline]

Obtain datatype based on raster creation parameters.

Returns:

RVC::IMAGE::DATATYPE of the raster

INT32 RVC::RASTER::MAKEPARMS::GetDftTileSize

(

)

const

Obtain default raster tile size based on creation parameters.

Returns:

default tile size

const IMAGESCALE& RVC::RASTER::MAKEPARMS::GetImageScale

(

)

const [inline]

Get image scale information (RVC::RASTER::IMAGESCALE).

Returns:

IMAGESCALE reference

bool RVC::RASTER::MAKEPARMS::GetInitialValue

(

ANYRASTVALUE &

value

)

const [inline]

Get initial raster value.

UINT16 RVC::RASTER::MAKEPARMS::GetNumBits

(

)

const [inline]

Obtain number of bits in a raster cell.

Returns:

number of raster bits

INT32 RVC::RASTER::MAKEPARMS::GetNumColumns

(

)

const [inline]

Obtain number of columns in a raster.

Returns:

number of raster columns

INT32 RVC::RASTER::MAKEPARMS::GetNumLines

(

)

const [inline]

Obtain number of lines in a raster.

Returns:

number of raster lines

UINT16 RVC::RASTER::MAKEPARMS::GetNumUsedBits

(

)

const [inline]

Get the number of used bits.

This related to JP2 compression and is dependent on the source raster value range. The number of used bits will be less than or equal to the number of bits in the created raster object.

void RVC::RASTER::MAKEPARMS::GetTileSize	(	INT32 &	TileLines,
		INT32 &	TileColumns
	)			const [inline]

Obtain current raster tile size values.

Parameters:

	TileLines	Number of lines in a tile RETURNED
	TileColumns	Number of columns in a tile RETURNED

void RVC::RASTER::MAKEPARMS::GetValueMinMax	(	ANYRASTVALUE &	min,
		ANYRASTVALUE &	max
	)			const

Obtain raster value range.

Parameters:

	min	Minimum possible raster value
	max	Maximum possible raster value

bool RVC::RASTER::MAKEPARMS::IsLossyCompressed

(

)

const [inline]

Is the raster compressed with a lossy compression algorithm?

Returns:

true if the raster is compressed with a lossy compression algorithm

bool RVC::RASTER::MAKEPARMS::IsValidCompression

(

COMPTYPE

CompType

)

const

Is the compression type valid for the raster cell type.

Returns:

True if it is, false if not

void RVC::RASTER::MAKEPARMS::SetCellType

(

CELLTYPE

CellType

)

[inline]

Set image cell type.

ERRVALUE RVC::RASTER::MAKEPARMS::SetCompression	(	COMPTYPE	CompType,
		UINT16	CompQuality,
		bool	FixCellType = false
	)

Set raster compression values.

Parameters:

	CompType	Raster compression type
	CompQuality	Compression quality for lossy compression
	FixCellType	Change cell type if unsupported by compression type

void RVC::RASTER::MAKEPARMS::SetImageScale

(

const IMAGESCALE &

ImageScale

)

[inline]

Set image scale information (RVC::RASTER::IMAGESCALE).

void RVC::RASTER::MAKEPARMS::SetIncludeEmbeddedPyramidTiers

(

bool

IncludeTiers

)

[inline]

Set whether to include embedded pyramid tiers if supported.

Used in JPEG2000 compressed rasters produce only single resolution level. Default is to include embedded pyramid tiers.

void RVC::RASTER::MAKEPARMS::SetInitialValue

(

const ANYRASTVALUE &

value

)

[inline]

Set initial raster value.

void RVC::RASTER::MAKEPARMS::SetInverted

(

)

[inline]

Set raster inversion flag.

void RVC::RASTER::MAKEPARMS::SetNumColumns

(

INT32

NumColumns

)

[inline]

Set number of columns in a raster.

void RVC::RASTER::MAKEPARMS::SetNumLines

(

INT32

NumLines

)

[inline]

Set number of lines in a raster.

void RVC::RASTER::MAKEPARMS::SetNumUsedBits

(

UINT16

UsedBits

)

[inline]

Set the number of used bits.

This related to JP2 compression and is dependent on the source raster value range. The number of used bits will be less than or equal to the number of bits in the created raster object.

void RVC::RASTER::MAKEPARMS::SetNumUsedBits

(

const RASTER &

SrcRastObj

)

Set the number of used bits.

This related to JP2 compression and is dependent on the source raster value range. The number of used bits will be less than or equal to the number of bits in the created raster object.

void RVC::RASTER::MAKEPARMS::SetPackOrder

(

PACKORDER

PackOrder

)

[inline]

Set raster pack order.

Parameters:

PackOrder

New raster pack order

void RVC::RASTER::MAKEPARMS::SetTileSize	(	INT32	TileLines,
		INT32	TileColumns
	)			[inline]

Set raster tile size.

void RVC::RASTER::MAKEPARMS::SetUsage

(

USAGE

usage

)

[inline]

Set raster usage parameter.

---

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

• rvc/raster.h