vtkCheckerboardSplatter Class Reference

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

#include <vtkCheckerboardSplatter.h>

Inheritance diagram for vtkCheckerboardSplatter:

Collaboration diagram for vtkCheckerboardSplatter:

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)
vtkCheckerboardSplatter *	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	SetFootprint (int)
virtual int	GetFootprint ()
virtual void	SetRadius (double)
virtual double	GetRadius ()
virtual void	SetScaleFactor (double)
virtual double	GetScaleFactor ()
virtual void	SetExponentFactor (double)
virtual double	GetExponentFactor ()
virtual void	SetScalarWarping (int)
virtual int	GetScalarWarping ()
virtual void	ScalarWarpingOn ()
virtual void	ScalarWarpingOff ()
virtual void	SetNormalWarping (int)
virtual int	GetNormalWarping ()
virtual void	NormalWarpingOn ()
virtual void	NormalWarpingOff ()
virtual void	SetEccentricity (double)
virtual double	GetEccentricity ()
virtual void	SetAccumulationMode (int)
virtual int	GetAccumulationMode ()
void	SetAccumulationModeToMin ()
void	SetAccumulationModeToMax ()
void	SetAccumulationModeToSum ()
const char *	GetAccumulationModeAsString ()
virtual void	SetOutputScalarType (int)
virtual int	GetOutputScalarType ()
void	SetOutputScalarTypeToDouble ()
void	SetOutputScalarTypeToFloat ()
virtual void	SetCapping (int)
virtual int	GetCapping ()
virtual void	CappingOn ()
virtual void	CappingOff ()
virtual void	SetCapValue (double)
virtual double	GetCapValue ()
virtual void	SetNullValue (double)
virtual double	GetNullValue ()
virtual void	SetMaximumDimension (int)
virtual int	GetMaximumDimension ()
virtual void	SetParallelSplatCrossover (int)
virtual int	GetParallelSplatCrossover ()
void	ComputeModelBounds (vtkDataSet *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 vtkCheckerboardSplatter *	SafeDownCast (vtkObjectBase *o)
static vtkCheckerboardSplatter *	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
	vtkCheckerboardSplatter ()
	~vtkCheckerboardSplatter ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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 &)

Protected Attributes
int	OutputScalarType
int	SampleDimensions [3]
double	Radius
int	Footprint
double	ExponentFactor
double	ModelBounds [6]
double	Origin [3]
double	Spacing [3]
int	NormalWarping
double	Eccentricity
int	ScalarWarping
double	ScaleFactor
int	Capping
double	CapValue
int	AccumulationMode
double	NullValue
unsigned char	MaximumDimension
int	ParallelSplatCrossover
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

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

splat points into a volume with an elliptical, Gaussian distribution

vtkCheckerboardSplatter is a filter that injects input points into a structured points (volume) dataset using a multithreaded 8-way checkerboard approach. It produces a scalar field of a specified type. 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). This algorithm is designed for scalability through multithreading.

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

This class makes use of vtkSMPTools to implement a parallel, shared-memory implementation. Hence performance will be significantly improved if VTK is built with VTK_SMP_IMPLEMENTATION_TYPE set to something other than "Sequential" (typically TBB). For example, on a standard laptop with four threads it is common to see a >10x speedup as compared to the serial version of vtkGaussianSplatter.

In summary, the algorithm operates by dividing the volume into a 3D checkerboard, where the squares of the checkerboard overlay voxels in the volume. The checkerboard overlay is designed as a function of the splat footprint, so that when splatting occurs in a group (or color) of checkerboard squares, the splat operation will not cause write contention as the splatting proceeds in parallel. There are eight colors in this checkerboard (like an octree) and parallel splatting occurs simultaneously in one of the eight colors (e.g., octants). A single splat operation (across the given 3D footprint) may also be parallelized if the splat is large enough.

Warning

The input to this filter is of type vtkPointSet. Currently only real types (e.g., float, double) are supported as input, but this could easily be extended to other types. The output type is limited to real types as well.

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. Note that NullValue is also the initial value of the output voxel values and will affect the accumulation process.

While this class is very similar to vtkGaussianSplatter, it does produce slightly different output in most cases (due to the way the footprint is computed).

See also

