vtkGaussianSplatter Class Reference

splat points into a volume with an elliptical, Gaussian distribution More...

#include <vtkGaussianSplatter.h>

Inheritance diagram for vtkGaussianSplatter:

Collaboration diagram for vtkGaussianSplatter:

Public Types
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkGaussianSplatter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetSampleDimensions (int i, int j, int k)
void	SetSampleDimensions (int dim[3])
virtual int *	GetSampleDimensions ()
virtual void	GetSampleDimensions (int data[3])
virtual void	SetModelBounds (double, double, double, double, double, double)
virtual void	SetModelBounds (double[6])
virtual double *	GetModelBounds ()
virtual void	GetModelBounds (double data[6])
virtual void	SetRadius (double)
virtual double	GetRadius ()
virtual void	SetScaleFactor (double)
virtual double	GetScaleFactor ()
virtual void	SetExponentFactor (double)
virtual double	GetExponentFactor ()
virtual void	SetNormalWarping (int)
virtual int	GetNormalWarping ()
virtual void	NormalWarpingOn ()
virtual void	NormalWarpingOff ()
virtual void	SetEccentricity (double)
virtual double	GetEccentricity ()
virtual void	SetScalarWarping (int)
virtual int	GetScalarWarping ()
virtual void	ScalarWarpingOn ()
virtual void	ScalarWarpingOff ()
virtual void	SetCapping (int)
virtual int	GetCapping ()
virtual void	CappingOn ()
virtual void	CappingOff ()
virtual void	SetCapValue (double)
virtual double	GetCapValue ()
virtual void	SetAccumulationMode (int)
virtual int	GetAccumulationMode ()
void	SetAccumulationModeToMin ()
void	SetAccumulationModeToMax ()
void	SetAccumulationModeToSum ()
const char *	GetAccumulationModeAsString ()
virtual void	SetNullValue (double)
virtual double	GetNullValue ()
void	ComputeModelBounds (vtkDataSet *input, vtkImageData *output, vtkInformation *outInfo)
void	ComputeModelBounds (vtkCompositeDataSet *input, vtkImageData *output, vtkInformation *outInfo)
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkImageData *	GetImageDataInput (int port)
virtual void	AddInputData (vtkDataObject *)
virtual void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkGaussianSplatter *	SafeDownCast (vtkObjectBase *o)
static vtkGaussianSplatter *	New ()
Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()
	~vtkImageAlgorithm ()
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
class	vtkGaussianSplatterAlgorithm
int	SampleDimensions [3]
double	Radius
double	ExponentFactor
double	ModelBounds [6]
int	NormalWarping
double	Eccentricity
int	ScalarWarping
double	ScaleFactor
int	Capping
double	CapValue
int	AccumulationMode
double	SamplePoint (double x[3])
void	SetScalar (int idx, double dist2, double *sPtr)
	vtkGaussianSplatter ()
	~vtkGaussianSplatter ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	Cap (vtkDoubleArray *s)
double	Gaussian (double x[3])
double	EccentricGaussian (double x[3])
double	ScalarSampling (double s)
double	PositionSampling (double)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

splat points into a volume with an elliptical, Gaussian distribution

vtkGaussianSplatter is a filter that injects input points into a structured points (volume) dataset. As each point is injected, it "splats" or distributes values to nearby voxels. Data is distributed using an elliptical, Gaussian distribution function. The distribution function is modified using scalar values (expands distribution) or normals (creates ellipsoidal distribution rather than spherical).

In general, the Gaussian distribution function f(x) around a given splat point p is given by

f(x) = ScaleFactor * exp( ExponentFactor*((r/Radius)**2) )

where x is the current voxel sample point; r is the distance |x-p| ExponentFactor <= 0.0, and ScaleFactor can be multiplied by the scalar value of the point p that is currently being splatted.

If points normals are present (and NormalWarping is on), then the splat function becomes elliptical (as compared to the spherical one described by the previous equation). The Gaussian distribution function then becomes:

f(x) = ScaleFactor *
          exp( ExponentFactor*( ((rxy/E)**2 + z**2)/R**2) )

where E is a user-defined eccentricity factor that controls the elliptical shape of the splat; z is the distance of the current voxel sample point along normal N; and rxy is the distance of x in the direction prependicular to N.

This class is typically used to convert point-valued distributions into a volume representation. The volume is then usually iso-surfaced or volume rendered to generate a visualization. It can be used to create surfaces from point distributions, or to create structure (i.e., topology) when none exists.

Warning

The input to this filter is any dataset type. This filter can be used to resample any form of data, i.e., the input data need not be unstructured.

