VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFastSplatter Class Reference

A splatter optimized for splatting single kernels. More...

#include <vtkFastSplatter.h>

Inheritance diagram for vtkFastSplatter:
[legend]
Collaboration diagram for vtkFastSplatter:
[legend]

Public Types

enum  { NoneLimit, ClampLimit, ScaleLimit, FreezeScaleLimit }
 
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 Member Functions

virtual int IsA (const char *type)
 
vtkFastSplatterNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSplatConnection (vtkAlgorithmOutput *)
 
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 SetOutputDimensions (int, int, int)
 
virtual void SetOutputDimensions (int[3])
 
virtual int * GetOutputDimensions ()
 
virtual void GetOutputDimensions (int &, int &, int &)
 
virtual void GetOutputDimensions (int[3])
 
virtual void SetLimitMode (int)
 
virtual int GetLimitMode ()
 
void SetLimitModeToNone ()
 
void SetLimitModeToClamp ()
 
void SetLimitModeToScale ()
 
void SetLimitModeToFreezeScale ()
 
virtual void SetMinValue (double)
 
virtual double GetMinValue ()
 
virtual void SetMaxValue (double)
 
virtual double GetMaxValue ()
 
virtual int GetNumberOfPointsSplatted ()
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkImageData * GetOutput ()
 
vtkImageData * GetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkImageData * GetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
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)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkFastSplatterSafeDownCast (vtkObjectBase *o)
 
static vtkFastSplatterNew ()
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static int IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
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 * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkFastSplatter ()
 
virtual ~vtkFastSplatter ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm ()
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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 Attributes

double ModelBounds [6]
 
int OutputDimensions [3]
 
int LimitMode
 
double MinValue
 
double MaxValue
 
double FrozenScale
 
vtkImageData * Buckets
 
double Origin [3]
 
double Spacing [3]
 
int NumberOfPointsSplatted
 
double LastDataMinValue
 
double LastDataMaxValue
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

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 vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

A splatter optimized for splatting single kernels.

vtkFastSplatter takes any vtkPointSet as input (of which vtkPolyData and vtkUnstructuredGrid inherit). Each point in the data set is considered to be an impulse. These impulses are convolved with a given splat image. In other words, the splat image is added to the final image at every place where there is an input point.

Note that point and cell data are thrown away. If you want a sampling of unstructured points consider vtkGaussianSplatter or vtkShepardMethod.

Use input port 0 for the impulse data (vtkPointSet), and input port 1 for the splat image (vtkImageData)

Bug:
Any point outside of the extents of the image is thrown away, even if it is close enough such that it's convolution with the splat image would overlap the extents.
Tests:
vtkFastSplatter (Tests)

Definition at line 53 of file vtkFastSplatter.h.

Member Typedef Documentation

Definition at line 56 of file vtkFastSplatter.h.

Member Enumeration Documentation

anonymous enum
Enumerator
NoneLimit 
ClampLimit 
ScaleLimit 
FreezeScaleLimit 

Definition at line 76 of file vtkFastSplatter.h.

Constructor & Destructor Documentation

vtkFastSplatter::vtkFastSplatter ( )
protected
virtual vtkFastSplatter::~vtkFastSplatter ( )
protectedvirtual

Member Function Documentation

static int vtkFastSplatter::IsTypeOf ( const char *  type)
static
virtual int vtkFastSplatter::IsA ( const char *  type)
virtual

Reimplemented from vtkImageAlgorithm.

static vtkFastSplatter* vtkFastSplatter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkFastSplatter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkFastSplatter* vtkFastSplatter::NewInstance ( ) const
static vtkFastSplatter* vtkFastSplatter::New ( )
static
virtual void vtkFastSplatter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
virtual void vtkFastSplatter::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 vtkFastSplatter::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* vtkFastSplatter::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 vtkFastSplatter::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 vtkFastSplatter::SetOutputDimensions ( int  ,
int  ,
int   
)
virtual

