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

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

#include <vtkImplicitModeller.h>

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

Public Types

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

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImplicitModellerNewInstance () 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...
 
virtual intGetSampleDimensions ()
 Set/Get the i-j-k dimensions on which to sample distance function. More...
 
virtual void GetSampleDimensions (int data[3])
 
void SetSampleDimensions (int i, int j, int k)
 
void SetSampleDimensions (int dim[3])
 
virtual void SetMaximumDistance (double)
 Set / get the distance away from surface of input geometry to sample. More...
 
virtual double GetMaximumDistance ()
 
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])
 
virtual doubleGetModelBounds ()
 
virtual void GetModelBounds (double data[6])
 
virtual void SetAdjustBounds (vtkTypeBool)
 Control how the model bounds are computed. More...
 
virtual vtkTypeBool GetAdjustBounds ()
 
virtual void AdjustBoundsOn ()
 
virtual void AdjustBoundsOff ()
 
virtual void SetAdjustDistance (double)
 Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). More...
 
virtual double GetAdjustDistance ()
 
virtual void SetCapping (vtkTypeBool)
 The outer boundary of the structured point set can be assigned a particular value. More...
 
virtual vtkTypeBool GetCapping ()
 
virtual void CappingOn ()
 
virtual void CappingOff ()
 
void SetCapValue (double value)
 Specify the capping value to use. More...
 
virtual double GetCapValue ()
 
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 ()
 
virtual void ScaleToMaximumDistanceOn ()
 
virtual void ScaleToMaximumDistanceOff ()
 
virtual void SetProcessMode (int)
 Specify whether to visit each cell once per append or each voxel once per append. More...
 
virtual int GetProcessMode ()
 
void SetProcessModeToPerVoxel ()
 
void SetProcessModeToPerCell ()
 
const char * GetProcessModeAsString (void)
 
virtual void SetLocatorMaxLevel (int)
 Specify the level of the locator to use when using the per voxel process mode. More...
 
virtual int GetLocatorMaxLevel ()
 
virtual void SetNumberOfThreads (int)
 Set / Get the number of threads used during Per-Voxel processing mode. More...
 
virtual int GetNumberOfThreads ()
 
void SetOutputScalarType (int type)
 Set the desired output scalar type. More...
 
virtual int GetOutputScalarType ()
 
void SetOutputScalarTypeToFloat ()
 
void SetOutputScalarTypeToDouble ()
 
void SetOutputScalarTypeToInt ()
 
void SetOutputScalarTypeToUnsignedInt ()
 
void SetOutputScalarTypeToLong ()
 
void SetOutputScalarTypeToUnsignedLong ()
 
void SetOutputScalarTypeToShort ()
 
void SetOutputScalarTypeToUnsignedShort ()
 
void SetOutputScalarTypeToUnsignedChar ()
 
void SetOutputScalarTypeToChar ()
 
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...
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

vtkMultiThreaderThreader
 
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
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

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

Detailed Description

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

◆ Superclass

Definition at line 109 of file vtkImplicitModeller.h.

Constructor & Destructor Documentation

◆ vtkImplicitModeller()

vtkImplicitModeller::vtkImplicitModeller ( )
protected

◆ ~vtkImplicitModeller()

vtkImplicitModeller::~vtkImplicitModeller ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitModeller::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

◆ NewInstance()

vtkImplicitModeller* vtkImplicitModeller::NewInstance ( ) const

◆ PrintSelf()

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.

◆ New()

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.

◆ ComputeModelBounds()

double vtkImplicitModeller::ComputeModelBounds ( vtkDataSet input = nullptr)

Compute ModelBounds from input geometry.

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

◆ GetSampleDimensions() [1/2]

virtual int* vtkImplicitModeller::GetSampleDimensions ( )
virtual

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

◆ GetSampleDimensions() [2/2]

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

◆ SetSampleDimensions() [1/2]

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

◆ SetSampleDimensions() [2/2]

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

◆ SetMaximumDistance()

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.

◆ GetMaximumDistance()