Some voxels may never receive a contribution during the splatting process. The final value of these points can be specified with the "NullValue" instance variable.

See also

vtkShepardMethod

Examples:

vtkGaussianSplatter (Examples)

Tests:

vtkGaussianSplatter (Tests)

Definition at line 87 of file vtkGaussianSplatter.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkGaussianSplatter::Superclass

Definition at line 90 of file vtkGaussianSplatter.h.

Constructor & Destructor Documentation

vtkGaussianSplatter::vtkGaussianSplatter ( )

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

vtkGaussianSplatter::~vtkGaussianSplatter ( )

inlineprotected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 259 of file vtkGaussianSplatter.h.

Member Function Documentation

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

static

virtual int vtkGaussianSplatter::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 vtkImageAlgorithm.

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

static

virtual vtkObjectBase* vtkGaussianSplatter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkGaussianSplatter* vtkGaussianSplatter::NewInstance

(

)

const

void vtkGaussianSplatter::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 vtkImageAlgorithm.

static vtkGaussianSplatter* vtkGaussianSplatter::New ( )

static

Construct object with dimensions=(50,50,50); automatic computation of bounds; a splat radius of 0.1; an exponent factor of -5; and normal and scalar warping turned on.

void vtkGaussianSplatter::SetSampleDimensions	(	int	i,
		int	j,
		int	k
	)

Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower.

void vtkGaussianSplatter::SetSampleDimensions

(

int

dim[3]

)

Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower.

virtual int* vtkGaussianSplatter::GetSampleDimensions ( )

virtual

Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower.

virtual void vtkGaussianSplatter::GetSampleDimensions ( int  data[3] )

virtual

Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower.

virtual void vtkGaussianSplatter::SetModelBounds ( double  , double  , double  , double  , double  , double    )

virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

virtual void vtkGaussianSplatter::SetModelBounds ( double  [6] )

virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

virtual double* vtkGaussianSplatter::GetModelBounds ( )

virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

virtual void vtkGaussianSplatter::GetModelBounds ( double  data[6] )

virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

virtual void vtkGaussianSplatter::SetRadius ( double  )

virtual

Set / get the radius of propagation of the splat. This value is expressed as a percentage of the length of the longest side of the sampling volume. Smaller numbers greatly reduce execution time.

virtual double vtkGaussianSplatter::GetRadius ( )

virtual

Set / get the radius of propagation of the splat. This value is expressed as a percentage of the length of the longest side of the sampling volume. Smaller numbers greatly reduce execution time.

virtual void vtkGaussianSplatter::SetScaleFactor ( double  )

virtual

Multiply Gaussian splat distribution by this value. If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.

virtual double vtkGaussianSplatter::GetScaleFactor ( )

virtual

Multiply Gaussian splat distribution by this value. If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function.

virtual void vtkGaussianSplatter::SetExponentFactor ( double  )

virtual

Set / get the sharpness of decay of the splats. This is the exponent constant in the Gaussian equation. Normally this is a negative value.

virtual double vtkGaussianSplatter::GetExponentFactor ( )

virtual

Set / get the sharpness of decay of the splats. This is the exponent constant in the Gaussian equation. Normally this is a negative value.

virtual void vtkGaussianSplatter::SetNormalWarping ( int  )

virtual

Turn on/off the generation of elliptical splats. If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

virtual int vtkGaussianSplatter::GetNormalWarping ( )

virtual

Turn on/off the generation of elliptical splats. If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

virtual void vtkGaussianSplatter::NormalWarpingOn ( )

virtual

Turn on/off the generation of elliptical splats. If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

virtual void vtkGaussianSplatter::NormalWarpingOff ( )

virtual

Turn on/off the generation of elliptical splats. If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

virtual void vtkGaussianSplatter::SetEccentricity ( double  )

virtual

Control the shape of elliptical splatting. Eccentricity is the ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes. So Eccentricity > 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates pancakes perpendicular to the normal vector.

virtual double vtkGaussianSplatter::GetEccentricity ( )

virtual

Control the shape of elliptical splatting. Eccentricity is the ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes. So Eccentricity > 1 creates needles with the long axis in the direction of the normal; Eccentricity<1 creates pancakes perpendicular to the normal vector.

virtual void vtkGaussianSplatter::SetScalarWarping ( int  )

virtual

Turn on/off the scaling of splats by scalar value.

virtual int vtkGaussianSplatter::GetScalarWarping ( )

virtual

Turn on/off the scaling of splats by scalar value.

virtual void vtkGaussianSplatter::ScalarWarpingOn ( )

virtual

Turn on/off the scaling of splats by scalar value.

virtual void vtkGaussianSplatter::ScalarWarpingOff ( )