Set/get the dimensions of the output image

virtual void vtkFastSplatter::SetOutputDimensions ( int  [3])
virtual

Set/get the dimensions of the output image

virtual int* vtkFastSplatter::GetOutputDimensions ( )
virtual

Set/get the dimensions of the output image

virtual void vtkFastSplatter::GetOutputDimensions ( int &  ,
int &  ,
int &   
)
virtual

Set/get the dimensions of the output image

virtual void vtkFastSplatter::GetOutputDimensions ( int  [3])
virtual

Set/get the dimensions of the output image

virtual void vtkFastSplatter::SetLimitMode ( int  )
virtual

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

virtual int vtkFastSplatter::GetLimitMode ( )
virtual

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

void vtkFastSplatter::SetLimitModeToNone ( )
inline

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

Definition at line 87 of file vtkFastSplatter.h.

void vtkFastSplatter::SetLimitModeToClamp ( )
inline

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

Definition at line 88 of file vtkFastSplatter.h.

void vtkFastSplatter::SetLimitModeToScale ( )
inline

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

Definition at line 89 of file vtkFastSplatter.h.

void vtkFastSplatter::SetLimitModeToFreezeScale ( )
inline

Set/get the way voxel values will be limited. If this is set to None (the default), the output can have arbitrarily large values. If set to clamp, the output will be clamped to [MinValue,MaxValue]. If set to scale, the output will be linearly scaled between MinValue and MaxValue.

Definition at line 90 of file vtkFastSplatter.h.

virtual void vtkFastSplatter::SetMinValue ( double  )
virtual

See the LimitMode method.

virtual double vtkFastSplatter::GetMinValue ( )
virtual

See the LimitMode method.

virtual void vtkFastSplatter::SetMaxValue ( double  )
virtual

See the LimitMode method.

virtual double vtkFastSplatter::GetMaxValue ( )
virtual

See the LimitMode method.

virtual int vtkFastSplatter::GetNumberOfPointsSplatted ( )
virtual

This returns the number of points splatted (as opposed to discarded for being outside the image) during the previous pass.

void vtkFastSplatter::SetSplatConnection ( vtkAlgorithmOutput )

Convenience function for connecting the splat algorithm source. This is provided mainly for convenience using the filter with ParaView, VTK users should prefer SetInputConnection(1, splat) instead.

virtual int vtkFastSplatter::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 vtkFastSplatter::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 vtkFastSplatter::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.

Reimplemented from vtkImageAlgorithm.

virtual int vtkFastSplatter::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

double vtkFastSplatter::ModelBounds[6]
protected

Definition at line 116 of file vtkFastSplatter.h.

int vtkFastSplatter::OutputDimensions[3]
protected

Definition at line 117 of file vtkFastSplatter.h.

int vtkFastSplatter::LimitMode
protected

Definition at line 119 of file vtkFastSplatter.h.

double vtkFastSplatter::MinValue
protected

Definition at line 120 of file vtkFastSplatter.h.

double vtkFastSplatter::MaxValue
protected

Definition at line 121 of file vtkFastSplatter.h.

double vtkFastSplatter::FrozenScale
protected

Definition at line 122 of file vtkFastSplatter.h.

vtkImageData* vtkFastSplatter::Buckets
protected

Definition at line 124 of file vtkFastSplatter.h.

double vtkFastSplatter::Origin[3]
protected

Definition at line 139 of file vtkFastSplatter.h.

double vtkFastSplatter::Spacing[3]
protected

Definition at line 140 of file vtkFastSplatter.h.

int vtkFastSplatter::NumberOfPointsSplatted
protected

Definition at line 143 of file vtkFastSplatter.h.

double vtkFastSplatter::LastDataMinValue
protected

Definition at line 148 of file vtkFastSplatter.h.

double vtkFastSplatter::LastDataMaxValue
protected

Definition at line 149 of file vtkFastSplatter.h.


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