public API for surface lic parameters arbitrary geometry. More...

#include <vtkSurfaceLICInterface.h>

Inheritance diagram for vtkSurfaceLICInterface:

Collaboration diagram for vtkSurfaceLICInterface:

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

vtkSurfaceLICInterface *	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 *)
	Methods used for parallel benchmarks. More...

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

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 (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	InitializeResources ()
	resoucre allocators More...

void	PrepareForGeometry ()

void	CompletedGeometry ()

void	GatherVectors ()

void	ApplyLIC ()

void	CombineColorsAndLIC ()

void	CopyToScreen ()

virtual void	GetGlobalMinMax (vtkPainterCommunicator *, float &, float &)
	Get the min/max across all ranks. 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)
	Each noise value will be length^2 pixels in area. More...

virtual int	GetNoiseGrainSize ()
	Each noise value will be length^2 pixels in area. 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...


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

bool	GetHasVectors ()
	Does the data have vectors which we require. More...


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

virtual int	GetEnable ()
	Enable/Disable LIC. More...

virtual void	EnableOn ()
	Enable/Disable LIC. More...

virtual void	EnableOff ()
	Enable/Disable LIC. 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 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 ()
	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

	vtkSurfaceLICInterface ()

	~vtkSurfaceLICInterface () override

void	UpdateNoiseImage (vtkRenderWindow *renWin)
	Updates the noise texture, downsampling by the requested sample rate. 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...

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

int	PrevDrawBuf

int	PrevFbo

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

public API for surface lic parameters arbitrary geometry.

vtkSurfaceLICInterface 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 parameters or input data.

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

See also: vtkLineIntegralConvolution2D

Tests:: vtkSurfaceLICInterface (Tests)

Definition at line 74 of file vtkSurfaceLICInterface.h.

Member Typedef Documentation

typedef vtkObject vtkSurfaceLICInterface::Superclass

Definition at line 78 of file vtkSurfaceLICInterface.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 approach 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 process.

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 216 of file vtkSurfaceLICInterface.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 controlled 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 276 of file vtkSurfaceLICInterface.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 350 of file vtkSurfaceLICInterface.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 427 of file vtkSurfaceLICInterface.h.

Constructor & Destructor Documentation

vtkSurfaceLICInterface::vtkSurfaceLICInterface ( )

protected

vtkSurfaceLICInterface::~vtkSurfaceLICInterface ( )

overrideprotected

Member Function Documentation

static vtkSurfaceLICInterface* vtkSurfaceLICInterface::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkSurfaceLICInterface::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkPSurfaceLICInterface.

vtkSurfaceLICInterface* vtkSurfaceLICInterface::NewInstance ( ) const

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

void vtkSurfaceLICInterface::SetNumberOfSteps ( int val )

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

virtual int vtkSurfaceLICInterface::GetNumberOfSteps ( )

virtual

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

void vtkSurfaceLICInterface::SetStepSize ( double val )

Get/Set the step size (in pixels).

virtual double vtkSurfaceLICInterface::GetStepSize ( )

virtual

Get/Set the step size (in pixels).

void vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 satisfied. 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 vtkSurfaceLICInterface::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 satisfied. 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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 153 of file vtkSurfaceLICInterface.h.

virtual double* vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 vtkSurfaceLICInterface::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 approach 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 process.

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 vtkSurfaceLICInterface::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 approach 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 process.

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 vtkSurfaceLICInterface::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))