|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkClipVolume * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More...
|
|
virtual void | SetValue (double) |
| Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). More...
|
|
virtual double | GetValue () |
|
virtual void | SetInsideOut (vtkTypeBool) |
| Set/Get the InsideOut flag. More...
|
|
virtual vtkTypeBool | GetInsideOut () |
|
virtual void | InsideOutOn () |
|
virtual void | InsideOutOff () |
|
virtual void | SetClipFunction (vtkImplicitFunction *) |
| Specify the implicit function with which to perform the clipping. More...
|
|
virtual vtkImplicitFunction * | GetClipFunction () |
|
virtual void | SetGenerateClipScalars (vtkTypeBool) |
| If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. More...
|
|
virtual vtkTypeBool | GetGenerateClipScalars () |
|
virtual void | GenerateClipScalarsOn () |
|
virtual void | GenerateClipScalarsOff () |
|
virtual void | SetGenerateClippedOutput (vtkTypeBool) |
| Control whether a second output is generated. More...
|
|
virtual vtkTypeBool | GetGenerateClippedOutput () |
|
virtual void | GenerateClippedOutputOn () |
|
virtual void | GenerateClippedOutputOff () |
|
vtkUnstructuredGrid * | GetClippedOutput () |
| Return the clipped output. More...
|
|
virtual void | SetMixed3DCellGeneration (vtkTypeBool) |
| Control whether the filter produces a mix of 3D cell types on output, or whether the output cells are all tetrahedra. More...
|
|
virtual vtkTypeBool | GetMixed3DCellGeneration () |
|
virtual void | Mixed3DCellGenerationOn () |
|
virtual void | Mixed3DCellGenerationOff () |
|
virtual void | SetMergeTolerance (double) |
| Set the tolerance for merging clip intersection points that are near the corners of voxels. More...
|
|
virtual double | GetMergeTolerance () |
|
void | SetLocator (vtkIncrementalPointLocator *locator) |
| Set / Get a spatial locator for merging points. More...
|
|
virtual vtkIncrementalPointLocator * | GetLocator () |
|
void | CreateDefaultLocator () |
| Create default locator. More...
|
|
vtkMTimeType | GetMTime () override |
| Return the mtime also considering the locator and clip function. More...
|
|
vtkUnstructuredGridAlgorithm * | NewInstance () const |
|
vtkUnstructuredGrid * | GetOutput () |
| Get the output data object for a port on this algorithm. More...
|
|
vtkUnstructuredGrid * | GetOutput (int) |
|
virtual void | SetOutput (vtkDataObject *d) |
|
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
| see vtkAlgorithm for details More...
|
|
vtkDataObject * | GetInput (int port) |
|
vtkDataObject * | GetInput () |
|
vtkUnstructuredGrid * | GetUnstructuredGridInput (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 *) |
|
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...
|
|
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...
|
|
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...
|
|
virtual vtkInformation * | GetInformation () |
| 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...
|
|
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 | 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) |
|
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 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 vtkProgressObserver * | GetProgressObserver () |
|
| 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) |
|
vtkCommand * | GetCommand (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) |
|
const char * | GetClassName () const |
| Return the class name as a string. More...
|
|
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
|
|
bool | GetIsInMemkind () const |
| A local state flag that remembers whether this object lives in the normal or extended memory space. More...
|
|
|
virtual vtkObjectBase * | NewInstanceInternal () const |
|
| vtkClipVolume (vtkImplicitFunction *cf=nullptr) |
|
| ~vtkClipVolume () override |
|
void | ReportReferences (vtkGarbageCollector *) 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 | ClipTets (double value, vtkTetra *clipTetra, vtkDataArray *clipScalars, vtkDataArray *cellScalars, vtkIdList *tetraIds, vtkPoints *tetraPts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD, vtkCellData *clippedCD, int insideOut) |
|
void | ClipVoxel (double value, vtkDataArray *cellScalars, int flip, double origin[3], double spacing[3], vtkIdList *cellIds, vtkPoints *cellPts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD, vtkCellData *clippedCD) |
|
| 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...
|
|
| 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) |
|
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) |
|
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) |
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input) |
|
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association) |
|
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) |
|
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) |
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input) |
|
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association) |
|
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...
|
|
virtual void | SetErrorCode (unsigned long) |
| The error code contains a possible error that occurred while reading or writing the file. More...
|
|
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) |
|
| 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 () |
|
| vtkObjectBase () |
|
virtual | ~vtkObjectBase () |
|
| vtkObjectBase (const vtkObjectBase &) |
|
void | operator= (const vtkObjectBase &) |
|
clip volume data with user-specified implicit function or input scalar data
vtkClipVolume is a filter that clips volume data (i.e., vtkImageData) using either: any subclass of vtkImplicitFunction or the input scalar data. The clipping operation cuts through the cells of the dataset–converting 3D image data into a 3D unstructured grid–returning everything inside of the specified implicit function (or greater than the scalar value). During the clipping the filter will produce pieces of a cell. (Compare this with vtkExtractGeometry or vtkGeometryFilter, which produces entire, uncut cells.) The output of this filter is a 3D unstructured grid (e.g., tetrahedra or other 3D cell types).
To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input scalar data. If you want to clip with an implicit function, you must first define and then set the implicit function with the SetClipFunction() method. Otherwise, you must make sure input scalar data is available. You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function. You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The cutting algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the dataset. This is compared to the scalar value to determine inside/outside.)
This filter can be configured to compute a second output. The second output is the portion of the volume that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.
The filter will produce an unstructured grid of entirely tetrahedra or a mixed grid of tetrahedra and other 3D cell types (e.g., wedges). Control this behavior by setting the Mixed3DCellGeneration. By default the Mixed3DCellGeneration is on and a combination of cell types will be produced. Note that producing mixed cell types is a faster than producing only tetrahedra.
- Warning
- This filter is designed to function with 3D structured points. Clipping 2D images should be done by converting the image to polygonal data and using vtkClipPolyData,
- See also
- vtkImplicitFunction vtkClipPolyData vtkGeometryFilter vtkExtractGeometry
Definition at line 83 of file vtkClipVolume.h.