mitk::TransferFunctionInitializer Class Reference

Wrapper class for VTK scalar opacity, gradient opacity, and color transfer functions. More...

#include <mitkTransferFunctionInitializer.h>

Inheritance diagram for mitk::TransferFunctionInitializer:

Collaboration diagram for mitk::TransferFunctionInitializer:

Public Member Functions
	mitkClassMacroItkParent (TransferFunctionInitializer, itk::Object)
Pointer	Clone () const
	mitkNewMacro1Param (TransferFunctionInitializer, TransferFunction::Pointer)
void	SetTransferFunction (TransferFunction::Pointer transferFunction)
	Set the transfer function to be initialized. More...
mitk::TransferFunction::Pointer	GetTransferFunction ()
	Return the currently held transfer function. More...
void	SetTransferFunctionMode (int mode)
	Set the transfer function preset mode and immediately apply it. More...
void	InitTransferFunctionMode ()
	Initialize the transfer function according to the currently set mode. More...

Static Public Member Functions
static Pointer	New ()
static void	GetPresetNames (std::vector< std::string > &presetNames)
	Populate a vector with the names of all available transfer function presets. More...

Protected Member Functions
	TransferFunctionInitializer (TransferFunction::Pointer transferFunction=nullptr)
	~TransferFunctionInitializer () override

Detailed Description

Wrapper class for VTK scalar opacity, gradient opacity, and color transfer functions.

Holds a copy of each of the three standard VTK transfer functions (scalar opacity, gradient opacity, color) and provides an interface for manipulating their control points. Each original function can be retrieved by a Get() method.

NOTE: Currently, transfer function initialization based on histograms or computed-tomography-presets is also provided by this class, but will likely be separated into a specific initializer class.

Definition at line 42 of file mitkTransferFunctionInitializer.h.

Constructor & Destructor Documentation

TransferFunctionInitializer()

mitk::TransferFunctionInitializer::TransferFunctionInitializer ( TransferFunction::Pointer  transferFunction = nullptr )

protected

~TransferFunctionInitializer()

mitk::TransferFunctionInitializer::~TransferFunctionInitializer ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::TransferFunctionInitializer::Clone

(

)

const

GetPresetNames()

static void mitk::TransferFunctionInitializer::GetPresetNames ( std::vector< std::string > &  presetNames )

static

Populate a vector with the names of all available transfer function presets.

Parameters

[out]

presetNames

Vector to be filled with preset name strings.

GetTransferFunction()

mitk::TransferFunction::Pointer mitk::TransferFunctionInitializer::GetTransferFunction

(

)

Return the currently held transfer function.

Returns

The transfer function, or nullptr if none has been set.

InitTransferFunctionMode()

void mitk::TransferFunctionInitializer::InitTransferFunctionMode

(

)

Initialize the transfer function according to the currently set mode.

Precondition

A transfer function must have been set via SetTransferFunction() or the constructor.

Exceptions

itk::ExceptionObject

if no transfer function has been set.

mitkClassMacroItkParent()

mitk::TransferFunctionInitializer::mitkClassMacroItkParent	(	TransferFunctionInitializer	,
		itk::Object
	)

mitkNewMacro1Param()

mitk::TransferFunctionInitializer::mitkNewMacro1Param	(	TransferFunctionInitializer	,
		TransferFunction::Pointer
	)

New()

static Pointer mitk::TransferFunctionInitializer::New ( )

static

SetTransferFunction()

void mitk::TransferFunctionInitializer::SetTransferFunction

(

TransferFunction::Pointer

transferFunction

)

Set the transfer function to be initialized.

Parameters

[in]

transferFunction

The transfer function to configure.

SetTransferFunctionMode()

void mitk::TransferFunctionInitializer::SetTransferFunctionMode

(

int

mode

)

Set the transfer function preset mode and immediately apply it.

Valid mode values correspond to the internal TransferFunctionMode enum (e.g., 0 for CT Default, 7 for MR Generic).

Parameters

[in]

mode

The preset index to apply.

---

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

• mitkTransferFunctionInitializer.h