Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::LookupTableProperty Class Reference

The LookupTableProperty class Property to associate mitk::LookupTable to an mitk::DataNode. More...

#include <mitkLookupTableProperty.h>

Inheritance diagram for mitk::LookupTableProperty:
Collaboration diagram for mitk::LookupTableProperty:

Public Types

typedef LookupTable::Pointer ValueType
 
typedef LookupTableProperty Self
 
typedef BaseProperty Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::BaseProperty
typedef BaseProperty Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual LookupTableGetLookupTable ()
 
ValueType GetValue () const
 
void SetLookupTable (const mitk::LookupTable::Pointer aLookupTable)
 
void SetValue (const ValueType &)
 
std::string GetValueAsString () const override
 
bool ToJSON (nlohmann::json &j) const override
 Serialize property value(s) to JSON. More...
 
bool FromJSON (const nlohmann::json &j) override
 Deserialize property value(s) from JSON. More...
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
- Public Member Functions inherited from mitk::BaseProperty
Pointer Clone () const
 
bool operator== (const BaseProperty &property) const
 Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...
 
BasePropertyoperator= (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 
bool AssignProperty (const BaseProperty &property)
 Assigns property to this BaseProperty instance. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static Pointer New (const mitk::LookupTable::Pointer _arg)
 
- Static Public Member Functions inherited from mitk::BaseProperty
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 LookupTableProperty ()
 
 LookupTableProperty (const LookupTableProperty &)
 
 LookupTableProperty (const mitk::LookupTable::Pointer lut)
 
- Protected Member Functions inherited from mitk::BaseProperty
 BaseProperty ()
 
 BaseProperty (const BaseProperty &other)
 
 ~BaseProperty () override
 

Protected Attributes

LookupTable::Pointer m_LookupTable
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::BaseProperty
static const std::string VALUE_CANNOT_BE_CONVERTED_TO_STRING
 Default return value if a property which can not be returned as string. More...
 

Detailed Description

The LookupTableProperty class Property to associate mitk::LookupTable to an mitk::DataNode.

Note
If you want to use this property to colorize an mitk::Image, make sure to set the mitk::RenderingModeProperty to a mode which supports lookup tables (e.g. LOOKUPTABLE_COLOR). Make sure to check the documentation of the mitk::RenderingModeProperty. For a code example how to use the mitk::LookupTable and this property check the mitkImageVtkMapper2DLookupTableTest.cpp in Core/Code/Testing.

Definition at line 38 of file mitkLookupTableProperty.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ LookupTableProperty() [1/3]

mitk::LookupTableProperty::LookupTableProperty ( )
protected

◆ LookupTableProperty() [2/3]

mitk::LookupTableProperty::LookupTableProperty ( const LookupTableProperty )
protected

◆ LookupTableProperty() [3/3]

mitk::LookupTableProperty::LookupTableProperty ( const mitk::LookupTable::Pointer  lut)
protected

Member Function Documentation

◆ Clone()

Pointer mitk::LookupTableProperty::Clone ( ) const

◆ FromJSON()

bool mitk::LookupTableProperty::FromJSON ( const nlohmann::json j)
overridevirtual

Deserialize property value(s) from JSON.

Rely on exceptions for error handling when implementing deserialization.

Returns
False if not deserializable by design, true otherwise.

Implements mitk::BaseProperty.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::LookupTableProperty::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 52 of file mitkLookupTableProperty.h.

◆ GetClassName()

virtual const char* mitk::LookupTableProperty::GetClassName ( ) const
virtual

Reimplemented from mitk::BaseProperty.

◆ GetLookupTable()

virtual LookupTable* mitk::LookupTableProperty::GetLookupTable ( )
virtual

◆ GetStaticNameOfClass()

static const char* mitk::LookupTableProperty::GetStaticNameOfClass ( )
inlinestatic

Definition at line 52 of file mitkLookupTableProperty.h.

◆ GetValue()

ValueType mitk::LookupTableProperty::GetValue ( ) const

◆ GetValueAsString()

std::string mitk::LookupTableProperty::GetValueAsString ( ) const
overridevirtual

Reimplemented from mitk::BaseProperty.

◆ New() [1/2]

static Pointer mitk::LookupTableProperty::New ( )
static

◆ New() [2/2]

static Pointer mitk::LookupTableProperty::New ( const mitk::LookupTable::Pointer  _arg)
inlinestatic

Definition at line 57 of file mitkLookupTableProperty.h.

◆ operator=()

BaseProperty& mitk::BaseProperty::operator=

Assigns property to this BaseProperty instance.

Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling of polymorphic assignments. The assignment operator of the subclass should be disabled and the baseclass operator should be made visible using "using" statements.

◆ SetLookupTable()

void mitk::LookupTableProperty::SetLookupTable ( const mitk::LookupTable::Pointer  aLookupTable)

◆ SetValue()

void mitk::LookupTableProperty::SetValue ( const ValueType )

◆ ToJSON()

bool mitk::LookupTableProperty::ToJSON ( nlohmann::json j) const
overridevirtual

Serialize property value(s) to JSON.

Rely on exceptions for error handling when implementing serialization.

Returns
False if not serializable by design, true otherwise.

Implements mitk::BaseProperty.

Member Data Documentation

◆ m_LookupTable

LookupTable::Pointer mitk::LookupTableProperty::m_LookupTable
protected

Definition at line 41 of file mitkLookupTableProperty.h.


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