parallel parts of the vtkSurfaceLICInterface More...

#include <vtkPSurfaceLICInterface.h>

Inheritance diagram for vtkPSurfaceLICInterface:

Collaboration diagram for vtkPSurfaceLICInterface:

Public Types
typedef vtkSurfaceLICInterface	Superclass

Public Types inherited from vtkSurfaceLICInterface
enum	{ ENHANCE_CONTRAST_OFF = 0, ENHANCE_CONTRAST_LIC = 1, ENHANCE_CONTRAST_COLOR = 3, ENHANCE_CONTRAST_BOTH = 4 }
	Enable/Disable contrast and dynamic range correction stages. More...

enum	{ COLOR_MODE_BLEND = 0, COLOR_MODE_MAP }
	Set/Get the color mode. More...

enum	{ NOISE_TYPE_UNIFORM = 0, NOISE_TYPE_GAUSSIAN = 1, NOISE_TYPE_PERLIN = 2 }
	Select the statistical distribution of randomly generated noise values. More...

enum	{ COMPOSITE_INPLACE = 0, COMPOSITE_INPLACE_DISJOINT = 1, COMPOSITE_BALANCED = 2, COMPOSITE_AUTO = 3 }
	Control the screen space decomposition where LIC is computed. 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...

vtkPSurfaceLICInterface *	NewInstance () const

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

virtual void	WriteTimerLog (const char *fileName) override
	Methods used for parallel benchmarks. More...

Public Member Functions inherited from vtkSurfaceLICInterface
vtkSurfaceLICInterface *	NewInstance () const

void	SetNumberOfSteps (int val)
	Get/Set the number of integration steps in each direction. More...

virtual int	GetNumberOfSteps ()

void	SetStepSize (double val)
	Get/Set the step size (in pixels). More...

virtual double	GetStepSize ()

void	SetNormalizeVectors (int val)
	Normalize vectors during integration. More...

virtual void	NormalizeVectorsOn ()

virtual void	NormalizeVectorsOff ()

virtual int	GetNormalizeVectors ()

void	SetMaskOnSurface (int val)
	When set MaskOnSurface computes \|V\| for use in the fragment masking tests on the surface. More...

virtual void	MaskOnSurfaceOn ()

virtual void	MaskOnSurfaceOff ()

virtual int	GetMaskOnSurface ()

void	SetMaskThreshold (double val)
	The MaskThreshold controls the rendering of fragments in stagnant regions of flow. More...

virtual double	GetMaskThreshold ()

void	SetMaskColor (double *val)
	The MaskColor is used on masked fragments. More...

void	SetMaskColor (double r, double g, double b)

virtual double *	GetMaskColor ()

virtual void	GetMaskColor (double &, double &, double &)

virtual void	GetMaskColor (double[3])

void	SetMaskIntensity (double val)
	The MaskIntensity controls the blending of the mask color and the geometry color. More...

virtual double	GetMaskIntensity ()

void	SetEnhancedLIC (int val)
	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 ()

void	SetEnhanceContrast (int val)

virtual int	GetEnhanceContrast ()

virtual double	GetLowLICContrastEnhancementFactor ()
	This feature is used to fine tune the contrast enhancement. More...

virtual double	GetHighLICContrastEnhancementFactor ()

void	SetLowLICContrastEnhancementFactor (double val)

void	SetHighLICContrastEnhancementFactor (double val)

virtual double	GetLowColorContrastEnhancementFactor ()

virtual double	GetHighColorContrastEnhancementFactor ()

void	SetLowColorContrastEnhancementFactor (double val)

void	SetHighColorContrastEnhancementFactor (double val)

void	SetAntiAlias (int val)
	Enable/Disable the anti-aliasing pass. More...

virtual void	AntiAliasOn ()

virtual void	AntiAliasOff ()

virtual int	GetAntiAlias ()

void	SetColorMode (int val)

virtual int	GetColorMode ()

void	SetLICIntensity (double val)
	Factor used when blend mode is set to COLOR_MODE_BLEND. More...

virtual double	GetLICIntensity ()

void	SetMapModeBias (double val)
	Factor used when blend mode is set to COLOR_MODE_MAP. More...

virtual double	GetMapModeBias ()

void	SetNoiseDataSet (vtkImageData *data)
	Set the data containing a noise array as active scalars. More...

vtkImageData *	GetNoiseDataSet ()

