VTK  9.3.20240418
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkPSurfaceLICComposite Class Reference

This class decomposes the image space and shuffles image space data onto the new decomposition with the necessary guard cells to prevent artifacts at the decomposition boundaries. More...

#include <vtkPSurfaceLICComposite.h>

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

Public Types

typedef vtkSurfaceLICComposite Superclass
 
- Public Types inherited from vtkSurfaceLICComposite
enum  { COMPOSITE_INPLACE = 0 , COMPOSITE_INPLACE_DISJOINT , COMPOSITE_BALANCED , COMPOSITE_AUTO }
 Control the screen space decomposition. 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...
 
vtkPSurfaceLICCompositeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetContext (vtkOpenGLRenderWindow *rwin) override
 Set the rendering context. More...
 
vtkOpenGLRenderWindowGetContext () override
 
void SetCommunicator (vtkPainterCommunicator *comm) override
 Set the communicator for parallel communication. More...
 
int BuildProgram (float *vectors) override
 Build programs to move data to the new decomp THIS IS A COLLECTIVE OPERATION. More...
 
int Gather (void *pSendPBO, int dataType, int nComps, vtkTextureObject *&newImage) override
 Move a single buffer from the geometry decomp to the LIC decomp. More...
 
int Scatter (void *pSendPBO, int dataType, int nComps, vtkTextureObject *&newImage) override
 Move a single buffer from the LIC decomp to the geometry decomp THIS IS A COLLECTIVE OPERATION. More...
 
- Public Member Functions inherited from vtkSurfaceLICComposite
vtkSurfaceLICCompositeNewInstance () const
 
void Initialize (const vtkPixelExtent &winExt, const std::deque< vtkPixelExtent > &blockExts, int strategy, double stepSize, int nSteps, int normalizeVectors, int enhancedLIC, int anitalias)
 Initialize the object based on the following description of the blocks projected onto the render window. More...
 
void SetStrategy (int val)
 
int GetStrategy ()
 
int GetNumberOfCompositeExtents () const
 Get the number of new extents assigned to this rank after the decomposition. More...
 
const vtkPixelExtentGetGuardExtent (int i=0) const
 Get the extent of the domain over which to compute the LIC. More...
 
const std::deque< vtkPixelExtent > & GetGuardExtents () const
 
const vtkPixelExtentGetDisjointGuardExtent (int i=0) const
 Get the extent of the domain over which to compute the LIC. More...
 
const std::deque< vtkPixelExtent > & GetDisjointGuardExtents () const
 
const vtkPixelExtentGetCompositeExtent (int i=0) const
 Get the extent of the domain over which to compute the LIC. More...
 
const std::deque< vtkPixelExtent > & GetCompositeExtents () const
 
const vtkPixelExtentGetDataSetExtent () const
 Get the whole dataset extent (all blocks). More...
 
const vtkPixelExtentGetWindowExtent () const
 Get the whole window extent. More...
 
int InitializeCompositeExtents (float *vectors)
 Set up for a serial run, makes the decomp disjoint and adds requisite guard pixles. More...
 
virtual void RestoreDefaultCommunicator ()
 Set the communicator to the default communicator. 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkPSurfaceLICCompositeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPSurfaceLICCompositeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSurfaceLICComposite
static vtkSurfaceLICCompositeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSurfaceLICCompositeSafeDownCast (vtkObjectBase *o)
 
static int MakeDecompDisjoint (std::deque< vtkPixelExtent > &in, std::deque< vtkPixelExtent > &out)
 Make a decomposition disjoint with respect to itself. More...
 