virtual

Turn on/off the scaling of splats by scalar value.

virtual void vtkGaussianSplatter::SetCapping ( int  )

virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.

virtual int vtkGaussianSplatter::GetCapping ( )

virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.

virtual void vtkGaussianSplatter::CappingOn ( )

virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.

virtual void vtkGaussianSplatter::CappingOff ( )

virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value. This can be used to close surfaces (after iso-surfacing) and create other effects.

virtual void vtkGaussianSplatter::SetCapValue ( double  )

virtual

Specify the cap value to use. (This instance variable only has effect if the ivar Capping is on.)

virtual double vtkGaussianSplatter::GetCapValue ( )

virtual

Specify the cap value to use. (This instance variable only has effect if the ivar Capping is on.)

virtual void vtkGaussianSplatter::SetAccumulationMode ( int  )

virtual

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

virtual int vtkGaussianSplatter::GetAccumulationMode ( )

virtual

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

void vtkGaussianSplatter::SetAccumulationModeToMin ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

Definition at line 188 of file vtkGaussianSplatter.h.

void vtkGaussianSplatter::SetAccumulationModeToMax ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

Definition at line 190 of file vtkGaussianSplatter.h.

void vtkGaussianSplatter::SetAccumulationModeToSum ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

Definition at line 192 of file vtkGaussianSplatter.h.

const char* vtkGaussianSplatter::GetAccumulationModeAsString

(

)

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird.

virtual void vtkGaussianSplatter::SetNullValue ( double  )

virtual

Set the Null value for output points not receiving a contribution from the input points. (This is the initial value of the voxel samples.)

virtual double vtkGaussianSplatter::GetNullValue ( )

virtual

Set the Null value for output points not receiving a contribution from the input points. (This is the initial value of the voxel samples.)

void vtkGaussianSplatter::ComputeModelBounds	(	vtkDataSet *	input,
		vtkImageData *	output,
		vtkInformation *	outInfo
	)

Compute the size of the sample bounding box automatically from the input data. This is an internal helper function.

void vtkGaussianSplatter::ComputeModelBounds	(	vtkCompositeDataSet *	input,
		vtkImageData *	output,
		vtkInformation *	outInfo
	)

Compute the size of the sample bounding box automatically from the input data. This is an internal helper function.

double vtkGaussianSplatter::SamplePoint ( double  x[3] )

inline

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 220 of file vtkGaussianSplatter.h.

void vtkGaussianSplatter::SetScalar ( int  idx, double  dist2, double *  sPtr  )

inline

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 222 of file vtkGaussianSplatter.h.

virtual int vtkGaussianSplatter::FillInputPortInformation ( int  port, vtkInformation *  info  )

protectedvirtual

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Reimplemented from vtkImageAlgorithm.

virtual int vtkGaussianSplatter::RequestInformation ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protectedvirtual

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Reimplemented from vtkImageAlgorithm.

virtual int vtkGaussianSplatter::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

protectedvirtual

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Reimplemented from vtkImageAlgorithm.

void vtkGaussianSplatter::Cap ( vtkDoubleArray *  s )

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

double vtkGaussianSplatter::Gaussian ( double  x[3] )

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

double vtkGaussianSplatter::EccentricGaussian ( double  x[3] )

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

double vtkGaussianSplatter::ScalarSampling ( double  s )

inlineprotected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 284 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::PositionSampling ( double  )

inlineprotected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 286 of file vtkGaussianSplatter.h.

Friends And Related Function Documentation

friend class vtkGaussianSplatterAlgorithm

friend

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 219 of file vtkGaussianSplatter.h.

Member Data Documentation

int vtkGaussianSplatter::SampleDimensions[3]

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 270 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::Radius

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 271 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::ExponentFactor

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 272 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::ModelBounds[6]

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 273 of file vtkGaussianSplatter.h.

int vtkGaussianSplatter::NormalWarping

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 274 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::Eccentricity

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 275 of file vtkGaussianSplatter.h.

int vtkGaussianSplatter::ScalarWarping

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 276 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::ScaleFactor

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 277 of file vtkGaussianSplatter.h.

int vtkGaussianSplatter::Capping

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 278 of file vtkGaussianSplatter.h.

double vtkGaussianSplatter::CapValue

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 279 of file vtkGaussianSplatter.h.

int vtkGaussianSplatter::AccumulationMode

protected

Provide access to templated helper class. Note that SamplePoint() method is public here because some compilers don't handle friend functions properly.

Definition at line 280 of file vtkGaussianSplatter.h.

---

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

• dox/Imaging/Hybrid/vtkGaussianSplatter.h