Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkConnectivityFilter Class Reference

extract data based on geometric connectivity. More...

#include <vtkConnectivityFilter.h>

Inheritance diagram for vtkConnectivityFilter:

Inheritance graph
Collaboration diagram for vtkConnectivityFilter:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetScalarConnectivity (int)
virtual int GetScalarConnectivity ()
virtual void ScalarConnectivityOn ()
virtual void ScalarConnectivityOff ()
virtual void SetScalarRange (float, float)
void SetScalarRange (float[2])
virtual float * GetScalarRange ()
virtual void GetScalarRange (float &, float &)
virtual void GetScalarRange (float[2])
virtual void SetExtractionMode (int)
virtual int GetExtractionMode ()
void SetExtractionModeToPointSeededRegions ()
void SetExtractionModeToCellSeededRegions ()
void SetExtractionModeToLargestRegion ()
void SetExtractionModeToSpecifiedRegions ()
void SetExtractionModeToClosestPointRegion ()
void SetExtractionModeToAllRegions ()
const char * GetExtractionModeAsString ()
void InitializeSeedList ()
void AddSeed (int id)
void DeleteSeed (int id)
void InitializeSpecifiedRegionList ()
void AddSpecifiedRegion (int id)
void DeleteSpecifiedRegion (int id)
virtual void SetClosestPoint (float, float, float)
virtual void SetClosestPoint (float[3])
virtual float * GetClosestPoint ()
virtual void GetClosestPoint (float data[3])
int GetNumberOfExtractedRegions ()
virtual void SetColorRegions (int)
virtual int GetColorRegions ()
virtual void ColorRegionsOn ()
virtual void ColorRegionsOff ()
void SetMaxRecursionDepth (int)
int GetMaxRecursionDepth ()

Static Public Methods

int IsTypeOf (const char *type)
vtkConnectivityFilter * SafeDownCast (vtkObject *o)
vtkConnectivityFilter * New ()

Protected Methods

 vtkConnectivityFilter ()
 ~vtkConnectivityFilter ()
 vtkConnectivityFilter (const vtkConnectivityFilter &)
void operator= (const vtkConnectivityFilter &)
void Execute ()
void TraverseAndMark ()

Protected Attributes

int ColorRegions
int ExtractionMode
float ClosestPoint [3]
int ScalarConnectivity
float ScalarRange [2]

Detailed Description

extract data based on geometric connectivity.

2000/12/10 20:08:32

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:
vtkConnectivityFilter (examples)

Definition at line 91 of file vtkConnectivityFilter.h.

Constructor & Destructor Documentation

vtkConnectivityFilter::vtkConnectivityFilter   [protected]

vtkConnectivityFilter::~vtkConnectivityFilter   [protected]

vtkConnectivityFilter::vtkConnectivityFilter const vtkConnectivityFilter &    [inline, protected]

Definition at line 174 of file vtkConnectivityFilter.h.

Member Function Documentation

virtual const char* vtkConnectivityFilter::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToUnstructuredGridFilter.

int vtkConnectivityFilter::IsTypeOf const char *    type [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 vtkDataSetToUnstructuredGridFilter.

virtual int vtkConnectivityFilter::IsA const char *    type [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 vtkDataSetToUnstructuredGridFilter.

vtkConnectivityFilter* vtkConnectivityFilter::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToUnstructuredGridFilter.

void vtkConnectivityFilter::PrintSelf ostream &    os,
vtkIndent    indent

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 vtkSource.

vtkConnectivityFilter* vtkConnectivityFilter::New   [static]

Construct with default extraction mode to extract largest regions.

Reimplemented from vtkUnstructuredGridSource.

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]

virtual void vtkConnectivityFilter::ScalarConnectivityOn   [virtual]

virtual void vtkConnectivityFilter::ScalarConnectivityOff   [virtual]

virtual void vtkConnectivityFilter::SetScalarRange float   ,

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

void vtkConnectivityFilter::SetScalarRange float   [2]

virtual float* vtkConnectivityFilter::GetScalarRange   [virtual]

virtual void vtkConnectivityFilter::GetScalarRange float &   ,
float &   

virtual void vtkConnectivityFilter::GetScalarRange float   [2] [virtual]

virtual void vtkConnectivityFilter::SetExtractionMode int    [virtual]

Control the extraction of connected surfaces.

virtual int vtkConnectivityFilter::GetExtractionMode   [virtual]

void vtkConnectivityFilter::SetExtractionModeToPointSeededRegions   [inline]

Definition at line 116 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToCellSeededRegions   [inline]

Definition at line 118 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToLargestRegion   [inline]

Definition at line 120 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToSpecifiedRegions   [inline]

Definition at line 122 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToClosestPointRegion   [inline]

Definition at line 124 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::SetExtractionModeToAllRegions   [inline]

Definition at line 126 of file vtkConnectivityFilter.h.

const char * vtkConnectivityFilter::GetExtractionModeAsString void    [inline]

Return the method of extraction as a string.

Definition at line 211 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::InitializeSeedList  

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

void vtkConnectivityFilter::AddSeed int    id

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

void vtkConnectivityFilter::DeleteSeed int    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 float   ,
float   ,

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

virtual void vtkConnectivityFilter::SetClosestPoint float   [3] [virtual]

virtual float* vtkConnectivityFilter::GetClosestPoint   [virtual]

virtual void vtkConnectivityFilter::GetClosestPoint float    data[3] [virtual]

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]

virtual void vtkConnectivityFilter::ColorRegionsOn   [virtual]

virtual void vtkConnectivityFilter::ColorRegionsOff   [virtual]

void vtkConnectivityFilter::SetMaxRecursionDepth int    [inline]

FOR LEGACY COMPATIBILITY ONLY, DO NOT USE. The connectivity extraction algorithm works recursively. In some systems the stack depth is limited. This methods specifies the maximum recursion depth.

Definition at line 165 of file vtkConnectivityFilter.h.

int vtkConnectivityFilter::GetMaxRecursionDepth   [inline]

Definition at line 167 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::operator= const vtkConnectivityFilter &    [inline, protected]

Definition at line 175 of file vtkConnectivityFilter.h.

void vtkConnectivityFilter::Execute   [protected, virtual]

Reimplemented from vtkSource.

void vtkConnectivityFilter::TraverseAndMark   [protected]

Member Data Documentation

int vtkConnectivityFilter::ColorRegions [protected]

Definition at line 180 of file vtkConnectivityFilter.h.

int vtkConnectivityFilter::ExtractionMode [protected]

Definition at line 181 of file vtkConnectivityFilter.h.

vtkIdList* vtkConnectivityFilter::Seeds [protected]

Definition at line 182 of file vtkConnectivityFilter.h.

vtkIdList* vtkConnectivityFilter::SpecifiedRegionIds [protected]

Definition at line 183 of file vtkConnectivityFilter.h.

vtkIntArray* vtkConnectivityFilter::RegionSizes [protected]

Definition at line 184 of file vtkConnectivityFilter.h.

float vtkConnectivityFilter::ClosestPoint[3] [protected]

Definition at line 186 of file vtkConnectivityFilter.h.

int vtkConnectivityFilter::ScalarConnectivity [protected]

Definition at line 188 of file vtkConnectivityFilter.h.

float vtkConnectivityFilter::ScalarRange[2] [protected]

Definition at line 189 of file vtkConnectivityFilter.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:47:01 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001