- 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 (vtkTypeBool 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 vtkTypeBool 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPSurfaceLICComposite ()
 
 ~vtkPSurfaceLICComposite () override
 
- Protected Member Functions inherited from vtkSurfaceLICComposite
 vtkSurfaceLICComposite ()
 
 ~vtkSurfaceLICComposite () override
 
int MakeDecompDisjoint (const std::deque< vtkPixelExtent > &in, std::deque< vtkPixelExtent > &out, float *vectors)
 For serial run. More...
 
float VectorMax (const vtkPixelExtent &ext, float *vectors)
 Compute max(V) on the given extent. More...
 
int VectorMax (const std::deque< vtkPixelExtent > &exts, float *vectors, std::vector< float > &vMax)
 Compute max(V) on a set of extents. More...
 
int AddGuardPixels (const std::deque< vtkPixelExtent > &exts, std::deque< vtkPixelExtent > &guardExts, std::deque< vtkPixelExtent > &disjointGuardExts, float *vectors)
 Add guard pixels (Serial run) More...
 
void GetPixelBounds (float *rgba, int ni, vtkPixelExtent &ext)
 shrink pixel extent based on non-zero alpha channel values More...
 
float GetFudgeFactor (int nx[2])
 factor for determining extra padding for guard pixels. 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

VTKRENDERINGPARALLELLIC_EXPORT ostream & operator<< (ostream &os, vtkPSurfaceLICComposite &ss)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkSurfaceLICComposite
int Pass
 
vtkPixelExtent WindowExt
 
vtkPixelExtent DataSetExt
 
std::deque< vtkPixelExtentBlockExts
 
std::deque< vtkPixelExtentCompositeExt
 
std::deque< vtkPixelExtentGuardExt
 
std::deque< vtkPixelExtentDisjointGuardExt
 
int Strategy
 
double StepSize
 
int NumberOfSteps
 
int NormalizeVectors
 
int NumberOfGuardLevels
 
int NumberOfEEGuardPixels
 
int NumberOfAAGuardPixels
 
- 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
 

Detailed Description

This class decomposes the image space and shuffles image space data onto the new decomposition with the necessary guard cells to prevent artifacts at the decomposition boundaries.

After the image LIC is computed on the new decomposition this class will un-shuffle the computed LIC back onto the original decomposition.

Definition at line 37 of file vtkPSurfaceLICComposite.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPSurfaceLICComposite.h.

Constructor & Destructor Documentation

◆ vtkPSurfaceLICComposite()

vtkPSurfaceLICComposite::vtkPSurfaceLICComposite ( )
protected

◆ ~vtkPSurfaceLICComposite()

vtkPSurfaceLICComposite::~vtkPSurfaceLICComposite ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPSurfaceLICComposite* vtkPSurfaceLICComposite::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPSurfaceLICComposite::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 vtkSurfaceLICComposite.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPSurfaceLICComposite::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSurfaceLICComposite.

◆ NewInstance()

vtkPSurfaceLICComposite* vtkPSurfaceLICComposite::NewInstance ( ) const

◆ PrintSelf()

void vtkPSurfaceLICComposite::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 vtkSurfaceLICComposite.

◆ SetContext()

void vtkPSurfaceLICComposite::SetContext ( vtkOpenGLRenderWindow rwin)
overridevirtual

Set the rendering context.

Must set prior to use. Reference is not held, so caller must ensure the renderer is not destroyed during use.

Reimplemented from vtkSurfaceLICComposite.

◆ GetContext()

vtkOpenGLRenderWindow* vtkPSurfaceLICComposite::GetContext ( )
inlineoverridevirtual

Reimplemented from vtkSurfaceLICComposite.

Definition at line 50 of file vtkPSurfaceLICComposite.h.

◆ SetCommunicator()

void vtkPSurfaceLICComposite::SetCommunicator ( vtkPainterCommunicator comm)
overridevirtual

Set the communicator for parallel communication.

The Default is COMM_NULL.

Reimplemented from vtkSurfaceLICComposite.

◆ BuildProgram()

int vtkPSurfaceLICComposite::BuildProgram ( float *  vectors)
overridevirtual

Build programs to move data to the new decomp THIS IS A COLLECTIVE OPERATION.

Reimplemented from vtkSurfaceLICComposite.

◆ Gather()

int vtkPSurfaceLICComposite::Gather ( void *  pSendPBO,
int  dataType,
int  nComps,
vtkTextureObject *&  newImage 
)
overridevirtual

Move a single buffer from the geometry decomp to the LIC decomp.

THIS IS A COLLECTIVE OPERATION

Reimplemented from vtkSurfaceLICComposite.

◆ Scatter()

int vtkPSurfaceLICComposite::Scatter ( void *  pSendPBO,
int  dataType,
int  nComps,
vtkTextureObject *&  newImage 
)
overridevirtual

Move a single buffer from the LIC decomp to the geometry decomp THIS IS A COLLECTIVE OPERATION.

Reimplemented from vtkSurfaceLICComposite.

Friends And Related Function Documentation

◆ operator<<

VTKRENDERINGPARALLELLIC_EXPORT ostream& operator<< ( ostream &  os,
vtkPSurfaceLICComposite ss 
)
friend

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