vtkUnsignedDistance Class Reference

compute unsigned (i.e., non-negative) distances from an input point cloud More...

#include <vtkUnsignedDistance.h>

Inheritance diagram for vtkUnsignedDistance:

Collaboration diagram for vtkUnsignedDistance:

Public Member Functions
void	StartAppend ()
	Initialize the filter for appending data.
void	Append (vtkPolyData *input)
	Append a data set to the existing output.
void	EndAppend ()
	Method completes the append process.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive.
virtual int *	GetDimensions ()
	Set/Get the i-j-k dimensions on which to computer the distance function.
virtual void	GetDimensions (int data[3])
	Set/Get the i-j-k dimensions on which to computer the distance function.
void	SetDimensions (int i, int j, int k)
	Set/Get the i-j-k dimensions on which to computer the distance function.
void	SetDimensions (const int dim[3])
	Set/Get the i-j-k dimensions on which to computer the distance function.
virtual void	SetBounds (double, double, double, double, double, double)
	Set / get the region in space in which to perform the sampling.
virtual void	SetBounds (double[6])
	Set / get the region in space in which to perform the sampling.
virtual double *	GetBounds ()
	Set / get the region in space in which to perform the sampling.
virtual void	GetBounds (double data[6])
	Set / get the region in space in which to perform the sampling.
virtual void	SetAdjustBounds (vtkTypeBool)
	Control how the model bounds are computed.
virtual vtkTypeBool	GetAdjustBounds ()
	Control how the model bounds are computed.
virtual void	AdjustBoundsOn ()
	Control how the model bounds are computed.
virtual void	AdjustBoundsOff ()
	Control how the model bounds are computed.
virtual void	SetAdjustDistance (double)
	Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
virtual double	GetAdjustDistance ()
	Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
virtual void	SetRadius (double)
	Set / get the radius of influence of each point.
virtual double	GetRadius ()
	Set / get the radius of influence of each point.
void	SetLocator (vtkAbstractPointLocator *locator)
	Specify a point locator.
virtual vtkAbstractPointLocator *	GetLocator ()
	Specify a point locator.
virtual void	SetCapping (vtkTypeBool)
	The outer boundary of the volume can be assigned a particular value after distances are computed.
virtual vtkTypeBool	GetCapping ()
	The outer boundary of the volume can be assigned a particular value after distances are computed.
virtual void	CappingOn ()
	The outer boundary of the volume can be assigned a particular value after distances are computed.
virtual void	CappingOff ()
	The outer boundary of the volume can be assigned a particular value after distances are computed.
virtual void	SetCapValue (double)
	Specify the capping value to use.
virtual double	GetCapValue ()
	Specify the capping value to use.
virtual void	SetOutputScalarType (int)
	Set the desired output scalar type.
virtual int	GetOutputScalarType ()
	Set the desired output scalar type.
void	SetOutputScalarTypeToFloat ()
	Set the desired output scalar type.
void	SetOutputScalarTypeToDouble ()
	Set the desired output scalar type.
Public Member Functions inherited from vtkImageAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive.
vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkImageData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections.
vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections.
vtkImageData *	GetImageDataInput (int port)
	Get a data object for one of the input port connections.
virtual void	AddInputData (vtkDataObject *)
	Assign a data object as input.
virtual void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
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.
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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
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.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
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).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
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.
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.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
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.
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.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Protected Member Functions
	vtkUnsignedDistance ()
	~vtkUnsignedDistance () override
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called in response to a REQUEST_DATA request from the executive.
int	FillInputPortInformation (int, vtkInformation *) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
Protected Member Functions inherited from vtkImageAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageAlgorithm ()
	~vtkImageAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
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.
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.
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called in response to a REQUEST_DATA request from the executive.
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
	This is a convenience method that is implemented in many subclasses instead of RequestData.
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
	Copy the other point and cell data.
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.
virtual void	Execute ()
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
	Allocate the output data.
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
	Allocate the output data.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
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.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
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.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
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.
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.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
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.
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.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	Dimensions [3]
double	Bounds [6]
vtkTypeBool	AdjustBounds
double	AdjustDistance
double	Radius
vtkAbstractPointLocator *	Locator
vtkTypeBool	Capping
double	CapValue
int	OutputScalarType
int	Initialized
Protected Attributes inherited from vtkAlgorithm
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.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkImageAlgorithm	Superclass
	Standard methods for instantiating the class, providing type information, and printing.
