VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkTreeFieldAggregator Class Reference

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

#include <vtkTreeFieldAggregator.h>

Inheritance diagram for vtkTreeFieldAggregator:
[legend]
Collaboration diagram for vtkTreeFieldAggregator:
[legend]

List of all members.

Public Types

typedef vtkTreeAlgorithm Superclass
- Public Types inherited from vtkTreeAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

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 ()
- Public Member Functions inherited from vtkTreeAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkTreeGetOutput ()
vtkTreeGetOutput (int index)
void SetInput (vtkDataObject *obj)
void SetInput (int index, vtkDataObject *obj)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkTreeAlgorithm
 vtkTreeAlgorithm ()
 ~vtkTreeAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (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 vtkExecutiveCreateDefaultExecutive ()
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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)
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 45 of file vtkTreeFieldAggregator.h.


Member Typedef Documentation

Reimplemented from vtkTreeAlgorithm.

Definition at line 50 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

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 
)
protectedvirtual

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: