painter that performs LIC on the surface of arbitrary geometry. More...

#include <vtkSurfaceLICPainter.h>

Inheritance diagram for vtkSurfaceLICPainter:

Collaboration diagram for vtkSurfaceLICPainter:

Public Types
typedef vtkPainter	Superclass

Public Types inherited from vtkPainter
enum	{ VERTS = 0x1, LINES = 0x2, POLYS = 0x4, STRIPS = 0x8 }

typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkSurfaceLICPainter *	NewInstance () const

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

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

virtual vtkDataObject *	GetOutput ()
	Get the output data object from this painter. More...

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


void	SetEnable (int val)
	Enable/Disable this painter. More...

virtual int	GetEnable ()
	Enable/Disable this painter. More...

void	SetEnableOn ()
	Enable/Disable this painter. More...

void	SetEnableOff ()
	Enable/Disable this painter. More...


void	SetInputArrayToProcess (int fieldAssociation, const char *name)
	Set the vectors to used for applying LIC. More...

void	SetInputArrayToProcess (int fieldAssociation, int fieldAttributeType)
	Set the vectors to used for applying LIC. More...


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

virtual int	GetNumberOfSteps ()
	Get/Set the number of integration steps in each direction. More...


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

virtual double	GetStepSize ()
	Get/Set the step size (in pixels). More...


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

virtual void	NormalizeVectorsOn ()
	Normalize vectors during integration. More...

virtual void	NormalizeVectorsOff ()
	Normalize vectors during integration. More...

virtual int	GetNormalizeVectors ()
	Normalize vectors during integration. More...


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

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

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

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


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

virtual double	GetMaskThreshold ()
	The MaskThreshold controls the rendering of fragments in stagnant regions of flow. More...


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

void	SetMaskColor (double r, double g, double b)
	The MaskColor is used on masked fragments. More...

virtual double *	GetMaskColor ()
	The MaskColor is used on masked fragments. More...

virtual void	GetMaskColor (double &, double &, double &)
	The MaskColor is used on masked fragments. More...

virtual void	GetMaskColor (double[3])
	The MaskColor is used on masked fragments. More...


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

virtual double	GetMaskIntensity ()
	The MaskIntensity controls the blending of the mask color and the geometry color. More...


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 ()
	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 void	EnhancedLICOn ()
	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 void	EnhancedLICOff ()
	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 double	GetLowLICContrastEnhancementFactor ()
	This feature is used to fine tune the contrast enhancement. More...

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

void	SetLowLICContrastEnhancementFactor (double val)
	This feature is used to fine tune the contrast enhancement. More...

void	SetHighLICContrastEnhancementFactor (double val)
	This feature is used to fine tune the contrast enhancement. More...

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

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

void	SetLowColorContrastEnhancementFactor (double val)
	This feature is used to fine tune the contrast enhancement. More...

void	SetHighColorContrastEnhancementFactor (double val)
	This feature is used to fine tune the contrast enhancement. More...


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

virtual void	AntiAliasOn ()
	Enable/Disable the anti-aliasing pass. More...

virtual void	AntiAliasOff ()
	Enable/Disable the anti-aliasing pass. More...

virtual int	GetAntiAlias ()
	Enable/Disable the anti-aliasing pass. More...


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

virtual double	GetLICIntensity ()
	Factor used when blend mode is set to COLOR_MODE_BLEND. More...


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

virtual double	GetMapModeBias ()
	Factor used when blend mode is set to COLOR_MODE_MAP. More...


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

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


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

virtual int	GetGenerateNoiseTexture ()
	Set/Get the noise texture source. More...


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

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


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

virtual int	GetNoiseGrainSize ()
	Set/Get the side length in pixels of the noise values in the noise texture. More...


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)
	Set/Get the minimum and mximum gray scale values that the generated noise can take on. More...

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

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


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

virtual int	GetNumberOfNoiseLevels ()
	Set/Get the number of discrete values a noise pixel may take on. More...


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

virtual double	GetImpulseNoiseProbability ()
	Control the density of of the noise. More...


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

