A LUT function combining several input LUTs into a single output LUT. More...

#include <mlLUTFCombine.h>

Inheritance diagram for ml::LUTFCombine:

Classes
class	LUTEntry
	stores a lut function entry that should be combined More...

Public Types
enum	Mode { REPLACE = 0 , ADD , BLEND , SUBTRACT , MULTIPLY , MIN , MAX , NUM_MODES }
	gives a mode that is used for combining More...

enum	Mask { MASK_R = 0 , MASK_G , MASK_B , MASK_A , MASK_RGB , MASK_RGBA , NUM_MASKS }
	gives a mask that is used for combining More...

Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Public Member Functions
	LUTFCombine (void)
	Constructor. More...

void	clearEntries ()
	clear the entries More...

void	addEntry (const LUTEntry &entry)
	add an entry More...

unsigned int	getNumEntries () const
	get number of entries More...

const LUTEntry &	getEntry (int i) const
	get the ith entry (no range checking!) More...

LUT properties
bool	isValid (void) const override
	Return true if the LUT function is valid. More...

double	getNativeMinIndex (void) const override
	Get native minimum index. More...

double	getNativeMaxIndex (void) const override
	Get native maximum index. More...

int	getHeight (void) const override
	Get native LUT height (= number of rows, numbering starts at 0) More...

int	getDepth (void) const override
	Get native LUT depth (= number of layers, numbering starts at 0) More...

double	getNativeMinValue (void) const override
	Get native minimum LUT value. More...

double	getNativeMaxValue (void) const override
	Get native maximum LUT value. More...

Public Member Functions inherited from ml::LUTFunction
	LUTFunction (LUTVisualType vt, bool relative)
	Constructor. More...

void	changed (void)
	Assign a new LUT ID. More...

void	overwriteUniqueId (unsigned int newId)
	Overwrites the unique id. NOTE: use this only if you really know what you are doing! More...

virtual LUTVisualType	getVisualType (void) const
	Get LUT visual type. More...

virtual bool	isRelative (void) const
	Is LUT relative? More...

virtual void	setRelative (bool relative)
	Set/reset relative flag. More...

virtual LUTDimensionality	getDimensionality (void) const
	Get dimensionality (1, 2, or 3), usually depending on height and depth. More...

unsigned int	getId (void) const
	Get current LUT ID. More...

virtual bool	render (LUTDataBase *lutData) const
	Render LUT in (previously initialized) LUTData object. More...

virtual bool	renderRescaled (LUTDataBase *lutData, double minIndex, double maxIndex) const
	Render rescaled LUT in (previously initialized) LUTData object. More...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion() More...

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument. More...

virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase. More...

virtual std::string	detailString () const
	Return a string describing this object. More...

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class. More...

virtual std::string	persistentState () const
	Returns a string describing the object's internal state. More...

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`. More...

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node. More...

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node. More...

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object. More...

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object. More...

Protected Member Functions
	ML_CLASS_HEADER (LUTFCombine)

LUT implementation
bool	renderLUTNative (LUTDataBase lutData, LUTIteratorBase lutIterator) const override
	Render the lookup table into lutData using lutIterator to access and increment the LUT pointers. More...

bool	renderLUTRescaled (LUTDataBase lutData, LUTIteratorBase lutIterator, double minIndex, double maxIndex) const override
	Render rescaled LUT into lutData using lutIterator to access and increment the LUT pointers. More...

template<typename T >
bool	renderLUT (LUTData< T > lutData, LUTIterator< T > lutIterator, double minIndex, double maxIndex, bool rescale) const
	Render the output LUT into lutData using lutIterator to access and increment the LUT pointers. More...

Protected Member Functions inherited from ml::LUTFunction
template<typename T >
bool	renderT (LUTData< T > *lutData, bool rescaled, double minIndex, double maxIndex) const
	Perform type-specific, native or rescaled (rescaled = true, rescale to range minIndex ... More...

template<typename T >
bool	interpolateLUT (LUTData< T > lutData, LUTIterator< T > lutIterator, double minIndex, double maxIndex) const
	Perform type-specific rescaled LUT rendering by. More...

	ML_ABSTRACT_CLASS_HEADER (LUTFunction)

virtual LUTVisualType	getRenderType (LUTDataBase *) const
	Get visual type used for rendering. More...

Protected Member Functions inherited from ml::Base
virtual char *	getPersistentState () const
	Returns a C string describing the object's internal state. More...

virtual void	setPersistentState (const char *)
	Restores the object's internal state from a string that had been previously generated using `getPersistentState()`. More...

virtual void	clearPersistentState (char *) const
	Disposes a string previously allocated by `getPersistentState()`. More...

Protected Attributes
std::vector< LUTEntry >	_entries

Protected Attributes inherited from ml::LUTFunction
LUTVisualType	_visualType
	LUT visual type. More...

bool	_relative
	Flag for relative LUT. More...

unsigned int	_id
	Unique LUT ID, changed by the changed() method whenever a property of the LUT function object is modified. More...

Additional Inherited Members
Static Public Member Functions inherited from ml::LUTFunction
static unsigned int	generateUniqueId (void)
	Generate a unique id (unique for all mlLUTFunctions), this can also be called to get a unique id for a LUTData object manually. More...

Static Protected Attributes inherited from ml::LUTFunction
static unsigned int	_gNextId
	Global storage for next unused LUT ID to ensure uniqueness. More...

Detailed Description

A LUT function combining several input LUTs into a single output LUT.

Definition at line 28 of file mlLUTFCombine.h.

Member Enumeration Documentation

◆ Mask

enum ml::LUTFCombine::Mask

gives a mask that is used for combining

Enumerator
MASK_R
MASK_G
MASK_B
MASK_A
MASK_RGB
MASK_RGBA
NUM_MASKS

Definition at line 70 of file mlLUTFCombine.h.

◆ Mode

enum ml::LUTFCombine::Mode

gives a mode that is used for combining

Enumerator
REPLACE
ADD
BLEND
SUBTRACT
MULTIPLY
MIN
MAX
NUM_MODES

Definition at line 63 of file mlLUTFCombine.h.

Constructor & Destructor Documentation

◆ LUTFCombine()

ml::LUTFCombine::LUTFCombine ( void )

inline

Constructor.

Definition at line 33 of file mlLUTFCombine.h.

Member Function Documentation

◆ addEntry()

void ml::LUTFCombine::addEntry ( const LUTEntry & entry )

add an entry

◆ clearEntries()

void ml::LUTFCombine::clearEntries ( )

clear the entries

◆ getDepth()

int ml::LUTFCombine::getDepth ( void ) const

overridevirtual

Get native LUT depth (= number of layers, numbering starts at 0)

Reimplemented from ml::LUTFunction.

◆ getEntry()

const LUTEntry& ml::LUTFCombine::getEntry ( int i ) const

get the ith entry (no range checking!)

◆ getHeight()

int ml::LUTFCombine::getHeight ( void ) const

overridevirtual

Get native LUT height (= number of rows, numbering starts at 0)

Reimplemented from ml::LUTFunction.

◆ getNativeMaxIndex()

double ml::LUTFCombine::getNativeMaxIndex ( void ) const

overridevirtual

Get native maximum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMaxValue()

double ml::LUTFCombine::getNativeMaxValue ( void ) const

overridevirtual

Get native maximum LUT value.

Reimplemented from ml::LUTFunction.

◆ getNativeMinIndex()

double ml::LUTFCombine::getNativeMinIndex ( void ) const

overridevirtual

Get native minimum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMinValue()

double ml::LUTFCombine::getNativeMinValue ( void ) const

overridevirtual

Get native minimum LUT value.

Reimplemented from ml::LUTFunction.

◆ getNumEntries()

unsigned int ml::LUTFCombine::getNumEntries ( ) const

get number of entries

◆ isValid()

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

overridevirtual

Return true if the LUT function is valid.

Reimplemented from ml::LUTFunction.

◆ ML_CLASS_HEADER()

ml::LUTFCombine::ML_CLASS_HEADER ( LUTFCombine )

protected

◆ renderLUT()

template<typename T >

bool ml::LUTFCombine::renderLUT	(	LUTData< T > *	lutData,
		LUTIterator< T > *	lutIterator,
		double	minIndex,
		double	maxIndex,
		bool	rescale
	)		const

protected

Render the output LUT into lutData using lutIterator to access and increment the LUT pointers.

Return true if successful.

◆ renderLUTNative()

bool ml::LUTFCombine::renderLUTNative	(	LUTDataBase *	lutData,
		LUTIteratorBase *	lutIterator
	)		const

overrideprotectedvirtual

Render the lookup table into lutData using lutIterator to access and increment the LUT pointers.

Both lutData and lutIterator should be type-cast to a derived, type specific class pointer, according to lutData->getDataType(). Return true if successful.

Implements ml::LUTFunction.

◆ renderLUTRescaled()

bool ml::LUTFCombine::renderLUTRescaled	(	LUTDataBase *	lutData,
		LUTIteratorBase *	lutIterator,
		double	minIndex,
		double	maxIndex
	)		const

overrideprotectedvirtual

Render rescaled LUT into lutData using lutIterator to access and increment the LUT pointers.

Both lutData and lutIterator should be type-cast to a derived, type specific class pointer, according to lutData->getDataType(). The LUT is rendered for range minIndex .. maxIndex, but resampled to the index range specified in lutData. Return true if successful.

Reimplemented from ml::LUTFunction.

Member Data Documentation

◆ _entries

std::vector<LUTEntry> ml::LUTFCombine::_entries

protected

Definition at line 124 of file mlLUTFCombine.h.

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

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mask

◆ Mode

Constructor & Destructor Documentation

◆ LUTFCombine()

Member Function Documentation

◆ addEntry()

◆ clearEntries()

◆ getDepth()

◆ getEntry()

◆ getHeight()

◆ getNativeMaxIndex()

◆ getNativeMaxValue()

◆ getNativeMinIndex()

◆ getNativeMinValue()

◆ getNumEntries()

◆ isValid()

◆ ML_CLASS_HEADER()

◆ renderLUT()

◆ renderLUTNative()

◆ renderLUTRescaled()

Member Data Documentation

◆ _entries