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

extract data based on geometric connectivity More...

#include <vtkConnectivityFilter.h>

Inheritance diagram for vtkConnectivityFilter:
[legend]
Collaboration diagram for vtkConnectivityFilter:
[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)
void InitializeSeedList ()
void AddSeed (vtkIdType id)
void DeleteSeed (vtkIdType id)
void InitializeSpecifiedRegionList ()
void AddSpecifiedRegion (int id)
void DeleteSpecifiedRegion (int id)
int GetNumberOfExtractedRegions ()
virtual void SetScalarConnectivity (int)
virtual int GetScalarConnectivity ()
virtual void ScalarConnectivityOn ()
virtual void ScalarConnectivityOff ()
virtual void SetScalarRange (double, double)
void SetScalarRange (double[2])
virtual double * GetScalarRange ()
virtual void GetScalarRange (double &, double &)
virtual void GetScalarRange (double[2])
virtual void SetExtractionMode (int)
virtual int GetExtractionMode ()
void SetExtractionModeToPointSeededRegions ()
void SetExtractionModeToCellSeededRegions ()
void SetExtractionModeToLargestRegion ()
void SetExtractionModeToSpecifiedRegions ()
void SetExtractionModeToClosestPointRegion ()
void SetExtractionModeToAllRegions ()
const char * GetExtractionModeAsString ()
virtual void SetClosestPoint (double, double, double)
virtual void SetClosestPoint (double[3])
virtual double * GetClosestPoint ()
virtual void GetClosestPoint (double data[3])
virtual void SetColorRegions (int)
virtual int GetColorRegions ()
virtual void ColorRegionsOn ()
virtual void ColorRegionsOff ()
- 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 ()
virtual unsigned long GetMTime ()
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 vtkConnectivityFilterSafeDownCast (vtkObject *o)
static vtkConnectivityFilterNew ()

Protected Member Functions

 vtkConnectivityFilter ()
 ~vtkConnectivityFilter ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
void TraverseAndMark (vtkDataSet *input)
- 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

int ColorRegions
int ExtractionMode
vtkIdListSeeds
vtkIdListSpecifiedRegionIds
vtkIdTypeArrayRegionSizes
double ClosestPoint [3]
int ScalarConnectivity
double ScalarRange [2]

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 data based on geometric connectivity

vtkConnectivityFilter is a filter that extracts cells that share common points and/or meet other connectivity criterion. (Cells that share vertices and meet other connectivity criterion such as scalar range are known as a region.) The filter works in one of six ways: 1) extract the largest connected region in the dataset; 2) extract specified region numbers; 3) extract all regions sharing specified point ids; 4) extract all regions sharing specified cell ids; 5) extract the region closest to the specified point; or 6) extract all regions (used to color the data by region).

vtkConnectivityFilter is generalized to handle any type of input dataset. It generates output data of type vtkUnstructuredGrid. If you know that your input type is vtkPolyData, you may wish to use vtkPolyDataConnectivityFilter.

The behavior of vtkConnectivityFilter can be modified by turning on the boolean ivar ScalarConnectivity. If this flag is on, the connectivity algorithm is modified so that cells are considered connected only if 1) they are geometrically connected (share a point) and 2) the scalar values of one of the cell's points falls in the scalar range specified. This use of ScalarConnectivity is particularly useful for volume datasets: it can be used as a simple "connected segmentation" algorithm. For example, by using a seed voxel (i.e., cell) on a known anatomical structure, connectivity will pull out all voxels "containing" the anatomical structure. These voxels can then be contoured or processed by other visualization filters.

See Also
vtkPolyDataConnectivityFilter
Examples:
vtkConnectivityFilter (Examples)
Tests:
vtkConnectivityFilter (Tests)

Definition at line 73 of file vtkConnectivityFilter.h.

Member Typedef Documentation

Definition at line 76 of file vtkConnectivityFilter.h.

Constructor & Destructor Documentation

vtkConnectivityFilter::vtkConnectivityFilter ( )
protected
vtkConnectivityFilter::~vtkConnectivityFilter ( )
protected

Member Function Documentation

virtual const char* vtkConnectivityFilter::GetClassName ( )
virtual

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkConnectivityFilter::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 vtkConnectivityFilter::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 vtkConnectivityFilter* vtkConnectivityFilter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkConnectivityFilter::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 vtkConnectivityFilter* vtkConnectivityFilter::New ( )
static

Construct with default extraction mode to extract largest regions.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual void vtkConnectivityFilter::SetScalarConnectivity ( int  )
virtual

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual int vtkConnectivityFilter::GetScalarConnectivity ( )
virtual

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkConnectivityFilter::ScalarConnectivityOn ( )
virtual

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkConnectivityFilter::ScalarConnectivityOff ( )
virtual

Turn on/off connectivity based on scalar value. If on, cells are connected only if they share points AND one of the cells scalar values falls in the scalar range specified.

