Documentation for vtkGaussianSplatter

vtkGaussianSplatter - splat points with Gaussian distribution

Super Class: vtkDataSetToStructuredPointsFilter

Description:

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

 

Methods:

void vtkGaussianSplatter ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkGaussianSplatter *New ()
void ComputeModelBounds ()
void SetSampleDimensions (int ,int ,int )
void SetSampleDimensions (int )
int *GetSampleDimensions ()
void SetRadius (float )
float GetRadius ()
void SetScaleFactor (float )
float GetScaleFactor ()
void SetExponentFactor (float )
float GetExponentFactor ()
void SetEccentricity (float )
float GetEccentricity ()
void SetModelBounds (float ,float ,float ,float ,float ,float )
void SetModelBounds (float *)
float *GetModelBounds ()
void SetNormalWarping (int )
int GetNormalWarping ()
void NormalWarpingOn ()
void NormalWarpingOff ()
void SetScalarWarping (int )
int GetScalarWarping ()
void ScalarWarpingOn ()
void ScalarWarpingOff ()
void SetCapping (int )
int GetCapping ()
void CappingOn ()
void CappingOff ()
void SetCapValue (float )
float GetCapValue ()
void Execute ()
void Cap (vtkScalars *)
void SplitIJK (int ,int ,int ,int ,int ,int )
void SplitIJ (int ,int ,int ,int ,int )
void SplitIK (int ,int ,int ,int ,int )
void SplitJK (int ,int ,int ,int ,int )
void SplitI (int ,int ,int ,int )
void SplitJ (int ,int ,int ,int )
void SplitK (int ,int ,int ,int )
float Gaussian (float )
float EccentricGaussian (float )
float ScalarSampling (float )
float PositionSampling (float )
void SetScalar (int ,float )

 

Detailed Method Descriptions:

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.

static vtkGaussianSplatter *New ()

Compute the size of the sample bounding box automatically from the input data.

void ComputeModelBounds ()

Set / get the dimensions of the sampling structured point set.

void SetSampleDimensions (int ,int ,int )
void SetSampleDimensions (int )
int *GetSampleDimensions ()

Set / get the radius of propagation of the splat. This value is expressed as a percentage of the sampling structured point set. Smaller numbers greatly reduce execution time.

void SetRadius (float )
float GetRadius ()

Multiply Gaussian splat distribution by this value.

void SetScaleFactor (float )
float GetScaleFactor ()

Set / get the sharpness of decay of the splats

void SetExponentFactor (float )
float GetExponentFactor ()

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.

void SetEccentricity (float )
float GetEccentricity ()

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed.

void SetModelBounds (float ,float ,float ,float ,float ,float )
void SetModelBounds (float *)
float *GetModelBounds ()

Turn on/off the generation of elliptical splats.

void SetNormalWarping (int )
int GetNormalWarping ()
void NormalWarpingOn ()
void NormalWarpingOff ()

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

void SetScalarWarping (int )
int GetScalarWarping ()
void ScalarWarpingOn ()
void ScalarWarpingOff ()

Turn on/off the capping of the outside parts of the structured point set by setting to a specified cap value.

void SetCapping (int )
int GetCapping ()
void CappingOn ()
void CappingOff ()

Specify the cap value to use.

void SetCapValue (float )
float GetCapValue ()