virtual double	GetImpulseNoiseBackgroundValue ()
	The color to use for untouched pixels when impulse noise probability < 1. More...


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

virtual int	GetNoiseGeneratorSeed ()
	Set/Get the seed value used by the random number generator. More...

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

virtual void	Render (vtkRenderer renderer, vtkActor actor, unsigned long typeflags, bool forceCompileOnly)
	Generates rendering primitives of appropriate type(s). More...

virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered. More...

virtual void	UpdateBounds (double bounds[6])
	Expand or shrink the estimated bounds of the object based on the geometric transformations performed in the painter. More...

virtual vtkInformation *	GetInformation ()
	Get/Set the information object associated with this painter. More...

virtual void	SetInformation (vtkInformation *)
	Get/Set the information object associated with this painter. More...

virtual vtkPainter *	GetDelegatePainter ()
	Set/Get the painter to which this painter should propagare its draw calls. More...

virtual void	SetDelegatePainter (vtkPainter *)
	Set/Get the painter to which this painter should propagare its draw calls. More...

void	Register (vtkObjectBase *o) override
	Take part in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Take part in garbage collection. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetInput (vtkDataObject *)
	Set the data object to paint. More...

virtual vtkDataObject *	GetInput ()
	Set the data object to paint. 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 ()

int	HasObserver (unsigned long event)

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

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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 vtkSurfaceLICPainter *	New ()

static int	IsTypeOf (const char *type)

static vtkSurfaceLICPainter *	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 vtkPainter
static int	IsTypeOf (const char *type)

static vtkPainter *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	STATIC_DATA ()
	Keys used to specify control the behaviour of the painter. More...

static vtkInformationIntegerKey *	CONSERVE_MEMORY ()
	Keys used to specify control the behaviour of the painter. More...

static vtkInformationIntegerKey *	HIGH_QUALITY ()
	Keys used to specify control the behaviour of the 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 ()
	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

	vtkSurfaceLICPainter ()

	~vtkSurfaceLICPainter ()

virtual void	ProcessInformation (vtkInformation *info)
	Called before RenderInternal() if the Information has been changed since the last time this method was called. More...

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

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

virtual void	EndTimerEvent (const char *)

virtual vtkPainterCommunicator *	CreateCommunicator (int)
	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...

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

void	GetBounds (vtkDataObject *data, double bounds[6])
	Computes data bounds. More...

void	ReportReferences (vtkGarbageCollector *collector) override
	Take part in garbage collection. More...

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

virtual void	RenderInternal (vtkRenderer renderer, vtkActor actor, unsigned long typeflags, bool forceCompileOnly)
	Performs the actual rendering. More...

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

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


bool	NeedToUpdateOutputData ()
	Return false if stage can be skipped. More...

virtual bool	NeedToUpdateCommunicator ()
	Return false if stage can be skipped. More...

bool	NeedToRenderGeometry (vtkRenderer renderer, vtkActor actor)
	Return false if stage can be skipped. More...

bool	NeedToGatherVectors ()
	Return false if stage can be skipped. More...

bool	NeedToComputeLIC ()
	Return false if stage can be skipped. More...

bool	NeedToColorLIC ()
	Return false if stage can be skipped. More...

void	SetUpdateAll ()
	Return false if stage can be skipped. More...


bool	PrepareOutput ()
	resoucre allocators More...

void	InitializeResources ()
	resoucre allocators More...


bool	VectorsToTCoords (vtkDataObject *dataObj)
	set tcoords with vectors More...

bool	VectorsToTCoords (vtkDataSet *dataObj)
	set tcoords with vectors More...

void	ClearTCoords (vtkDataSet *data)
	set tcoords with vectors More...

Protected Member Functions inherited from vtkPainter
	vtkPainter ()

	~vtkPainter ()

void	ReportReferences (vtkGarbageCollector *collector) override
	Take part in garbage collection. More...

void	UpdateDelegatePainter ()
	Updates the delegate painter. More...

