compute distance from input geometry on structured point dataset More...

#include <vtkImplicitModeller.h>

Inheritance diagram for vtkImplicitModeller:

Collaboration diagram for vtkImplicitModeller:

Public Types
typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

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

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImplicitModeller *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

double	ComputeModelBounds (vtkDataSet *input=nullptr)
	Compute ModelBounds from input geometry. More...

void	StartAppend ()
	Initialize the filter for appending data. More...

void	Append (vtkDataSet *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 int *	GetSampleDimensions ()
	Set/Get the i-j-k dimensions on which to sample distance function. More...

virtual void	GetSampleDimensions (int data[3])
	Set/Get the i-j-k dimensions on which to sample distance function. More...

void	SetSampleDimensions (int i, int j, int k)
	Set/Get the i-j-k dimensions on which to sample distance function. More...

void	SetSampleDimensions (int dim[3])
	Set/Get the i-j-k dimensions on which to sample distance function. More...


virtual void	SetMaximumDistance (double)
	Set / get the distance away from surface of input geometry to sample. More...

virtual double	GetMaximumDistance ()
	Set / get the distance away from surface of input geometry to sample. More...


virtual void	SetModelBounds (double, double, double, double, double, double)
	Set / get the region in space in which to perform the sampling. More...

virtual void	SetModelBounds (double[6])
	Set / get the region in space in which to perform the sampling. More...

virtual double *	GetModelBounds ()
	Set / get the region in space in which to perform the sampling. More...

virtual void	GetModelBounds (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	SetCapping (vtkTypeBool)
	The outer boundary of the structured point set can be assigned a particular value. More...

virtual vtkTypeBool	GetCapping ()
	The outer boundary of the structured point set can be assigned a particular value. More...

virtual void	CappingOn ()
	The outer boundary of the structured point set can be assigned a particular value. More...

virtual void	CappingOff ()
	The outer boundary of the structured point set can be assigned a particular value. More...


void	SetCapValue (double value)
	Specify the capping value to use. More...

virtual double	GetCapValue ()
	Specify the capping value to use. More...


virtual void	SetScaleToMaximumDistance (vtkTypeBool)
	If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user). More...

virtual vtkTypeBool	GetScaleToMaximumDistance ()
	If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user). More...

virtual void	ScaleToMaximumDistanceOn ()
	If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user). More...

virtual void	ScaleToMaximumDistanceOff ()
	If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user). More...


virtual void	SetProcessMode (int)
	Specify whether to visit each cell once per append or each voxel once per append. More...

virtual int	GetProcessMode ()
	Specify whether to visit each cell once per append or each voxel once per append. More...

void	SetProcessModeToPerVoxel ()
	Specify whether to visit each cell once per append or each voxel once per append. More...

void	SetProcessModeToPerCell ()
	Specify whether to visit each cell once per append or each voxel once per append. More...

const char *	GetProcessModeAsString (void)
	Specify whether to visit each cell once per append or each voxel once per append. More...


virtual void	SetLocatorMaxLevel (int)
	Specify the level of the locator to use when using the per voxel process mode. More...

virtual int	GetLocatorMaxLevel ()
	Specify the level of the locator to use when using the per voxel process mode. More...


virtual void	SetNumberOfThreads (int)
	Set / Get the number of threads used during Per-Voxel processing mode. More...

virtual int	GetNumberOfThreads ()
	Set / Get the number of threads used during Per-Voxel processing mode. More...


void	SetOutputScalarType (int type)
	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...

void	SetOutputScalarTypeToInt ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToUnsignedInt ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToLong ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToUnsignedLong ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToShort ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToUnsignedShort ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToUnsignedChar ()
	Set the desired output scalar type. More...

void	SetOutputScalarTypeToChar ()
	Set the desired output scalar type. More...

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const

vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkImageData *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections. More...

vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections. More...

vtkImageData *	GetImageDataInput (int port)
	Get a data object for one of the input port connections. More...

virtual void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

virtual void	AddInputData (int, vtkDataObject *)
	Assign a data object as input. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

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

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

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

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual 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 vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

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 void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. 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...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

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

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

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

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImplicitModeller *	SafeDownCast (vtkObjectBase *o)

static vtkImplicitModeller *	New ()
	Construct with sample dimensions=(50,50,50), and so that model bounds are automatically computed from the input. More...

Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImplicitModeller ()

	~vtkImplicitModeller () override

double	GetScalarTypeMax (int type)

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

void	StartAppend (int internal)

void	Cap (vtkDataArray *s)

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 vtkImageData *	AllocateOutputData (vtkDataObject out, vtkInformation outInfo)
	Allocate the output data. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

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

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkMultiThreader *	Threader

