VTK
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
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
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
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
vtkImageDataGetOutput ()
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
virtual void AddInput (vtkDataObject *)
 
virtual void AddInput (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
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 vtkFastSplatterSafeDownCast (vtkObject *o)
 
static vtkFastSplatterNew ()
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static int IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 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 AllocateOutputData (vtkImageData *out, int *uExtent)
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 
- 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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double ModelBounds [6]
 
int OutputDimensions [3]
 
int LimitMode
 
double MinValue
 
double MaxValue
 
double FrozenScale
 
vtkImageDataBuckets
 
double Origin [3]
 
double Spacing [3]
 
int NumberOfPointsSplatted
 
double LastDataMinValue
 
double LastDataMaxValue
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

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 52 of file vtkFastSplatter.h.

Member Typedef Documentation

Definition at line 55 of file vtkFastSplatter.h.

Member Enumeration Documentation

anonymous enum
Enumerator
NoneLimit 
ClampLimit 
ScaleLimit 
FreezeScaleLimit 

Definition at line 75 of file vtkFastSplatter.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual const char* vtkFastSplatter::GetClassName ( )
virtual

Reimplemented from vtkImageAlgorithm.

static int vtkFastSplatter::IsTypeOf ( const char *  type)
static
virtual int vtkFastSplatter::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 vtkFastSplatter* vtkFastSplatter::SafeDownCast ( vtkObject o)
static
static vtkFastSplatter* vtkFastSplatter::New ( )
static
virtual void vtkFastSplatter::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.

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 86 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 87 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 88 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 89 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

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.

virtual int vtkFastSplatter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

virtual int vtkFastSplatter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

double vtkFastSplatter::ModelBounds[6]
protected

Definition at line 115 of file vtkFastSplatter.h.

int vtkFastSplatter::OutputDimensions[3]
protected

Definition at line 116 of file vtkFastSplatter.h.

int vtkFastSplatter::LimitMode
protected

Definition at line 118 of file vtkFastSplatter.h.

double vtkFastSplatter::MinValue
protected

Definition at line 119 of file vtkFastSplatter.h.

double vtkFastSplatter::MaxValue
protected

Definition at line 120 of file vtkFastSplatter.h.

double vtkFastSplatter::FrozenScale
protected

Definition at line 121 of file vtkFastSplatter.h.

vtkImageData* vtkFastSplatter::Buckets
protected

Definition at line 123 of file vtkFastSplatter.h.

double vtkFastSplatter::Origin[3]
protected

Definition at line 138 of file vtkFastSplatter.h.

double vtkFastSplatter::Spacing[3]
protected

Definition at line 139 of file vtkFastSplatter.h.

int vtkFastSplatter::NumberOfPointsSplatted
protected

Definition at line 142 of file vtkFastSplatter.h.

double vtkFastSplatter::LastDataMinValue
protected

Definition at line 147 of file vtkFastSplatter.h.

double vtkFastSplatter::LastDataMaxValue
protected

Definition at line 148 of file vtkFastSplatter.h.


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