virtual void	PassInformation (vtkPainter *toPainter)
	Pass on the information and data (output) from the this to the argument painter. More...

virtual void	PrepareForRendering (vtkRenderer , vtkActor )
	Some subclasses may need to do some preprocessing before the actual rendering can be done eg. More...

virtual void	UpdateDelegateProgress (vtkPainter *delegate, double amount)
	Called when the delegate painter reports its progress. More...

virtual void	ObserverPainterProgress (vtkPainter *toObserve)
	Adds a progress event observer to toObserve. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

vtkAbstractArray *	GetInputArrayToProcess (int fieldAssociation, int fieldAttributeType, vtkDataSet ds, bool use_cell_data=0)
	Helper method to get input array to process. More...

vtkAbstractArray *	GetInputArrayToProcess (int fieldAssociation, const char name, vtkDataSet dsl, bool *use_cell_data=0)
	Helper method to get input array to process. 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=NULL)
	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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
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	Enable

int	CompositeStrategy

vtkDataObject *	Output

vtkInternals *	Internals

Protected Attributes inherited from vtkPainter
vtkTimeStamp	InformationProcessTime

vtkPainterObserver *	Observer

vtkInformation *	Information

vtkPainter *	DelegatePainter

double	Progress

double	ProgressOffset

double	ProgressScaleFactor

double	TimeToDraw

vtkTimerLog *	Timer

vtkWeakPointer< vtkWindow >	LastWindow

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

void	SetEnhanceContrast (int val)
	Enable/Disable contrast and dynamic range correction stages. More...

virtual int	GetEnhanceContrast ()
	Enable/Disable contrast and dynamic range correction stages. More...

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

void	SetColorMode (int val)
	Set/Get the color mode. More...

virtual int	GetColorMode ()
	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...

void	SetNoiseType (int type)
	Select the statistical distribution of randomly generated noise values. More...

virtual int	GetNoiseType ()
	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...

void	SetCompositeStrategy (int val)
	Control the screen space decomposition where LIC is computed. More...

virtual int	GetCompositeStrategy ()
	Control the screen space decomposition where LIC is computed. More...

Detailed Description

painter that performs LIC on the surface of arbitrary geometry.

vtkSurfaceLICPainter painter performs LIC on the surface of arbitrary geometry. Point vectors are used as the vector field for generating the LIC. The implementation was originallu based on "Image Space Based Visualization on Unsteady Flow on Surfaces" by Laramee, Jobard and Hauser appeared in proceedings of IEEE Visualization '03, pages 131-138.

Internal pipeline:

noise
    |
    [ PROJ (GAT) (COMP) LIC2D (SCAT) SHADE (CCE) DEP]
    |                                               |
vectors                                         surface LIC

PROj - prject vectors onto surface GAT - gather data for compositing and guard pixel generation (parallel only) COMP - composite gathered data LIC2D - line intengral convolution, see vtkLineIntegralConvolution2D. SCAT - scatter result (parallel only, not all compositors use it) SHADE - combine LIC and scalar colors CCE - color contrast enhancement (optional) DEP - depth test and copy to back buffer

The result of each stage is cached in a texture so that during interaction a stage may be skipped if the user has not modified its paramters or input data.

The parallel parts of algorithm are implemented in vtkPSurfaceLICPainter. Note that for MPI enabled builds this class will be automatically created by the object factory.

See also: vtkSurfaceLICDefaultPainter vtkLineIntegralConvolution2D

Tests:: vtkSurfaceLICPainter (Tests)

Definition at line 73 of file vtkSurfaceLICPainter.h.

Member Typedef Documentation

typedef vtkPainter vtkSurfaceLICPainter::Superclass

Definition at line 77 of file vtkSurfaceLICPainter.h.

Member Enumeration Documentation

anonymous enum

Enable/Disable contrast and dynamic range correction stages.

Contrast enhancement can be enabled during LIC computations (See vtkLineINtegralComvolution2D) and after the scalar colors have been combined with the LIC.

