VHTK::VHTKScalarImageNode Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::VHTKScalarImageNode:

[legend]

List of all members.

---

Detailed Description

This is the abstract base class nodes that contains an Image object that specifies the scalar field.

This data node implements methods for extracting and interpolating the image data, and thereby simulating a piecewise linear, but continuous, 3D function from the image data. Floating point image data is used as-is but integer data are mapped to the interval zero to one for unsigned integers and minus one to one for signed integers, to make them more easy to work with.

Public Member Functions
	VHTKScalarImageNode (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::Field > _dataChanged=0, H3D::Inst< H3D::SFBool > _scaleVectors=0, H3D::Inst< SFImage > _image=0)
virtual void	getVolumeResolution (int &x, int &y, int &z)
	Get the size of the volume in number of voxels.
virtual H3D::Vec3f	getVolumeSize ()
	Get the size of the volume in metres.
virtual float	getScalar (int x, int y, int z)
	Get the scalar value of a given voxel.
virtual float	getScalar (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the scalar value at a given position in space.
virtual H3D::Vec3f	getGradient (int x, int y, int z)
	Get the gradient at a given voxel.
virtual H3D::Vec3f	getGradient (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the voxel value at a given position in space.
Protected Attributes
GradientKernel	kernel
Classes
class	SFImage
	The SFImage class is specialized to hold a separate reference for use by the haptics loop in order for Image objects not be deleted in the scenegraph loop while still being used in the haptics loop. More...

---

Member Function Documentation

virtual void VHTK::VHTKScalarImageNode::getVolumeResolution	(	int &	x,
		int &	y,
		int &	z
	)			[virtual]

Get the size of the volume in number of voxels.

All parameters are outout parameters.

virtual H3D::Vec3f VHTK::VHTKScalarImageNode::getVolumeSize

(

)

[virtual]

Get the size of the volume in metres.

Implements VHTK::VHTKDataNode.

virtual float VHTK::VHTKScalarImageNode::getScalar	(	int	x,
		int	y,
		int	z
	)			[virtual]

Get the scalar value of a given voxel.

virtual float VHTK::VHTKScalarImageNode::getScalar	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the scalar value at a given position in space.

Parameters:

	T	is the transforation matrix from local space to the space the volume data is specified in.
	x	is the local position in space.

Implements VHTK::VHTKScalarDataNode.

virtual H3D::Vec3f VHTK::VHTKScalarImageNode::getGradient	(	int	x,
		int	y,
		int	z
	)			[virtual]

Get the gradient at a given voxel.

virtual H3D::Vec3f VHTK::VHTKScalarImageNode::getGradient	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the voxel value at a given position in space.

Parameters:

	T	is the transforation matrix from local space to the space the volume data is specified in.
	x	is the local position in space.

Implements VHTK::VHTKScalarDataNode.