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 | List of all members
vtkTreeFieldAggregator Class Reference

aggregate field values from the leaves up the tree More...

#include <vtkTreeFieldAggregator.h>

Inherits vtkTreeAlgorithm.

Public Types

typedef vtkTreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTreeFieldAggregatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual char * GetField ()
 
virtual void SetField (const char *)
 
virtual double GetMinValue ()
 
virtual void SetMinValue (double)
 
virtual void SetLeafVertexUnitSize (bool)
 
virtual bool GetLeafVertexUnitSize ()
 
virtual void LeafVertexUnitSizeOn ()
 
virtual void LeafVertexUnitSizeOff ()
 

Static Public Member Functions

static vtkTreeFieldAggregatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeFieldAggregatorSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void SetLogScale (bool)
 
virtual bool GetLogScale ()
 
virtual void LogScaleOn ()
 
virtual void LogScaleOff ()
 
 vtkTreeFieldAggregator ()
 
 ~vtkTreeFieldAggregator ()
 

Detailed Description

aggregate field values from the leaves up the tree

vtkTreeFieldAggregator may be used to assign sizes to all the vertices in the tree, based on the sizes of the leaves. The size of a vertex will equal the sum of the sizes of the child vertices. If you have a data array with values for all leaves, you may specify that array, and the values will be filled in for interior tree vertices. If you do not yet have an array, you may tell the filter to create a new array, assuming that the size of each leaf vertex is 1. You may optionally set a flag to first take the log of all leaf values before aggregating.

Tests:
vtkTreeFieldAggregator (Tests)

Definition at line 46 of file vtkTreeFieldAggregator.h.

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkTreeFieldAggregator::Superclass

Definition at line 51 of file vtkTreeFieldAggregator.h.

Constructor & Destructor Documentation

vtkTreeFieldAggregator::vtkTreeFieldAggregator ( )
protected

If set, the leaf values in the tree will be logarithmically scaled (base 10).

vtkTreeFieldAggregator::~vtkTreeFieldAggregator ( )
protected

If set, the leaf values in the tree will be logarithmically scaled (base 10).

Member Function Documentation

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

The field to aggregate. If this is a string array, the entries are converted to double. TODO: Remove this field and use the ArrayToProcess in vtkAlgorithm.

virtual void vtkTreeFieldAggregator::SetField ( const char *  )
virtual

The field to aggregate. If this is a string array, the entries are converted to double. TODO: Remove this field and use the ArrayToProcess in vtkAlgorithm.

virtual double vtkTreeFieldAggregator::GetMinValue ( )
virtual

If the value of the vertex is less than MinValue then consider it's value to be minVal.

virtual void vtkTreeFieldAggregator::SetMinValue ( double  )
virtual

If the value of the vertex is less than MinValue then consider it's value to be minVal.

virtual void vtkTreeFieldAggregator::SetLeafVertexUnitSize ( bool  )
virtual

If set, the algorithm will assume a size of 1 for each leaf vertex.

virtual bool vtkTreeFieldAggregator::GetLeafVertexUnitSize ( )
virtual

If set, the algorithm will assume a size of 1 for each leaf vertex.

virtual void vtkTreeFieldAggregator::LeafVertexUnitSizeOn ( )
virtual

If set, the algorithm will assume a size of 1 for each leaf vertex.

virtual void vtkTreeFieldAggregator::LeafVertexUnitSizeOff ( )
virtual

If set, the algorithm will assume a size of 1 for each leaf vertex.

virtual void vtkTreeFieldAggregator::SetLogScale ( bool  )
virtual

If set, the leaf values in the tree will be logarithmically scaled (base 10).

virtual bool vtkTreeFieldAggregator::GetLogScale ( )
virtual

If set, the leaf values in the tree will be logarithmically scaled (base 10).

virtual void vtkTreeFieldAggregator::LogScaleOn ( )
virtual

If set, the leaf values in the tree will be logarithmically scaled (base 10).

virtual void vtkTreeFieldAggregator::LogScaleOff ( )
virtual

If set, the leaf values in the tree will be logarithmically scaled (base 10).

int vtkTreeFieldAggregator::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

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