The best appraoch for using this feature is to enable LIC enhancement, and only if the image is to dark or dull enable COLOR enhancement.

Both stages are implemented by a histogram stretching algorithm. During LIC stages the contrast enhancement is applied to gray scale LIC image. During the scalar coloring stage the contrast enhancement is applied to the lightness channel of the color image in HSL color space. The histogram stretching is implemented as follows:

L = (L-m)/(M-m)

where, L is the fragment intensity/lightness, m is the intensity/lightness to map to 0, M is the intensity/lightness to map to 1. The default values of m and M are the min and max taken over all fragments.

This increase the dynamic range and contrast in the LIC'd image, both of which are natuarly attenuated by the convolution proccess.

Values

ENHANCE_CONTRAST_OFF – don't enhance LIC or scalar colors ENHANCE_CONTRAST_LIC – enhance in LIC high-pass input and output ENHANCE_CONTRAST_COLOR – enhance after scalars are combined with LIC ENHANCE_CONTRAST_BOTH – enhance in LIC stages and after scalar colors

This feature is disabled by default.

Enumerator
ENHANCE_CONTRAST_OFF
ENHANCE_CONTRAST_LIC
ENHANCE_CONTRAST_COLOR
ENHANCE_CONTRAST_BOTH

Definition at line 251 of file vtkSurfaceLICPainter.h.

anonymous enum

Set/Get the color mode.

The color mode controls how scalar colors are combined with the LIC in the final image. The BLEND mode combines scalar colors with LIC intensities with proportional blending controled by the LICIntensity parameter. The MAP mode combines scalar colors with LIC, by multiplication the HSL represntation of color's lightness.

The default is COLOR_MODE_BLEND.

Enumerator
COLOR_MODE_BLEND
COLOR_MODE_MAP

Definition at line 311 of file vtkSurfaceLICPainter.h.

anonymous enum

Select the statistical distribution of randomly generated noise values.

With uniform noise there is greater control over the range of values in the noise texture. The Default is NOISE_TYPE_GAUSSIAN.

Enumerator
NOISE_TYPE_UNIFORM
NOISE_TYPE_GAUSSIAN
NOISE_TYPE_PERLIN

Definition at line 385 of file vtkSurfaceLICPainter.h.

anonymous enum

Control the screen space decomposition where LIC is computed.

Enumerator
COMPOSITE_INPLACE
COMPOSITE_INPLACE_DISJOINT
COMPOSITE_BALANCED
COMPOSITE_AUTO

Definition at line 463 of file vtkSurfaceLICPainter.h.

Constructor & Destructor Documentation

vtkSurfaceLICPainter::vtkSurfaceLICPainter ( )

protected

vtkSurfaceLICPainter::~vtkSurfaceLICPainter ( )

protected

Member Function Documentation

static vtkSurfaceLICPainter* vtkSurfaceLICPainter::New ( )

static

static int vtkSurfaceLICPainter::IsTypeOf ( const char * type )

static

virtual int vtkSurfaceLICPainter::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 vtkPainter.

Reimplemented in vtkPSurfaceLICPainter.

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

static

virtual vtkObjectBase* vtkSurfaceLICPainter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPainter.

Reimplemented in vtkPSurfaceLICPainter.

vtkSurfaceLICPainter* vtkSurfaceLICPainter::NewInstance ( ) const

void vtkSurfaceLICPainter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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

Reimplemented in vtkPSurfaceLICPainter.

virtual void vtkSurfaceLICPainter::ReleaseGraphicsResources ( vtkWindow * win )

virtual

Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release. In this case, releases the display lists.

Reimplemented from vtkPainter.

virtual vtkDataObject* vtkSurfaceLICPainter::GetOutput ( )

virtual

Get the output data object from this painter.

Overridden to pass the input points (or cells) vectors as the tcoords to the deletage painters. This is required by the internal GLSL shader programs used for generating LIC.

Reimplemented from vtkPainter.

void vtkSurfaceLICPainter::SetEnable ( int val )

Enable/Disable this painter.

