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

mitkEncodedGradientEstimator Class Reference

mitkEncodedGradientEstimator - an abstract class for gradient estimation More...

#include <mitkEncodedGradientEstimator.h>

Inherits mitkObject.

Inherited by mitkFiniteDifferenceGradientEstimator.

Inheritance diagram for mitkEncodedGradientEstimator:

Inheritance graph
[legend]
Collaboration diagram for mitkEncodedGradientEstimator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void SetInput (mitkVolume *pInVolume)
mitkVolume * GetInput ()
void SetGradientMagnitudeScale (float fGMS)
float GetGradientMagnitudeScale ()
void SetGradientMagnitudeBias (float fGMB)
float GetGradientMagnitudeBias ()
virtual void SetBoundsClip (int nBoundsClip)
virtual int GetBoundsClipMinValue ()
virtual int GetBoundsClipMaxValue ()
virtual int GetBoundsClip ()
virtual void SetBoundsClipOn ()
virtual void SetBoundsClipOff ()
virtual void SetBounds (int arg1, int arg2, int arg3, int arg4, int arg5, int arg6)
virtual void SetBounds (int arg[6])
virtual void GetBounds (int &arg1, int &arg2, int &arg3, int &arg4, int &arg5, int &arg6)
void GetBounds (int arg[6])
int * GetBounds ()
void SetComputeGradientMagnitudes (int nCGM)
int GetComputeGradientMagnitudes ()
virtual void SetComputeGradientMagnitudesOn ()
virtual void SetComputeGradientMagnitudesOff ()
void SetCylinderClip (int nCC)
int GetCylinderClip ()
virtual void SetCylinderClipOn ()
virtual void SetCylinderClipOff ()
int GetUseCylinderClip ()
int * GetCircleLimits ()
void SetZeroNormalThreshold (float v)
float GetZeroNormalThreshold ()
virtual void SetZeroPad (int nZeroPad)
virtual int GetZeroPadMinValue ()
virtual int GetZeroPadMaxValue ()
virtual int GetZeroPad ()
virtual void SetZeroPadOn ()
virtual void SetZeroPadOff ()
void Update ()
unsigned short * GetEncodedNormals ()
mitkVolume * GetEncodedNormalsVol ()
unsigned char * GetGradientMagnitudes ()
mitkVolume * GetGradientMagnitudesVol ()
void SetDirectionEncoder (mitkDirectionEncoder *direnc)
mitkDirectionEncoder * GetDirectionEncoder ()

Detailed Description

mitkEncodedGradientEstimator - an abstract class for gradient estimation

mitkEncodedGradientEstimator is an abstract class for gradient estimation. Some codes are borrowed from VTK, and please see the copyright at end.

Member Function Documentation

int* mitkEncodedGradientEstimator::GetBounds (   ) 
 

Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

Returns:
Return the bounds value

void mitkEncodedGradientEstimator::GetBounds (  int  arg[6]  ) 
 

Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

Parameters:
arg[0] Represent the first bounds value
arg[1] Represent the second bounds value
arg[2] Represent the third bounds value
arg[3] Represent the forth bounds value
arg[4] Represent the fifth bounds value
arg[5] Represent the sixth bounds value

virtual void mitkEncodedGradientEstimator::GetBounds (  int &  arg1,
int &  arg2,
int &  arg3,
int &  arg4,
int &  arg5,
int &  arg6
)  [virtual]
 

Get the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

Parameters:
arg1 Represent the first bounds value
arg2 Represent the second bounds value
arg3 Represent the third bounds value
arg4 Represent the forth bounds value
arg5 Represent the fifth bounds value
arg6 Represent the sixth bounds value

virtual int mitkEncodedGradientEstimator::GetBoundsClip (   )  [inline, virtual]
 

Get the bounds clip value

Returns:
Return the bounds clip value

virtual int mitkEncodedGradientEstimator::GetBoundsClipMaxValue (   )  [inline, virtual]
 

Get the max bounds clip value

Returns:
Return the max bounds clip value

virtual int mitkEncodedGradientEstimator::GetBoundsClipMinValue (   )  [inline, virtual]
 

Get the min bounds clip value