void	SetGenerateNoiseTexture (int shouldGenerate)
	Set/Get the noise texture source. More...

virtual int	GetGenerateNoiseTexture ()

void	SetNoiseType (int type)

virtual int	GetNoiseType ()

void	SetNoiseTextureSize (int length)
	Set/Get the side length in pixels of the noise texture. More...

virtual int	GetNoiseTextureSize ()

void	SetNoiseGrainSize (int val)
	Each noise value will be length^2 pixels in area. More...

virtual int	GetNoiseGrainSize ()

void	SetMinNoiseValue (double val)
	Set/Get the minimum and mximum gray scale values that the generated noise can take on. More...

void	SetMaxNoiseValue (double val)

virtual double	GetMinNoiseValue ()

virtual double	GetMaxNoiseValue ()

void	SetNumberOfNoiseLevels (int val)
	Set/Get the number of discrete values a noise pixel may take on. More...

virtual int	GetNumberOfNoiseLevels ()

void	SetImpulseNoiseProbability (double val)
	Control the density of the noise. More...

virtual double	GetImpulseNoiseProbability ()

void	SetImpulseNoiseBackgroundValue (double val)
	The color to use for untouched pixels when impulse noise probability < 1. More...

virtual double	GetImpulseNoiseBackgroundValue ()

void	SetNoiseGeneratorSeed (int val)
	Set/Get the seed value used by the random number generator. More...

virtual int	GetNoiseGeneratorSeed ()

void	SetCompositeStrategy (int val)

virtual int	GetCompositeStrategy ()

void	ShallowCopy (vtkSurfaceLICInterface *m)
	Make a shallow copy of this interface. More...

virtual void	ReleaseGraphicsResources (vtkWindow *win)
	Release any graphics resources that are being consumed by this mapper. More...

bool	CanRenderSurfaceLIC (vtkActor *actor)
	Returns true when rendering LIC is possible. More...

void	ValidateContext (vtkRenderer *renderer)
	Look for changes that would trigger stage updates. More...

void	CreateCommunicator (vtkRenderer , vtkActor , vtkDataObject *data)
	Creates a new communicator for internal use based on this rank's visible data. More...

vtkPainterCommunicator *	GetCommunicator ()

void	UpdateCommunicator (vtkRenderer renderer, vtkActor actor, vtkDataObject *data)
	Called from a mapper, does what is needed to make sure the communicators are ready. More...

void	SetHasVectors (bool val)
	Does the data have vectors which we require. More...

bool	GetHasVectors ()

void	InitializeResources ()
	resoucre allocators More...

void	PrepareForGeometry ()

void	CompletedGeometry ()

void	GatherVectors ()

void	ApplyLIC ()

void	CombineColorsAndLIC ()

void	CopyToScreen ()

virtual void	SetEnable (int)
	Enable/Disable LIC. More...

virtual int	GetEnable ()

virtual void	EnableOn ()

virtual void	EnableOff ()

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)

vtkCommand *	GetCommand (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 vtkPSurfaceLICInterface *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPSurfaceLICInterface *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkSurfaceLICInterface
static vtkSurfaceLICInterface *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSurfaceLICInterface *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkRenderWindow *context)
	Returns true if the rendering context supports extensions needed by this painter. 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 ()

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

	vtkPSurfaceLICInterface ()

	~vtkPSurfaceLICInterface ()

virtual void	GetGlobalMinMax (vtkPainterCommunicator *comm, float &min, float &max) override
	Get the min/max across all ranks. More...

virtual vtkPainterCommunicator *	CreateCommunicator (int include) override
	Creates a new communicator with/without the calling processes as indicated by the passed in flag, if not 0 the calling process is included in the new communicator. More...

virtual bool	NeedToUpdateCommunicator () override
	Ensure that if any rank updates the communicator they all do. More...

virtual void	StartTimerEvent (const char *name)
	Methods used for parallel benchmarks. More...

virtual void	EndTimerEvent (const char *name)

Protected Member Functions inherited from vtkSurfaceLICInterface
	vtkSurfaceLICInterface ()

	~vtkSurfaceLICInterface () override

void	UpdateNoiseImage (vtkRenderWindow *renWin)
	Updates the noise texture, downsampling by the requested sample rate. More...

bool	NeedToRenderGeometry (vtkRenderer renderer, vtkActor actor)

bool	NeedToGatherVectors ()