int	NumberOfThreads

int	SampleDimensions [3]

double	MaximumDistance

double	ModelBounds [6]

vtkTypeBool	Capping

double	CapValue

int	DataAppended

vtkTypeBool	AdjustBounds

double	AdjustDistance

int	ProcessMode

int	LocatorMaxLevel

int	OutputScalarType

vtkTypeBool	ScaleToMaximumDistance

int	BoundsComputed

double	InternalMaxDistance

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

compute distance from input geometry on structured point dataset

vtkImplicitModeller is a filter that computes the distance from the input geometry to the points of an output structured point set. This distance function can then be "contoured" to generate new, offset surfaces from the original geometry. An important feature of this object is "capping". If capping is turned on, after the implicit model is created, the values on the boundary of the structured points dataset are set to the cap value. This is used to force closure of the resulting contoured surface. Note, however, that large cap values can generate weird surface normals in those cells adjacent to the boundary of the dataset. Using smaller cap value will reduce this effect.

Another important ivar is MaximumDistance. This controls how far into the volume the distance function is computed from the input geometry. Small values give significant increases in performance. However, there can strange sampling effects at the extreme range of the MaximumDistance.

In order to properly execute and sample the input data, a rectangular region in space must be defined (this is the ivar ModelBounds). If not explicitly defined, the model bounds will be computed. Note that to avoid boundary effects, it is possible to adjust the model bounds (i.e., using the AdjustBounds and AdjustDistance ivars) to strictly contain the sampled data.

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 datasets and want to create a conglomeration of all the data. However, the user must be careful to either specify the ModelBounds or specify the first item such that its bounds completely contain all other items. This is because the rectangular region of the output can not be changed after the 1st Append.

The ProcessMode ivar controls the method used within the Append function (where the actual work is done regardless if the Append function is explicitly called) to compute the implicit model. If set to work in voxel mode, each voxel is visited once. If set to cell mode, each cell is visited once. Tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode. Also, if explicitly using the Append feature many times, the cell mode will probably be better because each voxel will be visited each Append. Append the data before input if possible when using the voxel mode. Do not switch between voxel and cell mode between execution of StartAppend and EndAppend.

Further performance improvement is now possible using the PerVoxel process mode on multi-processor machines (the mode is now multithreaded). Each thread processes a different "slab" of the output. Also, if the input is vtkPolyData, it is appropriately clipped for each thread; that is, each thread only considers the input which could affect its slab of the output.

This filter can now produce output of any type supported by vtkImageData. However to support this change, additional sqrts must be executed during the Append step. Previously, the output was initialized to the squared CapValue in StartAppend, the output was updated with squared distance values during the Append, and then the sqrt of the distances was computed in EndAppend. To support different scalar types in the output (largely to reduce memory requirements as an vtkImageShiftScale and/or vtkImageCast could have achieved the same result), we can't "afford" to save squared value in the output, because then we could only represent up to the sqrt of the scalar max for an integer type in the output; 1 (instead of 255) for an unsigned char; 11 for a char (instead of 127). Thus this change may result in a minor performance degradation. Non-float output types can be scaled to the CapValue by turning ScaleToMaximumDistance On.

See also: vtkSampleFunction vtkContourFilter

Examples:: vtkImplicitModeller (Examples)

Tests:: vtkImplicitModeller (Tests)

Definition at line 106 of file vtkImplicitModeller.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkImplicitModeller::Superclass

Definition at line 109 of file vtkImplicitModeller.h.

Constructor & Destructor Documentation

vtkImplicitModeller::vtkImplicitModeller ( )

protected

vtkImplicitModeller::~vtkImplicitModeller ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool vtkImplicitModeller::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

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

static

virtual vtkObjectBase* vtkImplicitModeller::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageAlgorithm.

vtkImplicitModeller* vtkImplicitModeller::NewInstance ( ) const

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

static vtkImplicitModeller* vtkImplicitModeller::New ( )

static

Construct with sample dimensions=(50,50,50), and so that model bounds are automatically computed from the input.

Capping is turned on with CapValue equal to a large positive number.

double vtkImplicitModeller::ComputeModelBounds ( vtkDataSet * input = nullptr )

Compute ModelBounds from input geometry.

If input is not specified, the input of the filter will be used.

virtual int* vtkImplicitModeller::GetSampleDimensions ( )

virtual

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

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

virtual

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

void vtkImplicitModeller::SetSampleDimensions	(	int	i,
		int	j,
		int	k
	)

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

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

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

virtual void vtkImplicitModeller::SetMaximumDistance ( double )

virtual

Set / get the distance away from surface of input geometry to sample.

This value is specified as a percentage of the length of the diagonal of the input data bounding box. Smaller values make large increases in performance.

