mitkTransferFunction1D Class Reference

mitkTransferFunction1D - a concrete 1D transfer function to map the data property to opacity More...

#include <mitkTransferFunction1D.h>

Inherits mitkTransferFunction.

Inheritance diagram for mitkTransferFunction1D:

[legend]Collaboration diagram for mitkTransferFunction1D:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
void	AddPoint (int x, float val)
void	RemovePoint (int x)
void	RemoveAllPoints ()
int	GetPointsCount ()
int	GetDataValueAtPoint (int pointIndex)
float	GetOpacityAtPoint (int pointIndex)
void	SetMax (int xMax, float valMax)
int	GetMaxX ()
float	GetValue (int x)
virtual int	GetDimension ()

---

Detailed Description

mitkTransferFunction1D - a concrete 1D transfer function to map the data property to opacity

mitkTransferFunction1D is a 1D transfer function to map the data property, including scalar value, gradient value, etc., to opacity. The data property value has a range. The minimum value is always 0, the maximum value can be set by calling the function SetMax(). In general, you firstly get the maximum value from a volume, and then pass it to mitkTransferFunction1D.

---

Member Function Documentation

void mitkTransferFunction1D::AddPoint (  int  x, float  val )

Add a point to this transfer function Parameters: x  Specify the data value, such as scalar value, gradient value val  Specify the corresponding opacity

int mitkTransferFunction1D::GetDataValueAtPoint (  int  pointIndex  )

Get the data value at pointIndex point Parameters: pointIndex  Specify zero-based point index Returns: Return the data value at the specified point

virtual int mitkTransferFunction1D::GetDimension (   )  [inline, virtual]

Get the dimensionality of this transfer function. Returns: Always return 1 Implements mitkTransferFunction.

int mitkTransferFunction1D::GetMaxX (   )  [inline]

Get the maximum data value of this transfer function. Returns: Return the maximum data value of this transfer function.

float mitkTransferFunction1D::GetOpacityAtPoint (  int  pointIndex  )

Get the opacity at pointIndex point Parameters: pointIndex  Specify zero-based point index Returns: Return the opacity at the specified point

int mitkTransferFunction1D::GetPointsCount (   )

Get the number of points in this transfer function Returns: Return the points number

float mitkTransferFunction1D::GetValue (  int  x  )

Get the opacity corresponding to the specified data value. Parameters: x  The specified data value. Returns: Return the opacity corresponding to the data value x.

virtual void mitkTransferFunction1D::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkTransferFunction.

void mitkTransferFunction1D::RemoveAllPoints (   )

Remove all points from this transfer function

void mitkTransferFunction1D::RemovePoint (  int  x  )

Remove a point from this transfer function Parameters: x  Specify the data value, such as scalar value, gradient value. If the transfer function has a point which data value is equal to x, then this point will be removed. Otherwise nothing happens.

void mitkTransferFunction1D::SetMax (  int  xMax, float  valMax )

Set the maximum data value and its corresponding opacity. Parameters: xMax  Specify the maximum data value. The data value range of this transfer function is from 0 to xMax. valMax  Specify the corresponding opacity Note: This function will call RemoveAllPoints(), so it will clear the previous transfer function. After the calling of this function, the transfer function has two points. One is (0, 0.0), and the other is (xMax, valMax)

---

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

• mitkTransferFunction1D.h

---