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

Clip any dataset with a user-specified implicit function or an input scalar point data array. More...

#include <vtkTableBasedClipDataSet.h>

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

Public Types

typedef vtkUnstructuredGridAlgorithm Superclass
 
- Public Types inherited from vtkUnstructuredGridAlgorithm
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...
 
vtkTableBasedClipDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Get the MTime for which the point locator and clip function are considered. More...
 
virtual void SetInsideOut (vtkTypeBool)
 Set/Get the InsideOut flag. More...
 
virtual vtkTypeBool GetInsideOut ()
 
virtual void InsideOutOn ()
 
virtual void InsideOutOff ()
 
virtual void SetValue (double)
 Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value. More...
 
virtual double GetValue ()
 
virtual void SetUseValueAsOffset (bool)
 Set/Get flag UseValueAsOffset, with true as the default value. More...
 
virtual bool GetUseValueAsOffset ()
 
virtual void UseValueAsOffsetOn ()
 
virtual void UseValueAsOffsetOff ()
 
virtual void SetClipFunction (vtkImplicitFunction *)
 Set/Get the implicit function with which to perform the clipping operation. More...
 
virtual vtkImplicitFunctionGetClipFunction ()
 
virtual void SetGenerateClipScalars (vtkTypeBool)
 Set/Get flag GenerateClipScalars, with 0 as the default value. More...
 
virtual vtkTypeBool GetGenerateClipScalars ()
 
virtual void GenerateClipScalarsOn ()
 
virtual void GenerateClipScalarsOff ()
 
void SetLocator (vtkIncrementalPointLocator *locator)
 Set/Get a point locator locator for merging duplicate points. More...
 
virtual vtkIncrementalPointLocatorGetLocator ()
 
virtual void SetMergeTolerance (double)
 Set/Get the tolerance used for merging duplicate points near the clipping intersection cells. More...
 
virtual double GetMergeTolerance ()
 
void CreateDefaultLocator ()
 Create a default point locator when none is specified. More...
 
virtual void SetGenerateClippedOutput (vtkTypeBool)
 Set/Get whether a second output is generated. More...
 
virtual vtkTypeBool GetGenerateClippedOutput ()
 
virtual void GenerateClippedOutputOn ()
 
virtual void GenerateClippedOutputOff ()
 
vtkUnstructuredGridGetClippedOutput ()
 Return the clipped output. More...
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output types. More...
 
virtual int GetOutputPointsPrecision ()
 
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithmNewInstance () const
 
vtkUnstructuredGridGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUnstructuredGridGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkUnstructuredGridGetUnstructuredGridInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (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...
 
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 vtkTableBasedClipDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkTableBasedClipDataSetNew ()
 Create an instance with a user-specified implicit function, turning off IVARs InsideOut and GenerateClipScalars and setting IVAR Value to 0.0. More...
 
- Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridAlgorithmSafeDownCast (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
 
 vtkTableBasedClipDataSet (vtkImplicitFunction *cf=nullptr)
 
 ~vtkTableBasedClipDataSet () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
void ClipDataSet (vtkDataSet *pDataSet, vtkDataArray *clipAray, vtkUnstructuredGrid *unstruct)
 This function resorts to the sibling class vtkClipDataSet to handle special grids (such as cylinders or cones with capping faces in the form a vtkPolyData). More...
 
void ClipImageData (vtkDataSet *inputGrd, vtkDataArray *clipAray, double isoValue, vtkUnstructuredGrid *outputUG)
 This function takes a vtkImageData as a vtkRectilinearGrid, which is then clipped by ClipRectilinearGridData(......). More...
 
void ClipPolyData (vtkDataSet *inputGrd, vtkDataArray *clipAray, double isoValue, vtkUnstructuredGrid *outputUG)
 This function clips a vtkPolyData object based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). More...
 
void ClipRectilinearGridData (vtkDataSet *inputGrd, vtkDataArray *clipAray, double isoValue, vtkUnstructuredGrid *outputUG)
 This function clips a vtkRectilinearGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). More...
 
void ClipStructuredGridData (vtkDataSet *inputGrd, vtkDataArray *clipAray, double isoValue, vtkUnstructuredGrid *outputUG)
 This function clips a vtkStructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). More...
 
void ClipUnstructuredGridData (vtkDataSet *inputGrd, vtkDataArray *clipAray, double isoValue, vtkUnstructuredGrid *outputUG)
 This function clips a vtkUnstructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). More...
 
void InternalProgressCallback (vtkAlgorithm *algorithm)
 The actual operation executed by the callback function. More...
 
- Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
 vtkUnstructuredGridAlgorithm ()
 
 ~vtkUnstructuredGridAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. 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 &)
 

Static Protected Member Functions