virtual double vtkImplicitModeller::GetMaximumDistance ( )
virtual

◆ SetModelBounds() [1/2]

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.

◆ SetModelBounds() [2/2]

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

◆ GetModelBounds() [1/2]

virtual double* vtkImplicitModeller::GetModelBounds ( )
virtual

◆ GetModelBounds() [2/2]

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

◆ SetAdjustBounds()

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.

◆ GetAdjustBounds()

virtual vtkTypeBool vtkImplicitModeller::GetAdjustBounds ( )
virtual

◆ AdjustBoundsOn()

virtual void vtkImplicitModeller::AdjustBoundsOn ( )
virtual

◆ AdjustBoundsOff()

virtual void vtkImplicitModeller::AdjustBoundsOff ( )
virtual

◆ SetAdjustDistance()

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.

◆ GetAdjustDistance()

virtual double vtkImplicitModeller::GetAdjustDistance ( )
virtual

◆ SetCapping()

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.

◆ GetCapping()

virtual vtkTypeBool vtkImplicitModeller::GetCapping ( )
virtual

◆ CappingOn()

virtual void vtkImplicitModeller::CappingOn ( )
virtual

◆ CappingOff()

virtual void vtkImplicitModeller::CappingOff ( )
virtual

◆ SetCapValue()

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.

◆ GetCapValue()

virtual double vtkImplicitModeller::GetCapValue ( )
virtual

◆ SetScaleToMaximumDistance()

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.

◆ GetScaleToMaximumDistance()

virtual vtkTypeBool vtkImplicitModeller::GetScaleToMaximumDistance ( )
virtual

◆ ScaleToMaximumDistanceOn()

virtual void vtkImplicitModeller::ScaleToMaximumDistanceOn ( )
virtual

◆ ScaleToMaximumDistanceOff()

virtual void vtkImplicitModeller::ScaleToMaximumDistanceOff ( )
virtual

◆ SetProcessMode()

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.

◆ GetProcessMode()

virtual int vtkImplicitModeller::GetProcessMode ( )
virtual

◆ SetProcessModeToPerVoxel()

void vtkImplicitModeller::SetProcessModeToPerVoxel ( )
inline

Definition at line 221 of file vtkImplicitModeller.h.

◆ SetProcessModeToPerCell()

void vtkImplicitModeller::SetProcessModeToPerCell ( )
inline

Definition at line 222 of file vtkImplicitModeller.h.

◆ GetProcessModeAsString()

const char* vtkImplicitModeller::GetProcessModeAsString ( void  )

◆ SetLocatorMaxLevel()

virtual void vtkImplicitModeller::SetLocatorMaxLevel ( int  )
virtual

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

◆ GetLocatorMaxLevel()

virtual int vtkImplicitModeller::GetLocatorMaxLevel ( )
virtual

◆ SetNumberOfThreads()

virtual void vtkImplicitModeller::SetNumberOfThreads ( int  )
virtual

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

◆ GetNumberOfThreads()

virtual int vtkImplicitModeller::GetNumberOfThreads ( )
virtual

◆ SetOutputScalarType()

void vtkImplicitModeller::SetOutputScalarType ( int  type)

Set the desired output scalar type.

◆ GetOutputScalarType()

virtual int vtkImplicitModeller::GetOutputScalarType ( )
virtual

◆ SetOutputScalarTypeToFloat()

void vtkImplicitModeller::SetOutputScalarTypeToFloat ( )
inline

Definition at line 249 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToDouble()

void vtkImplicitModeller::SetOutputScalarTypeToDouble ( )
inline

Definition at line 250 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToInt()

void vtkImplicitModeller::SetOutputScalarTypeToInt ( )
inline

Definition at line 251 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToUnsignedInt()

void vtkImplicitModeller::SetOutputScalarTypeToUnsignedInt ( )
inline

Definition at line 252 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToLong()

void vtkImplicitModeller::SetOutputScalarTypeToLong ( )
inline

Definition at line 254 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToUnsignedLong()

void vtkImplicitModeller::SetOutputScalarTypeToUnsignedLong ( )
inline

