vtkTreeDifferenceFilter Class Reference

compare two trees More...

#include <vtkTreeDifferenceFilter.h>

Inheritance diagram for vtkTreeDifferenceFilter:

Collaboration diagram for vtkTreeDifferenceFilter:

Public Types
typedef vtkGraphAlgorithm	Superclass
Public Types inherited from vtkGraphAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkTreeDifferenceFilter *	NewInstance () 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 ()
Public Member Functions inherited from vtkGraphAlgorithm
vtkGraphAlgorithm *	NewInstance () const
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkGraph *	GetOutput ()
vtkGraph *	GetOutput (int index)
void	SetInputData (vtkDataObject *obj)
void	SetInputData (int index, vtkDataObject *obj)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
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)
vtkDataObject *	GetInputDataObject (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)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkTreeDifferenceFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeDifferenceFilter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkGraphAlgorithm
static vtkGraphAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkGraphAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

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 Member Functions inherited from vtkGraphAlgorithm
	vtkGraphAlgorithm ()
	~vtkGraphAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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 vtkExecutive *	CreateDefaultExecutive ()
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)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *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 &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	IdArrayName
char *	ComparisonArrayName
char *	OutputArrayName
bool	ComparisonArrayIsVertexData
std::vector< vtkIdType >	VertexMap
std::vector< vtkIdType >	EdgeMap
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 *  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 vtkGraphAlgorithm.

static vtkTreeDifferenceFilter* vtkTreeDifferenceFilter::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkTreeDifferenceFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphAlgorithm.

vtkTreeDifferenceFilter* vtkTreeDifferenceFilter::NewInstance

(

)

const

void vtkTreeDifferenceFilter::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 vtkGraphAlgorithm.

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 *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

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

Reimplemented from vtkGraphAlgorithm.

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

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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Infovis/Core/vtkTreeDifferenceFilter.h