VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCheckerboardSplatter Class Reference

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

#include <vtkCheckerboardSplatter.h>

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

Public Types

typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCheckerboardSplatterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSampleDimensions (int i, int j, int k)
 Set / get the dimensions of the sampling structured point set. More...
 
void SetSampleDimensions (int dim[3])
 
virtual int * GetSampleDimensions ()
 
virtual void GetSampleDimensions (int data[3])
 
virtual void SetModelBounds (double, double, double, double, double, double)
 Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...
 
virtual void SetModelBounds (double[6])
 
virtual double * GetModelBounds ()
 
virtual void GetModelBounds (double data[6])
 
virtual void SetFootprint (int)
 Control the footprint size of the splat in terms of propagation across a voxel neighborhood. More...
 
virtual int GetFootprint ()
 
virtual void SetRadius (double)
 Set / get the radius variable that controls the Gaussian exponential function (see equation above). More...
 
virtual double GetRadius ()
 
virtual void SetScaleFactor (double)
 Multiply Gaussian splat distribution by this value. More...
 
virtual double GetScaleFactor ()
 
virtual void SetExponentFactor (double)
 Set / get the sharpness of decay of the splats. More...
 
virtual double GetExponentFactor ()
 
virtual void SetScalarWarping (vtkTypeBool)
 Turn on/off the scaling of splats by scalar value. More...
 
virtual vtkTypeBool GetScalarWarping ()
 
virtual void ScalarWarpingOn ()
 
virtual void ScalarWarpingOff ()
 
virtual void SetNormalWarping (vtkTypeBool)
 Turn on/off the generation of elliptical splats. More...
 
virtual vtkTypeBool GetNormalWarping ()
 
virtual void NormalWarpingOn ()
 
virtual void NormalWarpingOff ()
 
virtual void SetEccentricity (double)
 Control the shape of elliptical splatting. More...
 
virtual double GetEccentricity ()
 
virtual void SetAccumulationMode (int)
 Specify the scalar accumulation mode. More...
 
virtual int GetAccumulationMode ()
 
void SetAccumulationModeToMin ()
 
void SetAccumulationModeToMax ()
 
void SetAccumulationModeToSum ()
 
const char * GetAccumulationModeAsString ()
 
virtual void SetOutputScalarType (int)
 Set what type of scalar data this source should generate. More...
 
virtual int GetOutputScalarType ()
 
void SetOutputScalarTypeToDouble ()
 
void SetOutputScalarTypeToFloat ()
 
virtual void SetCapping (vtkTypeBool)
 Turn on/off the capping of the outer boundary of the volume to a specified cap value. More...
 
virtual vtkTypeBool GetCapping ()
 
virtual void CappingOn ()
 
virtual void CappingOff ()
 
virtual void SetCapValue (double)
 Specify the cap value to use. More...
 
virtual double GetCapValue ()
 
virtual void SetNullValue (double)
 Set the Null value for output points not receiving a contribution from the input points. More...
 
virtual double GetNullValue ()
 
virtual void SetMaximumDimension (int)
 Set/Get the maximum dimension of the checkerboard (i.e., the number of squares in any of the i, j, or k directions). More...
 
virtual int GetMaximumDimension ()
 
virtual void SetParallelSplatCrossover (int)
 Set/get the crossover point expressed in footprint size where the splatting operation is parallelized (through vtkSMPTools). More...
 
virtual int GetParallelSplatCrossover ()
 
void ComputeModelBounds (vtkDataSet *input, vtkImageData *output, vtkInformation *outInfo)
 Compute the size of the sample bounding box automatically from the input data. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCheckerboardSplatterSafeDownCast (vtkObjectBase *o)
 
static vtkCheckerboardSplatterNew ()
 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. More...
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCheckerboardSplatter ()
 
 ~vtkCheckerboardSplatter () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called in response to a REQUEST_DATA request from the executive. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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]
 
vtkTypeBool NormalWarping
 
double Eccentricity
 
vtkTypeBool ScalarWarping
 
double ScaleFactor
 
vtkTypeBool Capping
 
double CapValue
 
int AccumulationMode
 
double NullValue
 
unsigned char MaximumDimension
 
int ParallelSplatCrossover
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

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

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

Definition at line 108 of file vtkCheckerboardSplatter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 111 of file vtkCheckerboardSplatter.h.

Constructor & Destructor Documentation

◆ vtkCheckerboardSplatter()

