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
vtkTreeDifferenceFilter Class Reference

compare two trees More...

#include <vtkTreeDifferenceFilter.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTreeDifferenceFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetIdArrayName (const char *)
 
virtual char * GetIdArrayName ()
 
virtual void SetComparisonArrayName (const char *)
 
virtual char * GetComparisonArrayName ()
 
virtual void SetOutputArrayName (const char *)
 
virtual char * GetOutputArrayName ()
 
virtual void SetComparisonArrayIsVertexData (bool)
 
virtual bool GetComparisonArrayIsVertexData ()
 

Static Public Member Functions

static vtkTreeDifferenceFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeDifferenceFilterSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTreeDifferenceFilter ()
 
 ~vtkTreeDifferenceFilter ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
bool GenerateMapping (vtkTree *tree1, vtkTree *tree2)
 
vtkSmartPointer< vtkDoubleArray > ComputeDifference (vtkTree *tree1, vtkTree *tree2)
 

Protected Attributes

char * IdArrayName
 
char * ComparisonArrayName
 
char * OutputArrayName
 
bool ComparisonArrayIsVertexData
 
std::vector< vtkIdType > VertexMap
 
std::vector< vtkIdType > EdgeMap
 

Detailed Description

compare two trees

vtkTreeDifferenceFilter compares two trees by analyzing a vtkDoubleArray. Each tree must have a copy of this array. A user of this filter should call SetComparisonArrayName to specify the array that should be used as the basis of coparison. This array can either be part of the trees' EdgeData or VertexData.

Tests:
vtkTreeDifferenceFilter (Tests)

Definition at line 43 of file vtkTreeDifferenceFilter.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkTreeDifferenceFilter::Superclass

Definition at line 47 of file vtkTreeDifferenceFilter.h.

Constructor & Destructor Documentation

vtkTreeDifferenceFilter::vtkTreeDifferenceFilter ( )
protected
vtkTreeDifferenceFilter::~vtkTreeDifferenceFilter ( )
protected

Member Function Documentation

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

Set/Get the name of the identifier array in the trees' VertexData. This array is used to find corresponding vertices in the two trees. If this array name is not set, then we assume that the vertices in the two trees to compare have corresponding vtkIdTypes. Otherwise, the named array must be a vtkStringArray. The identifier array does not necessarily have to specify a name for each vertex in the tree. If some vertices are unnamed, then this filter will assign correspondence between ancestors of named vertices.

virtual char* vtkTreeDifferenceFilter::GetIdArrayName ( )
virtual

Set/Get the name of the identifier array in the trees' VertexData. This array is used to find corresponding vertices in the two trees. If this array name is not set, then we assume that the vertices in the two trees to compare have corresponding vtkIdTypes. Otherwise, the named array must be a vtkStringArray. The identifier array does not necessarily have to specify a name for each vertex in the tree. If some vertices are unnamed, then this filter will assign correspondence between ancestors of named vertices.

virtual void vtkTreeDifferenceFilter::SetComparisonArrayName ( const char *  )
virtual

Set/Get the name of the array that we're comparing between the two trees. The named array must be a vtkDoubleArray.

virtual char* vtkTreeDifferenceFilter::GetComparisonArrayName ( )
virtual

Set/Get the name of the array that we're comparing between the two trees. The named array must be a vtkDoubleArray.

virtual void vtkTreeDifferenceFilter::SetOutputArrayName ( const char *  )
virtual

Set/Get the name of a new vtkDoubleArray that will contain the results of the comparison between the two trees. This new array will be added to the input tree's VertexData or EdgeData, based on the value of ComparisonArrayIsVertexData. If this method is not called, the new vtkDoubleArray will be named "difference" by default.

virtual char* vtkTreeDifferenceFilter::GetOutputArrayName ( )
virtual

Set/Get the name of a new vtkDoubleArray that will contain the results of the comparison between the two trees. This new array will be added to the input tree's VertexData or EdgeData, based on the value of ComparisonArrayIsVertexData. If this method is not called, the new vtkDoubleArray will be named "difference" by default.

virtual void vtkTreeDifferenceFilter::SetComparisonArrayIsVertexData ( bool  )
virtual

Specify whether the comparison array is within the trees' vertex data or not. By default, we assume that the array to compare is within the trees' EdgeData().

virtual bool vtkTreeDifferenceFilter::GetComparisonArrayIsVertexData ( )
virtual

Specify whether the comparison array is within the trees' vertex data or not. By default, we assume that the array to compare is within the trees' EdgeData().

virtual int vtkTreeDifferenceFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkTreeDifferenceFilter::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual
bool vtkTreeDifferenceFilter::GenerateMapping ( vtkTree *  tree1,
vtkTree *  tree2 
)
protected

Populate VertexMap and EdgeMap with meaningful values. These maps allow us to look up the vtkIdType of a vertex or edge in tree #2, given its vtkIdType in tree #1.

vtkSmartPointer<vtkDoubleArray> vtkTreeDifferenceFilter::ComputeDifference ( vtkTree *  tree1,
vtkTree *  tree2 
)
protected

Compute the differences between tree #1 and tree #2's copies of the comparison array.

Member Data Documentation

char* vtkTreeDifferenceFilter::IdArrayName
protected

Definition at line 111 of file vtkTreeDifferenceFilter.h.

char* vtkTreeDifferenceFilter::ComparisonArrayName
protected

Definition at line 112 of file vtkTreeDifferenceFilter.h.

char* vtkTreeDifferenceFilter::OutputArrayName
protected

Definition at line 113 of file vtkTreeDifferenceFilter.h.

bool vtkTreeDifferenceFilter::ComparisonArrayIsVertexData
protected

Definition at line 114 of file vtkTreeDifferenceFilter.h.

std::vector< vtkIdType > vtkTreeDifferenceFilter::VertexMap
protected

Definition at line 116 of file vtkTreeDifferenceFilter.h.

std::vector< vtkIdType > vtkTreeDifferenceFilter::EdgeMap
protected

Definition at line 117 of file vtkTreeDifferenceFilter.h.


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