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>

Inheritance diagram for vtkSurfaceLICComposite:

[legend]

Collaboration diagram for vtkSurfaceLICComposite:

[legend]

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

vtkSurfaceLICComposite *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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 vtkPixelExtent &	GetGuardExtent (int i=0) const
	Get the extent of the domain over which to compute the LIC. More...

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

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

const std::deque< vtkPixelExtent > &	GetCompositeExtents () const

const vtkPixelExtent &	GetDataSetExtent () const
	Get the whole dataset extent (all blocks). More...

const vtkPixelExtent &	GetWindowExtent () 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	SetContext (vtkOpenGLRenderWindow *)
	Set the rendering context. More...

virtual vtkOpenGLRenderWindow *	GetContext ()

virtual void	SetCommunicator (vtkPainterCommunicator *)
	Set the communicator for parallel communication. More...

virtual void	RestoreDefaultCommunicator ()
	Set the communicator to the default communicator. More...

virtual int	BuildProgram (float *)
	Build programs to move data to the new decomp In parallel THIS IS A COLLECTIVE OPERATION. More...

virtual int	Gather (void , int, int, vtkTextureObject &)
	Move a single buffer from the geometry decomp to the LIC decomp. More...

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

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

vtkCommand *	GetCommand (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...

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)
	This method invokes an event and return whether the event was aborted or not. More...

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

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

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

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. 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 ()
	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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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. 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	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	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

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
ostream &	operator<< (ostream &os, vtkSurfaceLICComposite &ss)

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 39 of file vtkSurfaceLICComposite.h.

Member Typedef Documentation

typedef vtkObject vtkSurfaceLICComposite::Superclass

Definition at line 43 of file vtkSurfaceLICComposite.h.

Member Enumeration Documentation

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 92 of file vtkSurfaceLICComposite.h.

Constructor & Destructor Documentation

vtkSurfaceLICComposite::vtkSurfaceLICComposite ( )

protected

vtkSurfaceLICComposite::~vtkSurfaceLICComposite ( )

overrideprotected

Member Function Documentation

static vtkSurfaceLICComposite* vtkSurfaceLICComposite::New ( )

static

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

static

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

Reimplemented in vtkPSurfaceLICComposite.

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

static

virtual vtkObjectBase* vtkSurfaceLICComposite::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkPSurfaceLICComposite.

vtkSurfaceLICComposite* vtkSurfaceLICComposite::NewInstance ( ) const

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

Reimplemented in vtkPSurfaceLICComposite.

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 coordiniate integration step size. when inplace is true compositing happens on the original extent.

void vtkSurfaceLICComposite::SetStrategy ( int val )

inline

Definition at line 98 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::GetStrategy ( )

inline

Definition at line 99 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::GetNumberOfCompositeExtents ( ) const

inline

Get the number of new extents assigned to this rank after the decomposition.

Definition at line 105 of file vtkSurfaceLICComposite.h.

const vtkPixelExtent& vtkSurfaceLICComposite::GetGuardExtent ( int i = 0 ) const

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 112 of file vtkSurfaceLICComposite.h.

const std::deque<vtkPixelExtent>& vtkSurfaceLICComposite::GetGuardExtents ( ) const

inline

Definition at line 115 of file vtkSurfaceLICComposite.h.

const vtkPixelExtent& vtkSurfaceLICComposite::GetDisjointGuardExtent ( int i = 0 ) const

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 122 of file vtkSurfaceLICComposite.h.

const std::deque<vtkPixelExtent>& vtkSurfaceLICComposite::GetDisjointGuardExtents ( ) const

inline

Definition at line 125 of file vtkSurfaceLICComposite.h.

const vtkPixelExtent& vtkSurfaceLICComposite::GetCompositeExtent ( int i = 0 ) const

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 132 of file vtkSurfaceLICComposite.h.

const std::deque<vtkPixelExtent>& vtkSurfaceLICComposite::GetCompositeExtents ( ) const

inline

Definition at line 135 of file vtkSurfaceLICComposite.h.

const vtkPixelExtent& vtkSurfaceLICComposite::GetDataSetExtent ( ) const

inline

Get the whole dataset extent (all blocks).

Definition at line 141 of file vtkSurfaceLICComposite.h.

const vtkPixelExtent& vtkSurfaceLICComposite::GetWindowExtent ( ) const

inline

Get the whole window extent.

Definition at line 147 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::InitializeCompositeExtents ( float * vectors )

Set up for a serial run, makes the decomp disjoint and adds requisite guard pixles.

virtual void vtkSurfaceLICComposite::SetContext ( vtkOpenGLRenderWindow * )

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 161 of file vtkSurfaceLICComposite.h.

virtual vtkOpenGLRenderWindow* vtkSurfaceLICComposite::GetContext ( )

