VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkClipVolume Class Reference

clip volume data with user-specified implicit function or input scalar data More...

#include <vtkClipVolume.h>

Inherits vtkUnstructuredGridAlgorithm.

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkClipVolumeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkUnstructuredGrid * GetClippedOutput ()
 
void CreateDefaultLocator ()
 
unsigned long int GetMTime ()
 
virtual void SetValue (double)
 
virtual double GetValue ()
 
virtual void SetInsideOut (int)
 
virtual int GetInsideOut ()
 
virtual void InsideOutOn ()
 
virtual void InsideOutOff ()
 
virtual void SetClipFunction (vtkImplicitFunction *)
 
virtual vtkImplicitFunction * GetClipFunction ()
 
virtual void SetGenerateClipScalars (int)
 
virtual int GetGenerateClipScalars ()
 
virtual void GenerateClipScalarsOn ()
 
virtual void GenerateClipScalarsOff ()
 
virtual void SetGenerateClippedOutput (int)
 
virtual int GetGenerateClippedOutput ()
 
virtual void GenerateClippedOutputOn ()
 
virtual void GenerateClippedOutputOff ()
 
virtual void SetMixed3DCellGeneration (int)
 
virtual int GetMixed3DCellGeneration ()
 
virtual void Mixed3DCellGenerationOn ()
 
virtual void Mixed3DCellGenerationOff ()
 
virtual void SetMergeTolerance (double)
 
virtual double GetMergeTolerance ()
 
void SetLocator (vtkIncrementalPointLocator *locator)
 
virtual
vtkIncrementalPointLocator * 
GetLocator ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkClipVolumeSafeDownCast (vtkObjectBase *o)
 
static vtkClipVolumeNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkClipVolume (vtkImplicitFunction *cf=NULL)
 
 ~vtkClipVolume ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
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)
 

Protected Attributes

vtkImplicitFunction * ClipFunction
 
vtkIncrementalPointLocator * Locator
 
int InsideOut
 
double Value
 
int GenerateClipScalars
 
double MergeTolerance
 
int Mixed3DCellGeneration
 
int GenerateClippedOutput
 
vtkUnstructuredGrid * ClippedOutput
 

Detailed Description

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

Definition at line 85 of file vtkClipVolume.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkClipVolume::Superclass

Definition at line 88 of file vtkClipVolume.h.

Constructor & Destructor Documentation

vtkClipVolume::vtkClipVolume ( vtkImplicitFunction *  cf = NULL)
protected
vtkClipVolume::~vtkClipVolume ( )
protected

Member Function Documentation

static int vtkClipVolume::IsTypeOf ( const char *  type)
static
virtual int vtkClipVolume::IsA ( const char *  type)
virtual
static vtkClipVolume* vtkClipVolume::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkClipVolume::NewInstanceInternal ( ) const
protectedvirtual
vtkClipVolume* vtkClipVolume::NewInstance ( ) const
void vtkClipVolume::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkClipVolume* vtkClipVolume::New ( )
static

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.

virtual void vtkClipVolume::SetValue ( double  )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual double vtkClipVolume::GetValue ( )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual void vtkClipVolume::SetInsideOut ( int  )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual int vtkClipVolume::GetInsideOut ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipVolume::InsideOutOn ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipVolume::InsideOutOff ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipVolume::SetClipFunction ( vtkImplicitFunction *  )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkClipVolume::GetClipFunction ( )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the input scalar data will be used for clipping.

virtual void vtkClipVolume::SetGenerateClipScalars ( int  )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual int vtkClipVolume::GetGenerateClipScalars ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipVolume::GenerateClipScalarsOn ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipVolume::GenerateClipScalarsOff ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipVolume::SetGenerateClippedOutput ( int  )
virtual

Control whether a second output is generated. The second output contains the unstructured grid that's been clipped away.

virtual int vtkClipVolume::GetGenerateClippedOutput ( )
virtual

Control whether a second output is generated. The second output contains the unstructured grid that's been clipped away.

virtual void vtkClipVolume::GenerateClippedOutputOn ( )
virtual

Control whether a second output is generated. The second output contains the unstructured grid that's been clipped away.

virtual void vtkClipVolume::GenerateClippedOutputOff ( )
virtual

Control whether a second output is generated. The second output contains the unstructured grid that's been clipped away.

vtkUnstructuredGrid* vtkClipVolume::GetClippedOutput ( )

Return the clipped output.

virtual void vtkClipVolume::SetMixed3DCellGeneration ( int  )
virtual

Control whether the filter produces a mix of 3D cell types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)

virtual int vtkClipVolume::GetMixed3DCellGeneration ( )
virtual

Control whether the filter produces a mix of 3D cell types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)

virtual void vtkClipVolume::Mixed3DCellGenerationOn ( )
virtual

Control whether the filter produces a mix of 3D cell types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)

virtual void vtkClipVolume::Mixed3DCellGenerationOff ( )
virtual

Control whether the filter produces a mix of 3D cell types on output, or whether the output cells are all tetrahedra. By default, a mixed set of cells (e.g., tetrahedra and wedges) is produced. (Note: mixed type generation is faster and less overall data is generated.)

virtual void vtkClipVolume::SetMergeTolerance ( double  )
virtual

Set the tolerance for merging clip intersection points that are near the corners of voxels. This tolerance is used to prevent the generation of degenerate tetrahedra.

virtual double vtkClipVolume::GetMergeTolerance ( )
virtual

Set the tolerance for merging clip intersection points that are near the corners of voxels. This tolerance is used to prevent the generation of degenerate tetrahedra.

void vtkClipVolume::SetLocator ( vtkIncrementalPointLocator *  locator)

Set / Get a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

virtual vtkIncrementalPointLocator* vtkClipVolume::GetLocator ( )
virtual

Set / Get a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void vtkClipVolume::CreateDefaultLocator ( )

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

unsigned long int vtkClipVolume::GetMTime ( )

Return the mtime also considering the locator and clip function.

virtual void vtkClipVolume::ReportReferences ( vtkGarbageCollector *  )
protectedvirtual
virtual int vtkClipVolume::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkClipVolume::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual
void vtkClipVolume::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 
)
protected
void vtkClipVolume::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 
)
protected

Member Data Documentation

vtkImplicitFunction* vtkClipVolume::ClipFunction
protected

Definition at line 195 of file vtkClipVolume.h.

vtkIncrementalPointLocator* vtkClipVolume::Locator
protected

Definition at line 196 of file vtkClipVolume.h.

int vtkClipVolume::InsideOut
protected

Definition at line 197 of file vtkClipVolume.h.

double vtkClipVolume::Value
protected

Definition at line 198 of file vtkClipVolume.h.

int vtkClipVolume::GenerateClipScalars
protected

Definition at line 199 of file vtkClipVolume.h.

double vtkClipVolume::MergeTolerance
protected

Definition at line 200 of file vtkClipVolume.h.

int vtkClipVolume::Mixed3DCellGeneration
protected

Definition at line 201 of file vtkClipVolume.h.

int vtkClipVolume::GenerateClippedOutput
protected

Definition at line 202 of file vtkClipVolume.h.

vtkUnstructuredGrid* vtkClipVolume::ClippedOutput
protected

Definition at line 203 of file vtkClipVolume.h.


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