Returns:
Return the min bounds clip value

int* mitkEncodedGradientEstimator::GetCircleLimits (   )  [inline]
 

Get the circle limits value

Returns:
Return the circle limits value

int mitkEncodedGradientEstimator::GetComputeGradientMagnitudes (   )  [inline]
 

Get the compute gradient magnitude value

Returns:
Return the compute gradient magnitude value

int mitkEncodedGradientEstimator::GetCylinderClip (   )  [inline]
 

Get the cylinder clip value

Returns:
Return the cylinder clip value

mitkDirectionEncoder* mitkEncodedGradientEstimator::GetDirectionEncoder (   )  [inline]
 

Get the direction encoder used to encode normal directions to fit within two bytes

Returns:
Return the direction encoder value

unsigned short* mitkEncodedGradientEstimator::GetEncodedNormals (   ) 
 

Get the encoded normals.

Returns:
Return the encoded normal
Warning:
The return value could be NULL, if the original data is out-of-core. Under this circumstance, please use GetEncodedNormalsVol() instead to get the volume of encoded normals and use the interfaces of mitkVolume (such as GetSliceData(), ReadSliceData() etc.) to get actual encoded normals.

mitkVolume* mitkEncodedGradientEstimator::GetEncodedNormalsVol (   ) 
 

Get the encoded normals volume (in case of out-of-core data).

Returns:
Return the volume contains the encoded normals.

float mitkEncodedGradientEstimator::GetGradientMagnitudeBias (   )  [inline]
 

Get the scale and bias for the gradient magnitude

Returns:
Return the gradient magnitude

unsigned char* mitkEncodedGradientEstimator::GetGradientMagnitudes (   ) 
 

Get the gradient magnitudes

Returns:
Return the gradient magnitude value
Warning:
The return value could be NULL, if the original data is out-of-core. Under this circumstance, please use GetGradientMagnitudesVol() instead to get the volume of gradient magnitudes and use the interfaces of mitkVolume (such as GetSliceData(), ReadSliceData() etc.) to get actual gradient magnitude values.

float mitkEncodedGradientEstimator::GetGradientMagnitudeScale (   )  [inline]
 

Get the scale and bias for the gradient magnitude

Returns:
Return the scale and bias for the gradient magnitude

mitkVolume* mitkEncodedGradientEstimator::GetGradientMagnitudesVol (   ) 
 

Get the gradient magnitudes volume (in case of out-of-core data).

Returns:
Return the volume contains the gradient magnitude value.

mitkVolume* mitkEncodedGradientEstimator::GetInput (   )  [inline]
 

Get the scalar input for which the normals will be calculated

Returns:
Return the scalar input for which the normals will be calculated

int mitkEncodedGradientEstimator::GetUseCylinderClip (   )  [inline]
 

Get the use cylinder clip value

Returns:
Return the use cylinder clip value

float mitkEncodedGradientEstimator::GetZeroNormalThreshold (   )  [inline]
 

Get teh zero normal threshold value

Returns:
Return the zero normal threshold value

virtual int mitkEncodedGradientEstimator::GetZeroPad (   )  [inline, virtual]
 

Get the zero pad value

Returns:
Return the zero pad value

virtual int mitkEncodedGradientEstimator::GetZeroPadMaxValue (   )  [inline, virtual]
 

Get the max zero pad value

Returns:
Return the min zero pad value

virtual int mitkEncodedGradientEstimator::GetZeroPadMinValue (   )  [inline, virtual]
 

Get the min zero pad value

Returns:
Return the min zero pad value

virtual void mitkEncodedGradientEstimator::SetBounds (  int  arg[6]  )  [virtual]
 

Set the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

Parameters:
arg[0] Represent the first bounds value
arg[1] Represent the second bounds value
arg[2] Represent the third bounds value
arg[3] Represent the forth bounds value
arg[4] Represent the fifth bounds value
arg[5] Represent the sixth bounds value

virtual void mitkEncodedGradientEstimator::SetBounds (  int  arg1,
int  arg2,
int  arg3,
int  arg4,
int  arg5,
int  arg6
)  [virtual]
 

