VTK
9.4.20241214
|
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 <vtkSurfaceLICComposite.h>
Public Types | |
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. | |
vtkSurfaceLICComposite * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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. | |
void | SetStrategy (int val) |
int | GetStrategy () |
int | GetNumberOfCompositeExtents () const |
Get the number of new extents assigned to this rank after the decomposition. | |
const vtkPixelExtent & | GetGuardExtent (int i=0) const |
Get the extent of the domain over which to compute the LIC. | |
const std::deque< vtkPixelExtent > & | GetGuardExtents () const |
const vtkPixelExtent & | GetDisjointGuardExtent (int i=0) const |
Get the extent of the domain over which to compute the LIC. | |
const std::deque< vtkPixelExtent > & | GetDisjointGuardExtents () const |
const vtkPixelExtent & | GetCompositeExtent (int i=0) const |
Get the extent of the domain over which to compute the LIC. | |
const std::deque< vtkPixelExtent > & | GetCompositeExtents () const |
const vtkPixelExtent & | GetDataSetExtent () const |
Get the whole dataset extent (all blocks). | |
const vtkPixelExtent & | GetWindowExtent () const |
Get the whole window extent. | |
int | InitializeCompositeExtents (float *vectors) |
Set up for a serial run, makes the decomp disjoint and adds requisite guard pixles. | |
virtual void | SetContext (vtkOpenGLRenderWindow *) |
Set the rendering context. | |
virtual vtkOpenGLRenderWindow * | GetContext () |
virtual void | SetCommunicator (vtkPainterCommunicator *) |
Set the communicator for parallel communication. | |
virtual void | RestoreDefaultCommunicator () |
Set the communicator to the default communicator. | |
virtual int | BuildProgram (float *) |
Build programs to move data to the new decomp In parallel THIS IS A COLLECTIVE OPERATION. | |
virtual int | Gather (void *, int, int, vtkTextureObject *&) |
Move a single buffer from the geometry decomp to the LIC decomp. | |
virtual int | Scatter (void *, int, int, vtkTextureObject *&) |
Move a single buffer from the LIC decomp to the geometry decomp In parallel THIS IS A COLLECTIVE OPERATION. | |
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. | |
vtkCommand * | GetCommand (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 vtkSurfaceLICComposite * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkSurfaceLICComposite * | SafeDownCast (vtkObjectBase *o) |
static int | MakeDecompDisjoint (std::deque< vtkPixelExtent > &in, std::deque< vtkPixelExtent > &out) |
Make a decomposition disjoint with respect to itself. | |
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. | |
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 vtkObjectBase * | New () |
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 vtkObjectBase * | NewInstanceInternal () const |
vtkSurfaceLICComposite () | |
~vtkSurfaceLICComposite () override | |
int | MakeDecompDisjoint (const std::deque< vtkPixelExtent > &in, std::deque< vtkPixelExtent > &out, float *vectors) |
For serial run. | |
float | VectorMax (const vtkPixelExtent &ext, float *vectors) |
Compute max(V) on the given extent. | |
int | VectorMax (const std::deque< vtkPixelExtent > &exts, float *vectors, std::vector< float > &vMax) |
Compute max(V) on a set of extents. | |
int | AddGuardPixels (const std::deque< vtkPixelExtent > &exts, std::deque< vtkPixelExtent > &guardExts, std::deque< vtkPixelExtent > &disjointGuardExts, float *vectors) |
Add guard pixels (Serial run) | |
void | GetPixelBounds (float *rgba, int ni, vtkPixelExtent &ext) |
shrink pixel extent based on non-zero alpha channel values | |
float | GetFudgeFactor (int nx[2]) |
factor for determining extra padding for guard pixels. | |
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 | |
int | Pass |
vtkPixelExtent | WindowExt |
vtkPixelExtent | DataSetExt |
std::deque< vtkPixelExtent > | BlockExts |
std::deque< vtkPixelExtent > | CompositeExt |
std::deque< vtkPixelExtent > | GuardExt |
std::deque< vtkPixelExtent > | DisjointGuardExt |
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 |
Friends | |
ostream & | operator<< (ostream &os, vtkSurfaceLICComposite &ss) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 28 of file vtkSurfaceLICComposite.h.
Definition at line 32 of file vtkSurfaceLICComposite.h.
anonymous enum |
Control the screen space decomposition.
The available modes are:
INPLACE use the block decomp. This may result in LIC being computed many times for the same pixels and an excessive amount of IPC during compositing if any of the block extents cover or intersect a number of block extents. The input data needs to be shuffled but not unshuffled since for overlapping regions LIC is computed by all processes that overlap. If there is very little overlap between block extents then this method is superior since no unshuffle is needed.
INPLACE_DISJOINT use a disjoint version of the block decomp. This will leave non-overlapping data in place, reasigning overlapping regions so that LIC is computed once for each pixel on the screen. An unshuffle step to move data in overlapping region to all processes that overlap.
BALANCED move to a new decomp where each rank gets an equal number of pixels. This ensures the best load balancing during LIC and that LIC is computed once for each pixel. In the worst case each pixel will be shuffled and unshuffled.
AUTO Use a heuristic to select the mode.
Enumerator | |
---|---|
COMPOSITE_INPLACE | |
COMPOSITE_INPLACE_DISJOINT | |
COMPOSITE_BALANCED | |
COMPOSITE_AUTO |
Definition at line 75 of file vtkSurfaceLICComposite.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkPSurfaceLICComposite.
|
static |
|
protectedvirtual |
Reimplemented in vtkPSurfaceLICComposite.
vtkSurfaceLICComposite * vtkSurfaceLICComposite::NewInstance | ( | ) | const |
|
overridevirtual |
void vtkSurfaceLICComposite::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.
wholeExt describes the window size, originalExts describe each block's extent in window coords. stepSize is the window coordinate integration step size. when inplace is true compositing happens on the original extent.
|
inline |
Definition at line 82 of file vtkSurfaceLICComposite.h.
|
inline |
Definition at line 83 of file vtkSurfaceLICComposite.h.
|
inline |
Get the number of new extents assigned to this rank after the decomposition.
Definition at line 89 of file vtkSurfaceLICComposite.h.
|
inline |
Get the extent of the domain over which to compute the LIC.
This can be querried only after the Composite takes place.
Definition at line 95 of file vtkSurfaceLICComposite.h.
|
inline |
Definition at line 97 of file vtkSurfaceLICComposite.h.
|
inline |
Get the extent of the domain over which to compute the LIC.
This can be querried only after the Composite takes place.
Definition at line 103 of file vtkSurfaceLICComposite.h.
|
inline |
Definition at line 108 of file vtkSurfaceLICComposite.h.
|
inline |
Get the extent of the domain over which to compute the LIC.
This can be querried only after the Composite takes place.
Definition at line 114 of file vtkSurfaceLICComposite.h.
|
inline |
Definition at line 116 of file vtkSurfaceLICComposite.h.
|
inline |
Get the whole dataset extent (all blocks).
Definition at line 121 of file vtkSurfaceLICComposite.h.
|
inline |
Get the whole window extent.
Definition at line 126 of file vtkSurfaceLICComposite.h.
int vtkSurfaceLICComposite::InitializeCompositeExtents | ( | float * | vectors | ) |
Set up for a serial run, makes the decomp disjoint and adds requisite guard pixles.
|
inlinevirtual |
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 in vtkPSurfaceLICComposite.
Definition at line 139 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Reimplemented in vtkPSurfaceLICComposite.
Definition at line 140 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Set the communicator for parallel communication.
A duplicate is not made. It is up to the caller to manage the life of the communicator such that it is around while this class needs it and is released after.
Reimplemented in vtkPSurfaceLICComposite.
Definition at line 148 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Set the communicator to the default communicator.
Definition at line 153 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Build programs to move data to the new decomp In parallel THIS IS A COLLECTIVE OPERATION.
Reimplemented in vtkPSurfaceLICComposite.
Definition at line 159 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Move a single buffer from the geometry decomp to the LIC decomp.
THIS IS A COLLECTIVE OPERATION
Reimplemented in vtkPSurfaceLICComposite.
Definition at line 165 of file vtkSurfaceLICComposite.h.
|
inlinevirtual |
Move a single buffer from the LIC decomp to the geometry decomp In parallel THIS IS A COLLECTIVE OPERATION.
Reimplemented in vtkPSurfaceLICComposite.
Definition at line 171 of file vtkSurfaceLICComposite.h.
|
static |
Make a decomposition disjoint with respect to itself.
Extents are removed from the input array and disjoint extents are appended onto the output array. This is a local operation.
|
protected |
For serial run.
Make a decomposition disjoint. Sorts extents and processes largest to smallest , repeatedly subtracting smaller remaining blocks from the largest remaining. Each extent in the new disjoint set is shrunk to tightly bound the vector data, extents with empty vectors are removed. This is a local operation since vector field is local.
|
protected |
Compute max(V) on the given extent.
|
protected |
Compute max(V) on a set of extents.
Neighboring extents are including in the computation.
|
protected |
Add guard pixels (Serial run)
|
protected |
shrink pixel extent based on non-zero alpha channel values
|
protected |
factor for determining extra padding for guard pixels.
depends on window aspect ratio because of anisotropic transform to texture space. see note in implementation.
|
friend |
|
protected |
Definition at line 224 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 226 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 227 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 228 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 230 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 231 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 232 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 234 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 236 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 237 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 238 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 239 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 240 of file vtkSurfaceLICComposite.h.
|
protected |
Definition at line 241 of file vtkSurfaceLICComposite.h.