virtual void vtkConnectivityFilter::SetScalarRange ( double  ,
double   
)
virtual

Set the scalar range to use to extract cells based on scalar connectivity.

void vtkConnectivityFilter::SetScalarRange ( double  [2])

Set the scalar range to use to extract cells based on scalar connectivity.

virtual double* vtkConnectivityFilter::GetScalarRange ( )
virtual

Set the scalar range to use to extract cells based on scalar connectivity.

virtual void vtkConnectivityFilter::GetScalarRange ( double &  ,
double &   
)
virtual

Set the scalar range to use to extract cells based on scalar connectivity.

virtual void vtkConnectivityFilter::GetScalarRange ( double  [2])
virtual

Set the scalar range to use to extract cells based on scalar connectivity.

virtual void vtkConnectivityFilter::SetExtractionMode ( int  )
virtual

Control the extraction of connected surfaces.

virtual int vtkConnectivityFilter::GetExtractionMode ( )
virtual

Control the extraction of connected surfaces.

void vtkConnectivityFilter::SetExtractionModeToPointSeededRegions ( )
inline

Control the extraction of connected surfaces.

Definition at line 103 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToCellSeededRegions ( )
inline

Control the extraction of connected surfaces.

Definition at line 105 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToLargestRegion ( )
inline

Control the extraction of connected surfaces.

Definition at line 107 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToSpecifiedRegions ( )
inline

Control the extraction of connected surfaces.

Definition at line 109 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToClosestPointRegion ( )
inline

Control the extraction of connected surfaces.

Definition at line 111 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToAllRegions ( )
inline

Control the extraction of connected surfaces.

Definition at line 113 of file vtkConnectivityFilter.h.

const char * vtkConnectivityFilter::GetExtractionModeAsString ( void  )
inline

Return the method of extraction as a string.

Definition at line 197 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::InitializeSeedList ( )

Initialize list of point ids/cell ids used to seed regions.

void vtkConnectivityFilter::AddSeed ( vtkIdType  id)

Add a seed id (point or cell id). Note: ids are 0-offset.

void vtkConnectivityFilter::DeleteSeed ( vtkIdType  id)

Delete a seed id (point or cell id). Note: ids are 0-offset.

void vtkConnectivityFilter::InitializeSpecifiedRegionList ( )

Initialize list of region ids to extract.

void vtkConnectivityFilter::AddSpecifiedRegion ( int  id)

Add a region id to extract. Note: ids are 0-offset.

void vtkConnectivityFilter::DeleteSpecifiedRegion ( int  id)

Delete a region id to extract. Note: ids are 0-offset.

virtual void vtkConnectivityFilter::SetClosestPoint ( double  ,
double  ,
double   
)
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkConnectivityFilter::SetClosestPoint ( double  [3])
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual double* vtkConnectivityFilter::GetClosestPoint ( )
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

virtual void vtkConnectivityFilter::GetClosestPoint ( double  data[3])
virtual

Use to specify x-y-z point coordinates when extracting the region closest to a specified point.

int vtkConnectivityFilter::GetNumberOfExtractedRegions ( )

Obtain the number of connected regions.

virtual void vtkConnectivityFilter::SetColorRegions ( int  )
virtual

Turn on/off the coloring of connected regions.

virtual int vtkConnectivityFilter::GetColorRegions ( )
virtual

Turn on/off the coloring of connected regions.

virtual void vtkConnectivityFilter::ColorRegionsOn ( )
virtual

Turn on/off the coloring of connected regions.

virtual void vtkConnectivityFilter::ColorRegionsOff ( )
virtual

Turn on/off the coloring of connected regions.

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

void vtkConnectivityFilter::TraverseAndMark ( vtkDataSet input)
protected

Member Data Documentation

int vtkConnectivityFilter::ColorRegions
protected

Definition at line 161 of file vtkConnectivityFilter.h.

int vtkConnectivityFilter::ExtractionMode
protected

Definition at line 162 of file vtkConnectivityFilter.h.

vtkIdList* vtkConnectivityFilter::Seeds
protected

Definition at line 163 of file vtkConnectivityFilter.h.

vtkIdList* vtkConnectivityFilter::SpecifiedRegionIds
protected

Definition at line 164 of file vtkConnectivityFilter.h.

vtkIdTypeArray* vtkConnectivityFilter::RegionSizes
protected

Definition at line 165 of file vtkConnectivityFilter.h.

double vtkConnectivityFilter::ClosestPoint[3]
protected

Definition at line 167 of file vtkConnectivityFilter.h.

int vtkConnectivityFilter::ScalarConnectivity
protected

Definition at line 169 of file vtkConnectivityFilter.h.

double vtkConnectivityFilter::ScalarRange[2]
protected

Definition at line 170 of file vtkConnectivityFilter.h.


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