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

parallel part of GPU-based implementation of Line Integral Convolution (LIC) More...

#include <vtkPLineIntegralConvolution2D.h>

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

Public Types

typedef vtkLineIntegralConvolution2D Superclass
 
- Public Types inherited from vtkLineIntegralConvolution2D
enum  { ENHANCE_CONTRAST_OFF = 0, ENHANCE_CONTRAST_ON = 1 }
 Enable/Disable contrast and dynamic range correction stages. More...
 
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...
 
vtkPLineIntegralConvolution2DNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetCommunicator (vtkPainterCommunicator *) override
 Set the communicator to use during parallel operation The communicator will not be duplicated or reference counted for performance reasons thus caller should hold/manage reference to the communicator during use of the LIC object. More...
 
virtual vtkPainterCommunicatorGetCommunicator () override
 
virtual void GetGlobalMinMax (vtkPainterCommunicator *comm, float &min, float &max) override
 For parallel operation, find global min/max min/max are in/out. More...
 
virtual void WriteTimerLog (const char *fileName) override
 Methods used for parallel benchmarks. More...
 
- Public Member Functions inherited from vtkLineIntegralConvolution2D
vtkLineIntegralConvolution2DNewInstance () const
 
void SetContext (vtkOpenGLRenderWindow *context)
 Set/Get the rendering context. More...
 
vtkOpenGLRenderWindowGetContext ()
 
virtual void SetEnhancedLIC (int)
 EnhancedLIC mean compute the LIC twice with the second pass using the edge-enhanced result of the first pass as a noise texture. More...
 
virtual int GetEnhancedLIC ()
 
virtual void EnhancedLICOn ()
 
virtual void EnhancedLICOff ()
 
virtual void SetEnhanceContrast (int)
 
virtual int GetEnhanceContrast ()
 
virtual void EnhanceContrastOn ()
 
virtual void EnhanceContrastOff ()
 
virtual void SetLowContrastEnhancementFactor (double)
 This feature is used to fine tune the contrast enhancement. More...
 
virtual double GetLowContrastEnhancementFactor ()
 
virtual void SetHighContrastEnhancementFactor (double)
 
virtual double GetHighContrastEnhancementFactor ()
 
virtual void SetAntiAlias (int)
 Enable/Disable the anti-aliasing pass. More...
 
virtual int GetAntiAlias ()
 
virtual void AntiAliasOn ()
 
virtual void AntiAliasOff ()
 
virtual void SetNumberOfSteps (int)
 Number of streamline integration steps (initial value is 1). More...
 
virtual int GetNumberOfSteps ()
 
virtual void SetStepSize (double)
 Get/Set the streamline integration step size (0.01 by default). More...
 
virtual double GetStepSize ()
 
void SetComponentIds (int c0, int c1)
 If VectorField has >= 3 components, we must choose which 2 components form the (X, Y) components for the vector field. More...
 
void SetComponentIds (int c[2])
 
virtual int * GetComponentIds ()
 
virtual void GetComponentIds (int &, int &)
 
virtual void GetComponentIds (int[2])
 
virtual void SetMaxNoiseValue (double)
 Set the max noise value for use during LIC integration normalization. More...
 
virtual double GetMaxNoiseValue ()
 
void SetTransformVectors (int val)
 This class performs LIC in the normalized image space. More...
 
virtual int GetTransformVectors ()
 
void SetNormalizeVectors (int val)
 Set/Get the spacing in each dimension of the plane on which the vector field is defined. More...
 
virtual int GetNormalizeVectors ()
 
virtual void SetMaskThreshold (double)
 The MaskThreshold controls blanking of the LIC texture. More...
 
virtual double GetMaskThreshold ()
 
vtkTextureObjectExecute (vtkTextureObject *vectorTex, vtkTextureObject *noiseTex)
 Compute the lic on the entire vector field texture. More...
 
vtkTextureObjectExecute (const int extent[4], vtkTextureObject *vectorTex, vtkTextureObject *noiseTex)
 Compute the lic on the indicated subset of the vector field texture. More...
 
vtkTextureObjectExecute (const vtkPixelExtent &inputTexExtent, const std::deque< vtkPixelExtent > &vectorExtent, const std::deque< vtkPixelExtent > &licExtent, vtkTextureObject *vectorTex, vtkTextureObject *maskVectorTex, vtkTextureObject *noiseTex)
 Compute LIC over the desired subset of the input texture. 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 vtkPLineIntegralConvolution2DNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPLineIntegralConvolution2DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLineIntegralConvolution2D
static vtkLineIntegralConvolution2DNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLineIntegralConvolution2DSafeDownCast (vtkObjectBase *o)
 
static bool IsSupported (vtkRenderWindow *renWin)
 Returns if the context supports the required extensions. More...
 
static void SetVectorTexParameters (vtkTextureObject *vectors)
 Convenience functions to ensure that the input textures are configured correctly. More...
 
static void SetNoiseTexParameters (vtkTextureObject *noise)
 
- 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
 
 vtkPLineIntegralConvolution2D ()
 
virtual ~vtkPLineIntegralConvolution2D ()
 
virtual void StartTimerEvent (const char *name) override
 Methods used for parallel benchmarks. More...
 
virtual void EndTimerEvent (const char *name) override
 
