VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUnstructuredGridPreIntegration Class Reference

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

#include <vtkUnstructuredGridPreIntegration.h>

Inheritance diagram for vtkUnstructuredGridPreIntegration:
[legend]
Collaboration diagram for vtkUnstructuredGridPreIntegration:
[legend]

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...
 
vtkUnstructuredGridPreIntegrationNewInstance () 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 vtkUnstructuredGridVolumeRayIntegratorGetIntegrator ()
 The class used to fill the pre integration table. More...
 
virtual void SetIntegrator (vtkUnstructuredGridVolumeRayIntegrator *)
 
virtual void SetIntegrationTableScalarResolution (int)
 Set/Get the size of the integration table built. More...
 
virtual int GetIntegrationTableScalarResolution ()
 
virtual void SetIntegrationTableLengthResolution (int)
 
virtual int GetIntegrationTableLengthResolution ()
 
virtual double GetIntegrationTableScalarShift (int component=0)
 Get how an integration table is indexed. More...
 
virtual double GetIntegrationTableScalarScale (int component=0)
 
virtual double GetIntegrationTableLengthScale ()
 
virtual vtkTypeBool GetIncrementalPreIntegration ()
 Get/set whether to use incremental pre-integration (by default it's on). More...
 
virtual void SetIncrementalPreIntegration (vtkTypeBool)
 
virtual void IncrementalPreIntegrationOn ()
 
virtual void IncrementalPreIntegrationOff ()
 
virtual floatGetPreIntegrationTable (int component=0)
 Get the partial pre-integration table for the given scalar component. More...
 
floatGetTableEntry (double scalar_front, double scalar_back, double length, int component=0)
 Get an entry (RGBA) in one of the pre-integration tables. More...
 
floatGetIndexedTableEntry (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...
 
- Public Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
vtkUnstructuredGridVolumeRayIntegratorNewInstance () 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridPreIntegrationSafeDownCast (vtkObjectBase *o)
 
static vtkUnstructuredGridPreIntegrationNew ()
 
- Static Public Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridVolumeRayIntegratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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

vtkUnstructuredGridVolumeRayIntegratorIntegrator
 
vtkVolumeVolume
 
vtkVolumePropertyProperty
 
double MaxLength
 
int NumComponents
 
float ** IntegrationTable
 
doubleIntegrationTableScalarShift
 
doubleIntegrationTableScalarScale
 
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
std::atomic< int32_t > 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

◆ Superclass

Definition at line 56 of file vtkUnstructuredGridPreIntegration.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridPreIntegration()

vtkUnstructuredGridPreIntegration::vtkUnstructuredGridPreIntegration ( )
protected

◆ ~vtkUnstructuredGridPreIntegration()

vtkUnstructuredGridPreIntegration::~vtkUnstructuredGridPreIntegration ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkUnstructuredGridPreIntegration::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkUnstructuredGridPreIntegration* vtkUnstructuredGridPreIntegration::NewInstance ( ) const

◆ New()

static vtkUnstructuredGridPreIntegration* vtkUnstructuredGridPreIntegration::New ( )
static

◆ PrintSelf()

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.

◆ Initialize()

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

Set up the integrator with the given properties and scalars.

Implements vtkUnstructuredGridVolumeRayIntegrator.

◆ Integrate()

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.

◆ GetIntegrator()

virtual vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridPreIntegration::GetIntegrator ( )
virtual

The class used to fill the pre integration table.

By default, a vtkUnstructuredGridPartialPreIntegration is built.

◆ SetIntegrator()

virtual void vtkUnstructuredGridPreIntegration::SetIntegrator ( vtkUnstructuredGridVolumeRayIntegrator )
virtual

◆ SetIntegrationTableScalarResolution()

virtual void vtkUnstructuredGridPreIntegration::SetIntegrationTableScalarResolution ( int  )
virtual

Set/Get the size of the integration table built.

◆ GetIntegrationTableScalarResolution()

virtual int vtkUnstructuredGridPreIntegration::GetIntegrationTableScalarResolution ( )
virtual

◆ SetIntegrationTableLengthResolution()

virtual void vtkUnstructuredGridPreIntegration::SetIntegrationTableLengthResolution ( int  )
virtual

◆ GetIntegrationTableLengthResolution()

virtual int vtkUnstructuredGridPreIntegration::GetIntegrationTableLengthResolution ( )
virtual

◆ GetIntegrationTableScalarShift()

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

Get how an integration table is indexed.

◆ GetIntegrationTableScalarScale()

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

◆ GetIntegrationTableLengthScale()

virtual double vtkUnstructuredGridPreIntegration::GetIntegrationTableLengthScale ( )
virtual

◆ GetIncrementalPreIntegration()

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.

◆ SetIncrementalPreIntegration()

virtual void vtkUnstructuredGridPreIntegration::SetIncrementalPreIntegration ( vtkTypeBool  )
virtual

◆ IncrementalPreIntegrationOn()

virtual void vtkUnstructuredGridPreIntegration::IncrementalPreIntegrationOn ( )
virtual

◆ IncrementalPreIntegrationOff()

virtual void vtkUnstructuredGridPreIntegration::IncrementalPreIntegrationOff ( )
virtual

◆ GetPreIntegrationTable()

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

◆ GetTableEntry()

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.

◆ GetIndexedTableEntry()

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 164 of file vtkUnstructuredGridPreIntegration.h.

◆ BuildPreIntegrationTables()

virtual void vtkUnstructuredGridPreIntegration::BuildPreIntegrationTables ( vtkDataArray scalars)
protectedvirtual

Member Data Documentation

◆ Integrator

vtkUnstructuredGridVolumeRayIntegrator* vtkUnstructuredGridPreIntegration::Integrator
protected

Definition at line 139 of file vtkUnstructuredGridPreIntegration.h.

◆ Volume

vtkVolume* vtkUnstructuredGridPreIntegration::Volume
protected

Definition at line 141 of file vtkUnstructuredGridPreIntegration.h.

◆ Property

vtkVolumeProperty* vtkUnstructuredGridPreIntegration::Property
protected

Definition at line 142 of file vtkUnstructuredGridPreIntegration.h.

◆ MaxLength

double vtkUnstructuredGridPreIntegration::MaxLength
protected

Definition at line 143 of file vtkUnstructuredGridPreIntegration.h.

◆ NumComponents

int vtkUnstructuredGridPreIntegration::NumComponents
protected

Definition at line 145 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTable

float** vtkUnstructuredGridPreIntegration::IntegrationTable
protected

Definition at line 146 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableScalarShift

double* vtkUnstructuredGridPreIntegration::IntegrationTableScalarShift
protected

Definition at line 147 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableScalarScale

double* vtkUnstructuredGridPreIntegration::IntegrationTableScalarScale
protected

Definition at line 148 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableLengthScale

double vtkUnstructuredGridPreIntegration::IntegrationTableLengthScale
protected

Definition at line 149 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableBuilt

vtkTimeStamp vtkUnstructuredGridPreIntegration::IntegrationTableBuilt
protected

Definition at line 150 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableScalarResolution

int vtkUnstructuredGridPreIntegration::IntegrationTableScalarResolution
protected

Definition at line 152 of file vtkUnstructuredGridPreIntegration.h.

◆ IntegrationTableLengthResolution

int vtkUnstructuredGridPreIntegration::IntegrationTableLengthResolution
protected

Definition at line 153 of file vtkUnstructuredGridPreIntegration.h.

◆ IncrementalPreIntegration

vtkTypeBool vtkUnstructuredGridPreIntegration::IncrementalPreIntegration
protected

Definition at line 155 of file vtkUnstructuredGridPreIntegration.h.


The documentation for this class was generated from the following file: