vtkVolumeRayCastSpaceLeapingImageFilter Class Reference

#include <vtkVolumeRayCastSpaceLeapingImageFilter.h>

Inheritance diagram for vtkVolumeRayCastSpaceLeapingImageFilter:

[legend]

Collaboration diagram for vtkVolumeRayCastSpaceLeapingImageFilter:

[legend]

List of all members.

Detailed Description

Builds the space leaping data structure.

This is an optimized multi-threaded imaging filter that builds the space leaping datastructure, used by vtkFixedPointVolumeRayCastMapper. Empty space leaping is used to skip large empty regions in the scalar opacity and/or the gradient opacity transfer functions. Depending on the various options set by vtkFixedPointVolumeRayCastMapper, the class will internally invoke one of the many optmized routines to compute the min/max/gradient-max values within a fixed block size, trying to compute everything in a single multi-threaded pass through the data

The block size may be changed at compile time. Its ifdef'ed to 4 in the CXX file.

Definition at line 38 of file vtkVolumeRayCastSpaceLeapingImageFilter.h.


Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetNumberOfIndependentComponents ()
unsigned short *	GetMinMaxVolume (int dims[4])
virtual void	SetCache (vtkImageData *imageCache)
unsigned long	ComputeOffset (int ext[6], int wholeExt[6], int nComponents)

virtual void	SetCurrentScalars (vtkDataArray *)
virtual vtkDataArray *	GetCurrentScalars ()

virtual void	SetIndependentComponents (int)
virtual int	GetIndependentComponents ()

virtual void	SetComputeGradientOpacity (int)
virtual int	GetComputeGradientOpacity ()
virtual void	ComputeGradientOpacityOn ()
virtual void	ComputeGradientOpacityOff ()

virtual void	SetComputeMinMax (int)
virtual int	GetComputeMinMax ()
virtual void	ComputeMinMaxOn ()
virtual void	ComputeMinMaxOff ()

virtual void	SetUpdateGradientOpacityFlags (int)
virtual int	GetUpdateGradientOpacityFlags ()
virtual void	UpdateGradientOpacityFlagsOn ()
virtual void	UpdateGradientOpacityFlagsOff ()

unsigned long	GetLastMinMaxBuildTime ()

unsigned long	GetLastMinMaxFlagTime ()

virtual void	SetTableShift (float, float, float, float)
virtual void	SetTableShift (float[4])
virtual float *	GetTableShift ()
virtual void	GetTableShift (float &, float &, float &, float &)
virtual void	GetTableShift (float[4])
virtual void	SetTableScale (float, float, float, float)
virtual void	SetTableScale (float[4])
virtual float *	GetTableScale ()
virtual void	GetTableScale (float &, float &, float &, float &)
virtual void	GetTableScale (float[4])
virtual void	SetTableSize (int, int, int, int)
virtual void	SetTableSize (int[4])
virtual int *	GetTableSize ()
virtual void	GetTableSize (int &, int &, int &, int &)
virtual void	GetTableSize (int[4])

unsigned short *	GetMinNonZeroScalarIndex ()
unsigned char *	GetMinNonZeroGradientMagnitudeIndex ()

void	SetGradientMagnitude (unsigned char **gradientMagnitude)
unsigned char **	GetGradientMagnitude ()

void	SetScalarOpacityTable (int c, unsigned short *t)
void	SetGradientOpacityTable (int c, unsigned short *t)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkVolumeRayCastSpaceLeapingImageFilter *	SafeDownCast (vtkObject *o)
static vtkVolumeRayCastSpaceLeapingImageFilter *	New ()

static void	ComputeInputExtentsForOutput (int inExt[6], unsigned int inDim[3], int outExt[6], vtkImageData *inData)
Protected Member Functions
	vtkVolumeRayCastSpaceLeapingImageFilter ()
	~vtkVolumeRayCastSpaceLeapingImageFilter ()
void	InternalRequestUpdateExtent (int , int )
void	ComputeFirstNonZeroOpacityIndices ()

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
void	ThreadedRequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector, vtkImageData *inData, vtkImageData outData, int outExt[6], int id)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

void	FillScalarOpacityFlags (vtkImageData *minMaxVolume, int outExt[6])

void	FillScalarAndGradientOpacityFlags (vtkImageData *minMaxVolume, int outExt[6])

virtual void	AllocateOutputData (vtkImageData out, int uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out)
Protected Attributes
int	IndependentComponents
vtkTimeStamp	LastMinMaxBuildTime
vtkTimeStamp	LastMinMaxFlagTime
vtkDataArray *	CurrentScalars
float	TableShift [4]
float	TableScale [4]
int	TableSize [4]
int	ComputeGradientOpacity
int	ComputeMinMax
int	UpdateGradientOpacityFlags
unsigned short *	MinNonZeroScalarIndex
unsigned char *	MinNonZeroGradientMagnitudeIndex
unsigned char **	GradientMagnitude
unsigned short *	ScalarOpacityTable [4]
unsigned short *	GradientOpacityTable [4]
vtkImageData *	Cache

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkVolumeRayCastSpaceLeapingImageFilter::Superclass

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 41 of file vtkVolumeRayCastSpaceLeapingImageFilter.h.