virtual double vtkImplicitModeller::GetMaximumDistance ( )

virtual

Set / get the distance away from surface of input geometry to sample.

This value is specified as a percentage of the length of the diagonal of the input data bounding box. Smaller values make large increases in performance.

virtual void vtkImplicitModeller::SetModelBounds	(	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 vtkImplicitModeller::SetModelBounds ( 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* vtkImplicitModeller::GetModelBounds ( )

virtual

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

If not specified, it will be computed automatically.

virtual void vtkImplicitModeller::GetModelBounds ( 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 vtkImplicitModeller::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 vtkImplicitModeller::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 vtkImplicitModeller::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 vtkImplicitModeller::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 vtkImplicitModeller::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 vtkImplicitModeller::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 vtkImplicitModeller::SetCapping ( vtkTypeBool )

virtual

The outer boundary of the structured point set can be assigned a particular value.

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

virtual vtkTypeBool vtkImplicitModeller::GetCapping ( )

virtual

The outer boundary of the structured point set can be assigned a particular value.

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

virtual void vtkImplicitModeller::CappingOn ( )

virtual

The outer boundary of the structured point set can be assigned a particular value.

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

virtual void vtkImplicitModeller::CappingOff ( )

virtual

The outer boundary of the structured point set can be assigned a particular value.

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

void vtkImplicitModeller::SetCapValue ( double value )

Specify the capping value to use.

The CapValue is also used as an initial distance value at each point in the dataset.

virtual double vtkImplicitModeller::GetCapValue ( )

virtual

Specify the capping value to use.

The CapValue is also used as an initial distance value at each point in the dataset.

virtual void vtkImplicitModeller::SetScaleToMaximumDistance ( vtkTypeBool )

virtual

If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user).

For example, if ScaleToMaximumDistance is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled between 0 (for distances "very close" to the surface) and 255 (at the specified maximum distance)... assuming the CapValue is not changed from 255.

virtual vtkTypeBool vtkImplicitModeller::GetScaleToMaximumDistance ( )

virtual

If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user).

For example, if ScaleToMaximumDistance is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled between 0 (for distances "very close" to the surface) and 255 (at the specified maximum distance)... assuming the CapValue is not changed from 255.

virtual void vtkImplicitModeller::ScaleToMaximumDistanceOn ( )

virtual

If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user).

For example, if ScaleToMaximumDistance is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled between 0 (for distances "very close" to the surface) and 255 (at the specified maximum distance)... assuming the CapValue is not changed from 255.

virtual void vtkImplicitModeller::ScaleToMaximumDistanceOff ( )

virtual

If a non-floating output type is specified, the output distances can be scaled to use the entire positive scalar range of the output type specified (up to the CapValue which is equal to the max for the type unless modified by the user).

For example, if ScaleToMaximumDistance is On and the OutputScalarType is UnsignedChar the distances saved in the output would be linearly scaled between 0 (for distances "very close" to the surface) and 255 (at the specified maximum distance)... assuming the CapValue is not changed from 255.

virtual void vtkImplicitModeller::SetProcessMode ( int )

virtual

Specify whether to visit each cell once per append or each voxel once per append.

Some tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode.

virtual int vtkImplicitModeller::GetProcessMode ( )

virtual

Specify whether to visit each cell once per append or each voxel once per append.

Some tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode.

void vtkImplicitModeller::SetProcessModeToPerVoxel ( )

inline

Specify whether to visit each cell once per append or each voxel once per append.

Some tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode.

Definition at line 221 of file vtkImplicitModeller.h.

void vtkImplicitModeller::SetProcessModeToPerCell ( )

inline

Specify whether to visit each cell once per append or each voxel once per append.

Some tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode.

Definition at line 222 of file vtkImplicitModeller.h.

const char* vtkImplicitModeller::GetProcessModeAsString ( void )

Specify whether to visit each cell once per append or each voxel once per append.

Some tests have shown once per voxel to be faster when there are a lot of cells (at least a thousand?); relative performance improvement increases with addition cells. Primitives should not be stripped for best performance of the voxel mode.

virtual void vtkImplicitModeller::SetLocatorMaxLevel ( int )

virtual

Specify the level of the locator to use when using the per voxel process mode.

virtual int vtkImplicitModeller::GetLocatorMaxLevel ( )

virtual

Specify the level of the locator to use when using the per voxel process mode.

virtual void vtkImplicitModeller::SetNumberOfThreads ( int )

virtual

Set / Get the number of threads used during Per-Voxel processing mode.

virtual int vtkImplicitModeller::GetNumberOfThreads ( )

virtual

Set / Get the number of threads used during Per-Voxel processing mode.

void vtkImplicitModeller::SetOutputScalarType ( int type )