static vtkUnsignedDistance *	New ()
	Standard methods for instantiating the class, providing type information, and printing.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiating the class, providing type information, and printing.
static vtkUnsignedDistance *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiating the class, providing type information, and printing.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiating the class, providing type information, and printing.
vtkUnsignedDistance *	NewInstance () const
	Standard methods for instantiating the class, providing type information, and printing.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiating the class, providing type information, and printing.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiating the class, providing type information, and printing.

Additional Inherited Members
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
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.
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.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.
Public Attributes inherited from vtkAlgorithm
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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

compute unsigned (i.e., non-negative) distances from an input point cloud

vtkUnsignedDistance is a filter that computes non-negative (i.e., unsigned) distances over a volume from an input point cloud. This filter is distinct from vtkSignedDistance in that it does not require point normals. However, isocontouring a zero-valued distance function (e.g., trying to fit a surface will produce unsatisfactory results). Rather this filter, when combined with an isocontouring filter such as vtkFlyingEdges3D, can produce an offset, bounding surface surrounding the input point cloud.

To use this filter, specify the input vtkPolyData (which represents the point cloud); define the sampling volume; specify a radius (which limits the radius of influence of each point); and set an optional point locator (to accelerate proximity operations, a vtkStaticPointLocator is used by default). Note that large radius values may have significant impact on performance. The volume is defined by specifying dimensions in the x-y-z directions, as well as a domain bounds. By default the model bounds are defined from the input points, but the user can also manually specify them. Finally, because the radius data member limits the influence of the distance calculation, some voxels may receive no contribution. These voxel values are set to the CapValue.

This filter has one other unusual capability: it is possible to append data in a sequence of operations to generate a single output. This is useful when you have multiple point clouds (e.g., possibly from multiple acqusition scans) and want to incrementally accumulate all the data. However, the user must be careful to either specify the Bounds or order the input such that the bounds of the first input completely contains all other input data. This is because the geometry and topology of the output sampling volume cannot be changed after the initial Append operation.

Warning

Note that multiple, non-connected surfaces may be produced. For example, if the point cloud is from the surface of the sphere, it is possible to generate two surfaces (with isocontouring): one inside the sphere, one outside the sphere. It is sometimes possible to select the surface you want from the output of the contouring filter by using vtkPolyDataConnectivityFilter.

This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

See also

vtkSignedDistance vtkExtractSurface vtkImplicitModeller

Online Examples:

UnsignedDistance

Definition at line 94 of file vtkUnsignedDistance.h.

Member Typedef Documentation

Superclass

typedef vtkImageAlgorithm vtkUnsignedDistance::Superclass

Standard methods for instantiating the class, providing type information, and printing.

Definition at line 103 of file vtkUnsignedDistance.h.

Constructor & Destructor Documentation

vtkUnsignedDistance()

vtkUnsignedDistance::vtkUnsignedDistance ( )

protected

~vtkUnsignedDistance()

vtkUnsignedDistance::~vtkUnsignedDistance ( )

overrideprotected

Member Function Documentation

New()

static vtkUnsignedDistance * vtkUnsignedDistance::New ( )

static

Standard methods for instantiating the class, providing type information, and printing.

IsTypeOf()

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

static

Standard methods for instantiating the class, providing type information, and printing.

IsA()

virtual vtkTypeBool vtkUnsignedDistance::IsA ( const char *  type )

virtual

Standard methods for instantiating the class, providing type information, and printing.

Reimplemented from vtkImageAlgorithm.

SafeDownCast()

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

static

Standard methods for instantiating the class, providing type information, and printing.

NewInstanceInternal()

virtual vtkObjectBase * vtkUnsignedDistance::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiating the class, providing type information, and printing.

Reimplemented from vtkImageAlgorithm.

NewInstance()

vtkUnsignedDistance * vtkUnsignedDistance::NewInstance

(

)

const

Standard methods for instantiating the class, providing type information, and printing.

PrintSelf()