Constructor & Destructor Documentation

vtkVolumeRayCastSpaceLeapingImageFilter::vtkVolumeRayCastSpaceLeapingImageFilter ( ) [protected]

vtkVolumeRayCastSpaceLeapingImageFilter::~vtkVolumeRayCastSpaceLeapingImageFilter ( ) [protected]

Member Function Documentation

virtual const char* vtkVolumeRayCastSpaceLeapingImageFilter::GetClassName ( ) [virtual]

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkVolumeRayCastSpaceLeapingImageFilter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkThreadedImageAlgorithm.

static vtkVolumeRayCastSpaceLeapingImageFilter* vtkVolumeRayCastSpaceLeapingImageFilter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkThreadedImageAlgorithm.

void vtkVolumeRayCastSpaceLeapingImageFilter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkThreadedImageAlgorithm.

static vtkVolumeRayCastSpaceLeapingImageFilter* vtkVolumeRayCastSpaceLeapingImageFilter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetCurrentScalars ( vtkDataArray * ) [virtual]

Set the scalars.

virtual vtkDataArray* vtkVolumeRayCastSpaceLeapingImageFilter::GetCurrentScalars ( ) [virtual]

Set the scalars.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetIndependentComponents ( int ) [virtual]

Do we use independent components, or dependent components ?

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::GetIndependentComponents ( ) [virtual]

Do we use independent components, or dependent components ?

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetComputeGradientOpacity ( int ) [virtual]

Compute gradient opacity ?

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::GetComputeGradientOpacity ( ) [virtual]

Compute gradient opacity ?

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeGradientOpacityOn ( ) [virtual]

Compute gradient opacity ?

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeGradientOpacityOff ( ) [virtual]

Compute gradient opacity ?

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetComputeMinMax ( int ) [virtual]

Compute the min max structure ?.

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::GetComputeMinMax ( ) [virtual]

Compute the min max structure ?.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeMinMaxOn ( ) [virtual]

Compute the min max structure ?.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeMinMaxOff ( ) [virtual]

Compute the min max structure ?.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetUpdateGradientOpacityFlags ( int ) [virtual]

Update the gradient opacity flags. (The scalar opacity flags are always updated upon execution of this filter.)

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::GetUpdateGradientOpacityFlags ( ) [virtual]

Update the gradient opacity flags. (The scalar opacity flags are always updated upon execution of this filter.)

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::UpdateGradientOpacityFlagsOn ( ) [virtual]

Update the gradient opacity flags. (The scalar opacity flags are always updated upon execution of this filter.)

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::UpdateGradientOpacityFlagsOff ( ) [virtual]

Update the gradient opacity flags. (The scalar opacity flags are always updated upon execution of this filter.)

unsigned long vtkVolumeRayCastSpaceLeapingImageFilter::GetLastMinMaxBuildTime ( ) [inline]

Get the last execution time. This is updated every time the scalars or the gradient opacity values are computed

Definition at line 83 of file vtkVolumeRayCastSpaceLeapingImageFilter.h.

unsigned long vtkVolumeRayCastSpaceLeapingImageFilter::GetLastMinMaxFlagTime ( ) [inline]

Get the last execution time. This is updated every time the flags bits are re-computed.

