vtkUnstructuredGridPreIntegration Class Reference

#include <vtkUnstructuredGridPreIntegration.h>

Inheritance diagram for vtkUnstructuredGridPreIntegration:

[legend]

Collaboration diagram for vtkUnstructuredGridPreIntegration:

[legend]

List of all members.

Detailed Description

performs ray integration with pre-integration tables.

vtkUnstructuredGridPreIntegration performs ray integration by looking into a precomputed table. The result should be equivalent to that computed by vtkUnstructuredGridLinearRayIntegrator and vtkUnstructuredGridPartialPreIntegration, but faster than either one. The pre-integration algorithm was first introduced by Roettger, Kraus, and Ertl in "Hardware-Accelerated Volume And Isosurface Rendering Based On Cell-Projection."

Due to table size limitations, a table can only be indexed by independent scalars. Thus, dependent scalars are not supported.

Tests:: vtkUnstructuredGridPreIntegration (Tests)

Definition at line 53 of file vtkUnstructuredGridPreIntegration.h.


Public Types
typedef vtkUnstructuredGridVolumeRayIntegrator	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize (vtkVolume volume, vtkDataArray scalars)
virtual void	Integrate (vtkDoubleArray intersectionLengths, vtkDataArray nearIntersections, vtkDataArray *farIntersections, float color[4])
virtual float *	GetPreIntegrationTable (int component=0)

virtual vtkUnstructuredGridVolumeRayIntegrator *	GetIntegrator ()
virtual void	SetIntegrator (vtkUnstructuredGridVolumeRayIntegrator *)

virtual void	SetIntegrationTableScalarResolution (int)
virtual int	GetIntegrationTableScalarResolution ()
virtual void	SetIntegrationTableLengthResolution (int)
virtual int	GetIntegrationTableLengthResolution ()

virtual double	GetIntegrationTableScalarShift (int component=0)
virtual double	GetIntegrationTableScalarScale (int component=0)
virtual double	GetIntegrationTableLengthScale ()

virtual int	GetIncrementalPreIntegration ()
virtual void	SetIncrementalPreIntegration (int)
virtual void	IncrementalPreIntegrationOn ()
virtual void	IncrementalPreIntegrationOff ()

float *	GetTableEntry (double scalar_front, double scalar_back, double lenth, int component=0)

float *	GetIndexedTableEntry (int scalar_front_index, int scalar_back_index, int length_index, int component=0)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkUnstructuredGridPreIntegration *	SafeDownCast (vtkObject *o)
static vtkUnstructuredGridPreIntegration *	New ()
Protected Member Functions
	vtkUnstructuredGridPreIntegration ()
	~vtkUnstructuredGridPreIntegration ()
virtual void	BuildPreIntegrationTables (vtkDataArray *scalars)
Protected Attributes
vtkUnstructuredGridVolumeRayIntegrator *	Integrator
vtkVolume *	Volume
vtkVolumeProperty *	Property
double	MaxLength
int	NumComponents
float **	IntegrationTable
double *	IntegrationTableScalarShift
double *	IntegrationTableScalarScale
double	IntegrationTableLengthScale
vtkTimeStamp	IntegrationTableBuilt
int	IntegrationTableScalarResolution
int	IntegrationTableLengthResolution
int	IncrementalPreIntegration

Member Typedef Documentation

typedef vtkUnstructuredGridVolumeRayIntegrator vtkUnstructuredGridPreIntegration::Superclass

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

Definition at line 57 of file vtkUnstructuredGridPreIntegration.h.

Constructor & Destructor Documentation

vtkUnstructuredGridPreIntegration::vtkUnstructuredGridPreIntegration ( ) [protected]

vtkUnstructuredGridPreIntegration::~vtkUnstructuredGridPreIntegration ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

static int vtkUnstructuredGridPreIntegration::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

virtual int vtkUnstructuredGridPreIntegration::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

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

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

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

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

Reimplemented from vtkObject.

virtual void vtkUnstructuredGridPreIntegration::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 vtkUnstructuredGridVolumeRayIntegrator.

virtual void vtkUnstructuredGridPreIntegration::Initialize	(	vtkVolume *	volume,
		vtkDataArray *	scalars
	)			`[virtual]`

Set up the integrator with the given properties and scalars.

Implements vtkUnstructuredGridVolumeRayIntegrator.

virtual void vtkUnstructuredGridPreIntegration::Integrate	(	vtkDoubleArray *	intersectionLengths,
		vtkDataArray *	nearIntersections,
		vtkDataArray *	farIntersections,
		float	color[4]
	)			`[virtual]`

Given a set of intersections (defined by the three arrays), compute the peicewise integration of the array in front to back order. /c intersectionLengths holds the lengths of each peicewise segment. /c nearIntersections and /c farIntersections hold the scalar values at the front and back of each segment. /c color should contain the RGBA value of the volume in front of the segments passed in, and the result will be placed back into /c color.

Implements vtkUnstructuredGridVolumeRayIntegrator.

virtual vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridPreIntegration::GetIntegrator ( ) [virtual]

The class used to fill the pre integration table. By default, a vtkUnstructuredGridPartialPreIntegration is built.

virtual void vtkUnstructuredGridPreIntegration::SetIntegrator ( vtkUnstructuredGridVolumeRayIntegrator * ) [virtual]

The class used to fill the pre integration table. By default, a vtkUnstructuredGridPartialPreIntegration is built.

virtual void vtkUnstructuredGridPreIntegration::SetIntegrationTableScalarResolution ( int ) [virtual]

Set/Get the size of the integration table built.

virtual int vtkUnstructuredGridPreIntegration::GetIntegrationTableScalarResolution ( ) [virtual]

Set/Get the size of the integration table built.

virtual void vtkUnstructuredGridPreIntegration::SetIntegrationTableLengthResolution ( int ) [virtual]

Set/Get the size of the integration table built.

virtual int vtkUnstructuredGridPreIntegration::GetIntegrationTableLengthResolution ( ) [virtual]

Set/Get the size of the integration table built.

virtual double vtkUnstructuredGridPreIntegration::GetIntegrationTableScalarShift ( int component = 0 ) [virtual]

Get how an integration table is indexed.

virtual double vtkUnstructuredGridPreIntegration::GetIntegrationTableScalarScale ( int component = 0 ) [virtual]

Get how an integration table is indexed.

virtual double vtkUnstructuredGridPreIntegration::GetIntegrationTableLengthScale ( ) [virtual]

Get how an integration table is indexed.

virtual int vtkUnstructuredGridPreIntegration::GetIncrementalPreIntegration ( ) [virtual]

Get/set whether to use incremental pre-integration (by default it's on). Incremental pre-integration is much faster but can introduce error due to numerical imprecision. Under most circumstances, the error is not noticable.

virtual void vtkUnstructuredGridPreIntegration::SetIncrementalPreIntegration ( int ) [virtual]

Get/set whether to use incremental pre-integration (by default it's on). Incremental pre-integration is much faster but can introduce error due to numerical imprecision. Under most circumstances, the error is not noticable.

virtual void vtkUnstructuredGridPreIntegration::IncrementalPreIntegrationOn ( ) [virtual]

Get/set whether to use incremental pre-integration (by default it's on). Incremental pre-integration is much faster but can introduce error due to numerical imprecision. Under most circumstances, the error is not noticable.

virtual void vtkUnstructuredGridPreIntegration::IncrementalPreIntegrationOff ( ) [virtual]

Get/set whether to use incremental pre-integration (by default it's on). Incremental pre-integration is much faster but can introduce error due to numerical imprecision. Under most circumstances, the error is not noticable.

virtual float* vtkUnstructuredGridPreIntegration::GetPreIntegrationTable ( int component = 0 ) [virtual]

Get the partial pre-integration table for the given scalar component. The tables are built when Initialize is called. A segment of length d with a front scalar of sf and a back scalar of sb is referenced in the resulting table as 4 * ((l * IntegrationTableLengthScale) * IntegrationTableScalarResolution * IntegrationTableScalarResolution + (sb * IntegrationTableScalarScale + IntegrationTableScalarShift) * IntegrationTableScalarResolution + (sf * IntegrationTableScalarScale + IntegrationTableScalarShift)).

float * vtkUnstructuredGridPreIntegration::GetTableEntry	(	double	scalar_front,
		double	scalar_back,
		double	lenth,
		int	component = `0`
	)			`[inline]`

Get an entry (RGBA) in one of the pre-integration tables. The tables are built when Intialize is called.

Definition at line 181 of file vtkUnstructuredGridPreIntegration.h.

float * vtkUnstructuredGridPreIntegration::GetIndexedTableEntry	(	int	scalar_front_index,
		int	scalar_back_index,
		int	length_index,
		int	component = `0`
	)			`[inline]`

Like GetTableEntry, except the inputs are scaled indices into the table rather than than the actual scalar and length values. Use GetTableEntry unless you are really sure you know what you are doing.

Definition at line 155 of file vtkUnstructuredGridPreIntegration.h.

virtual void vtkUnstructuredGridPreIntegration::BuildPreIntegrationTables ( vtkDataArray * scalars ) [protected, virtual]