void vtkUnsignedDistance::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Standard methods for instantiating the class, providing type information, and printing.

Reimplemented from vtkImageAlgorithm.

GetDimensions() [1/2]

virtual int * vtkUnsignedDistance::GetDimensions ( )

virtual

Set/Get the i-j-k dimensions on which to computer the distance function.

GetDimensions() [2/2]

virtual void vtkUnsignedDistance::GetDimensions ( int  data[3] )

virtual

Set/Get the i-j-k dimensions on which to computer the distance function.

SetDimensions() [1/2]

void vtkUnsignedDistance::SetDimensions	(	int	i,
		int	j,
		int	k
	)

Set/Get the i-j-k dimensions on which to computer the distance function.

SetDimensions() [2/2]

void vtkUnsignedDistance::SetDimensions

(

const int

dim[3]

)

Set/Get the i-j-k dimensions on which to computer the distance function.

SetBounds() [1/2]

virtual void vtkUnsignedDistance::SetBounds ( double  , double  , double  , double  , double  , double    )

virtual

Set / get the region in space in which to perform the sampling.

If not specified, it will be computed automatically.

SetBounds() [2/2]

virtual void vtkUnsignedDistance::SetBounds ( double  [6] )

virtual

Set / get the region in space in which to perform the sampling.

If not specified, it will be computed automatically.

GetBounds() [1/2]

virtual double * vtkUnsignedDistance::GetBounds ( )

virtual

Set / get the region in space in which to perform the sampling.

If not specified, it will be computed automatically.

GetBounds() [2/2]

virtual void vtkUnsignedDistance::GetBounds ( double  data[6] )

virtual

Set / get the region in space in which to perform the sampling.

If not specified, it will be computed automatically.

SetAdjustBounds()

virtual void vtkUnsignedDistance::SetAdjustBounds ( vtkTypeBool  )

virtual

Control how the model bounds are computed.

If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

GetAdjustBounds()

virtual vtkTypeBool vtkUnsignedDistance::GetAdjustBounds ( )

virtual

Control how the model bounds are computed.

If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

AdjustBoundsOn()

virtual void vtkUnsignedDistance::AdjustBoundsOn ( )

virtual

Control how the model bounds are computed.

If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

AdjustBoundsOff()

virtual void vtkUnsignedDistance::AdjustBoundsOff ( )

virtual

Control how the model bounds are computed.

If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

SetAdjustDistance()

virtual void vtkUnsignedDistance::SetAdjustDistance ( double  )

virtual

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).

The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

GetAdjustDistance()

virtual double vtkUnsignedDistance::GetAdjustDistance ( )

virtual

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).

The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

SetRadius()

virtual void vtkUnsignedDistance::SetRadius ( double  )

virtual

Set / get the radius of influence of each point.

Smaller values generally improve performance markedly.

GetRadius()

virtual double vtkUnsignedDistance::GetRadius ( )

virtual

Set / get the radius of influence of each point.

Smaller values generally improve performance markedly.

SetLocator()

void vtkUnsignedDistance::SetLocator

(

vtkAbstractPointLocator *

locator

)

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points surrounding a voxel (within the specified radius).

GetLocator()

virtual vtkAbstractPointLocator * vtkUnsignedDistance::GetLocator ( )

virtual

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points surrounding a voxel (within the specified radius).

SetCapping()

virtual void vtkUnsignedDistance::SetCapping ( vtkTypeBool  )

virtual

The outer boundary of the volume can be assigned a particular value after distances are computed.

This can be used to close or "cap" all surfaces during isocontouring.

GetCapping()

virtual vtkTypeBool vtkUnsignedDistance::GetCapping ( )

virtual

The outer boundary of the volume can be assigned a particular value after distances are computed.

This can be used to close or "cap" all surfaces during isocontouring.

CappingOn()

virtual void vtkUnsignedDistance::CappingOn ( )

virtual

The outer boundary of the volume can be assigned a particular value after distances are computed.

This can be used to close or "cap" all surfaces during isocontouring.

CappingOff()

virtual void vtkUnsignedDistance::CappingOff ( )

virtual

The outer boundary of the volume can be assigned a particular value after distances are computed.