bool	NeedToComputeLIC ()

bool	NeedToColorLIC ()

void	SetUpdateAll ()

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 vtkSurfaceLICInterface
int	Enable

int	NumberOfSteps

double	StepSize

int	NormalizeVectors

int	EnhancedLIC

int	EnhanceContrast

double	LowLICContrastEnhancementFactor

double	HighLICContrastEnhancementFactor

double	LowColorContrastEnhancementFactor

double	HighColorContrastEnhancementFactor

int	AntiAlias

int	MaskOnSurface

double	MaskThreshold

double	MaskIntensity

double	MaskColor [3]

int	ColorMode

double	LICIntensity

double	MapModeBias

int	GenerateNoiseTexture

int	NoiseType

int	NoiseTextureSize

int	NoiseGrainSize

double	MinNoiseValue

double	MaxNoiseValue

int	NumberOfNoiseLevels

double	ImpulseNoiseProbability

double	ImpulseNoiseBackgroundValue

int	NoiseGeneratorSeed

int	AlwaysUpdate

int	CompositeStrategy

vtkSurfaceLICHelper *	Internals

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 parts of the vtkSurfaceLICInterface

Parallel parts of the vtkSurfaceLICInterface, see that class for documentation.

Definition at line 33 of file vtkPSurfaceLICInterface.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSurfaceLICInterface vtkPSurfaceLICInterface::Superclass

Definition at line 37 of file vtkPSurfaceLICInterface.h.

Constructor & Destructor Documentation

◆ vtkPSurfaceLICInterface()

vtkPSurfaceLICInterface::vtkPSurfaceLICInterface ( )

protected

◆ ~vtkPSurfaceLICInterface()

vtkPSurfaceLICInterface::~vtkPSurfaceLICInterface ( )

protected

Member Function Documentation

◆ New()

static vtkPSurfaceLICInterface* vtkPSurfaceLICInterface::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkPSurfaceLICInterface::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 vtkSurfaceLICInterface.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPSurfaceLICInterface::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSurfaceLICInterface.

◆ NewInstance()

vtkPSurfaceLICInterface* vtkPSurfaceLICInterface::NewInstance ( ) const

◆ PrintSelf()

void vtkPSurfaceLICInterface::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 vtkSurfaceLICInterface.

◆ WriteTimerLog()

virtual void vtkPSurfaceLICInterface::WriteTimerLog ( const char * fileName )

overridevirtual

Methods used for parallel benchmarks.

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

Reimplemented from vtkSurfaceLICInterface.

◆ GetGlobalMinMax()

virtual void vtkPSurfaceLICInterface::GetGlobalMinMax	(	vtkPainterCommunicator *	comm,
		float &	min,
		float &	max
	)

overrideprotectedvirtual

Get the min/max across all ranks.

min/max are in/out. In serial operation this is a no-op, in parallel it is a global collective reduction.

Reimplemented from vtkSurfaceLICInterface.

◆ CreateCommunicator()

virtual vtkPainterCommunicator* vtkPSurfaceLICInterface::CreateCommunicator ( int include )

overrideprotectedvirtual

Creates a new communicator with/without the calling processes as indicated by the passed in flag, if not 0 the calling process is included in the new communicator.

In parallel this call is mpi collective on the world communicator. In serial this is a no-op.

Reimplemented from vtkSurfaceLICInterface.

◆ NeedToUpdateCommunicator()

virtual bool vtkPSurfaceLICInterface::NeedToUpdateCommunicator ( )

overrideprotectedvirtual

Ensure that if any rank updates the communicator they all do.

This is a global collective operation.

Reimplemented from vtkSurfaceLICInterface.

◆ StartTimerEvent()

virtual void vtkPSurfaceLICInterface::StartTimerEvent ( const char * name )

protectedvirtual

Methods used for parallel benchmarks.

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

◆ EndTimerEvent()

virtual void vtkPSurfaceLICInterface::EndTimerEvent ( const char * name )

protectedvirtual

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

dox/Rendering/ParallelLIC/vtkPSurfaceLICInterface.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPSurfaceLICInterface()

◆ ~vtkPSurfaceLICInterface()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ WriteTimerLog()

◆ GetGlobalMinMax()

◆ CreateCommunicator()

◆ NeedToUpdateCommunicator()

◆ StartTimerEvent()

◆ EndTimerEvent()