performs ray integration with pre-integration tables. More...

#include <vtkUnstructuredGridPreIntegration.h>

Inheritance diagram for vtkUnstructuredGridPreIntegration:

Collaboration diagram for vtkUnstructuredGridPreIntegration:

Public Types
typedef vtkUnstructuredGridVolumeRayIntegrator	Superclass

Public Types inherited from vtkUnstructuredGridVolumeRayIntegrator
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkUnstructuredGridPreIntegration *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Initialize (vtkVolume volume, vtkDataArray scalars) override
	Set up the integrator with the given properties and scalars. More...

void	Integrate (vtkDoubleArray intersectionLengths, vtkDataArray nearIntersections, vtkDataArray *farIntersections, float color[4]) override
	Given a set of intersections (defined by the three arrays), compute the piecewise integration of the array in front to back order. More...

virtual float *	GetPreIntegrationTable (int component=0)
	Get the partial pre-integration table for the given scalar component. More...

float *	GetTableEntry (double scalar_front, double scalar_back, double length, int component=0)
	Get an entry (RGBA) in one of the pre-integration tables. More...

float *	GetIndexedTableEntry (int scalar_front_index, int scalar_back_index, int length_index, int component=0)
	Like GetTableEntry, except the inputs are scaled indices into the table rather than than the actual scalar and length values. More...


virtual vtkUnstructuredGridVolumeRayIntegrator *	GetIntegrator ()
	The class used to fill the pre integration table. More...

virtual void	SetIntegrator (vtkUnstructuredGridVolumeRayIntegrator *)
	The class used to fill the pre integration table. More...


virtual void	SetIntegrationTableScalarResolution (int)
	Set/Get the size of the integration table built. More...

virtual int	GetIntegrationTableScalarResolution ()
	Set/Get the size of the integration table built. More...

virtual void	SetIntegrationTableLengthResolution (int)
	Set/Get the size of the integration table built. More...

virtual int	GetIntegrationTableLengthResolution ()
	Set/Get the size of the integration table built. More...


virtual double	GetIntegrationTableScalarShift (int component=0)
	Get how an integration table is indexed. More...

virtual double	GetIntegrationTableScalarScale (int component=0)
	Get how an integration table is indexed. More...

virtual double	GetIntegrationTableLengthScale ()
	Get how an integration table is indexed. More...


virtual vtkTypeBool	GetIncrementalPreIntegration ()
	Get/set whether to use incremental pre-integration (by default it's on). More...

virtual void	SetIncrementalPreIntegration (vtkTypeBool)
	Get/set whether to use incremental pre-integration (by default it's on). More...

virtual void	IncrementalPreIntegrationOn ()
	Get/set whether to use incremental pre-integration (by default it's on). More...

virtual void	IncrementalPreIntegrationOff ()
	Get/set whether to use incremental pre-integration (by default it's on). More...

Public Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
vtkUnstructuredGridVolumeRayIntegrator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkUnstructuredGridPreIntegration *	SafeDownCast (vtkObjectBase *o)

static vtkUnstructuredGridPreIntegration *	New ()

Static Public Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
static vtkTypeBool	IsTypeOf (const char *type)

static vtkUnstructuredGridVolumeRayIntegrator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkUnstructuredGridPreIntegration ()

	~vtkUnstructuredGridPreIntegration () override

virtual void	BuildPreIntegrationTables (vtkDataArray *scalars)

Protected Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
	vtkUnstructuredGridVolumeRayIntegrator ()

	~vtkUnstructuredGridVolumeRayIntegrator () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

vtkTypeBool	IncrementalPreIntegration

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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.

Definition at line 52 of file vtkUnstructuredGridPreIntegration.h.

Member Typedef Documentation

typedef vtkUnstructuredGridVolumeRayIntegrator vtkUnstructuredGridPreIntegration::Superclass

Definition at line 56 of file vtkUnstructuredGridPreIntegration.h.

Constructor & Destructor Documentation

vtkUnstructuredGridPreIntegration::vtkUnstructuredGridPreIntegration ( )

protected

vtkUnstructuredGridPreIntegration::~vtkUnstructuredGridPreIntegration ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkUnstructuredGridPreIntegration::IsTypeOf ( const char * type )

static

virtual vtkTypeBool 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

static vtkUnstructuredGridPreIntegration* vtkUnstructuredGridPreIntegration::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkUnstructuredGridPreIntegration::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridVolumeRayIntegrator.

vtkUnstructuredGridPreIntegration* vtkUnstructuredGridPreIntegration::NewInstance ( ) const

static vtkUnstructuredGridPreIntegration* vtkUnstructuredGridPreIntegration::New ( )

static

void vtkUnstructuredGridPreIntegration::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkObject.

void vtkUnstructuredGridPreIntegration::Initialize	(	vtkVolume *	volume,
		vtkDataArray *	scalars
	)

overridevirtual

Set up the integrator with the given properties and scalars.

Implements vtkUnstructuredGridVolumeRayIntegrator.

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

overridevirtual

Given a set of intersections (defined by the three arrays), compute the piecewise integration of the array in front to back order.

/c intersectionLengths holds the lengths of each piecewise 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 vtkTypeBool 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 noticeable.

virtual void vtkUnstructuredGridPreIntegration::SetIncrementalPreIntegration ( vtkTypeBool )

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 noticeable.

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 noticeable.

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 noticeable.

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	length,
		int	component = `0`
	)

inline

Get an entry (RGBA) in one of the pre-integration tables.

The tables are built when Initialize is called.

Definition at line 190 of file vtkUnstructuredGridPreIntegration.h.

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