VTK
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUnsignedDistance Class Reference

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

#include <vtkUnsignedDistance.h>

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

Public Member Functions

void StartAppend ()
 Initialize the filter for appending data. More...
 
void Append (vtkPolyData *input)
 Append a data set to the existing output. More...
 
void EndAppend ()
 Method completes the append process. More...
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
virtual intGetDimensions ()
 Set/Get the i-j-k dimensions on which to computer the distance function. More...
 
virtual void GetDimensions (int data[3])
 Set/Get the i-j-k dimensions on which to computer the distance function. More...
 
void SetDimensions (int i, int j, int k)
 Set/Get the i-j-k dimensions on which to computer the distance function. More...
 
void SetDimensions (const int dim[3])
 Set/Get the i-j-k dimensions on which to computer the distance function. More...
 
virtual void SetBounds (double, double, double, double, double, double)
 Set / get the region in space in which to perform the sampling. More...
 
virtual void SetBounds (double[6])
 Set / get the region in space in which to perform the sampling. More...
 
virtual doubleGetBounds ()
 Set / get the region in space in which to perform the sampling. More...
 
virtual void GetBounds (double data[6])
 Set / get the region in space in which to perform the sampling. More...
 
virtual void SetAdjustBounds (vtkTypeBool)
 Control how the model bounds are computed. More...
 
virtual vtkTypeBool GetAdjustBounds ()
 Control how the model bounds are computed. More...
 
virtual void AdjustBoundsOn ()
 Control how the model bounds are computed. More...
 
virtual void AdjustBoundsOff ()
 Control how the model bounds are computed. More...
 
virtual void SetAdjustDistance (double)
 Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). More...
 
virtual double GetAdjustDistance ()
 Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). More...
 
virtual void SetRadius (double)
 Set / get the radius of influence of each point. More...
 
virtual double GetRadius ()
 Set / get the radius of influence of each point. More...
 
void SetLocator (vtkAbstractPointLocator *locator)
 Specify a point locator. More...
 
virtual vtkAbstractPointLocatorGetLocator ()
 Specify a point locator. More...
 
virtual void SetCapping (vtkTypeBool)
 The outer boundary of the volume can be assigned a particular value after distances are computed. More...
 
virtual vtkTypeBool GetCapping ()
 The outer boundary of the volume can be assigned a particular value after distances are computed. More...
 
virtual void CappingOn ()
 The outer boundary of the volume can be assigned a particular value after distances are computed. More...
 
virtual void CappingOff ()
 The outer boundary of the volume can be assigned a particular value after distances are computed. More...
 
virtual void SetCapValue (double)
 Specify the capping value to use. More...
 
virtual double GetCapValue ()
 Specify the capping value to use. More...
 
virtual void SetOutputScalarType (int)
 Set the desired output scalar type. More...
 
virtual int GetOutputScalarType ()
 Set the desired output scalar type. More...
 
void SetOutputScalarTypeToFloat ()
 Set the desired output scalar type. More...
 
void SetOutputScalarTypeToDouble ()
 Set the desired output scalar type. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (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...
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 Get a data object for one of the input port connections. More...
 
vtkImageDataGetImageDataInput (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
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
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 SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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 int 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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) 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 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 (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 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)
 
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. 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...
 
vtkCommandGetCommand (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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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...
 

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. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called in response to a REQUEST_DATA request from the executive. More...
 
int FillInputPortInformation (int, vtkInformation *) override
 These method should be reimplemented by subclasses that have more than a single input or single output. 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 vtkImageDataAllocateOutputData (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
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
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...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int Dimensions [3]
 
double Bounds [6]
 
vtkTypeBool AdjustBounds
 
double AdjustDistance
 
double Radius
 
vtkAbstractPointLocatorLocator
 
vtkTypeBool Capping
 
double CapValue
 
int OutputScalarType
 
int Initialized
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkImageAlgorithm Superclass
 Standard methods for instantiating the class, providing type information, and printing. More...
 
static vtkUnsignedDistanceNew ()
 Standard methods for instantiating the class, providing type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiating the class, providing type information, and printing. More...
 
static vtkUnsignedDistanceSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiating the class, providing type information, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiating the class, providing type information, and printing. More...
 
vtkUnsignedDistanceNewInstance () const
 Standard methods for instantiating the class, providing type information, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiating the class, providing type information, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiating the class, providing type information, and printing. More...
 

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

Detailed Description

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
Tests:
vtkUnsignedDistance (Tests)

Definition at line 79 of file vtkUnsignedDistance.h.

Member Typedef Documentation

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

Definition at line 88 of file vtkUnsignedDistance.h.

Constructor & Destructor Documentation

vtkUnsignedDistance::vtkUnsignedDistance ( )
protected
vtkUnsignedDistance::~vtkUnsignedDistance ( )
overrideprotected

Member Function Documentation

static vtkUnsignedDistance* vtkUnsignedDistance::New ( )
static

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

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

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

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

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

Reimplemented from vtkImageAlgorithm.

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

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

virtual vtkObjectBase* vtkUnsignedDistance::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkImageAlgorithm.

vtkUnsignedDistance* vtkUnsignedDistance::NewInstance ( ) const

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

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

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

Reimplemented from vtkImageAlgorithm.

virtual int* vtkUnsignedDistance::GetDimensions ( )
virtual

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

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

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

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

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

void vtkUnsignedDistance::SetDimensions ( const int  dim[3])

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

virtual void vtkUnsignedDistance::SetRadius ( double  )
virtual

Set / get the radius of influence of each point.

Smaller values generally improve performance markedly.

virtual double vtkUnsignedDistance::GetRadius ( )
virtual

Set / get the radius of influence of each point.

Smaller values generally improve performance markedly.

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

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

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.

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.

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.

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.

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;

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;

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.

virtual int vtkUnsignedDistance::GetOutputScalarType ( )
virtual

Set the desired output scalar type.

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

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 179 of file vtkUnsignedDistance.h.

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 180 of file vtkUnsignedDistance.h.

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.

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.

void vtkUnsignedDistance::EndAppend ( )

Method completes the append process.

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

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.

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.

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

int vtkUnsignedDistance::Dimensions[3]
protected

Definition at line 214 of file vtkUnsignedDistance.h.

double vtkUnsignedDistance::Bounds[6]
protected

Definition at line 215 of file vtkUnsignedDistance.h.

vtkTypeBool vtkUnsignedDistance::AdjustBounds
protected

Definition at line 216 of file vtkUnsignedDistance.h.

double vtkUnsignedDistance::AdjustDistance
protected

Definition at line 217 of file vtkUnsignedDistance.h.

double vtkUnsignedDistance::Radius
protected

Definition at line 218 of file vtkUnsignedDistance.h.

vtkAbstractPointLocator* vtkUnsignedDistance::Locator
protected

Definition at line 219 of file vtkUnsignedDistance.h.

vtkTypeBool vtkUnsignedDistance::Capping
protected

Definition at line 220 of file vtkUnsignedDistance.h.

double vtkUnsignedDistance::CapValue
protected

Definition at line 221 of file vtkUnsignedDistance.h.

int vtkUnsignedDistance::OutputScalarType
protected

Definition at line 222 of file vtkUnsignedDistance.h.

int vtkUnsignedDistance::Initialized
protected

Definition at line 225 of file vtkUnsignedDistance.h.


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