Set the bounds of the computation (used if this->ComputationBounds is 1.) The bounds are specified xmin, xmax, ymin, ymax, zmin, zmax.

Parameters:
arg1 Represent the first bounds value
arg2 Represent the second bounds value
arg3 Represent the third bounds value
arg4 Represent the forth bounds value
arg5 Represent the fifth bounds value
arg6 Represent the sixth bounds value

virtual void mitkEncodedGradientEstimator::SetBoundsClip (  int  nBoundsClip  )  [inline, virtual]
 

Turn on the bounding of the normal computation by the this->Bounds bounding box

Parameters:
nBoundsClip Represent the on or off value

virtual void mitkEncodedGradientEstimator::SetBoundsClipOff (   )  [inline, virtual]
 

Turn off the bounding of the normal computation by the this->Bounds bounding box

virtual void mitkEncodedGradientEstimator::SetBoundsClipOn (   )  [inline, virtual]
 

Turn on the bounding of the normal computation by the this->Bounds bounding box

void mitkEncodedGradientEstimator::SetComputeGradientMagnitudes (  int  nCGM  )  [inline]
 

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

Parameters:
nCGM Represent the compute gradient magnitude value

virtual void mitkEncodedGradientEstimator::SetComputeGradientMagnitudesOff (   )  [inline, virtual]
 

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

virtual void mitkEncodedGradientEstimator::SetComputeGradientMagnitudesOn (   )  [inline, virtual]
 

If you don't want to compute gradient magnitudes (but you do want normals for shading) this can be used. Be careful - if if you a non-constant gradient magnitude transfer function and you turn this on, it may crash

void mitkEncodedGradientEstimator::SetCylinderClip (  int  nCC  )  [inline]
 

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

Parameters:
nCC Represent the cylinder clip value

virtual void mitkEncodedGradientEstimator::SetCylinderClipOff (   )  [inline, virtual]
 

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

virtual void mitkEncodedGradientEstimator::SetCylinderClipOn (   )  [inline, virtual]
 

If the data in each slice is only contained within a circle circumscribed within the slice, and the slice is square, then don't compute anything outside the circle. This circle through the slices forms a cylinder.

void mitkEncodedGradientEstimator::SetDirectionEncoder (  mitkDirectionEncoder *  direnc  ) 
 

Set the direction encoder used to encode normal directions to fit within two bytes

Parameters:
direnc Represent the direction encoder value

void mitkEncodedGradientEstimator::SetGradientMagnitudeBias (  float  fGMB  )  [inline]
 

Set the scale and bias for the gradient magnitude

Parameters:
fGMB Represent the gradient magnitude

void mitkEncodedGradientEstimator::SetGradientMagnitudeScale (  float  fGMS  )  [inline]
 

Set the scale and bias for the gradient magnitude

Parameters:
fGMS Represent the scale and bias for the gradient magnitude

void mitkEncodedGradientEstimator::SetInput (  mitkVolume *  pInVolume  ) 
 

Set the scalar input for which the normals will be calculated

Parameters:
pInVolume Represent the scalar input for which the normals will be calculated

void mitkEncodedGradientEstimator::SetZeroNormalThreshold (  float  v  ) 
 

Set the ZeroNormalThreshold - this defines the minimum magnitude of a gradient that is considered sufficient to define a direction. Gradients with magnitudes at or less than this value are given a "zero normal" index. These are handled specially in the shader, and you can set the intensity of light for these zero normals in the gradient shader.

Parameters:
v Represent the zero normal threshold value

virtual void mitkEncodedGradientEstimator::SetZeroPad (  int  nZeroPad  )  [inline, virtual]
 

Assume that the data value outside the volume is zero when computing normals.

Parameters:
nZeroPad Represent teh zero pad value

virtual void mitkEncodedGradientEstimator::SetZeroPadOff (   )  [inline, virtual]
 

Assume that the data value outside the volume is zero when computing normals.

virtual void mitkEncodedGradientEstimator::SetZeroPadOn (   )  [inline, virtual]
 

Assume that the data value outside the volume is zero when computing normals.

void mitkEncodedGradientEstimator::Update (   ) 
 

Recompute the encoded normals and gradient magnitudes.

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