MeVisLab Toolbox Reference
ml::LUTIteratorBase Class Reference

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

#include <mlLUTIterator.h>

Inheritance diagram for ml::LUTIteratorBase:
ml::LUTIterator< T >

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) More...
 
bool isValid (void) const
 Is iterator valid? More...
 
LUTVisualType getSourceType (void) const
 Get visual type used for rendering (source type) More...
 
LUTVisualType getTargetType (void) const
 Get visual type used for storing (target type) More...
 
bool alphaNeedsInit (void) const
 Alpha channel needs initialization. More...
 
int getWidth (void) const
 Get LUT width. More...
 
int operator() (void) const
 Get current index (zero based) More...
 
int getRow (void) const
 Get current row. More...
 
int getLayer (void) const
 Get current layer. More...
 
bool atEnd (void) const
 End of index range reached? More...
 
int getNumChannels (void) const
 Get number of (source) channels. More...
 

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) More...
 

Protected Attributes

bool _valid
 Iterator valid flag. More...
 
LUTVisualType _vtFrom
 Source visual type, used by the LUT being rendered. More...
 
LUTVisualType _vtTo
 Target visual type, used by the LUTData object storing the rendered LUT. More...
 
enum ml::LUTIteratorBase::ConvMethod _convMethodId
 
int _incMethodId
 Pointer increment method id (= number of channel pointers to increment) More...
 
bool _initAlpha
 Alpha channel needs initialization. More...
 
int _width
 Width of LUTData object. More...
 
int _index
 Current index. More...
 
int _row
 Current row and layer. More...
 
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

Luminance channel.

A_LA 

Alpha channel (source type = LA)

Red channel.

Green channel.

Blue channel.

A_RGBA 

Alpha channel (source type = RGBA)

MAX_CHANNELS 

Number of channels.

Definition at line 44 of file mlLUTIterator.h.

◆ ConvMethod

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)

◆ ~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.

◆ atEnd()

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

End of index range reached?

Definition at line 81 of file mlLUTIterator.h.

◆ getLayer()

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

Get current layer.

Definition at line 78 of file mlLUTIterator.h.

◆ getNumChannels()

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

Get number of (source) channels.

Definition at line 84 of file mlLUTIterator.h.

References ml::LUTNumberOfChannels().

◆ getRow()

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

Get current row.

Definition at line 75 of file mlLUTIterator.h.

◆ getSourceType()

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

Get visual type used for rendering (source type)

Definition at line 60 of file mlLUTIterator.h.

◆ getTargetType()

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

Get visual type used for storing (target type)

Definition at line 63 of file mlLUTIterator.h.

◆ getWidth()

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

Get LUT width.

Definition at line 69 of file mlLUTIterator.h.

◆ isValid()

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

Is iterator valid?

Definition at line 57 of file mlLUTIterator.h.

◆ operator()()

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

Get current index (zero based)

Definition at line 72 of file mlLUTIterator.h.

Member Data Documentation

◆ _convMethodId

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

◆ _incMethodId

int ml::LUTIteratorBase::_incMethodId
protected

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

Definition at line 102 of file mlLUTIterator.h.

◆ _index

int ml::LUTIteratorBase::_index
protected

Current index.

Definition at line 111 of file mlLUTIterator.h.

◆ _initAlpha

bool ml::LUTIteratorBase::_initAlpha
protected

Alpha channel needs initialization.

Definition at line 105 of file mlLUTIterator.h.

◆ _layer

int ml::LUTIteratorBase::_layer
protected

Definition at line 114 of file mlLUTIterator.h.

◆ _row

int ml::LUTIteratorBase::_row
protected

Current row and layer.

Definition at line 114 of file mlLUTIterator.h.

◆ _valid

bool ml::LUTIteratorBase::_valid
protected

Iterator valid flag.

Definition at line 90 of file mlLUTIterator.h.

◆ _vtFrom

LUTVisualType ml::LUTIteratorBase::_vtFrom
protected

Source visual type, used by the LUT being rendered.

Definition at line 93 of file mlLUTIterator.h.

◆ _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.

◆ _width

int ml::LUTIteratorBase::_width
protected

Width of LUTData object.

Definition at line 108 of file mlLUTIterator.h.


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