vtkTreeFieldAggregator Class Reference
#include <vtkTreeFieldAggregator.h>
Detailed Description
aggregate field values from the leaves up the treevtkTreeFieldAggregator 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.
Definition at line 45 of file vtkTreeFieldAggregator.h.
| virtual void | SetLogScale (bool) |
| virtual bool | GetLogScale () |
| virtual void | LogScaleOn () |
| virtual void | LogScaleOff () |
| vtkTreeFieldAggregator () | |
| ~vtkTreeFieldAggregator () | |
Public Types | |
| typedef vtkTreeAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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 vtkTreeFieldAggregator * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkTreeFieldAggregator * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Member Typedef Documentation
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkTreeAlgorithm.
| virtual const char* vtkTreeFieldAggregator::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkTreeAlgorithm.
| static int vtkTreeFieldAggregator::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 vtkTreeAlgorithm.
| virtual int vtkTreeFieldAggregator::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 vtkTreeAlgorithm.
| static vtkTreeFieldAggregator* vtkTreeFieldAggregator::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkTreeAlgorithm.
| void vtkTreeFieldAggregator::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 vtkTreeAlgorithm.
| 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 * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkTreeAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkTreeFieldAggregator.h
