VHTK::ScalarExtractorFilter Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::ScalarExtractorFilter:

[legend]

List of all members.

---

Detailed Description

This filter extracts the magnitude of some feature of a scalar or vector image.

X3D Interface
	Name	Type	Default value	Description
	transferFunction	SFTransferFunction	null	Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.
	property	SFString	""	The property that should be extracted. If this field is not set, the gradient magnitude of the scalar volume is used if present. If the scalar volume is not present, the vector magnitude of the vector volume is sampled. Valid values are GRADIENT, VECTOR, CURL and DIV.
Derived from ScalarImageFilter
	scalarVolume	MFScalarImageNode	[]	Scalar volume(s) to extract data from.
	vectorVolume	MFVectorImageNode	[]	Vector volume(s) to extract data from.
	pixelComponentType	SFString	""	The type of the target volume. One of SIGNED, UNSIGNED or RATIONAL. If empty the source volume type is used.
	bitsPerPixel	SFInt32	0	The number of bits per voxel for the target volume. If zero the source volume type is used.

Public Member Functions
	ScalarExtractorFilter (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::Field > _dataChanged=0, H3D::Inst< H3D::SFBool > _scaleVectors=0, H3D::Inst< SFImage > _image=0, H3D::Inst< MFScalarImageNode > _scalarVolume=0, H3D::Inst< MFVectorImageNode > _vectorVolume=0, H3D::Inst< H3D::SFString > _pixelComponentType=0, H3D::Inst< H3D::SFInt32 > _bitsPerPixel=0, H3D::Inst< SFTransferFunction > _transferFunction=0, H3D::Inst< H3D::SFString > _property=0)
	Constructor.
Public Attributes
auto_ptr< SFTransferFunction >	transferFunction
	Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.
auto_ptr< H3D::SFString >	property
	The property that should be extracted.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	X3D node/field database.
Protected Member Functions
virtual bool	convertData (void *&data, int &width, int &height, int &depth, H3D::Vec3f &pixelSize)
template<typename DST_TYPE>
bool	doConvertData (DST_TYPE *&data, int &width, int &height, int &depth, H3D::Vec3f &pixelSize)
Friends
class	ScalarImageFilterHelper

---

Constructor & Destructor Documentation

VHTK::ScalarExtractorFilter::ScalarExtractorFilter	(	H3D::Inst< H3D::SFNode >	_metadata = 0,
		H3D::Inst< H3D::Field >	_dataChanged = 0,
		H3D::Inst< H3D::SFBool >	_scaleVectors = 0,
		H3D::Inst< SFImage >	_image = 0,
		H3D::Inst< MFScalarImageNode >	_scalarVolume = 0,
		H3D::Inst< MFVectorImageNode >	_vectorVolume = 0,
		H3D::Inst< H3D::SFString >	_pixelComponentType = 0,
		H3D::Inst< H3D::SFInt32 >	_bitsPerPixel = 0,
		H3D::Inst< SFTransferFunction >	_transferFunction = 0,
		H3D::Inst< H3D::SFString >	_property = 0
	)

Constructor.

---

Member Function Documentation

virtual bool VHTK::ScalarExtractorFilter::convertData	(	void *&	data,
		int &	width,
		int &	height,
		int &	depth,
		H3D::Vec3f &	pixelSize
	)			[inline, protected, virtual]

See also:

ScalarImageFilter::convertData

Reimplemented from VHTK::ScalarImageFilter.

template<typename DST_TYPE>

bool VHTK::ScalarExtractorFilter::doConvertData	(	DST_TYPE *&	data,
		int &	width,
		int &	height,
		int &	depth,
		H3D::Vec3f &	pixelSize
	)			[inline, protected]

See also:

ScalarImageFilter::doConvertData

Reimplemented from VHTK::ScalarImageFilter.

---

Member Data Documentation

auto_ptr< SFTransferFunction > VHTK::ScalarExtractorFilter::transferFunction

Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.

auto_ptr< H3D::SFString > VHTK::ScalarExtractorFilter::property

The property that should be extracted.

If this field is not set, the gradient magnitude of the scalar volume is used if present. If the scalar volume is not present, the vector magnitude of the vector volume is sampled.

Valid values are

• GRADIENT - scalar field gradient magnitude
• VECTOR - vector magnitude of the vector volume
• CURL - vector curl of the vector volume
• DIV - vector divergence of the vector volume

H3D::H3DNodeDatabase VHTK::ScalarExtractorFilter::database [static]

X3D node/field database.

Reimplemented from VHTK::ScalarImageFilter.