MeVisLab Toolbox Reference
ml::LUTFSelect Class Reference

Select a 1D-LUT from a specified row/layer of a 2D- or 3D-LUT. More...

#include <mlLUTFSelect.h>

Inheritance diagram for ml::LUTFSelect:
ml::LUTFunction ml::Base

Public Member Functions

 LUTFSelect (void)
 Constructor.
 
virtual void setInputLUT (const LUTFunction *inLUT)
 Set input LUT, set relative flag to true if input LUT is relative.
 
Transform parameters
virtual void setRow (int row)
 Set row index.
 
virtual int getRow (void) const
 Get row index.
 
virtual void setLayer (int layer)
 Set layer index.
 
virtual int getLayer (void) const
 Get layer index.
 
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.
 
double getNativeMinValue (void) const override
 Get native minimum LUT value.
 
double getNativeMaxValue (void) const override
 Get native maximum LUT value.
 
- 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.
 
virtual int getHeight (void) const
 Get native LUT height (= number of rows, numbering starts at 0)
 
virtual int getDepth (void) const
 Get native LUT depth (= number of layers, numbering starts at 0)
 
unsigned int getId (void) const
 Get current LUT ID.
 
virtual bool render (LUTDataBase *lutData) const
 Render LUT in (previously initialized) LUTData object.
 
virtual bool renderRescaled (LUTDataBase *lutData, double minIndex, double maxIndex) const
 Render rescaled LUT in (previously initialized) LUTData object.
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
 
virtual ~Base ()
 Destructor.
 
virtual BasedeepCopy () 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 (LUTFSelect)
 
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.
 
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 rescaled) const
 Perform LUT rendering, return true if successful.
 
- 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)
 
virtual LUTVisualType getRenderType (LUTDataBase *) const
 Get visual type used for rendering.
 

Protected Attributes

const LUTFunction_inLUT
 Input LUT.
 
int _row
 Row and layer index of selected 1D-LUT.
 
int _layer
 
- 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.
 

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

Select a 1D-LUT from a specified row/layer of a 2D- or 3D-LUT.

Definition at line 28 of file mlLUTFSelect.h.

Constructor & Destructor Documentation

◆ LUTFSelect()

ml::LUTFSelect::LUTFSelect ( void )

Constructor.

Member Function Documentation

◆ getLayer()

virtual int ml::LUTFSelect::getLayer ( void ) const
inlinevirtual

Get layer index.

Definition at line 53 of file mlLUTFSelect.h.

◆ getNativeMaxIndex()

double ml::LUTFSelect::getNativeMaxIndex ( void ) const
overridevirtual

Get native maximum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMaxValue()

double ml::LUTFSelect::getNativeMaxValue ( void ) const
overridevirtual

Get native maximum LUT value.

Reimplemented from ml::LUTFunction.

◆ getNativeMinIndex()

double ml::LUTFSelect::getNativeMinIndex ( void ) const
overridevirtual

Get native minimum index.

Reimplemented from ml::LUTFunction.

◆ getNativeMinValue()

double ml::LUTFSelect::getNativeMinValue ( void ) const
overridevirtual

Get native minimum LUT value.

Reimplemented from ml::LUTFunction.

◆ getRow()

virtual int ml::LUTFSelect::getRow ( void ) const
inlinevirtual

Get row index.

Definition at line 47 of file mlLUTFSelect.h.

◆ isValid()

bool ml::LUTFSelect::isValid ( void ) const
overridevirtual

Return true if the LUT function is valid.

Reimplemented from ml::LUTFunction.

◆ ML_CLASS_HEADER()

ml::LUTFSelect::ML_CLASS_HEADER ( LUTFSelect )
protected

◆ renderLUT()

template<typename T >
bool ml::LUTFSelect::renderLUT ( LUTData< T > * lutData,
LUTIterator< T > * lutIterator,
double minIndex,
double maxIndex,
bool rescaled ) const
protected

Perform LUT rendering, return true if successful.

◆ renderLUTNative()

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

◆ setInputLUT()

virtual void ml::LUTFSelect::setInputLUT ( const LUTFunction * inLUT)
virtual

Set input LUT, set relative flag to true if input LUT is relative.

◆ setLayer()

virtual void ml::LUTFSelect::setLayer ( int layer)
inlinevirtual

Set layer index.

Definition at line 50 of file mlLUTFSelect.h.

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

◆ setRow()

virtual void ml::LUTFSelect::setRow ( int row)
inlinevirtual

Set row index.

Definition at line 44 of file mlLUTFSelect.h.

References ml::LUTFunction::changed().

Member Data Documentation

◆ _inLUT

const LUTFunction* ml::LUTFSelect::_inLUT
protected

Input LUT.

Definition at line 108 of file mlLUTFSelect.h.

◆ _layer

int ml::LUTFSelect::_layer
protected

Definition at line 111 of file mlLUTFSelect.h.

◆ _row

int ml::LUTFSelect::_row
protected

Row and layer index of selected 1D-LUT.

Definition at line 111 of file mlLUTFSelect.h.


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