VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkReduceTable Class Reference

combine some of the rows of a table More...

#include <vtkReduceTable.h>

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

Public Types

typedef vtkTableAlgorithm Superclass
 
enum  { MEAN, MEDIAN, MODE }
 
- Public Types inherited from vtkTableAlgorithm
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)
 
vtkReduceTableNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetReductionMethodForColumn (vtkIdType col)
 
void SetReductionMethodForColumn (vtkIdType col, int method)
 
virtual vtkIdType GetIndexColumn ()
 
virtual void SetIndexColumn (vtkIdType)
 
virtual int GetNumericalReductionMethod ()
 
virtual void SetNumericalReductionMethod (int)
 
virtual int GetNonNumericalReductionMethod ()
 
virtual void SetNonNumericalReductionMethod (int)
 
- Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithmNewInstance () const
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkTableGetOutput ()
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
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)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (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 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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
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])
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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 vtkReduceTableNew ()
 
static int IsTypeOf (const char *type)
 
static vtkReduceTableSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkReduceTable ()
 
 ~vtkReduceTable ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void InitializeOutputTable (vtkTable *input, vtkTable *output)
 
void AccumulateIndexValues (vtkTable *input)
 
void PopulateIndexColumn (vtkTable *output)
 
void PopulateDataColumn (vtkTable *input, vtkTable *output, vtkIdType col)
 
void ReduceValuesToMean (vtkTable *input, vtkTable *output, vtkIdType row, vtkIdType col, std::vector< vtkIdType > oldRows)
 
void ReduceValuesToMedian (vtkTable *input, vtkTable *output, vtkIdType row, vtkIdType col, std::vector< vtkIdType > oldRows)
 
void ReduceValuesToMode (vtkTable *input, vtkTable *output, vtkIdType row, vtkIdType col, std::vector< vtkIdType > oldRows)
 
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm ()
 
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)
 
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

vtkIdType IndexColumn
 
std::set< vtkVariantIndexValues
 
std::map< vtkVariant, std::vector< vtkIdType > > NewRowToOldRowsMap
 
std::map< vtkIdType, intColumnReductionMethods
 
int NumericalReductionMethod
 
int NonNumericalReductionMethod
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

combine some of the rows of a table

Collapses the rows of the input table so that one particular column (the IndexColumn) does not contain any duplicate values. Thus the output table will have the same columns as the input table, but potentially fewer rows. One example use of this class would be to generate a summary table from a table of observations. When two or more rows of the input table share a value in the IndexColumn, the values from these rows will be combined on a column-by-column basis. By default, such numerical values will be reduced to their mean, and non-numerical values will be reduced to their mode. This default behavior can be changed by calling SetNumericalReductionMethod() or SetNonNumericalReductionMethod(). You can also specify the reduction method to use for a particular column by calling SetReductionMethodForColumn().

Tests:
vtkReduceTable (Tests)

Definition at line 50 of file vtkReduceTable.h.

Member Typedef Documentation

Definition at line 54 of file vtkReduceTable.h.

Member Enumeration Documentation

anonymous enum

Enum for methods of reduction

Enumerator
MEAN 
MEDIAN 
MODE 

Definition at line 90 of file vtkReduceTable.h.

Constructor & Destructor Documentation

vtkReduceTable::vtkReduceTable ( )
protected
vtkReduceTable::~vtkReduceTable ( )
protected

Member Function Documentation

static vtkReduceTable* vtkReduceTable::New ( )
static
static int vtkReduceTable::IsTypeOf ( const char *  type)
static
virtual int vtkReduceTable::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 vtkTableAlgorithm.

static vtkReduceTable* vtkReduceTable::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkReduceTable::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTableAlgorithm.

vtkReduceTable* vtkReduceTable::NewInstance ( ) const
void vtkReduceTable::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 vtkTableAlgorithm.

virtual vtkIdType vtkReduceTable::GetIndexColumn ( )
virtual

Get/Set the column that will be used to reduce the input table. Any rows sharing a value in this column will be collapsed into a single row in the output table.

virtual void vtkReduceTable::SetIndexColumn ( vtkIdType  )
virtual

Get/Set the column that will be used to reduce the input table. Any rows sharing a value in this column will be collapsed into a single row in the output table.

virtual int vtkReduceTable::GetNumericalReductionMethod ( )
virtual

Get/Set the method that should be used to combine numerical values.

virtual void vtkReduceTable::SetNumericalReductionMethod ( int  )
virtual

Get/Set the method that should be used to combine numerical values.

virtual int vtkReduceTable::GetNonNumericalReductionMethod ( )
virtual

Get/Set the method that should be used to combine non-numerical values.

virtual void vtkReduceTable::SetNonNumericalReductionMethod ( int  )
virtual

Get/Set the method that should be used to combine non-numerical values.

int vtkReduceTable::GetReductionMethodForColumn ( vtkIdType  col)

Get the method that should be used to combine the values within the specified column. Returns -1 if no method has been set for this particular column.

void vtkReduceTable::SetReductionMethodForColumn ( vtkIdType  col,
int  method 
)

Set the method that should be used to combine the values within the specified column.

int vtkReduceTable::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkTableAlgorithm.

void vtkReduceTable::InitializeOutputTable ( vtkTable input,
vtkTable output 
)
protected

Initialize the output table to have the same types of columns as the input table, but no rows.

void vtkReduceTable::AccumulateIndexValues ( vtkTable input)
protected

Find the distinct values in the input table's index column. This function also populates the mapping of new row IDs to old row IDs.

void vtkReduceTable::PopulateIndexColumn ( vtkTable output)
protected

Populate the index column of the output table.

void vtkReduceTable::PopulateDataColumn ( vtkTable input,
vtkTable output,
vtkIdType  col 
)
protected

Populate a non-index column of the output table. This involves potentially combining multiple values from the input table into a single value for the output table.

void vtkReduceTable::ReduceValuesToMean ( vtkTable input,
vtkTable output,
vtkIdType  row,
vtkIdType  col,
std::vector< vtkIdType oldRows 
)
protected

Find the mean of a series of values from the input table and store it in the output table.

void vtkReduceTable::ReduceValuesToMedian ( vtkTable input,
vtkTable output,
vtkIdType  row,
vtkIdType  col,
std::vector< vtkIdType oldRows 
)
protected

Find the median of a series of values from the input table and store it in the output table.

void vtkReduceTable::ReduceValuesToMode ( vtkTable input,
vtkTable output,
vtkIdType  row,
vtkIdType  col,
std::vector< vtkIdType oldRows 
)
protected

Find the mode of a series of values from the input table and store it in the output table.

Member Data Documentation

vtkIdType vtkReduceTable::IndexColumn
protected

Definition at line 148 of file vtkReduceTable.h.

std::set<vtkVariant> vtkReduceTable::IndexValues
protected

Definition at line 149 of file vtkReduceTable.h.

std::map<vtkVariant, std::vector<vtkIdType> > vtkReduceTable::NewRowToOldRowsMap
protected

Definition at line 150 of file vtkReduceTable.h.

std::map<vtkIdType, int> vtkReduceTable::ColumnReductionMethods
protected

Definition at line 151 of file vtkReduceTable.h.

int vtkReduceTable::NumericalReductionMethod
protected

Definition at line 153 of file vtkReduceTable.h.

int vtkReduceTable::NonNumericalReductionMethod
protected

Definition at line 154 of file vtkReduceTable.h.


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