vtkShepardMethod vtkGaussianSplatter

Tests:

vtkCheckerboardSplatter (Tests)

Definition at line 110 of file vtkCheckerboardSplatter.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkCheckerboardSplatter::Superclass

Definition at line 113 of file vtkCheckerboardSplatter.h.

Constructor & Destructor Documentation

vtkCheckerboardSplatter::vtkCheckerboardSplatter ( )

protected

vtkCheckerboardSplatter::~vtkCheckerboardSplatter ( )

inlineprotected

Definition at line 290 of file vtkCheckerboardSplatter.h.

Member Function Documentation

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

static

virtual int vtkCheckerboardSplatter::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 vtkCheckerboardSplatter* vtkCheckerboardSplatter::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkCheckerboardSplatter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkCheckerboardSplatter* vtkCheckerboardSplatter::NewInstance

(

)

const

void vtkCheckerboardSplatter::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 vtkCheckerboardSplatter* vtkCheckerboardSplatter::New ( )

static

Construct object with dimensions=(50,50,50); automatic computation of bounds; a Footprint of 2; a Radius of 0; an exponent factor of -5; and normal and scalar warping enabled; and Capping enabled.

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

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

void vtkCheckerboardSplatter::SetSampleDimensions

(

int

dim[3]

)

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

virtual int* vtkCheckerboardSplatter::GetSampleDimensions ( )

virtual

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

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

virtual

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

virtual void vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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* vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::SetFootprint ( int  )

virtual

Control the footprint size of the splat in terms of propagation across a voxel neighborhood. The Footprint value simply indicates the number of neigboring voxels in the i-j-k directions to extend the splat. A value of zero means that only the voxel containing the splat point is affected. A value of one means the immediate neighbors touching the affected voxel are affected as well. Larger numbers increase the splat footprint and significantly increase processing time. Note that the footprint is always 3D rectangular.

virtual int vtkCheckerboardSplatter::GetFootprint ( )

virtual

Control the footprint size of the splat in terms of propagation across a voxel neighborhood. The Footprint value simply indicates the number of neigboring voxels in the i-j-k directions to extend the splat. A value of zero means that only the voxel containing the splat point is affected. A value of one means the immediate neighbors touching the affected voxel are affected as well. Larger numbers increase the splat footprint and significantly increase processing time. Note that the footprint is always 3D rectangular.

virtual void vtkCheckerboardSplatter::SetRadius ( double  )

virtual

Set / get the radius variable that controls the Gaussian exponential function (see equation above). If set to zero, it is automatically set to the radius of the circumsphere bounding a single voxel. (By default, the Radius is set to zero and is automatically computed.)

virtual double vtkCheckerboardSplatter::GetRadius ( )

virtual

Set / get the radius variable that controls the Gaussian exponential function (see equation above). If set to zero, it is automatically set to the radius of the circumsphere bounding a single voxel. (By default, the Radius is set to zero and is automatically computed.)

virtual void vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::SetExponentFactor ( double  )

virtual

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

virtual double vtkCheckerboardSplatter::GetExponentFactor ( )

virtual

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

virtual void vtkCheckerboardSplatter::SetScalarWarping ( int  )

virtual

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

virtual int vtkCheckerboardSplatter::GetScalarWarping ( )

virtual

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

virtual void vtkCheckerboardSplatter::ScalarWarpingOn ( )

virtual

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

virtual void vtkCheckerboardSplatter::ScalarWarpingOff ( )

virtual

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

virtual void vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::SetAccumulationMode ( int  )

virtual

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

virtual int vtkCheckerboardSplatter::GetAccumulationMode ( )

virtual

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

void vtkCheckerboardSplatter::SetAccumulationModeToMin ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 213 of file vtkCheckerboardSplatter.h.

void vtkCheckerboardSplatter::SetAccumulationModeToMax ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 215 of file vtkCheckerboardSplatter.h.

void vtkCheckerboardSplatter::SetAccumulationModeToSum ( )

inline

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 217 of file vtkCheckerboardSplatter.h.

const char* vtkCheckerboardSplatter::GetAccumulationModeAsString

