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

extract cells that lie either entirely inside or outside of a specified implicit function More...

#include <vtkExtractGeometry.h>

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

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass
- Public Types inherited from vtkUnstructuredGridAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
virtual void SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetImplicitFunction ()
virtual void SetExtractInside (int)
virtual int GetExtractInside ()
virtual void ExtractInsideOn ()
virtual void ExtractInsideOff ()
virtual void SetExtractBoundaryCells (int)
virtual int GetExtractBoundaryCells ()
virtual void ExtractBoundaryCellsOn ()
virtual void ExtractBoundaryCellsOff ()
virtual void SetExtractOnlyBoundaryCells (int)
virtual int GetExtractOnlyBoundaryCells ()
virtual void ExtractOnlyBoundaryCellsOn ()
virtual void ExtractOnlyBoundaryCellsOff ()
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkUnstructuredGridGetUnstructuredGridInput (int port)
vtkUnstructuredGridGetOutput ()
vtkUnstructuredGridGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
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)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkExtractGeometrySafeDownCast (vtkObject *o)
static vtkExtractGeometryNew ()

Protected Member Functions

 vtkExtractGeometry (vtkImplicitFunction *f=NULL)
 ~vtkExtractGeometry ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
 vtkUnstructuredGridAlgorithm ()
 ~vtkUnstructuredGridAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkImplicitFunctionImplicitFunction
int ExtractInside
int ExtractBoundaryCells
int ExtractOnlyBoundaryCells

Additional Inherited Members

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

Detailed Description

extract cells that lie either entirely inside or outside of a specified implicit function

vtkExtractGeometry extracts from its input dataset all cells that are either completely inside or outside of a specified implicit function. Any type of dataset can be input to this filter. On output the filter generates an unstructured grid.

To use this filter you must specify an implicit function. You must also specify whethter to extract cells lying inside or outside of the implicit function. (The inside of an implicit function is the negative values region.) An option exists to extract cells that are neither inside or outside (i.e., boundary).

A more efficient version of this filter is available for vtkPolyData input. See vtkExtractPolyDataGeometry.

See Also
vtkExtractPolyDataGeometry vtkGeometryFilter vtkExtractVOI
Examples:
vtkExtractGeometry (Examples)
Tests:
vtkExtractGeometry (Tests)

Definition at line 50 of file vtkExtractGeometry.h.

Member Typedef Documentation

Definition at line 53 of file vtkExtractGeometry.h.

Constructor & Destructor Documentation

vtkExtractGeometry::vtkExtractGeometry ( vtkImplicitFunction f = NULL)
protected
vtkExtractGeometry::~vtkExtractGeometry ( )
protected

Member Function Documentation

virtual const char* vtkExtractGeometry::GetClassName ( )
virtual

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkExtractGeometry::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int vtkExtractGeometry::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.

static vtkExtractGeometry* vtkExtractGeometry::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkExtractGeometry::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

static vtkExtractGeometry* vtkExtractGeometry::New ( )
static

Construct object with ExtractInside turned on.

Reimplemented from vtkUnstructuredGridAlgorithm.

unsigned long vtkExtractGeometry::GetMTime ( )
virtual

Return the MTime taking into account changes to the implicit function

Reimplemented from vtkObject.

virtual void vtkExtractGeometry::SetImplicitFunction ( vtkImplicitFunction )
virtual

Specify the implicit function for inside/outside checks.

virtual vtkImplicitFunction* vtkExtractGeometry::GetImplicitFunction ( )
virtual

Specify the implicit function for inside/outside checks.

virtual void vtkExtractGeometry::SetExtractInside ( int  )
virtual

Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).

virtual int vtkExtractGeometry::GetExtractInside ( )
virtual

Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).

virtual void vtkExtractGeometry::ExtractInsideOn ( )
virtual

Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).

virtual void vtkExtractGeometry::ExtractInsideOff ( )
virtual

Boolean controls whether to extract cells that are inside of implicit function (ExtractInside == 1) or outside of implicit function (ExtractInside == 0).

virtual void vtkExtractGeometry::SetExtractBoundaryCells ( int  )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual int vtkExtractGeometry::GetExtractBoundaryCells ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual void vtkExtractGeometry::ExtractBoundaryCellsOn ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual void vtkExtractGeometry::ExtractBoundaryCellsOff ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual void vtkExtractGeometry::SetExtractOnlyBoundaryCells ( int  )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual int vtkExtractGeometry::GetExtractOnlyBoundaryCells ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual void vtkExtractGeometry::ExtractOnlyBoundaryCellsOn ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual void vtkExtractGeometry::ExtractOnlyBoundaryCellsOff ( )
virtual

Boolean controls whether to extract cells that are partially inside. By default, ExtractBoundaryCells is off.

virtual int vtkExtractGeometry::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkExtractGeometry::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

Member Data Documentation

vtkImplicitFunction* vtkExtractGeometry::ImplicitFunction
protected

Definition at line 97 of file vtkExtractGeometry.h.

int vtkExtractGeometry::ExtractInside
protected

Definition at line 98 of file vtkExtractGeometry.h.

int vtkExtractGeometry::ExtractBoundaryCells
protected

Definition at line 99 of file vtkExtractGeometry.h.

int vtkExtractGeometry::ExtractOnlyBoundaryCells
protected

Definition at line 100 of file vtkExtractGeometry.h.


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