Definition at line 255 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToShort()

void vtkImplicitModeller::SetOutputScalarTypeToShort ( )
inline

Definition at line 257 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToUnsignedShort()

void vtkImplicitModeller::SetOutputScalarTypeToUnsignedShort ( )
inline

Definition at line 258 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToUnsignedChar()

void vtkImplicitModeller::SetOutputScalarTypeToUnsignedChar ( )
inline

Definition at line 260 of file vtkImplicitModeller.h.

◆ SetOutputScalarTypeToChar()

void vtkImplicitModeller::SetOutputScalarTypeToChar ( )
inline

Definition at line 262 of file vtkImplicitModeller.h.

◆ StartAppend() [1/2]

void vtkImplicitModeller::StartAppend ( )

Initialize the filter for appending data.

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

◆ Append()

void vtkImplicitModeller::Append ( vtkDataSet input)

Append a data set to the existing output.

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

◆ EndAppend()

void vtkImplicitModeller::EndAppend ( )

Method completes the append process.

◆ ProcessRequest()

vtkTypeBool vtkImplicitModeller::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.

◆ GetScalarTypeMax()

double vtkImplicitModeller::GetScalarTypeMax ( int  type)
protected

◆ RequestInformation()

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

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

Reimplemented from vtkImageAlgorithm.

◆ RequestData()

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

◆ StartAppend() [2/2]

void vtkImplicitModeller::StartAppend ( int  internal)
protected

◆ Cap()

void vtkImplicitModeller::Cap ( vtkDataArray s)
protected

◆ FillInputPortInformation()

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

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.

Member Data Documentation

◆ Threader

vtkMultiThreader* vtkImplicitModeller::Threader
protected

Definition at line 308 of file vtkImplicitModeller.h.

◆ NumberOfThreads

int vtkImplicitModeller::NumberOfThreads
protected

Definition at line 309 of file vtkImplicitModeller.h.

◆ SampleDimensions

int vtkImplicitModeller::SampleDimensions[3]
protected

Definition at line 311 of file vtkImplicitModeller.h.

◆ MaximumDistance

double vtkImplicitModeller::MaximumDistance
protected

Definition at line 312 of file vtkImplicitModeller.h.

◆ ModelBounds

double vtkImplicitModeller::ModelBounds[6]
protected

Definition at line 313 of file vtkImplicitModeller.h.

◆ Capping

vtkTypeBool vtkImplicitModeller::Capping
protected

Definition at line 314 of file vtkImplicitModeller.h.

◆ CapValue

double vtkImplicitModeller::CapValue
protected

Definition at line 315 of file vtkImplicitModeller.h.

◆ DataAppended

int vtkImplicitModeller::DataAppended
protected

Definition at line 316 of file vtkImplicitModeller.h.

◆ AdjustBounds

vtkTypeBool vtkImplicitModeller::AdjustBounds
protected

Definition at line 317 of file vtkImplicitModeller.h.

◆ AdjustDistance

double vtkImplicitModeller::AdjustDistance
protected

Definition at line 318 of file vtkImplicitModeller.h.

◆ ProcessMode

int vtkImplicitModeller::ProcessMode
protected

Definition at line 319 of file vtkImplicitModeller.h.

◆ LocatorMaxLevel

int vtkImplicitModeller::LocatorMaxLevel
protected

Definition at line 320 of file vtkImplicitModeller.h.

◆ OutputScalarType

int vtkImplicitModeller::OutputScalarType
protected

Definition at line 321 of file vtkImplicitModeller.h.

◆ ScaleToMaximumDistance

vtkTypeBool vtkImplicitModeller::ScaleToMaximumDistance
protected

Definition at line 322 of file vtkImplicitModeller.h.

◆ BoundsComputed

int vtkImplicitModeller::BoundsComputed
protected

Definition at line 325 of file vtkImplicitModeller.h.

◆ InternalMaxDistance

double vtkImplicitModeller::InternalMaxDistance
protected

Definition at line 328 of file vtkImplicitModeller.h.


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