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

#include <mlLUTIterator.h>

Inheritance diagram for ml::LUTIteratorBase:

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
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 29 of file mlLUTIterator.h.

Member Enumeration Documentation

◆ anonymous enum

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 44 of file mlLUTIterator.h.

◆ ConvMethod

enum ml::LUTIteratorBase::ConvMethod

protected

Conversion method id.

Enumerator
CONV_NONE
CONV_L_TO_RGB
CONV_RGB_TO_L

Definition at line 99 of file mlLUTIterator.h.

Constructor & Destructor Documentation

◆ LUTIteratorBase()

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

protected

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

Referenced by ml::LUTIterator< T >::LUTIterator(), ml::LUTIterator< T >::LUTIterator(), and ml::LUTIterator< T >::LUTIterator().

◆ ~LUTIteratorBase()

virtual ml::LUTIteratorBase::~LUTIteratorBase ( )

inlinevirtual

Destructor (declared here to make it virtual).

Definition at line 40 of file mlLUTIterator.h.

Member Function Documentation

◆ alphaNeedsInit()

bool ml::LUTIteratorBase::alphaNeedsInit ( void ) const

inline

Alpha channel needs initialization.

Definition at line 66 of file mlLUTIterator.h.

References _initAlpha.

◆ atEnd()

bool ml::LUTIteratorBase::atEnd ( void ) const

inline

End of index range reached?

Definition at line 81 of file mlLUTIterator.h.

References _index, and _width.

◆ getLayer()

int ml::LUTIteratorBase::getLayer ( void ) const

inline

Get current layer.

Definition at line 78 of file mlLUTIterator.h.

References _layer.

◆ getNumChannels()

int ml::LUTIteratorBase::getNumChannels ( void ) const

inline

Get number of (source) channels.

Definition at line 84 of file mlLUTIterator.h.

References _vtFrom, and ml::LUTNumberOfChannels().

◆ getRow()

int ml::LUTIteratorBase::getRow ( void ) const

inline

Get current row.

Definition at line 75 of file mlLUTIterator.h.

References _row.

◆ getSourceType()

LUTVisualType ml::LUTIteratorBase::getSourceType ( void ) const

inline

Get visual type used for rendering (source type).

Definition at line 60 of file mlLUTIterator.h.

References _vtFrom.

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

◆ getTargetType()

LUTVisualType ml::LUTIteratorBase::getTargetType ( void ) const

inline

Get visual type used for storing (target type).

Definition at line 63 of file mlLUTIterator.h.

References _vtTo.

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

◆ getWidth()

int ml::LUTIteratorBase::getWidth ( void ) const

inline

Get LUT width.

Definition at line 69 of file mlLUTIterator.h.

References _width.

Referenced by ml::LUTIterator< T >::LUTIterator(), ml::LUTIterator< T >::LUTIterator(), and ml::LUTIterator< T >::LUTIterator().

◆ isValid()

bool ml::LUTIteratorBase::isValid ( void ) const

inline

Is iterator valid?

Definition at line 57 of file mlLUTIterator.h.

References _valid.

◆ operator()()

int ml::LUTIteratorBase::operator() ( void ) const

inline

Get current index (zero based).

Definition at line 72 of file mlLUTIterator.h.

References _index.

Member Data Documentation

◆ _convMethodId

enum ml::LUTIteratorBase::ConvMethod ml::LUTIteratorBase::_convMethodId

protected

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

◆ _incMethodId

int ml::LUTIteratorBase::_incMethodId

protected

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

Definition at line 102 of file mlLUTIterator.h.

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

◆ _index

int ml::LUTIteratorBase::_index

protected

Current index.

Definition at line 111 of file mlLUTIterator.h.

Referenced by atEnd(), operator()(), and ml::LUTIterator< T >::operator++().

◆ _initAlpha

bool ml::LUTIteratorBase::_initAlpha

protected

Alpha channel needs initialization.

Definition at line 105 of file mlLUTIterator.h.

Referenced by alphaNeedsInit().

◆ _layer

int ml::LUTIteratorBase::_layer

protected

Definition at line 114 of file mlLUTIterator.h.

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

◆ _row

int ml::LUTIteratorBase::_row

protected

Current row and layer.

Definition at line 114 of file mlLUTIterator.h.

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

◆ _valid

bool ml::LUTIteratorBase::_valid

protected

Iterator valid flag.

Definition at line 90 of file mlLUTIterator.h.

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

◆ _vtFrom

LUTVisualType ml::LUTIteratorBase::_vtFrom

protected

Source visual type, used by the LUT being rendered.

Definition at line 93 of file mlLUTIterator.h.

Referenced by getNumChannels(), and getSourceType().

◆ _vtTo

LUTVisualType ml::LUTIteratorBase::_vtTo

protected

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

Definition at line 96 of file mlLUTIterator.h.

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

◆ _width

int ml::LUTIteratorBase::_width

protected

Width of LUTData object.

Definition at line 108 of file mlLUTIterator.h.

Referenced by atEnd(), and getWidth().

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

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ ConvMethod

Constructor & Destructor Documentation

◆ LUTIteratorBase()

◆ ~LUTIteratorBase()

Member Function Documentation

◆ alphaNeedsInit()

◆ atEnd()

◆ getLayer()

◆ getNumChannels()

◆ getRow()

◆ getSourceType()

◆ getTargetType()

◆ getWidth()

◆ isValid()

◆ operator()()

Member Data Documentation

◆ _convMethodId

◆ _incMethodId

◆ _index

◆ _initAlpha

◆ _layer

◆ _row

◆ _valid

◆ _vtFrom

◆ _vtTo

◆ _width