(

)

Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats overlap one another. 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 (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

virtual void vtkCheckerboardSplatter::SetOutputScalarType ( int  )

virtual

Set what type of scalar data this source should generate. Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

virtual int vtkCheckerboardSplatter::GetOutputScalarType ( )

virtual

Set what type of scalar data this source should generate. Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

void vtkCheckerboardSplatter::SetOutputScalarTypeToDouble ( )

inline

Set what type of scalar data this source should generate. Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

Definition at line 228 of file vtkCheckerboardSplatter.h.

void vtkCheckerboardSplatter::SetOutputScalarTypeToFloat ( )

inline

Set what type of scalar data this source should generate. Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

Definition at line 230 of file vtkCheckerboardSplatter.h.

virtual void vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::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 vtkCheckerboardSplatter::SetCapValue ( double  )

virtual

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

virtual double vtkCheckerboardSplatter::GetCapValue ( )

virtual

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

virtual void vtkCheckerboardSplatter::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, by default it is set to zero.) Note that the value should be consistent with the output dataset type. The NullValue also provides the initial value on which the accumulations process operates.

virtual double vtkCheckerboardSplatter::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, by default it is set to zero.) Note that the value should be consistent with the output dataset type. The NullValue also provides the initial value on which the accumulations process operates.

virtual void vtkCheckerboardSplatter::SetMaximumDimension ( int  )

virtual

Set/Get the maximum dimension of the checkerboard (i.e., the number of squares in any of the i, j, or k directions). This number also impacts the granularity of the parallel threading (since each checker square is processed separaely). Because of the internal addressing, the maximum dimension is limited to 255 (maximum value of an unsigned char).

virtual int vtkCheckerboardSplatter::GetMaximumDimension ( )

virtual

Set/Get the maximum dimension of the checkerboard (i.e., the number of squares in any of the i, j, or k directions). This number also impacts the granularity of the parallel threading (since each checker square is processed separaely). Because of the internal addressing, the maximum dimension is limited to 255 (maximum value of an unsigned char).

virtual void vtkCheckerboardSplatter::SetParallelSplatCrossover ( int  )

virtual

Set/get the crossover point expressed in footprint size where the splatting operation is parallelized (through vtkSMPTools). By default the parallel crossover point is for splat footprints of size two or greater (i.e., at footprint=2 then splat is 5x5x5 and parallel splatting occurs). This is really meant for experimental purposes.

virtual int vtkCheckerboardSplatter::GetParallelSplatCrossover ( )

virtual

Set/get the crossover point expressed in footprint size where the splatting operation is parallelized (through vtkSMPTools). By default the parallel crossover point is for splat footprints of size two or greater (i.e., at footprint=2 then splat is 5x5x5 and parallel splatting occurs). This is really meant for experimental purposes.

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

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

protectedvirtual

These method should be reimplemented by subclasses that have more than a single input or single output. See vtkAlgorithm for more information.

Reimplemented from vtkImageAlgorithm.

virtual int vtkCheckerboardSplatter::RequestInformation ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

virtual int vtkCheckerboardSplatter::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

int vtkCheckerboardSplatter::OutputScalarType

protected

Definition at line 300 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::SampleDimensions[3]

protected

Definition at line 301 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::Radius

protected

Definition at line 302 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::Footprint

protected

Definition at line 303 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::ExponentFactor

protected

Definition at line 304 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::ModelBounds[6]

protected

Definition at line 305 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::Origin[3]

protected

Definition at line 306 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::Spacing[3]

protected

Definition at line 306 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::NormalWarping

protected

Definition at line 307 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::Eccentricity

protected

Definition at line 308 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::ScalarWarping

protected

Definition at line 309 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::ScaleFactor

protected

Definition at line 310 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::Capping

protected

Definition at line 311 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::CapValue

protected

Definition at line 312 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::AccumulationMode

protected

Definition at line 313 of file vtkCheckerboardSplatter.h.

double vtkCheckerboardSplatter::NullValue

protected

Definition at line 314 of file vtkCheckerboardSplatter.h.

unsigned char vtkCheckerboardSplatter::MaximumDimension

protected

Definition at line 315 of file vtkCheckerboardSplatter.h.

int vtkCheckerboardSplatter::ParallelSplatCrossover

protected

Definition at line 316 of file vtkCheckerboardSplatter.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Imaging/Hybrid/vtkCheckerboardSplatter.h