inlinevirtual

Reimplemented in vtkPSurfaceLICComposite.

Definition at line 162 of file vtkSurfaceLICComposite.h.

virtual void vtkSurfaceLICComposite::SetCommunicator ( vtkPainterCommunicator * )

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 170 of file vtkSurfaceLICComposite.h.

virtual void vtkSurfaceLICComposite::RestoreDefaultCommunicator ( )

inlinevirtual

Set the communicator to the default communicator.

Definition at line 175 of file vtkSurfaceLICComposite.h.

virtual int vtkSurfaceLICComposite::BuildProgram ( float * )

inlinevirtual

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

Reimplemented in vtkPSurfaceLICComposite.

Definition at line 181 of file vtkSurfaceLICComposite.h.

virtual int vtkSurfaceLICComposite::Gather	(	void *	,
		int	,
		int	,
		vtkTextureObject *&
	)

inlinevirtual

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

THIS IS A COLLECTIVE OPERATION

Reimplemented in vtkPSurfaceLICComposite.

Definition at line 187 of file vtkSurfaceLICComposite.h.

virtual int vtkSurfaceLICComposite::Scatter	(	void *	,
		int	,
		int	,
		vtkTextureObject *&
	)

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 194 of file vtkSurfaceLICComposite.h.

static int vtkSurfaceLICComposite::MakeDecompDisjoint	(	std::deque< vtkPixelExtent > &	in,
		std::deque< vtkPixelExtent > &	out
	)

static

Make a decomposition disjoint with respect to itself.

Extents are removed from the input array and disjoint extents are appened onto the output array. This is a local operation.

int vtkSurfaceLICComposite::MakeDecompDisjoint	(	const std::deque< vtkPixelExtent > &	in,
		std::deque< vtkPixelExtent > &	out,
		float *	vectors
	)

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.

float vtkSurfaceLICComposite::VectorMax	(	const vtkPixelExtent &	ext,
		float *	vectors
	)

protected

Compute max(V) on the given extent.

int vtkSurfaceLICComposite::VectorMax	(	const std::deque< vtkPixelExtent > &	exts,
		float *	vectors,
		std::vector< float > &	vMax
	)

protected

Compute max(V) on a set of extents.

Neighboring extents are including in the computation.

int vtkSurfaceLICComposite::AddGuardPixels	(	const std::deque< vtkPixelExtent > &	exts,
		std::deque< vtkPixelExtent > &	guardExts,
		std::deque< vtkPixelExtent > &	disjointGuardExts,
		float *	vectors
	)

protected

Add guard pixels (Serial run)

void vtkSurfaceLICComposite::GetPixelBounds	(	float *	rgba,
		int	ni,
		vtkPixelExtent &	ext
	)

protected

shrink pixel extent based on non-zero alpha channel values

float vtkSurfaceLICComposite::GetFudgeFactor ( int nx[2] )

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.

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	os,
		vtkSurfaceLICComposite &	ss
	)

friend

Member Data Documentation

int vtkSurfaceLICComposite::Pass

protected

Definition at line 265 of file vtkSurfaceLICComposite.h.

vtkPixelExtent vtkSurfaceLICComposite::WindowExt

protected

Definition at line 267 of file vtkSurfaceLICComposite.h.

vtkPixelExtent vtkSurfaceLICComposite::DataSetExt

protected

Definition at line 268 of file vtkSurfaceLICComposite.h.

std::deque<vtkPixelExtent> vtkSurfaceLICComposite::BlockExts

protected

Definition at line 269 of file vtkSurfaceLICComposite.h.

std::deque<vtkPixelExtent> vtkSurfaceLICComposite::CompositeExt

protected

Definition at line 271 of file vtkSurfaceLICComposite.h.

std::deque<vtkPixelExtent> vtkSurfaceLICComposite::GuardExt

protected

Definition at line 272 of file vtkSurfaceLICComposite.h.

std::deque<vtkPixelExtent> vtkSurfaceLICComposite::DisjointGuardExt

protected

Definition at line 273 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::Strategy

protected

Definition at line 275 of file vtkSurfaceLICComposite.h.

double vtkSurfaceLICComposite::StepSize

protected

Definition at line 277 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::NumberOfSteps

protected

Definition at line 278 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::NormalizeVectors

protected

Definition at line 279 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::NumberOfGuardLevels

protected

Definition at line 280 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::NumberOfEEGuardPixels

protected

Definition at line 281 of file vtkSurfaceLICComposite.h.

int vtkSurfaceLICComposite::NumberOfAAGuardPixels

protected

Definition at line 282 of file vtkSurfaceLICComposite.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/LICOpenGL2/vtkSurfaceLICComposite.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation