Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

mitkTF2DRGBAClassifier Class Reference

#include <mitkTF2DRGBAClassifier.h>

Inherits mitkObject.

Inherited by mitkTF2DRGBAEllipsoidClassifier, mitkTF2DRGBAPSPSplineClassifier, mitkTF2DRGBAPyramidClassifier, mitkTF2DRGBARampClassifier, and mitkTF2DRGBASlopeClassifier.

Inheritance diagram for mitkTF2DRGBAClassifier:

Inheritance graph
[legend]
Collaboration diagram for mitkTF2DRGBAClassifier:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void SetLeft (int left)
void SetRight (int right)
void SetBottom (int bottom)
void SetTop (int top)
void SetCenter (int centerX, int centerY)
void Move (int deltaX, int deltaY)
void SetMaxOpacity (float MaxOpacity)
void SetMinOpacity (float MinOpacity)
void SetColor (float r, float g, float b)
int GetLeft () const
int GetRight () const
int GetBottom () const
int GetTop () const
void GetCenter (int &centerX, int &centerY) const
float GetMaxOpacity () const
float GetMinOpacity () const
const float * GetColor () const
void GetColor (float &r, float &g, float &b) const
bool IsModified ()
void SetUnmodified ()
float * GetCurve ()
void Update ()

Detailed Description

mitkTF2DRGBAClassifier - An Abstract class defining the interface of a classifier for 2D-RGBA-TransferFunction.

mitkTF2DRGBAClassifier - is an abstract class defining the interface of a classifier for 2D-RGBA-TransferFunction. A 2D-RGBA-TransferFunction maps scalar values along with gredient values to RGBA values, which can be used to render a volume. The shape of a classifier is determined by its 4 boundaries and a center control point. The actual behaviour is defined in subclasses.


Member Function Documentation

int mitkTF2DRGBAClassifier::GetBottom  )  const [inline]
 

Get the bottom boundary (minimum gradient value) of the classifier

Returns:
Return the bottom boundary (minimum gradient value) of the classifier

void mitkTF2DRGBAClassifier::GetCenter int &  centerX,
int &  centerY
const [inline]
 

Set the coordinate of the center control point

Parameters:
centerX Recieve X coordinate(scalar value) of the center control point
centerY Recieve Y coordinate(scalar value) of the center control point

void mitkTF2DRGBAClassifier::GetColor float &  r,
float &  g,
float &  b
const [inline]
 

Get the color of the classifier

Parameters:
r Receive the red value of the classifier
g Receive the green value of the classifier
b Receive the blue value of the classifier

const float* mitkTF2DRGBAClassifier::GetColor  )  const [inline]
 

Get the color of the classifier

Returns:
Return the color of the classifier

float* mitkTF2DRGBAClassifier::GetCurve  ) 
 

Get curve values of the classifier, it is calculated by subclasses and is the range 0~1 Call Update to apply the changes to parameters.

Returns:
Return opacity values of the classifier

int mitkTF2DRGBAClassifier::GetLeft  )  const [inline]
 

Get the left boundary (minimum scalar value) of the classifier

Returns:
Return the left boundary (minimum scalar value) of the classifier

float mitkTF2DRGBAClassifier::GetMaxOpacity  )  const [inline]
 

Get the maximum opacity of the classifier

Returns:
Return the maximum opacity of the classifier

float mitkTF2DRGBAClassifier::GetMinOpacity  )  const [inline]
 

Get the minimum opacity of the classifier

Returns:
Return the minimum opacity of the classifier

int mitkTF2DRGBAClassifier::GetRight  )  const [inline]
 

Get the right boundary (maximum scalar value) of the classifier

Returns:
Return the right boundary (maximum scalar value) of the classifier

int mitkTF2DRGBAClassifier::GetTop  )  const [inline]
 

Get the top boundary (maximum gradient value) of the classifier

Returns:
Return the top boundary (maximum gradient value) of the classifier

bool mitkTF2DRGBAClassifier::IsModified  )  [inline]
 

Get the modified status of the classifier, after last call to SetUnmodified, Call Update to apply the changes to parameters.

Returns:
Return the modified status of the classifier

void mitkTF2DRGBAClassifier::Move int  deltaX,
int  deltaY
 

Quickly move the classifier without changing its shape

Parameters:
deltaX Specify shift along X
deltaY Specify shift along Y

void mitkTF2DRGBAClassifier::SetBottom int  bottom  ) 
 

Set the bottom boundary (minimum gradient value) of the classifier

Parameters:
bottom Specify the bottom boundary (minimum gradient value) of the classifier

void mitkTF2DRGBAClassifier::SetCenter int  centerX,
int  centerY
 

Set the coordinate of the center control point

Parameters:
centerX Specify X coordinate(scalar value) of the center control point
centerY Specify Y coordinate(scalar value) of the center control point

void mitkTF2DRGBAClassifier::SetColor float  r,
float  g,
float  b
 

Set the color of the classifier, the default is 1,1,1

Parameters:
r Specify the red value of the classifier
g Specify the green value of the classifier
b Specify the blue value of the classifier

void mitkTF2DRGBAClassifier::SetLeft int  left  ) 
 

Set the left boundary (minimum scalar value) of the classifier

Parameters:
left Specify the left boundary (minimum scalar value) of the classifier

void mitkTF2DRGBAClassifier::SetMaxOpacity float  MaxOpacity  ) 
 

Set the maximum opacity of the classifier, the default is 1

Parameters:
MaxOpacity Specify the maximum opacity of the classifier.

void mitkTF2DRGBAClassifier::SetMinOpacity float  MinOpacity  ) 
 

Set the minimum opacity of the classifier, the default is 0

Parameters:
MinOpacity Specify the minimum opacity of the classifier.

void mitkTF2DRGBAClassifier::SetRight int  right  ) 
 

Set the right boundary (maximum scalar value) of the classifier

Parameters:
right Specify the right boundary (maximum scalar value) of the classifier

void mitkTF2DRGBAClassifier::SetTop int  top  ) 
 

Set the top boundary (maximum gradient value) of the classifier

Parameters:
top Specify the top boundary (maximum gradient value) of the classifier

void mitkTF2DRGBAClassifier::SetUnmodified  )  [inline]
 

Set the modified status of the classifier to false.

void mitkTF2DRGBAClassifier::Update  ) 
 

Apply the changes to parameters. If any change is made, the modified status will be set to true


The documentation for this class was generated from the following file:
Generated on Tue Feb 25 15:06:24 2014 for MITK (Medical Imaging ToolKit) by  doxygen 1.4.3