virtual int vtkSurfaceLICPainter::GetEnable ( )

virtual

Enable/Disable this painter.

void vtkSurfaceLICPainter::SetEnableOn ( )

inline

Enable/Disable this painter.

Definition at line 101 of file vtkSurfaceLICPainter.h.

void vtkSurfaceLICPainter::SetEnableOff ( )

inline

Enable/Disable this painter.

Definition at line 102 of file vtkSurfaceLICPainter.h.

void vtkSurfaceLICPainter::SetInputArrayToProcess	(	int	fieldAssociation,
		const char *	name
	)

Set the vectors to used for applying LIC.

By default point vectors are used. Arguments are same as those passed to vtkAlgorithm::SetInputArrayToProcess except the first 3 arguments i.e. idx, port, connection.

void vtkSurfaceLICPainter::SetInputArrayToProcess	(	int	fieldAssociation,
		int	fieldAttributeType
	)

Set the vectors to used for applying LIC.

By default point vectors are used. Arguments are same as those passed to vtkAlgorithm::SetInputArrayToProcess except the first 3 arguments i.e. idx, port, connection.

void vtkSurfaceLICPainter::SetNumberOfSteps ( int val )

Get/Set the number of integration steps in each direction.

virtual int vtkSurfaceLICPainter::GetNumberOfSteps ( )

virtual

Get/Set the number of integration steps in each direction.

void vtkSurfaceLICPainter::SetStepSize ( double val )

Get/Set the step size (in pixels).

virtual double vtkSurfaceLICPainter::GetStepSize ( )

virtual

Get/Set the step size (in pixels).

void vtkSurfaceLICPainter::SetNormalizeVectors ( int val )

Normalize vectors during integration.

When set(the default) the input vector field is normalized during integration, and each integration occurs over the same arclength. When not set each integration occurs over an arc length proportional to the field magnitude as is customary in traditional numerical methods. See, "Imaging Vector Fields Using Line Integral Convolution" for an axample where normalization is used. See, "Image Space Based Visualization of Unsteady Flow on Surfaces" for an example of where no normalization is used.

virtual void vtkSurfaceLICPainter::NormalizeVectorsOn ( )

virtual

Normalize vectors during integration.

When set(the default) the input vector field is normalized during integration, and each integration occurs over the same arclength. When not set each integration occurs over an arc length proportional to the field magnitude as is customary in traditional numerical methods. See, "Imaging Vector Fields Using Line Integral Convolution" for an axample where normalization is used. See, "Image Space Based Visualization of Unsteady Flow on Surfaces" for an example of where no normalization is used.

virtual void vtkSurfaceLICPainter::NormalizeVectorsOff ( )

virtual

Normalize vectors during integration.

When set(the default) the input vector field is normalized during integration, and each integration occurs over the same arclength. When not set each integration occurs over an arc length proportional to the field magnitude as is customary in traditional numerical methods. See, "Imaging Vector Fields Using Line Integral Convolution" for an axample where normalization is used. See, "Image Space Based Visualization of Unsteady Flow on Surfaces" for an example of where no normalization is used.

virtual int vtkSurfaceLICPainter::GetNormalizeVectors ( )

virtual

Normalize vectors during integration.

When set(the default) the input vector field is normalized during integration, and each integration occurs over the same arclength. When not set each integration occurs over an arc length proportional to the field magnitude as is customary in traditional numerical methods. See, "Imaging Vector Fields Using Line Integral Convolution" for an axample where normalization is used. See, "Image Space Based Visualization of Unsteady Flow on Surfaces" for an example of where no normalization is used.

void vtkSurfaceLICPainter::SetMaskOnSurface ( int val )

When set MaskOnSurface computes |V| for use in the fragment masking tests on the surface.

When not set the original un-projected un-transformed |V| is used.

virtual void vtkSurfaceLICPainter::MaskOnSurfaceOn ( )

virtual

When set MaskOnSurface computes |V| for use in the fragment masking tests on the surface.

When not set the original un-projected un-transformed |V| is used.

