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

mitkInterpolateFilter Class Reference

mitkInterpolateFilter - an abstract class specifies interface for interpolating values when objects are resampled through the Transform More...

#include <mitkInterpolateFilter.h>

Inherits mitkVolumeToVolumeFilter.

Inherited by mitkBSplineInterpolateFilter, mitkCubicInterpolateFilter, mitkLinearInterpolateFilter, and mitkNearestNeighborInterpolateFilter.

Inheritance diagram for mitkInterpolateFilter:

Inheritance graph
[legend]
Collaboration diagram for mitkInterpolateFilter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void PrintSelf (ostream &os)
void SetCorrdinates (mitkVolume *coordinates)
mitkVolume * GetCoordinates ()
void SetRegion (const VectorIndexType &r)
void GetRegion (int r[6])
virtual void Update ()
virtual bool InterpolatePoint (float x, float y, float z, float &value)
virtual bool InterpolatePoint (float x, float y, float z, float *value)
virtual bool InterpolatePoint (const VectorParameterType &index, ScalarPixelType &value)
virtual bool InterpolatePoint (const VectorParameterType &index, VectorPixelType &value)
void SetOutputDatatype (int dataType)
void SetDefaultPixelValue (ScalarPixelType val)

Detailed Description

mitkInterpolateFilter - an abstract class specifies interface for interpolating values when objects are resampled through the Transform

mitkInterpolateFilter is an abstract class specifies interface for interpolating values when objects are resampled through the Transform.

mitkInterpolateFilter and its child class will only works inside the registration framework. If you want to perform geometric transform and interpolation outside the framework, please use mitkGeometricTransformFilter.

Note:
data type of the output is float.

Member Function Documentation

mitkVolume* mitkInterpolateFilter::GetCoordinates (   ) 
 

Get coordinates for interpolating pixels.

Returns:
Return the pointer to the coordinates.

void mitkInterpolateFilter::GetRegion (  int  r[6]  )  [inline]
 

Get valid region for interpolation.

Parameters:
r[0] Return the first (smaller) index in x axis, the unit is pixel.
r[1] Return the second (bigger) index in x axis, the unit is pixel.
r[2] Return the first (smaller) index in y axis, the unit is pixel.
r[3] Return the second (bigger) index in y axis, the unit is pixel.
r[4] Return the first (smaller) index in z axis, the unit is pixel.
r[5] Return the second (bigger) index in z axis, the unit is pixel.

virtual bool mitkInterpolateFilter::InterpolatePoint (  const VectorParameterType &  index,
VectorPixelType &  value
)  [virtual]
 

Perform a point interpolation for multi-channel(color) images.

Parameters:
index The index of the point in image.
value The point's intensity value after interpolation.
Returns:
Return true if the interpolation was performed without error.

virtual bool mitkInterpolateFilter::InterpolatePoint (  const VectorParameterType &  index,
ScalarPixelType &  value
)  [virtual]
 

Perform a point interpolation for single channel images.

Parameters:
index The index of the point in image.
value The point's intensity value after interpolation.
Returns:
Return true if the interpolation was performed without error.

virtual bool mitkInterpolateFilter::InterpolatePoint (  float  x,
float  y,
float  z,
float *  value
)  [virtual]
 

Perform a point interpolation for multi-channel(color) images.

Parameters:
x The x index of the point in image.
y The y index of the point in image.
z The z index of the point in image.
value The point's intensity value after interpolation.
Returns:
Return true if the interpolation was performed without error.

virtual bool mitkInterpolateFilter::InterpolatePoint (  float  x,
float  y,
float  z,
float &  value
)  [virtual]
 

Perform a point interpolation for single channel images.

Parameters:
x The x index of the point in image.
y The y index of the point in image.
z The z index of the point in image.
value The point's intensity value after interpolation.
Returns:
Return true if the interpolation was performed without error.

virtual void mitkInterpolateFilter::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 mitkVolumeToVolumeFilter.

Reimplemented in mitkBSplineInterpolateFilter, mitkCubicInterpolateFilter, mitkLinearInterpolateFilter, and mitkNearestNeighborInterpolateFilter.

void mitkInterpolateFilter::SetCorrdinates (  mitkVolume *  coordinates  )  [inline]
 

Set coordinates for interpolating pixels.

Parameters:
coordinates The pointer to the coordinates for interpolating pixels.

void mitkInterpolateFilter::SetDefaultPixelValue (  ScalarPixelType  val  )  [inline]
 

Set the default pixel value for background.

Parameters:
val The pixel value.

void mitkInterpolateFilter::SetOutputDatatype (  int  dataType  )  [inline]
 

Set the data type for output volume.

Parameters:
dataType Specify the output volume's data type.

void mitkInterpolateFilter::SetRegion (  const VectorIndexType &  r  )  [inline]
 

Set valid region for interpolation.

Parameters:
r[0] The first (smaller) index in x axis, the unit is pixel.
r[1] The second (bigger) index in x axis, the unit is pixel.
r[2] The first (smaller) index in y axis, the unit is pixel.
r[3] The second (bigger) index in y axis, the unit is pixel.
r[4] The first (smaller) index in z axis, the unit is pixel.
r[5] The second (bigger) index in z axis, the unit is pixel.

virtual void mitkInterpolateFilter::Update (   )  [virtual]
 

Initialize the Interpolator . Perform before Run() function.

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