This can be used to close or "cap" all surfaces during isocontouring.

SetCapValue()

virtual void vtkUnsignedDistance::SetCapValue ( double  )

virtual

Specify the capping value to use.

The CapValue is also used as an initial distance value at each point in the dataset. By default, the CapValue is VTK_FLOAT_MAX;

GetCapValue()

virtual double vtkUnsignedDistance::GetCapValue ( )

virtual

Specify the capping value to use.

The CapValue is also used as an initial distance value at each point in the dataset. By default, the CapValue is VTK_FLOAT_MAX;

SetOutputScalarType()

virtual void vtkUnsignedDistance::SetOutputScalarType ( int  )

virtual

Set the desired output scalar type.

Currently only real types are supported. By default, VTK_FLOAT scalars are created.

GetOutputScalarType()

virtual int vtkUnsignedDistance::GetOutputScalarType ( )

virtual

Set the desired output scalar type.

Currently only real types are supported. By default, VTK_FLOAT scalars are created.

SetOutputScalarTypeToFloat()

void vtkUnsignedDistance::SetOutputScalarTypeToFloat ( )

inline

Set the desired output scalar type.

Currently only real types are supported. By default, VTK_FLOAT scalars are created.

Definition at line 194 of file vtkUnsignedDistance.h.

SetOutputScalarTypeToDouble()

void vtkUnsignedDistance::SetOutputScalarTypeToDouble ( )

inline

Set the desired output scalar type.

Currently only real types are supported. By default, VTK_FLOAT scalars are created.

Definition at line 195 of file vtkUnsignedDistance.h.

StartAppend()

void vtkUnsignedDistance::StartAppend

(

)

Initialize the filter for appending data.

You must invoke the StartAppend() method before doing successive Appends(). It's also a good idea to manually specify the model bounds; otherwise the input bounds for the data will be used.

Append()

void vtkUnsignedDistance::Append

(

vtkPolyData *

input

)

Append a data set to the existing output.

To use this function, you'll have to invoke the StartAppend() method before doing successive appends. It's also a good idea to specify the model bounds; otherwise the input model bounds is used. When you've finished appending, use the EndAppend() method.

EndAppend()

void vtkUnsignedDistance::EndAppend

(

)

Method completes the append process.

ProcessRequest()

vtkTypeBool vtkUnsignedDistance::ProcessRequest ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overridevirtual

Process a request from the executive.

For vtkImageAlgorithm, the request will be delegated to one of the following methods: RequestData, RequestInformation, or RequestUpdateExtent.

Reimplemented from vtkImageAlgorithm.

RequestInformation()

int vtkUnsignedDistance::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 vtkUnsignedDistance::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.

FillInputPortInformation()

int vtkUnsignedDistance::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.

Member Data Documentation

Dimensions

int vtkUnsignedDistance::Dimensions[3]

protected

Definition at line 228 of file vtkUnsignedDistance.h.

Bounds

double vtkUnsignedDistance::Bounds[6]

protected

Definition at line 229 of file vtkUnsignedDistance.h.

AdjustBounds

vtkTypeBool vtkUnsignedDistance::AdjustBounds

protected

Definition at line 230 of file vtkUnsignedDistance.h.

AdjustDistance

double vtkUnsignedDistance::AdjustDistance

protected

Definition at line 231 of file vtkUnsignedDistance.h.

Radius

double vtkUnsignedDistance::Radius

protected

Definition at line 232 of file vtkUnsignedDistance.h.

Locator

vtkAbstractPointLocator* vtkUnsignedDistance::Locator

protected

Definition at line 233 of file vtkUnsignedDistance.h.

Capping

vtkTypeBool vtkUnsignedDistance::Capping

protected

Definition at line 234 of file vtkUnsignedDistance.h.

CapValue

double vtkUnsignedDistance::CapValue

protected

Definition at line 235 of file vtkUnsignedDistance.h.

OutputScalarType

int vtkUnsignedDistance::OutputScalarType

protected

Definition at line 236 of file vtkUnsignedDistance.h.

Initialized

int vtkUnsignedDistance::Initialized

protected

Definition at line 239 of file vtkUnsignedDistance.h.

---

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

• Filters/Points/vtkUnsignedDistance.h