virtual void vtkSurfaceLICPainter::MaskOnSurfaceOff ( )

virtual

When set MaskOnSurface computes |V| for use in the fragment masking tests on the surface.

When not set the original un-projected un-transformed |V| is used.

virtual int vtkSurfaceLICPainter::GetMaskOnSurface ( )

virtual

When set MaskOnSurface computes |V| for use in the fragment masking tests on the surface.

When not set the original un-projected un-transformed |V| is used.

void vtkSurfaceLICPainter::SetMaskThreshold ( double val )

The MaskThreshold controls the rendering of fragments in stagnant regions of flow.

// In these regions LIC noise texture will be masked, where |V| < MaskThreshold is satisifed. The masking process blends a the MaskColor with the scalar color of the surface proportional to MaskIntesnsity. See MaskIntensity for more information on the blending algorithm. This blending allows one control over the masking process so that masked fragments may be: highlighted (by setting a unique mask color and mask intensity > 0), made invisible with and without passing the un-convolved noise texture (by setting mask intensity 0), made to blend into the LIC.

MaskThreshold units are in the original vector space. Note that the threshold can be applied to the original vector field or to the surface projected vector field. See MaskOnSurface.

virtual double vtkSurfaceLICPainter::GetMaskThreshold ( )

virtual

The MaskThreshold controls the rendering of fragments in stagnant regions of flow.

// In these regions LIC noise texture will be masked, where |V| < MaskThreshold is satisifed. The masking process blends a the MaskColor with the scalar color of the surface proportional to MaskIntesnsity. See MaskIntensity for more information on the blending algorithm. This blending allows one control over the masking process so that masked fragments may be: highlighted (by setting a unique mask color and mask intensity > 0), made invisible with and without passing the un-convolved noise texture (by setting mask intensity 0), made to blend into the LIC.

MaskThreshold units are in the original vector space. Note that the threshold can be applied to the original vector field or to the surface projected vector field. See MaskOnSurface.

void vtkSurfaceLICPainter::SetMaskColor ( double * val )

The MaskColor is used on masked fragments.

The default of (0.5, 0.5, 0.5) makes the masked fragments look similar to the LIC'd fragments. The mask color is applied only when MaskIntensity > 0.

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

inline

The MaskColor is used on masked fragments.

The default of (0.5, 0.5, 0.5) makes the masked fragments look similar to the LIC'd fragments. The mask color is applied only when MaskIntensity > 0.

Definition at line 188 of file vtkSurfaceLICPainter.h.

virtual double* vtkSurfaceLICPainter::GetMaskColor ( )

virtual

The MaskColor is used on masked fragments.

The default of (0.5, 0.5, 0.5) makes the masked fragments look similar to the LIC'd fragments. The mask color is applied only when MaskIntensity > 0.

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

virtual

The MaskColor is used on masked fragments.

The default of (0.5, 0.5, 0.5) makes the masked fragments look similar to the LIC'd fragments. The mask color is applied only when MaskIntensity > 0.

virtual void vtkSurfaceLICPainter::GetMaskColor ( double [3] )

virtual

The MaskColor is used on masked fragments.

The default of (0.5, 0.5, 0.5) makes the masked fragments look similar to the LIC'd fragments. The mask color is applied only when MaskIntensity > 0.

void vtkSurfaceLICPainter::SetMaskIntensity ( double val )

The MaskIntensity controls the blending of the mask color and the geometry color.

The color of masked fragments is given by:

c = maskColor * maskIntensity + geomColor * (1 - maskIntensity)

The default value of 0.0 results in the geometry color being used.

virtual double vtkSurfaceLICPainter::GetMaskIntensity ( )

virtual

The MaskIntensity controls the blending of the mask color and the geometry color.

The color of masked fragments is given by:

c = maskColor * maskIntensity + geomColor * (1 - maskIntensity)

The default value of 0.0 results in the geometry color being used.

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

Edge enhancedment is made by a simple Laplace convolution.

virtual int vtkSurfaceLICPainter::GetEnhancedLIC ( )