Definition at line 90 of file vtkVolumeRayCastSpaceLeapingImageFilter.h.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableShift	(	float	,
		float	,
		float	,
		float
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableShift ( float [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual float* vtkVolumeRayCastSpaceLeapingImageFilter::GetTableShift ( ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableShift	(	float &	,
		float &	,
		float &	,
		float &
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableShift ( float [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableScale	(	float	,
		float	,
		float	,
		float
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableScale ( float [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual float* vtkVolumeRayCastSpaceLeapingImageFilter::GetTableScale ( ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableScale	(	float &	,
		float &	,
		float &	,
		float &
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableScale ( float [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableSize	(	int	,
		int	,
		int	,
		int
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetTableSize ( int [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual int* vtkVolumeRayCastSpaceLeapingImageFilter::GetTableSize ( ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableSize	(	int &	,
		int &	,
		int &	,
		int &
	)			`[virtual]`

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::GetTableSize ( int [4] ) [virtual]

Is the difference between max and min of the data less than 32768? If so, and if the data is not of float/double type, use a simple offset mapping. If the difference between max and min is 32768 or greater, or the data is of type float or double, we must use an offset / scaling mapping. In this case, the array size will be 32768 - we need to figure out the offset and scale factor.

int vtkVolumeRayCastSpaceLeapingImageFilter::GetNumberOfIndependentComponents ( )

Get the number of independent components for which we need to keep track of min/max

unsigned short* vtkVolumeRayCastSpaceLeapingImageFilter::GetMinMaxVolume ( int dims[4] )

Get the raw pointer to the final computed space leaping datastructure. The result is only valid after Update() has been called on the filter. Note that this filter holds onto its memory. The dimensions of the min- max volume are in dims. The 4th value in the array indicates the number of independent components, (also queried via GetNumberOfIndependentComponents())

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::SetCache ( vtkImageData * imageCache ) [virtual]

INTERNAL - Do not use Set the last cached min-max volume, as used by vtkFixedPointVolumeRayCastMapper.

static void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeInputExtentsForOutput	(	int	inExt[6],
		unsigned int	inDim[3],
		int	outExt[6],
		vtkImageData *	inData
	)			`[static]`

Compute the extents and dimensions of the input that's required to generate an output min-max structure given by outExt. INTERNAL - Do not use

unsigned short* vtkVolumeRayCastSpaceLeapingImageFilter::GetMinNonZeroScalarIndex ( )

Get the first non-zero scalar opacity and gradient opacity indices for each independent copmonent INTERNAL - Do not use.

unsigned char* vtkVolumeRayCastSpaceLeapingImageFilter::GetMinNonZeroGradientMagnitudeIndex ( )

Get the first non-zero scalar opacity and gradient opacity indices for each independent copmonent INTERNAL - Do not use.

void vtkVolumeRayCastSpaceLeapingImageFilter::SetGradientMagnitude ( unsigned char ** gradientMagnitude )

Pointer to the pre-computed gradient magnitude structure. This is pre- computed by the vtkFixedPointVolumeRayCastMapper class. This should be set if one has the ComputeGradientOpacity flag enabled.

unsigned char** vtkVolumeRayCastSpaceLeapingImageFilter::GetGradientMagnitude ( )

Pointer to the pre-computed gradient magnitude structure. This is pre- computed by the vtkFixedPointVolumeRayCastMapper class. This should be set if one has the ComputeGradientOpacity flag enabled.

void vtkVolumeRayCastSpaceLeapingImageFilter::SetScalarOpacityTable	(	int	c,
		unsigned short *	t
	)

Set the scalar opacity and gradient opacity tables computed for each component by the vtkFixedPointVolumeRayCastMapper

void vtkVolumeRayCastSpaceLeapingImageFilter::SetGradientOpacityTable	(	int	c,
		unsigned short *	t
	)

Set the scalar opacity and gradient opacity tables computed for each component by the vtkFixedPointVolumeRayCastMapper

unsigned long vtkVolumeRayCastSpaceLeapingImageFilter::ComputeOffset	(	int	ext[6],
		int	wholeExt[6],
		int	nComponents
	)

INTERNAL - Do not use Compute the offset within an image of whole extents wholeExt, to access the data starting at extents ext.

void vtkVolumeRayCastSpaceLeapingImageFilter::InternalRequestUpdateExtent	(	int *	,
		int *
	)			`[protected]`

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

See superclass for details

Reimplemented from vtkImageAlgorithm.

void vtkVolumeRayCastSpaceLeapingImageFilter::ThreadedRequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector,
		vtkImageData ***	inData,
		vtkImageData **	outData,
		int	outExt[6],
		int	id
	)			`[protected, virtual]`

See superclass for details

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

See superclass for details

Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkVolumeRayCastSpaceLeapingImageFilter::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

See superclass for details

Reimplemented from vtkImageAlgorithm.

void vtkVolumeRayCastSpaceLeapingImageFilter::ComputeFirstNonZeroOpacityIndices ( ) [protected]

Compute the first non-zero scalar opacity and gradient opacity values that are encountered when marching from the beginning of the transfer function tables.

void vtkVolumeRayCastSpaceLeapingImageFilter::FillScalarOpacityFlags	(	vtkImageData *	minMaxVolume,
		int	outExt[6]
	)			`[protected]`

Fill the flags after processing the min/max/gradient structure. This optimized version is invoked when only scalar opacity table is needed.

void vtkVolumeRayCastSpaceLeapingImageFilter::FillScalarAndGradientOpacityFlags	(	vtkImageData *	minMaxVolume,
		int	outExt[6]
	)			`[protected]`

Fill the flags after processing the min/max/gradient structure. This optimized version is invoked when both scalar and gradient opacity tables need to be visited.

virtual void vtkVolumeRayCastSpaceLeapingImageFilter::AllocateOutputData	(	vtkImageData *	out,
		int *	uExtent
	)			`[protected, virtual]`

Allocate the output data. If we have a cache with the same metadata as the output we are going to generate, re-use the cache as we may not be updating all data in the min-max structure.

Reimplemented from vtkImageAlgorithm.

virtual vtkImageData* vtkVolumeRayCastSpaceLeapingImageFilter::AllocateOutputData ( vtkDataObject * out ) [protected, virtual]

Allocate the output data. If we have a cache with the same metadata as the output we are going to generate, re-use the cache as we may not be updating all data in the min-max structure.

Reimplemented from vtkImageAlgorithm.