vtkCheckerboardSplatter::vtkCheckerboardSplatter ( )
protected

◆ ~vtkCheckerboardSplatter()

vtkCheckerboardSplatter::~vtkCheckerboardSplatter ( )
inlineoverrideprotected

Definition at line 313 of file vtkCheckerboardSplatter.h.

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCheckerboardSplatter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

◆ NewInstance()

vtkCheckerboardSplatter* vtkCheckerboardSplatter::NewInstance ( ) const

◆ PrintSelf()

void vtkCheckerboardSplatter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ New()

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.

◆ SetSampleDimensions() [1/2]

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.

◆ SetSampleDimensions() [2/2]

void vtkCheckerboardSplatter::SetSampleDimensions ( int  dim[3])

◆ GetSampleDimensions() [1/2]

virtual int* vtkCheckerboardSplatter::GetSampleDimensions ( )
virtual

◆ GetSampleDimensions() [2/2]

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

◆ SetModelBounds() [1/2]

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.

◆ SetModelBounds() [2/2]

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

◆ GetModelBounds() [1/2]

virtual double* vtkCheckerboardSplatter::GetModelBounds ( )
virtual

◆ GetModelBounds() [2/2]

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

◆ SetFootprint()

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

◆ GetFootprint()

virtual int vtkCheckerboardSplatter::GetFootprint ( )
virtual

◆ SetRadius()

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

◆ GetRadius()

virtual double vtkCheckerboardSplatter::GetRadius ( )
virtual

◆ SetScaleFactor()

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.

◆ GetScaleFactor()

virtual double vtkCheckerboardSplatter::GetScaleFactor ( )
virtual

◆ SetExponentFactor()

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.

◆ GetExponentFactor()

virtual double vtkCheckerboardSplatter::GetExponentFactor ( )
virtual

◆ SetScalarWarping()

virtual void vtkCheckerboardSplatter::SetScalarWarping ( vtkTypeBool  )
virtual

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

◆ GetScalarWarping()

virtual vtkTypeBool vtkCheckerboardSplatter::GetScalarWarping ( )
virtual

◆ ScalarWarpingOn()

virtual void vtkCheckerboardSplatter::ScalarWarpingOn ( )
virtual

◆ ScalarWarpingOff()

virtual void vtkCheckerboardSplatter::ScalarWarpingOff ( )
virtual

◆ SetNormalWarping()

virtual void vtkCheckerboardSplatter::SetNormalWarping ( vtkTypeBool  )
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.

◆ GetNormalWarping()

virtual vtkTypeBool vtkCheckerboardSplatter::GetNormalWarping ( )
virtual

◆ NormalWarpingOn()

virtual void vtkCheckerboardSplatter::NormalWarpingOn ( )
virtual

◆ NormalWarpingOff()

virtual void vtkCheckerboardSplatter::NormalWarpingOff ( )
virtual

◆ SetEccentricity()

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.

◆ GetEccentricity()

virtual double vtkCheckerboardSplatter::GetEccentricity ( )
virtual

◆ SetAccumulationMode()

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.

◆ GetAccumulationMode()

virtual int vtkCheckerboardSplatter::GetAccumulationMode ( )
virtual

◆ SetAccumulationModeToMin()

void vtkCheckerboardSplatter::SetAccumulationModeToMin ( )
inline

Definition at line 231 of file vtkCheckerboardSplatter.h.

◆ SetAccumulationModeToMax()

void vtkCheckerboardSplatter::SetAccumulationModeToMax ( )
inline

Definition at line 232 of file vtkCheckerboardSplatter.h.

◆ SetAccumulationModeToSum()

void vtkCheckerboardSplatter::SetAccumulationModeToSum ( )
inline

Definition at line 233 of file vtkCheckerboardSplatter.h.

◆ GetAccumulationModeAsString()

const char* vtkCheckerboardSplatter::GetAccumulationModeAsString ( )

◆ SetOutputScalarType()

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.

◆ GetOutputScalarType()

virtual int vtkCheckerboardSplatter::GetOutputScalarType ( )
virtual

◆ SetOutputScalarTypeToDouble()

void vtkCheckerboardSplatter::SetOutputScalarTypeToDouble ( )
inline

Definition at line 245 of file vtkCheckerboardSplatter.h.

◆ SetOutputScalarTypeToFloat()

void vtkCheckerboardSplatter::SetOutputScalarTypeToFloat ( )
inline

