RVC::IMAGE::NULLVALUE Class Reference

Container for image null value. More...

#include <rvc/image.h>

List of all members.

Public Types
enum	CONFLICTADJUST { CONFLICTADJUST_Auto, CONFLICTADJUST_None, CONFLICTADJUST_Down, CONFLICTADJUST_Up }
Public Member Functions
	NULLVALUE (CELLTYPE CellType)
	NULLVALUE ()
ERRVALUE	ApplyMask (void *cellbuffer, const UINT8 *maskbuffer, INT32 count, CONFLICTADJUST conflictadjust=CONFLICTADJUST_Auto) const
ERRVALUE	ConvFromCellType (double &value)
ERRVALUE	ConvToCellType (double value, bool setEachColorToValue=false)
ERRVALUE	ExtractMask (const void *cellbuffer, UINT8 *maskbuffer, INT32 count) const
ERRVALUE	GetValue (DCOMPLEXMP &value) const
ERRVALUE	GetValue (DCOMPLEXRI &value) const
ERRVALUE	GetValue (FCOMPLEXMP &value) const
ERRVALUE	GetValue (FCOMPLEXRI &value) const
ERRVALUE	GetValue (double &value) const
ERRVALUE	GetValue (float &value) const
ERRVALUE	GetValue (UINT32 &value) const
ERRVALUE	GetValue (INT32 &value) const
ERRVALUE	GetValue (UINT16 &value) const
ERRVALUE	GetValue (INT16 &value) const
ERRVALUE	GetValue (UINT8 &value) const
ERRVALUE	GetValue (INT8 &value) const
void	GetValue (ANYRASTVALUE &value) const
void	SetCellType (CELLTYPE CellType)
void	SetDefault ()
ERRVALUE	SetValue (const DCOMPLEXMP &value)
ERRVALUE	SetValue (const DCOMPLEXRI &value)
ERRVALUE	SetValue (const FCOMPLEXMP &value)
ERRVALUE	SetValue (const FCOMPLEXRI &value)
ERRVALUE	SetValue (double value)
ERRVALUE	SetValue (unsigned int value)
ERRVALUE	SetValue (int value)
void	SetValue (CELLTYPE CellType, const ANYRASTVALUE &value)

---

Detailed Description

Container for image null value.

---

Member Enumeration Documentation

enum RVC::IMAGE::NULLVALUE::CONFLICTADJUST

Mode for adjusting non-null cells having null value in ApplyMask.

Enumerator:

CONFLICTADJUST_Auto	If null value <= 0 adjust up, otherwise down.
CONFLICTADJUST_None	Don't adjust conflicting values.
CONFLICTADJUST_Down	Adjust down (if null value minimum per cell type will adjust up).
CONFLICTADJUST_Up	Adjust up (if null value maximum per cell type will adjust down).

---

Constructor & Destructor Documentation

RVC::IMAGE::NULLVALUE::NULLVALUE

(

)

[inline]

Default constructor.

RVC::IMAGE::NULLVALUE::NULLVALUE

(

CELLTYPE

CellType

)

[inline, explicit]

Construct for specified cell type and initialize to default.

---

Member Function Documentation

ERRVALUE RVC::IMAGE::NULLVALUE::ApplyMask	(	void *	cellbuffer,
		const UINT8 *	maskbuffer,
		INT32	count,
		CONFLICTADJUST	conflictadjust = CONFLICTADJUST_Auto
	)			const

Apply mask to image cell buffer.

Cells with mask values of 0 will be set to the null value. Cells with non-zero mask values and having the null value will be adjusted as specified.

Parameters:

	cellbuffer	Cell buffer to apply mask to, must match cell type set for null value
	maskbuffer	Mask buffer containing 0 where null and non-0 where valid
	count	Number of cells to process

ERRVALUE RVC::IMAGE::NULLVALUE::ConvFromCellType

(

double &

value

)

Convert value from cell type of *this to a double.

Returns:

Error if value cannot be converted.

Parameters:

value

Returns "packed" value if it has components

ERRVALUE RVC::IMAGE::NULLVALUE::ConvToCellType	(	double	value,
		bool	setEachColorToValue = false
	)

Convert value to cell type of *this.

Returns:

Error if value cannot be converted.

Parameters:

setEachColorToValue

True for setting the value for each color component (>=24bit cell types)

ERRVALUE RVC::IMAGE::NULLVALUE::ExtractMask	(	const void *	cellbuffer,
		UINT8 *	maskbuffer,
		INT32	count
	)			const

Extract mask from image cell buffer.

Parameters:

	cellbuffer	Cell buffer to extract mask from, must match cell type set
	maskbuffer	Mask buffer returned, will contain 0 where null and 255 where valid
	count	Number of cells to process

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

DCOMPLEXMP &

value

)

const

Get null value as DCOMPLEXMP.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

DCOMPLEXRI &

value

)

const

Get null value as DCOMPLEXRI.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

FCOMPLEXMP &

value

)

const

Get null value as FCOMPLEXMP.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

FCOMPLEXRI &

value

)

const

Get null value as FCOMPLEXRI.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

double &

value

)

const

Get null value as double.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

float &

value

)

const

Get null value as float.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

UINT32 &

value

)

const

Get null value as UINT32.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

INT32 &

value

)

const

Get null value as INT32.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

UINT16 &

value

)

const

Get null value as UINT16, suitable for 16-bit RGB also.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

INT16 &

value

)

const

Get null value as INT16.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

UINT8 &

value

)

const

Get null value as UINT8.

Returns:

Error if value cannot be converted without truncation.

ERRVALUE RVC::IMAGE::NULLVALUE::GetValue

(

INT8 &

value

)

const

Get null value as INT8.

Returns:

Error if value cannot be converted without truncation.

void RVC::IMAGE::NULLVALUE::GetValue

(

ANYRASTVALUE &

value

)

const

Obtain image null value as ANYRASTVALUE.

void RVC::IMAGE::NULLVALUE::SetCellType

(

CELLTYPE

CellType

)

[inline]

Set cell type for null value.

This will also set the null value to the default for the specified cell type.

void RVC::IMAGE::NULLVALUE::SetDefault

(

)

Set default null value for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

const DCOMPLEXMP &

value

)

Set value from DCOMPLEXMP.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

const DCOMPLEXRI &

value

)

Set value from DCOMPLEXRI.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

const FCOMPLEXMP &

value

)

Set value from FCOMPLEXMP.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

const FCOMPLEXRI &

value

)

Set value from FCOMPLEXRI.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

double

value

)

Set value from float/double.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

unsigned int

value

)

Set value from unsigned integer.

Returns:

Error if out of range for current cell type.

ERRVALUE RVC::IMAGE::NULLVALUE::SetValue

(

int

value

)

Set value from signed integer.

Returns:

Error if out of range for current cell type.

void RVC::IMAGE::NULLVALUE::SetValue	(	CELLTYPE	CellType,
		const ANYRASTVALUE &	value
	)

Set cell type and value from ANYRASTVALUE.

---

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

• rvc/image.h