- Protected Member Functions inherited from vtkLineIntegralConvolution2D
 vtkLineIntegralConvolution2D ()
 
 ~vtkLineIntegralConvolution2D () override
 
void SetVTShader (vtkShaderProgram *prog)
 
void SetLIC0Shader (vtkShaderProgram *prog)
 
void SetLICIShader (vtkShaderProgram *prog)
 
void SetLICNShader (vtkShaderProgram *prog)
 
void SetEEShader (vtkShaderProgram *prog)
 
void SetCEShader (vtkShaderProgram *prog)
 
void SetAAHShader (vtkShaderProgram *prog)
 
void SetAAVShader (vtkShaderProgram *prog)
 
void BuildShaders ()
 
void RenderQuad (float computeBounds[4], vtkPixelExtent computeExtent)
 
vtkTextureObjectAllocateBuffer (unsigned int texSize[2])
 
void SetNoise2TexParameters (vtkTextureObject *noise)
 Convenience functions to ensure that the input textures are configured correctly. More...
 
- 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkLineIntegralConvolution2D
vtkPainterCommunicatorComm
 
vtkWeakPointer< vtkOpenGLRenderWindowContext
 
vtkOpenGLFramebufferObjectFBO
 
int ShadersNeedBuild
 
vtkOpenGLHelperFinalBlendProgram
 
vtkOpenGLHelperIntermediateBlendProgram
 
vtkOpenGLHelperVTShader
 
vtkOpenGLHelperLIC0Shader
 
vtkOpenGLHelperLICIShader
 
vtkOpenGLHelperLICNShader
 
vtkOpenGLHelperEEShader
 
vtkOpenGLHelperCEShader
 
vtkOpenGLHelperAAHShader
 
vtkOpenGLHelperAAVShader
 
int NumberOfSteps
 
double StepSize
 
int EnhancedLIC
 
int EnhanceContrast
 
double LowContrastEnhancementFactor
 
double HighContrastEnhancementFactor
 
int AntiAlias
 
int NoiseTextureLookupCompatibilityMode
 
double MaskThreshold
 
int TransformVectors
 
int NormalizeVectors
 
int ComponentIds [2]
 
double MaxNoiseValue
 
- 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

parallel part of GPU-based implementation of Line Integral Convolution (LIC)

Implements the parallel parts of the algorithm.

See also
vtkPLineIntegralConvolution2D

Definition at line 37 of file vtkPLineIntegralConvolution2D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkPLineIntegralConvolution2D.h.

Constructor & Destructor Documentation

◆ vtkPLineIntegralConvolution2D()

vtkPLineIntegralConvolution2D::vtkPLineIntegralConvolution2D ( )
protected

◆ ~vtkPLineIntegralConvolution2D()

virtual vtkPLineIntegralConvolution2D::~vtkPLineIntegralConvolution2D ( )
protectedvirtual

Member Function Documentation

◆ New()

static vtkPLineIntegralConvolution2D* vtkPLineIntegralConvolution2D::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPLineIntegralConvolution2D::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 vtkLineIntegralConvolution2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPLineIntegralConvolution2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLineIntegralConvolution2D.

◆ NewInstance()

vtkPLineIntegralConvolution2D* vtkPLineIntegralConvolution2D::NewInstance ( ) const

◆ PrintSelf()

virtual void vtkPLineIntegralConvolution2D::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 vtkLineIntegralConvolution2D.

◆ SetCommunicator()

virtual void vtkPLineIntegralConvolution2D::SetCommunicator ( vtkPainterCommunicator )
overridevirtual

Set the communicator to use during parallel operation The communicator will not be duplicated or reference counted for performance reasons thus caller should hold/manage reference to the communicator during use of the LIC object.

Reimplemented from vtkLineIntegralConvolution2D.

◆ GetCommunicator()

virtual vtkPainterCommunicator* vtkPLineIntegralConvolution2D::GetCommunicator ( )
overridevirtual

Reimplemented from vtkLineIntegralConvolution2D.

◆ GetGlobalMinMax()

virtual void vtkPLineIntegralConvolution2D::GetGlobalMinMax ( vtkPainterCommunicator comm,
float &  min,
float &  max 
)
overridevirtual

For parallel operation, find global min/max min/max are in/out.

Reimplemented from vtkLineIntegralConvolution2D.

◆ WriteTimerLog()

virtual void vtkPLineIntegralConvolution2D::WriteTimerLog ( const char *  fileName)
overridevirtual

Methods used for parallel benchmarks.

Use cmake to define vtkLineIntegralConviolution2DTIME to enable benchmarks. During each update timing information is stored, it can be written to disk by calling WriteLog.

Reimplemented from vtkLineIntegralConvolution2D.

◆ StartTimerEvent()

virtual void vtkPLineIntegralConvolution2D::StartTimerEvent ( const char *  name)
overrideprotectedvirtual

Methods used for parallel benchmarks.

Use cmake to define vtkSurfaceLICPainterTIME to enable benchmarks. During each update timing information is stored, it can be written to disk by calling WriteLog. Note: Some of the timings are enabled by the surface lic painter.

Reimplemented from vtkLineIntegralConvolution2D.

◆ EndTimerEvent()

virtual void vtkPLineIntegralConvolution2D::EndTimerEvent ( const char *  name)
overrideprotectedvirtual

Reimplemented from vtkLineIntegralConvolution2D.


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