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

#include <mlLUTFCompose.h>

Inheritance diagram for ml::LUTFCompose:

Public Member Functions
	LUTFCompose (void)
	Constructor.

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

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

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

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

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

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

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

LUT rendering
These methods are called by LUT users to obtain a rendering of the LUT function.
bool	render (LUTDataBase *lutData) const override
	Render LUT in (previously initialized) LUTData object.

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

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

void	changed (void)
	Assign a new LUT ID.

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

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

virtual bool	isRelative (void) const
	Is LUT relative?

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

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

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

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

virtual	~Base ()
	Destructor.

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

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.

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

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

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

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

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

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

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

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

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

Protected Member Functions
	ML_CLASS_HEADER (LUTFCompose)

LUT implementation
LUTVisualType	getRenderType (LUTDataBase *lutData) const override
	Get visual type used for rendering.

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

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.

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.

unsigned int	getInputLUTWidth (unsigned int index) const
	Get the width of the index range for which the specified input LUT needs to be rendered.

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 ... maxIndex) LUT rendering by.

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

	ML_ABSTRACT_CLASS_HEADER (LUTFunction)

Protected Attributes
std::vector< const LUTFunction * >	_inputLUTs
	List of input LUTs.

unsigned int	_resolution
	Intermediate resolution.

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

bool	_relative
	Flag for relative LUT.

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

Input LUT list and intermediate resolution
static unsigned int	defaultResolution
	Default value for the intermediate resolution.

void	clear (void)
	Clear list of input LUTs.

void	addInputLUT (const LUTFunction &inputLUT)
	Add an input LUT.

unsigned int	getNumInputLUTs (void) const
	Get number of input LUTs.

const LUTFunction *	getInputLUT (unsigned int i) const
	Get pointer to i-th input LUT (or NULL if out of range)

void	setResolution (unsigned int resolution)
	Set intermediate resolution (if not obtained from input LUT)

unsigned int	getResolution (void) const
	Get intermediate resolution.

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

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.

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

Detailed Description

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

Definition at line 29 of file mlLUTFCompose.h.

Constructor & Destructor Documentation

◆ LUTFCompose()

ml::LUTFCompose::LUTFCompose ( void )

Constructor.

Member Function Documentation

◆ addInputLUT()

void ml::LUTFCompose::addInputLUT ( const LUTFunction & inputLUT )

Add an input LUT.

◆ clear()

void ml::LUTFCompose::clear ( void )

Clear list of input LUTs.

◆ getDepth()

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

overridevirtual

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

Reimplemented from ml::LUTFunction.

◆ getHeight()

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

overridevirtual

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

Reimplemented from ml::LUTFunction.

◆ getInputLUT()

const LUTFunction * ml::LUTFCompose::getInputLUT ( unsigned int i ) const

Get pointer to i-th input LUT (or NULL if out of range)

◆ getInputLUTWidth()

unsigned int ml::LUTFCompose::getInputLUTWidth ( unsigned int index ) const

protected

Get the width of the index range for which the specified input LUT needs to be rendered.

◆ getNativeMaxIndex()

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

overridevirtual

Get native maximum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMaxValue()

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

overridevirtual

Get native maximum LUT value.

Reimplemented from ml::LUTFunction.

◆ getNativeMinIndex()

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

overridevirtual

Get native minimum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMinValue()

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

overridevirtual

Get native minimum LUT value.

Reimplemented from ml::LUTFunction.

◆ getNumInputLUTs()

unsigned int ml::LUTFCompose::getNumInputLUTs ( void ) const

Get number of input LUTs.

◆ getRenderType()

LUTVisualType ml::LUTFCompose::getRenderType ( LUTDataBase * lutData ) const

inlineoverrideprotectedvirtual

Get visual type used for rendering.

This method is called by render() and renderRescaled() to initialize the LUT iterator object appropriate for a pair of source/target visual types. By returning the visual type of lutData, we always render directly in the visual type requested.

Reimplemented from ml::LUTFunction.

Definition at line 122 of file mlLUTFCompose.h.

References mlrange_cast().

◆ getResolution()

unsigned int ml::LUTFCompose::getResolution ( void ) const

inline

Get intermediate resolution.

Definition at line 83 of file mlLUTFCompose.h.

◆ isValid()

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

overridevirtual

Return true if the LUT function is valid.

Reimplemented from ml::LUTFunction.

◆ ML_CLASS_HEADER()

ml::LUTFCompose::ML_CLASS_HEADER ( LUTFCompose )

protected

◆ render()

bool ml::LUTFCompose::render ( LUTDataBase * lutData ) const

overridevirtual

Render LUT in (previously initialized) LUTData object.

Return true if successful.

Overloaded here to directly render the LUT if only one input LUT is specified

Reimplemented from ml::LUTFunction.

◆ renderLUT()

template<typename T >

bool ml::LUTFCompose::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::LUTFCompose::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::LUTFCompose::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.

◆ renderRescaled()

bool ml::LUTFCompose::renderRescaled	(	LUTDataBase *	lutData,
		double	minIndex,
		double	maxIndex ) const

overridevirtual

Render rescaled LUT in (previously initialized) LUTData object.

LUT is rendered for range minIndex .. maxIndex, but resampled to the index range specified in lutData. Return true if successful

Overloaded here to directly render the LUT if only one input LUT is specified

Reimplemented from ml::LUTFunction.

◆ setResolution()

void ml::LUTFCompose::setResolution ( unsigned int resolution )

inline

Set intermediate resolution (if not obtained from input LUT)

Definition at line 80 of file mlLUTFCompose.h.

References ml::LUTFunction::changed(), and mlrange_cast().

Member Data Documentation

◆ _inputLUTs

std::vector<const LUTFunction*> ml::LUTFCompose::_inputLUTs

protected

List of input LUTs.

Definition at line 152 of file mlLUTFCompose.h.

◆ _resolution

unsigned int ml::LUTFCompose::_resolution

protected

Intermediate resolution.

Definition at line 155 of file mlLUTFCompose.h.

◆ defaultResolution

unsigned int ml::LUTFCompose::defaultResolution

static

Default value for the intermediate resolution.

Definition at line 86 of file mlLUTFCompose.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Input LUT list and intermediate resolution

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LUTFCompose()

Member Function Documentation

◆ addInputLUT()

◆ clear()

◆ getDepth()

◆ getHeight()

◆ getInputLUT()

◆ getInputLUTWidth()

◆ getNativeMaxIndex()

◆ getNativeMaxValue()

◆ getNativeMinIndex()

◆ getNativeMinValue()

◆ getNumInputLUTs()

◆ getRenderType()

◆ getResolution()

◆ isValid()

◆ ML_CLASS_HEADER()

◆ render()

◆ renderLUT()

◆ renderLUTNative()

◆ renderLUTRescaled()

◆ renderRescaled()

◆ setResolution()

Member Data Documentation

◆ _inputLUTs

◆ _resolution

◆ defaultResolution