ml::LUTIteratorBase Class Reference

LUT iterator base class with type independent functionality and declarations. More...

#include <mlLUTIterator.h>

Inheritance diagram for ml::LUTIteratorBase:

List of all members.

Public Types
enum	{   L = 0, A_LA = 1, R = 0, G = 1,   B = 2, A_RGBA = 3, MAX_CHANNELS = 4 }
	Channel pointer access constants. More...
Public Member Functions
virtual	~LUTIteratorBase ()
	Destructor (declared here to make it virtual).
bool	isValid (void) const
	Is iterator valid?
LUTVisualType	getSourceType (void) const
	Get visual type used for rendering (source type).
LUTVisualType	getTargetType (void) const
	Get visual type used for storing (target type).
bool	alphaNeedsInit (void) const
	Alpha channel needs initialization.
int	getWidth (void) const
	Get LUT width.
int	operator() (void) const
	Get current index (zero based).
int	getRow (void) const
	Get current row.
int	getLayer (void) const
	Get current layer.
bool	atEnd (void) const
	End of index range reached?
int	getNumChannels (void) const
	Get number of (source) channels.
Protected Types
enum	ConvMethod { CONV_NONE = 0, CONV_L_TO_RGB, CONV_RGB_TO_L }
	Conversion method id. More...
Protected Member Functions
	LUTIteratorBase (LUTVisualType vtFrom, LUTVisualType vtTo, int width, int row, int layer)
	Constructor (protected, class can only be used by derived classes).
Protected Attributes
bool	_valid
	Iterator valid flag.
LUTVisualType	_vtFrom
	Source visual type, used by the LUT being rendered.
LUTVisualType	_vtTo
	Target visual type, used by the LUTData object storing the rendered LUT.
enum ml::LUTIteratorBase::ConvMethod	_convMethodId
	Conversion method id.
int	_incMethodId
	Pointer increment method id (= number of channel pointers to increment).
bool	_initAlpha
	Alpha channel needs initialization.
int	_width
	Width of LUTData object.
int	_index
	Current index.
int	_row
	Current row and layer.
int	_layer

---

Detailed Description

LUT iterator base class with type independent functionality and declarations.

Definition at line 33 of file mlLUTIterator.h.

---

Member Enumeration Documentation

anonymous enum

Channel pointer access constants.

Enumerator:

L	Luminance channel.
A_LA	Alpha channel (source type = LA).
R	Red channel.
G	Green channel.
B	Blue channel.
A_RGBA	Alpha channel (source type = RGBA).
MAX_CHANNELS	Number of channels.

Definition at line 48 of file mlLUTIterator.h.

enum ml::LUTIteratorBase::ConvMethod [protected]

Conversion method id.

Enumerator:

CONV_NONE
CONV_L_TO_RGB
CONV_RGB_TO_L

Definition at line 103 of file mlLUTIterator.h.

---

Constructor & Destructor Documentation

ml::LUTIteratorBase::LUTIteratorBase	(	LUTVisualType	vtFrom,
		LUTVisualType	vtTo,
		int	width,
		int	row,
		int	layer
	)			[protected]

Constructor (protected, class can only be used by derived classes).

virtual ml::LUTIteratorBase::~LUTIteratorBase

(

)

[inline, virtual]

Destructor (declared here to make it virtual).

Definition at line 44 of file mlLUTIterator.h.

---

Member Function Documentation

bool ml::LUTIteratorBase::alphaNeedsInit

(

void

)

const [inline]

Alpha channel needs initialization.

Definition at line 70 of file mlLUTIterator.h.

bool ml::LUTIteratorBase::atEnd

(

void

)

const [inline]

End of index range reached?

Definition at line 85 of file mlLUTIterator.h.

int ml::LUTIteratorBase::getLayer

(

void

)

const [inline]

Get current layer.

Definition at line 82 of file mlLUTIterator.h.

int ml::LUTIteratorBase::getNumChannels

(

void

)

const [inline]

Get number of (source) channels.

Definition at line 88 of file mlLUTIterator.h.

References ml::LUTNumberOfChannels().

int ml::LUTIteratorBase::getRow

(

void

)

const [inline]

Get current row.

Definition at line 79 of file mlLUTIterator.h.

LUTVisualType ml::LUTIteratorBase::getSourceType

(

void

)

const [inline]

Get visual type used for rendering (source type).

Definition at line 64 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

LUTVisualType ml::LUTIteratorBase::getTargetType

(

void

)

const [inline]

Get visual type used for storing (target type).

Definition at line 67 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

int ml::LUTIteratorBase::getWidth

(

void

)

const [inline]

Get LUT width.

Definition at line 73 of file mlLUTIterator.h.

bool ml::LUTIteratorBase::isValid

(

void

)

const [inline]

Is iterator valid?

Definition at line 61 of file mlLUTIterator.h.

int ml::LUTIteratorBase::operator()

(

void

)

const [inline]

Get current index (zero based).

Definition at line 76 of file mlLUTIterator.h.

---

Member Data Documentation

enum ml::LUTIteratorBase::ConvMethod ml::LUTIteratorBase::_convMethodId [protected]

Conversion method id.

Referenced by ml::LUTIterator< T >::init().

int ml::LUTIteratorBase::_incMethodId [protected]

Pointer increment method id (= number of channel pointers to increment).

Definition at line 106 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

int ml::LUTIteratorBase::_index [protected]

Current index.

Definition at line 115 of file mlLUTIterator.h.

bool ml::LUTIteratorBase::_initAlpha [protected]

Alpha channel needs initialization.

Definition at line 109 of file mlLUTIterator.h.

int ml::LUTIteratorBase::_layer [protected]

Definition at line 118 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

int ml::LUTIteratorBase::_row [protected]

Current row and layer.

Definition at line 118 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

bool ml::LUTIteratorBase::_valid [protected]

Iterator valid flag.

Definition at line 94 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

LUTVisualType ml::LUTIteratorBase::_vtFrom [protected]

Source visual type, used by the LUT being rendered.

Definition at line 97 of file mlLUTIterator.h.

LUTVisualType ml::LUTIteratorBase::_vtTo [protected]

Target visual type, used by the LUTData object storing the rendered LUT.

Definition at line 100 of file mlLUTIterator.h.

Referenced by ml::LUTIterator< T >::init().

int ml::LUTIteratorBase::_width [protected]

Width of LUTData object.

Definition at line 112 of file mlLUTIterator.h.

---

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

• MeVisLab/Standard/Sources/Shared/MLLUT/mlLUTIterator.h