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

performs piecewise linear ray integration. More...

#include <vtkUnstructuredGridLinearRayIntegrator.h>

Inheritance diagram for vtkUnstructuredGridLinearRayIntegrator:
[legend]
Collaboration diagram for vtkUnstructuredGridLinearRayIntegrator:
[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.
 
vtkUnstructuredGridLinearRayIntegratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Initialize (vtkVolume *volume, vtkDataArray *scalars) override
 Set up the integrator with the given properties and scalars.
 
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.
 
- Public Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkUnstructuredGridVolumeRayIntegratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Initialize (vtkVolume *volume, vtkDataArray *scalars)=0
 Set up the integrator with the given properties and scalars.
 
virtual void Integrate (vtkDoubleArray *intersectionLengths, vtkDataArray *nearIntersections, vtkDataArray *farIntersections, float color[4])=0
 Given a set of intersections (defined by the three arrays), compute the piecewise integration of the array in front to back order.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridLinearRayIntegratorSafeDownCast (vtkObjectBase *o)
 
static vtkUnstructuredGridLinearRayIntegratorNew ()
 
static float Psi (float length, float attenuation_front, float attenuation_back)
 Computes Psi (as defined by Moreland and Angel, "A Fast High Accuracy Volume Renderer for Unstructured Data").
 
static void IntegrateRay (double length, double intensity_front, double attenuation_front, double intensity_back, double attenuation_back, float color[4])
 Integrates a single ray segment.
 
static void IntegrateRay (double length, const double color_front[3], double attenuation_front, const double color_back[3], double attenuation_back, float color[4])
 Integrates a single ray segment.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUnstructuredGridLinearRayIntegrator ()
 
 ~vtkUnstructuredGridLinearRayIntegrator () override
 
- Protected Member Functions inherited from vtkUnstructuredGridVolumeRayIntegrator
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkVolumePropertyProperty
 
vtkLinearRayIntegratorTransferFunction * TransferFunctions
 
vtkTimeStamp TransferFunctionsModified
 
int NumIndependentComponents
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

performs piecewise linear ray integration.

vtkUnstructuredGridLinearRayIntegrator performs piecewise linear ray integration. Considering that transfer functions in VTK are piecewise linear, this class should give the "correct" integration under most circumstances. However, the computations performed are fairly hefty and should, for the most part, only be used as a benchmark for other, faster methods.

See also
vtkUnstructuredGridPartialPreIntegration

Definition at line 33 of file vtkUnstructuredGridLinearRayIntegrator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkUnstructuredGridLinearRayIntegrator.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridLinearRayIntegrator()

vtkUnstructuredGridLinearRayIntegrator::vtkUnstructuredGridLinearRayIntegrator ( )
protected

◆ ~vtkUnstructuredGridLinearRayIntegrator()

vtkUnstructuredGridLinearRayIntegrator::~vtkUnstructuredGridLinearRayIntegrator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkUnstructuredGridLinearRayIntegrator::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 vtkUnstructuredGridLinearRayIntegrator * vtkUnstructuredGridLinearRayIntegrator::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUnstructuredGridLinearRayIntegrator::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkUnstructuredGridLinearRayIntegrator * vtkUnstructuredGridLinearRayIntegrator::NewInstance ( ) const

◆ New()

static vtkUnstructuredGridLinearRayIntegrator * vtkUnstructuredGridLinearRayIntegrator::New ( )
static

◆ PrintSelf()

void vtkUnstructuredGridLinearRayIntegrator::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 vtkUnstructuredGridLinearRayIntegrator::Initialize ( vtkVolume volume,
vtkDataArray scalars 
)
overridevirtual

Set up the integrator with the given properties and scalars.

Implements vtkUnstructuredGridVolumeRayIntegrator.

◆ Integrate()

void vtkUnstructuredGridLinearRayIntegrator::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.

◆ IntegrateRay() [1/2]

static void vtkUnstructuredGridLinearRayIntegrator::IntegrateRay ( double  length,
double  intensity_front,
double  attenuation_front,
double  intensity_back,
double  attenuation_back,
float  color[4] 
)
static

Integrates a single ray segment.

color is blended with the result (with color in front). The result is written back into color.

◆ IntegrateRay() [2/2]

static void vtkUnstructuredGridLinearRayIntegrator::IntegrateRay ( double  length,
const double  color_front[3],
double  attenuation_front,
const double  color_back[3],
double  attenuation_back,
float  color[4] 
)
static

Integrates a single ray segment.

color is blended with the result (with color in front). The result is written back into color.

◆ Psi()

static float vtkUnstructuredGridLinearRayIntegrator::Psi ( float  length,
float  attenuation_front,
float  attenuation_back 
)
static

Computes Psi (as defined by Moreland and Angel, "A Fast High Accuracy Volume Renderer for Unstructured Data").

Member Data Documentation

◆ Property

vtkVolumeProperty* vtkUnstructuredGridLinearRayIntegrator::Property
protected

Definition at line 67 of file vtkUnstructuredGridLinearRayIntegrator.h.

◆ TransferFunctions

vtkLinearRayIntegratorTransferFunction* vtkUnstructuredGridLinearRayIntegrator::TransferFunctions
protected

Definition at line 69 of file vtkUnstructuredGridLinearRayIntegrator.h.

◆ TransferFunctionsModified

vtkTimeStamp vtkUnstructuredGridLinearRayIntegrator::TransferFunctionsModified
protected

Definition at line 70 of file vtkUnstructuredGridLinearRayIntegrator.h.

◆ NumIndependentComponents

int vtkUnstructuredGridLinearRayIntegrator::NumIndependentComponents
protected

Definition at line 71 of file vtkUnstructuredGridLinearRayIntegrator.h.


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