static void InternalProgressCallbackFunction (vtkObject *, unsigned long, void *clientdata, void *)
 Register a callback function with the InternalProgressObserver. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkTypeBool InsideOut
 
vtkTypeBool GenerateClipScalars
 
vtkTypeBool GenerateClippedOutput
 
bool UseValueAsOffset
 
double Value
 
double MergeTolerance
 
vtkCallbackCommandInternalProgressObserver
 
vtkImplicitFunctionClipFunction
 
vtkIncrementalPointLocatorLocator
 
int OutputPointsPrecision
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Clip any dataset with a user-specified implicit function or an input scalar point data array.

vtkTableBasedClipDataSet is a filter that clips any type of dataset using either any subclass of vtkImplicitFunction or an input scalar point data array. Clipping means that it actually "cuts" through the cells of the dataset, returning everything outside the specified implicit function (or greater than the scalar value) including "pieces" of a cell (Note to compare this with vtkExtractGeometry, which pulls out entire, uncut cells). The output of this filter is a vtkUnstructuredGrid data.

To use this filter, you need to decide whether an implicit function or an input scalar point data array is used for clipping. For the former case, 1) define an implicit function 2) provide it to this filter via SetClipFunction() If a clipping function is not specified, or GenerateClipScalars is off( the default), the input scalar point data array is then employed for clipping.

You can also specify a scalar (iso-)value, which is used to decide what is inside and outside the implicit function. You can also reverse the sense of what inside/outside is by setting IVAR InsideOut. The clipping algorithm proceeds by computing an implicit function value or using the input scalar point data value for each point in the dataset. This is compared against the scalar (iso-)value to determine the inside/outside status.

Although this filter sometimes (but rarely) may resort to the sibling class vtkClipDataSet for handling some special grids (such as cylinders or cones with capping faces in the form of a vtkPolyData), it itself is able to deal with most grids. It is worth mentioning that vtkTableBasedClipDataSet is capable of addressing the artifacts that may occur with vtkClipDataSet due to the possibly inconsistent triangulation modes between neighboring cells. In addition, the former is much faster than the latter. Furthermore, the former produces less cells (with ratio usually being 5~6) than by the latter in the output. In other words, this filter retains the original cells (i.e., without triangulation / tetrahedralization) wherever possible. All these advantages are gained by adopting the unique clipping and triangulation tables proposed by VisIt.

Warning
vtkTableBasedClipDataSet makes use of a hash table (that is provided by class maintained by internal class vtkTableBasedClipperDataSetFromVolume) to achieve rapid removal of duplicate points. The hash-based mechanism simply compares the point Ids, without considering the actual inter-point distance (vtkClipDataSet adopts vtkMergePoints that though considers the inter-point distance for robust points merging ). As a result, some duplicate points may be present in the output. This problem occurs when some boundary (cut-through cells) happen to have faces EXACTLY aligned with the clipping plane (such as Plane, Box, or other implicit functions with planar shapes). The occurrence (though very rare) of duplicate points produces degenerate cells, which can be fixed by post-processing the output with a filter like vtkCleanGrid.
Thanks:
This filter was adapted from the VisIt clipper (vtkVisItClipper).
See also
vtkClipDataSet vtkClipVolume vtkClipPolyData vtkCutter vtkImplicitFunction

Definition at line 100 of file vtkTableBasedClipDataSet.h.

Member Typedef Documentation

◆ Superclass

Definition at line 103 of file vtkTableBasedClipDataSet.h.

Constructor & Destructor Documentation

◆ vtkTableBasedClipDataSet()

vtkTableBasedClipDataSet::vtkTableBasedClipDataSet ( vtkImplicitFunction cf = nullptr)
protected

◆ ~vtkTableBasedClipDataSet()

vtkTableBasedClipDataSet::~vtkTableBasedClipDataSet ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTableBasedClipDataSet::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 vtkUnstructuredGridAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTableBasedClipDataSet::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ NewInstance()

vtkTableBasedClipDataSet* vtkTableBasedClipDataSet::NewInstance ( ) const

◆ PrintSelf()

void vtkTableBasedClipDataSet::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 vtkUnstructuredGridAlgorithm.

◆ New()

static vtkTableBasedClipDataSet* vtkTableBasedClipDataSet::New ( )
static

Create an instance with a user-specified implicit function, turning off IVARs InsideOut and GenerateClipScalars and setting IVAR Value to 0.0.

◆ GetMTime()

vtkMTimeType vtkTableBasedClipDataSet::GetMTime ( )
overridevirtual

Get the MTime for which the point locator and clip function are considered.

Reimplemented from vtkObject.

◆ SetInsideOut()

virtual void vtkTableBasedClipDataSet::SetInsideOut ( vtkTypeBool  )
virtual

Set/Get the InsideOut flag.

With this flag off, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less than or equal to IVAR Value. This flag is off by default.

◆ GetInsideOut()

virtual vtkTypeBool vtkTableBasedClipDataSet::GetInsideOut ( )
virtual

◆ InsideOutOn()

virtual void vtkTableBasedClipDataSet::InsideOutOn ( )
virtual

◆ InsideOutOff()

virtual void vtkTableBasedClipDataSet::InsideOutOff ( )
virtual

◆ SetValue()

virtual void vtkTableBasedClipDataSet::SetValue ( double  )
virtual

Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value.

This value is ignored if flag UseValueAsOffset is true AND a clip function is defined.

◆ GetValue()

virtual double vtkTableBasedClipDataSet::GetValue ( )
virtual

◆ SetUseValueAsOffset()

virtual void vtkTableBasedClipDataSet::SetUseValueAsOffset ( bool  )
virtual

Set/Get flag UseValueAsOffset, with true as the default value.

With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when clipping using a scalar array.

◆ GetUseValueAsOffset()

virtual bool vtkTableBasedClipDataSet::GetUseValueAsOffset ( )
virtual

◆ UseValueAsOffsetOn()

virtual void vtkTableBasedClipDataSet::UseValueAsOffsetOn ( )
virtual

◆ UseValueAsOffsetOff()

virtual void vtkTableBasedClipDataSet::UseValueAsOffsetOff ( )
virtual

◆ SetClipFunction()

virtual void vtkTableBasedClipDataSet::SetClipFunction ( vtkImplicitFunction )
virtual

Set/Get the implicit function with which to perform the clipping operation.

Unless an implicit function is defined, the specified input scalar data will be used for clipping.

◆ GetClipFunction()

virtual vtkImplicitFunction* vtkTableBasedClipDataSet::GetClipFunction ( )
virtual

◆ SetGenerateClipScalars()

virtual void vtkTableBasedClipDataSet::SetGenerateClipScalars ( vtkTypeBool  )
virtual

Set/Get flag GenerateClipScalars, with 0 as the default value.

With this flag on, the scalar point data values obtained by evaluating the implicit function will be exported to the output. Note that this flag requiries that an implicit function be provided.

◆ GetGenerateClipScalars()

virtual vtkTypeBool vtkTableBasedClipDataSet::GetGenerateClipScalars ( )
virtual

◆ GenerateClipScalarsOn()

virtual void vtkTableBasedClipDataSet::GenerateClipScalarsOn ( )
virtual

◆ GenerateClipScalarsOff()

virtual void vtkTableBasedClipDataSet::GenerateClipScalarsOff ( )
virtual

◆ SetLocator()

void vtkTableBasedClipDataSet::SetLocator ( vtkIncrementalPointLocator locator)

Set/Get a point locator locator for merging duplicate points.

By default, an instance of vtkMergePoints is used. Note that this IVAR is provided in this class only because this filter may resort to its sibling class vtkClipDataSet when processing some special grids (such as cylinders or cones with capping faces in the form of a vtkPolyData) while the latter requires a point locator. This filter itself does not need a locator.

◆ GetLocator()

virtual vtkIncrementalPointLocator* vtkTableBasedClipDataSet::GetLocator ( )
virtual

◆ SetMergeTolerance()

virtual void vtkTableBasedClipDataSet::SetMergeTolerance ( double  )
virtual

Set/Get the tolerance used for merging duplicate points near the clipping intersection cells.

This tolerance may prevent the generation of degenerate primitives. Note that only 3D cells actually use this IVAR.

◆ GetMergeTolerance()

virtual double vtkTableBasedClipDataSet::GetMergeTolerance ( )
virtual

◆ CreateDefaultLocator()

void vtkTableBasedClipDataSet::CreateDefaultLocator ( )

Create a default point locator when none is specified.

The point locator is used to merge coincident points.

◆ SetGenerateClippedOutput()

virtual void vtkTableBasedClipDataSet::SetGenerateClippedOutput ( vtkTypeBool  )
virtual

Set/Get whether a second output is generated.

The second output contains the polygonal data that is clipped away by the iso-surface.

◆ GetGenerateClippedOutput()

virtual vtkTypeBool vtkTableBasedClipDataSet::GetGenerateClippedOutput ( )
virtual

◆ GenerateClippedOutputOn()

virtual void vtkTableBasedClipDataSet::GenerateClippedOutputOn ( )
virtual

◆ GenerateClippedOutputOff()

virtual void vtkTableBasedClipDataSet::GenerateClippedOutputOff ( )
virtual

◆ GetClippedOutput()

vtkUnstructuredGrid* vtkTableBasedClipDataSet::GetClippedOutput ( )

Return the clipped output.

◆ SetOutputPointsPrecision()

virtual void vtkTableBasedClipDataSet::SetOutputPointsPrecision ( int  )
virtual

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::Precision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

virtual int vtkTableBasedClipDataSet::GetOutputPointsPrecision ( )
virtual

◆ RequestData()

int vtkTableBasedClipDataSet::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ FillInputPortInformation()

int vtkTableBasedClipDataSet::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 vtkUnstructuredGridAlgorithm.

◆ ClipDataSet()

void vtkTableBasedClipDataSet::ClipDataSet ( vtkDataSet pDataSet,
vtkDataArray clipAray,
vtkUnstructuredGrid unstruct 
)
protected

This function resorts to the sibling class vtkClipDataSet to handle special grids (such as cylinders or cones with capping faces in the form a vtkPolyData).

◆ ClipImageData()

void vtkTableBasedClipDataSet::ClipImageData ( vtkDataSet inputGrd,
vtkDataArray clipAray,
double  isoValue,
vtkUnstructuredGrid outputUG 
)
protected

This function takes a vtkImageData as a vtkRectilinearGrid, which is then clipped by ClipRectilinearGridData(......).

◆ ClipPolyData()

void vtkTableBasedClipDataSet::ClipPolyData ( vtkDataSet inputGrd,
vtkDataArray clipAray,
double  isoValue,
vtkUnstructuredGrid outputUG 
)
protected

This function clips a vtkPolyData object based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()).

The clipping result is exported to outputUG.

◆ ClipRectilinearGridData()

void vtkTableBasedClipDataSet::ClipRectilinearGridData ( vtkDataSet inputGrd,
vtkDataArray clipAray,
double  isoValue,
vtkUnstructuredGrid outputUG 
)
protected

This function clips a vtkRectilinearGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()).

The clipping result is exported to outputUG.

◆ ClipStructuredGridData()

void vtkTableBasedClipDataSet::ClipStructuredGridData ( vtkDataSet inputGrd,
vtkDataArray clipAray,
double  isoValue,
vtkUnstructuredGrid outputUG 
)
protected

This function clips a vtkStructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()).

The clipping result is exported to outputUG.

◆ ClipUnstructuredGridData()

void vtkTableBasedClipDataSet::ClipUnstructuredGridData ( vtkDataSet inputGrd,
vtkDataArray clipAray,
double  isoValue,
vtkUnstructuredGrid outputUG 
)
protected

This function clips a vtkUnstructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()).

The clipping result is exported to outputUG.

◆ InternalProgressCallbackFunction()

static void vtkTableBasedClipDataSet::InternalProgressCallbackFunction ( vtkObject ,
unsigned long  ,
void *  clientdata,
void *   
)
staticprotected

Register a callback function with the InternalProgressObserver.

◆ InternalProgressCallback()

void vtkTableBasedClipDataSet::InternalProgressCallback ( vtkAlgorithm algorithm)
protected

The actual operation executed by the callback function.

Member Data Documentation

◆ InsideOut

vtkTypeBool vtkTableBasedClipDataSet::InsideOut
protected

Definition at line 295 of file vtkTableBasedClipDataSet.h.

◆ GenerateClipScalars

vtkTypeBool vtkTableBasedClipDataSet::GenerateClipScalars
protected

Definition at line 296 of file vtkTableBasedClipDataSet.h.

◆ GenerateClippedOutput

vtkTypeBool vtkTableBasedClipDataSet::GenerateClippedOutput
protected

Definition at line 297 of file vtkTableBasedClipDataSet.h.

◆ UseValueAsOffset

bool vtkTableBasedClipDataSet::UseValueAsOffset
protected

Definition at line 298 of file vtkTableBasedClipDataSet.h.

◆ Value

double vtkTableBasedClipDataSet::Value
protected

Definition at line 299 of file vtkTableBasedClipDataSet.h.

◆ MergeTolerance

double vtkTableBasedClipDataSet::MergeTolerance
protected

Definition at line 300 of file vtkTableBasedClipDataSet.h.

◆ InternalProgressObserver

vtkCallbackCommand* vtkTableBasedClipDataSet::InternalProgressObserver
protected

Definition at line 301 of file vtkTableBasedClipDataSet.h.

◆ ClipFunction

vtkImplicitFunction* vtkTableBasedClipDataSet::ClipFunction
protected

Definition at line 302 of file vtkTableBasedClipDataSet.h.

◆ Locator

vtkIncrementalPointLocator* vtkTableBasedClipDataSet::Locator
protected

Definition at line 303 of file vtkTableBasedClipDataSet.h.

◆ OutputPointsPrecision

int vtkTableBasedClipDataSet::OutputPointsPrecision
protected

Definition at line 305 of file vtkTableBasedClipDataSet.h.


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