virtual

EnhancedLIC mean compute the LIC twice with the second pass using the edge-enhanced result of the first pass as a noise texture.

Edge enhancedment is made by a simple Laplace convolution.

virtual void vtkSurfaceLICPainter::EnhancedLICOn ( )

virtual

EnhancedLIC mean compute the LIC twice with the second pass using the edge-enhanced result of the first pass as a noise texture.

Edge enhancedment is made by a simple Laplace convolution.

virtual void vtkSurfaceLICPainter::EnhancedLICOff ( )

virtual

EnhancedLIC mean compute the LIC twice with the second pass using the edge-enhanced result of the first pass as a noise texture.

Edge enhancedment is made by a simple Laplace convolution.

void vtkSurfaceLICPainter::SetEnhanceContrast ( int val )

Enable/Disable contrast and dynamic range correction stages.

Contrast enhancement can be enabled during LIC computations (See vtkLineINtegralComvolution2D) and after the scalar colors have been combined with the LIC.

The best appraoch for using this feature is to enable LIC enhancement, and only if the image is to dark or dull enable COLOR enhancement.

Both stages are implemented by a histogram stretching algorithm. During LIC stages the contrast enhancement is applied to gray scale LIC image. During the scalar coloring stage the contrast enhancement is applied to the lightness channel of the color image in HSL color space. The histogram stretching is implemented as follows:

L = (L-m)/(M-m)

where, L is the fragment intensity/lightness, m is the intensity/lightness to map to 0, M is the intensity/lightness to map to 1. The default values of m and M are the min and max taken over all fragments.

This increase the dynamic range and contrast in the LIC'd image, both of which are natuarly attenuated by the convolution proccess.

Values

ENHANCE_CONTRAST_OFF – don't enhance LIC or scalar colors ENHANCE_CONTRAST_LIC – enhance in LIC high-pass input and output ENHANCE_CONTRAST_COLOR – enhance after scalars are combined with LIC ENHANCE_CONTRAST_BOTH – enhance in LIC stages and after scalar colors

This feature is disabled by default.

virtual int vtkSurfaceLICPainter::GetEnhanceContrast ( )

virtual

Enable/Disable contrast and dynamic range correction stages.

Contrast enhancement can be enabled during LIC computations (See vtkLineINtegralComvolution2D) and after the scalar colors have been combined with the LIC.

The best appraoch for using this feature is to enable LIC enhancement, and only if the image is to dark or dull enable COLOR enhancement.

Both stages are implemented by a histogram stretching algorithm. During LIC stages the contrast enhancement is applied to gray scale LIC image. During the scalar coloring stage the contrast enhancement is applied to the lightness channel of the color image in HSL color space. The histogram stretching is implemented as follows:

L = (L-m)/(M-m)

where, L is the fragment intensity/lightness, m is the intensity/lightness to map to 0, M is the intensity/lightness to map to 1. The default values of m and M are the min and max taken over all fragments.

This increase the dynamic range and contrast in the LIC'd image, both of which are natuarly attenuated by the convolution proccess.

Values

ENHANCE_CONTRAST_OFF – don't enhance LIC or scalar colors ENHANCE_CONTRAST_LIC – enhance in LIC high-pass input and output ENHANCE_CONTRAST_COLOR – enhance after scalars are combined with LIC ENHANCE_CONTRAST_BOTH – enhance in LIC stages and after scalar colors

This feature is disabled by default.

virtual double vtkSurfaceLICPainter::GetLowLICContrastEnhancementFactor ( )

virtual

This feature is used to fine tune the contrast enhancement.

There are two modes AUTOMATIC and MANUAL.In AUTOMATIC mode values are provided indicating the fraction of the range to adjust M and m by, during contrast enahncement histogram stretching. M and m are the intensity/lightness values that map to 1 and 0. (see EnhanceContrast for an explanation of the mapping procedure). m and M are computed using the factors as follows:

m = min(C) + mFactor * (max(C) - min(C)) M = max(C) - MFactor * (max(C) - min(C))