VTK: vtkCheckerboardSplatter Class Reference

| VTK 9.3.1

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...
vtkCheckerboardSplatter * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
void | ComputeModelBounds (vtkDataSet *input, vtkImageData *output, vtkInformation *outInfo)
| Compute the size of the sample bounding box automatically from the input data. 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])
| Set / get the dimensions of the sampling structured point set. More...
virtual int * | GetSampleDimensions ()
| Set / get the dimensions of the sampling structured point set. More...
virtual void | GetSampleDimensions (int data[3])
| Set / get the dimensions of the sampling structured point set. More...
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])
| Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...
virtual double * | GetModelBounds ()
| Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...
virtual void | GetModelBounds (double data[6])
| Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...
virtual void | SetFootprint (int)
| Control the footprint size of the splat in terms of propagation across a voxel neighborhood. More...
virtual int | GetFootprint ()
| Control the footprint size of the splat in terms of propagation across a voxel neighborhood. More...
virtual void | SetRadius (double)
| Set / get the radius variable that controls the Gaussian exponential function (see equation above). More...
virtual double | GetRadius ()
| Set / get the radius variable that controls the Gaussian exponential function (see equation above). More...
virtual void | SetScaleFactor (double)
| Multiply Gaussian splat distribution by this value. More...
virtual double | GetScaleFactor ()
| Multiply Gaussian splat distribution by this value. More...
virtual void | SetExponentFactor (double)
| Set / get the sharpness of decay of the splats. More...
virtual double | GetExponentFactor ()
| Set / get the sharpness of decay of the splats. More...
virtual void | SetScalarWarping (vtkTypeBool)
| Turn on/off the scaling of splats by scalar value. More...
virtual vtkTypeBool | GetScalarWarping ()
| Turn on/off the scaling of splats by scalar value. More...
virtual void | ScalarWarpingOn ()
| Turn on/off the scaling of splats by scalar value. More...
virtual void | ScalarWarpingOff ()
| Turn on/off the scaling of splats by scalar value. More...
virtual void | SetNormalWarping (vtkTypeBool)
| Turn on/off the generation of elliptical splats. More...
virtual vtkTypeBool | GetNormalWarping ()
| Turn on/off the generation of elliptical splats. More...
virtual void | NormalWarpingOn ()
| Turn on/off the generation of elliptical splats. More...
virtual void | NormalWarpingOff ()
| Turn on/off the generation of elliptical splats. More...
virtual void | SetEccentricity (double)
| Control the shape of elliptical splatting. More...
virtual double | GetEccentricity ()
| Control the shape of elliptical splatting. More...
virtual void | SetAccumulationMode (int)
| Specify the scalar accumulation mode. More...
virtual int | GetAccumulationMode ()
| Specify the scalar accumulation mode. More...
void | SetAccumulationModeToMin ()
| Specify the scalar accumulation mode. More...
void | SetAccumulationModeToMax ()
| Specify the scalar accumulation mode. More...
void | SetAccumulationModeToSum ()
| Specify the scalar accumulation mode. More...
const char * | GetAccumulationModeAsString ()
| Specify the scalar accumulation mode. More...
virtual void | SetOutputScalarType (int)
| Set what type of scalar data this source should generate. More...
virtual int | GetOutputScalarType ()
| Set what type of scalar data this source should generate. More...
void | SetOutputScalarTypeToDouble ()
| Set what type of scalar data this source should generate. More...
void | SetOutputScalarTypeToFloat ()
| Set what type of scalar data this source should generate. More...
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 ()
| Turn on/off the capping of the outer boundary of the volume to a specified cap value. More...
virtual void | CappingOn ()
| Turn on/off the capping of the outer boundary of the volume to a specified cap value. More...
virtual void | CappingOff ()
| Turn on/off the capping of the outer boundary of the volume to a specified cap value. More...
virtual void | SetCapValue (double)
| Specify the cap value to use. More...
virtual double | GetCapValue ()
| Specify the cap value to use. More...
virtual void | SetNullValue (double)
| Set the Null value for output points not receiving a contribution from the input points. More...
virtual double | GetNullValue ()
| Set the Null value for output points not receiving a contribution from the input points. More...
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 ()
| 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 void | SetParallelSplatCrossover (int)
| Set/get the crossover point expressed in footprint size where the splatting operation is parallelized (through vtkSMPTools). More...
virtual int | GetParallelSplatCrossover ()
| Set/get the crossover point expressed in footprint size where the splatting operation is parallelized (through vtkSMPTools). More...
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm * | NewInstance () const
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| Process a request from the executive. More...
vtkImageData * | GetOutput ()
| Get the output data object for a port on this algorithm. More...
vtkImageData * | GetOutput (int)
| Get the output data object for a port on this algorithm. More...
virtual void | SetOutput (vtkDataObject *d)
| Get the output data object for a port on this algorithm. More...
void | SetInputData (vtkDataObject *)
| Assign a data object as input. More...
void | SetInputData (int, vtkDataObject *)
| Assign a data object as input. More...
vtkDataObject * | GetInput (int port)
| Get a data object for one of the input port connections. More...
vtkDataObject * | GetInput ()
| Get a data object for one of the input port connections. More...
vtkImageData * | GetImageDataInput (int port)
| Get a data object for one of the input port connections. More...
virtual void | AddInputData (vtkDataObject *)
| Assign a data object as input. More...
virtual void | AddInputData (int, vtkDataObject *)
| Assign a data object as input. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | HasExecutive ()
| Check whether this algorithm has an assigned executive. More...
vtkExecutive * | GetExecutive ()
| 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...
vtkInformation * | GetInputPortInformation (int port)
| Get the information object associated with an input port. More...
vtkInformation * | GetOutputPortInformation (int port)
| Get the information object associated with an output port. More...
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 | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. More...
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
| String based versions of SetInputArrayToProcess(). More...
vtkInformation * | GetInputArrayInformation (int idx)
| Get the info object for the specified input array to this algorithm. More...
void | RemoveAllInputs ()
| Remove all the input data. More...
vtkDataObject * | GetOutputDataObject (int port)
| Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject * | GetInputDataObject (int port, int connection)
| Get the data object that will contain the algorithm input for the given port and given connection. More...
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)
vtkAlgorithmOutput * | GetOutputPort (int index)
| Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput * | GetOutputPort ()
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...
vtkAlgorithmOutput * | GetInputConnection (int port, int index)
| Get the algorithm output port connected to an input port. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort)
| Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index)
| Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm ()
| Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive * | GetInputExecutive (int port, int index)
| Returns the executive associated with a particular input connection. More...
vtkExecutive * | GetInputExecutive ()
| Equivalent to GetInputExecutive(0, 0) More...
vtkInformation * | GetInputInformation (int port, int index)
| Return the information object that is associated with a particular input connection. More...
vtkInformation * | GetInputInformation ()
| Equivalent to GetInputInformation(0, 0) More...
vtkInformation * | GetOutputInformation (int port)
| Return the information object that is associated with a particular output port. More...
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 vtkInformation * | GetInformation ()
| Set/Get the information object associated with this algorithm. More...
virtual void | SetInformation (vtkInformation *)
| Set/Get the information object associated with this algorithm. More...
bool | UsesGarbageCollector () const override
| Participate in garbage collection. More...
virtual void | SetAbortExecute (vtkTypeBool)
| Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool | GetAbortExecute ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOn ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOff ()
| Set/Get the AbortExecute flag for the process object. More...
virtual double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. 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 ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
void | SetProgressText (const char *ptext)
| Set the current text message associated with the progress state. More...
virtual char * | GetProgressText ()
| Set the current text message associated with the progress state. More...
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)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | SetInputConnection (vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | AddInputConnection (vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | Update (int port)
| Bring this algorithm's outputs up-to-date. More...
virtual void | Update ()
| Bring this algorithm's outputs up-to-date. More...
virtual void | SetReleaseDataFlag (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | GetReleaseDataFlag ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOn ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOff ()
| Turn release data flag on or off for all output ports. More...
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)
| 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 * | GetUpdateExtent ()
| These functions return the update extent for output ports that use 3D extents. More...
int * | GetUpdateExtent (int port)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
int | GetUpdatePiece ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdatePiece (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel (int port)
| These functions return the update extent for output ports that use piece extents. More...
void | SetProgressObserver (vtkProgressObserver *)
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver * | GetProgressObserver ()
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
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...
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)
vtkTypeBool | InvokeEvent (unsigned long event)
vtkTypeBool | InvokeEvent (const char *event)
std::string | GetObjectDescription () const override
| The object description printed in messages and PrintSelf output. 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)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand * | GetCommand (unsigned long tag)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObserver (vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
| 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, 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...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
Public Member Functions inherited from vtkObjectBase
const char * | GetClassName () const
| Return the class name as a string. More...
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name)
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
int | GetReferenceCount ()
| Return the current reference count of this object. More...
void | SetReferenceCount (int)
| Sets the reference count. More...
bool | GetIsInMemkind () const
| A local state flag that remembers whether this object lives in the normal or extended memory space. More...
virtual void | PrintHeader (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | PrintTrailer (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...

## Static Public Member Functions
static vtkTypeBool | IsTypeOf (const char *type)
static vtkCheckerboardSplatter * | SafeDownCast (vtkObjectBase *o)
static vtkCheckerboardSplatter * | New ()
| 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 vtkImageAlgorithm * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAlgorithm * | SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL ()
| Keys used to specify input port requirements. More...
static vtkInformationIntegerKey * | INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * | INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * | INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * | INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * | INPUT_PORT ()
static vtkInformationIntegerKey * | INPUT_CONNECTION ()
static vtkInformationIntegerKey * | CAN_PRODUCE_SUB_EXTENT ()
| This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey * | CAN_HANDLE_PIECE_REQUEST ()
| Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static vtkInformationIntegerKey * | ABORTED ()
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 vtkObject * | New ()
| 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 (vtkTypeBool val)
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOn ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOff ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static vtkTypeBool | GetGlobalWarningDisplay ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name)
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void | SetMemkindDirectory (const char *directoryname)
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool | GetUsingMemkind ()
| A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

## Protected Member Functions
virtual vtkObjectBase * | NewInstanceInternal () const
| vtkCheckerboardSplatter ()
| ~vtkCheckerboardSplatter () override=default
int | FillInputPortInformation (int port, vtkInformation *info) override
| These method should be reimplemented by subclasses that have more than a single input or single output. 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 | CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
| Copy the other point and cell data. 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 ()
| This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
virtual void | AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
| Allocate the output data. More...
virtual vtkImageData * | AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
| Allocate the output 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
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. More...
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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
| This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive * | CreateDefaultExecutive ()
| Create a default executive. 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)
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)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (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...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (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...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
virtual void | SetErrorCode (unsigned long)
| The error code contains a possible error that occurred while reading or writing the file. More...
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 ()
| These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
| vtkObjectBase ()
virtual | ~vtkObjectBase ()
| 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
vtkTimeStamp | LastAbortCheckTime
vtkInformation * | Information
double | Progress
char * | ProgressText
vtkProgressObserver * | ProgressObserver
unsigned long | ErrorCode
| The error code contains a possible error that occurred while reading or writing the file. More...
Protected Attributes inherited from vtkObject
bool | Debug
vtkTimeStamp | MTime
vtkSubjectHelper * | SubjectHelper
std::string | ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > | ReferenceCount
vtkWeakPointerBase ** | WeakPointers

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction | GetCurrentMallocFunction ()
static vtkReallocingFunction | GetCurrentReallocFunction ()
static vtkFreeingFunction | GetCurrentFreeFunction ()
static vtkFreeingFunction | GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

splat points into a volume with an elliptical, Gaussian distribution

vtkCheckerboardSplatter is a filter that injects input points into a structured points (volume) dataset using a multithreaded 8-way checkerboard approach. It produces a scalar field of a specified type. As each point is injected, it "splats" or distributes values to nearby voxels. Data is distributed using an elliptical, Gaussian distribution function. The distribution function is modified using scalar values (expands distribution) or normals (creates ellipsoidal distribution rather than spherical). This algorithm is designed for scalability through multithreading.

In general, the Gaussian distribution function f(x) around a given splat point p is given by

    f(x) = ScaleFactor * exp( ExponentFactor*((r/Radius)**2) )

where x is the current voxel sample point; r is the distance |x-p| ExponentFactor <= 0.0, and ScaleFactor can be multiplied by the scalar value of the point p that is currently being splatted.

If point normals are present (and NormalWarping is on), then the splat function becomes elliptical (as compared to the spherical one described by the previous equation). The Gaussian distribution function then becomes:

    f(x) = ScaleFactor *
              exp( ExponentFactor*( ((rxy/E)**2 + z**2)/R**2) )

where E is a user-defined eccentricity factor that controls the elliptical shape of the splat; z is the distance of the current voxel sample point along normal N; and rxy is the distance of x in the direction perpendicular to N.

This class is typically used to convert point-valued distributions into a volume representation. The volume is then usually iso-surfaced or volume rendered to generate a visualization. It can be used to create surfaces from point distributions, or to create structure (i.e., topology) when none exists.

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

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

Warning
  The input to this filter is of type vtkPointSet. Currently only real types (e.g., float, double) are supported as input, but this could easily be extended to other types. The output type is limited to real types as well.
  Some voxels may never receive a contribution during the splatting process. The final value of these points can be specified with the "NullValue" instance variable. Note that NullValue is also the initial value of the output voxel values and will affect the accumulation process.
  While this class is very similar to vtkGaussianSplatter, it does produce slightly different output in most cases (due to the way the footprint is computed).

See also
  vtkShepardMethod vtkGaussianSplatter

Tests:
  vtkCheckerboardSplatter (Tests)

Definition at line 100 of file vtkCheckerboardSplatter.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkImageAlgorithm vtkCheckerboardSplatter::Superclass

Definition at line 103 of file vtkCheckerboardSplatter.h.

## Constructor & Destructor Documentation

## ◆ vtkCheckerboardSplatter()

vtkCheckerboardSplatter::vtkCheckerboardSplatter | ( |  | ) |
| protected

## ◆ ~vtkCheckerboardSplatter()

vtkCheckerboardSplatter::~vtkCheckerboardSplatter | ( |  | ) |
| overrideprotecteddefault

## 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] | ) |

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

Higher values produce better results but may be much slower.

## ◆ GetSampleDimensions() [1/2]

virtual int* vtkCheckerboardSplatter::GetSampleDimensions | ( |  | ) |
| virtual

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

Higher values produce better results but may be much slower.

## ◆ GetSampleDimensions() [2/2]

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

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

Higher values produce better results but may be much slower.

## ◆ 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

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.

## ◆ GetModelBounds() [1/2]

virtual double* vtkCheckerboardSplatter::GetModelBounds | ( |  | ) |
| virtual

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

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

## ◆ GetModelBounds() [2/2]

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

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

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

## ◆ 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

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.

## ◆ 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

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

## ◆ 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

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.

## ◆ 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

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.

## ◆ SetScalarWarping()

virtual void vtkCheckerboardSplatter::SetScalarWarping | ( | vtkTypeBool |  | ) |
| virtual

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

## ◆ GetScalarWarping()

virtual vtkTypeBool vtkCheckerboardSplatter::GetScalarWarping | ( |  | ) |
| virtual

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

## ◆ ScalarWarpingOn()

virtual void vtkCheckerboardSplatter::ScalarWarpingOn | ( |  | ) |
| virtual

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

## ◆ ScalarWarpingOff()

virtual void vtkCheckerboardSplatter::ScalarWarpingOff | ( |  | ) |
| virtual

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

## ◆ 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

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.

## ◆ NormalWarpingOn()

virtual void vtkCheckerboardSplatter::NormalWarpingOn | ( |  | ) |
| virtual

Turn on/off the generation of elliptical splats.

If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

## ◆ NormalWarpingOff()

virtual void vtkCheckerboardSplatter::NormalWarpingOff | ( |  | ) |
| virtual

Turn on/off the generation of elliptical splats.

If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar.

## ◆ 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

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.

## ◆ 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

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.

## ◆ SetAccumulationModeToMin()

void vtkCheckerboardSplatter::SetAccumulationModeToMin | ( |  | ) |
| inline

Specify the scalar accumulation mode.

This mode expresses how scalar values are combined when splats overlap one another. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 223 of file vtkCheckerboardSplatter.h.

## ◆ SetAccumulationModeToMax()

void vtkCheckerboardSplatter::SetAccumulationModeToMax | ( |  | ) |
| inline

Specify the scalar accumulation mode.

This mode expresses how scalar values are combined when splats overlap one another. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 224 of file vtkCheckerboardSplatter.h.

## ◆ SetAccumulationModeToSum()

void vtkCheckerboardSplatter::SetAccumulationModeToSum | ( |  | ) |
| inline

Specify the scalar accumulation mode.

This mode expresses how scalar values are combined when splats overlap one another. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

Definition at line 225 of file vtkCheckerboardSplatter.h.

## ◆ GetAccumulationModeAsString()

const char* vtkCheckerboardSplatter::GetAccumulationModeAsString | ( |  | ) |

Specify the scalar accumulation mode.

This mode expresses how scalar values are combined when splats overlap one another. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird (and can potentially cause accumulation overflow in extreme cases). Note that the NullValue must be set consistent with the accumulation operation.

## ◆ 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

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.

## ◆ SetOutputScalarTypeToDouble()

void vtkCheckerboardSplatter::SetOutputScalarTypeToDouble | ( |  | ) |
| inline

Set what type of scalar data this source should generate.

Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

Definition at line 237 of file vtkCheckerboardSplatter.h.

## ◆ SetOutputScalarTypeToFloat()

void vtkCheckerboardSplatter::SetOutputScalarTypeToFloat | ( |  | ) |
| inline

Set what type of scalar data this source should generate.

Only double and float types are supported currently due to precision requirements during accumulation. By default, float scalars are produced.

Definition at line 238 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

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.

## ◆ CappingOn()

virtual void vtkCheckerboardSplatter::CappingOn | ( |  | ) |
| virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value.

This can be used to close surfaces (after iso-surfacing) and create other effects.

## ◆ CappingOff()

virtual void vtkCheckerboardSplatter::CappingOff | ( |  | ) |
| virtual

Turn on/off the capping of the outer boundary of the volume to a specified cap value.

This can be used to close surfaces (after iso-surfacing) and create other effects.

## ◆ 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

Specify the cap value to use.

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

## ◆ 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

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.

## ◆ 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

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

## ◆ 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

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.

## ◆ 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

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.

## ◆ 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 311 of file vtkCheckerboardSplatter.h.

## ◆ SampleDimensions

int vtkCheckerboardSplatter::SampleDimensions[3]
| protected

Definition at line 312 of file vtkCheckerboardSplatter.h.

## ◆ Radius

double vtkCheckerboardSplatter::Radius
| protected

Definition at line 313 of file vtkCheckerboardSplatter.h.

## ◆ Footprint

int vtkCheckerboardSplatter::Footprint
| protected

Definition at line 314 of file vtkCheckerboardSplatter.h.

## ◆ ExponentFactor

double vtkCheckerboardSplatter::ExponentFactor
| protected

Definition at line 315 of file vtkCheckerboardSplatter.h.

## ◆ ModelBounds

double vtkCheckerboardSplatter::ModelBounds[6]
| protected

Definition at line 316 of file vtkCheckerboardSplatter.h.

## ◆ Origin

double vtkCheckerboardSplatter::Origin[3]
| protected

Definition at line 317 of file vtkCheckerboardSplatter.h.

## ◆ Spacing

double vtkCheckerboardSplatter::Spacing[3]
| protected

Definition at line 317 of file vtkCheckerboardSplatter.h.

## ◆ NormalWarping

vtkTypeBool vtkCheckerboardSplatter::NormalWarping
| protected

Definition at line 318 of file vtkCheckerboardSplatter.h.

## ◆ Eccentricity

double vtkCheckerboardSplatter::Eccentricity
| protected

Definition at line 319 of file vtkCheckerboardSplatter.h.

## ◆ ScalarWarping

vtkTypeBool vtkCheckerboardSplatter::ScalarWarping
| protected

Definition at line 320 of file vtkCheckerboardSplatter.h.

## ◆ ScaleFactor

double vtkCheckerboardSplatter::ScaleFactor
| protected

Definition at line 321 of file vtkCheckerboardSplatter.h.

## ◆ Capping

vtkTypeBool vtkCheckerboardSplatter::Capping
| protected

Definition at line 322 of file vtkCheckerboardSplatter.h.

## ◆ CapValue

double vtkCheckerboardSplatter::CapValue
| protected

Definition at line 323 of file vtkCheckerboardSplatter.h.

## ◆ AccumulationMode

int vtkCheckerboardSplatter::AccumulationMode
| protected

Definition at line 324 of file vtkCheckerboardSplatter.h.

## ◆ NullValue

double vtkCheckerboardSplatter::NullValue
| protected

Definition at line 325 of file vtkCheckerboardSplatter.h.

## ◆ MaximumDimension

unsigned char vtkCheckerboardSplatter::MaximumDimension
| protected

Definition at line 326 of file vtkCheckerboardSplatter.h.

## ◆ ParallelSplatCrossover

int vtkCheckerboardSplatter::ParallelSplatCrossover
| protected

Definition at line 327 of file vtkCheckerboardSplatter.h.

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

- Imaging/Hybrid/vtkCheckerboardSplatter.h