Definition at line 246 of file vtkCheckerboardSplatter.h.

◆ SetCapping()

virtual void vtkCheckerboardSplatter::SetCapping ( vtkTypeBool  )
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.

◆ GetCapping()

virtual vtkTypeBool vtkCheckerboardSplatter::GetCapping ( )
virtual

◆ CappingOn()

virtual void vtkCheckerboardSplatter::CappingOn ( )
virtual

◆ CappingOff()

virtual void vtkCheckerboardSplatter::CappingOff ( )
virtual

◆ SetCapValue()

virtual void vtkCheckerboardSplatter::SetCapValue ( double  )
virtual

Specify the cap value to use.

(This instance variable only has effect if the ivar Capping is on.)

◆ GetCapValue()

virtual double vtkCheckerboardSplatter::GetCapValue ( )
virtual

◆ SetNullValue()

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.

◆ GetNullValue()

virtual double vtkCheckerboardSplatter::GetNullValue ( )
virtual

◆ SetMaximumDimension()

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

◆ GetMaximumDimension()

virtual int vtkCheckerboardSplatter::GetMaximumDimension ( )
virtual

◆ SetParallelSplatCrossover()

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.

◆ GetParallelSplatCrossover()

virtual int vtkCheckerboardSplatter::GetParallelSplatCrossover ( )
virtual

◆ ComputeModelBounds()

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.

◆ FillInputPortInformation()

int vtkCheckerboardSplatter::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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.

◆ RequestInformation()

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

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

Reimplemented from vtkImageAlgorithm.

◆ RequestData()

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

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

◆ OutputScalarType

int vtkCheckerboardSplatter::OutputScalarType
protected

Definition at line 319 of file vtkCheckerboardSplatter.h.

◆ SampleDimensions

int vtkCheckerboardSplatter::SampleDimensions[3]
protected

Definition at line 320 of file vtkCheckerboardSplatter.h.

◆ Radius

double vtkCheckerboardSplatter::Radius
protected

Definition at line 321 of file vtkCheckerboardSplatter.h.

◆ Footprint

int vtkCheckerboardSplatter::Footprint
protected

Definition at line 322 of file vtkCheckerboardSplatter.h.

◆ ExponentFactor

double vtkCheckerboardSplatter::ExponentFactor
protected

Definition at line 323 of file vtkCheckerboardSplatter.h.

◆ ModelBounds

double vtkCheckerboardSplatter::ModelBounds[6]
protected

Definition at line 324 of file vtkCheckerboardSplatter.h.

◆ Origin

double vtkCheckerboardSplatter::Origin[3]
protected

Definition at line 325 of file vtkCheckerboardSplatter.h.

◆ Spacing

double vtkCheckerboardSplatter::Spacing[3]
protected

Definition at line 325 of file vtkCheckerboardSplatter.h.

◆ NormalWarping

vtkTypeBool vtkCheckerboardSplatter::NormalWarping
protected

Definition at line 326 of file vtkCheckerboardSplatter.h.

◆ Eccentricity

double vtkCheckerboardSplatter::Eccentricity
protected

Definition at line 327 of file vtkCheckerboardSplatter.h.

◆ ScalarWarping

vtkTypeBool vtkCheckerboardSplatter::ScalarWarping
protected

Definition at line 328 of file vtkCheckerboardSplatter.h.

◆ ScaleFactor

double vtkCheckerboardSplatter::ScaleFactor
protected

Definition at line 329 of file vtkCheckerboardSplatter.h.

◆ Capping

vtkTypeBool vtkCheckerboardSplatter::Capping
protected

Definition at line 330 of file vtkCheckerboardSplatter.h.

◆ CapValue

double vtkCheckerboardSplatter::CapValue
protected

Definition at line 331 of file vtkCheckerboardSplatter.h.

◆ AccumulationMode

int vtkCheckerboardSplatter::AccumulationMode
protected

Definition at line 332 of file vtkCheckerboardSplatter.h.

◆ NullValue

double vtkCheckerboardSplatter::NullValue
protected

Definition at line 333 of file vtkCheckerboardSplatter.h.

◆ MaximumDimension

unsigned char vtkCheckerboardSplatter::MaximumDimension
protected

Definition at line 334 of file vtkCheckerboardSplatter.h.

◆ ParallelSplatCrossover

int vtkCheckerboardSplatter::ParallelSplatCrossover
protected

Definition at line 335 of file vtkCheckerboardSplatter.h.


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