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
vtkTableToSparseArray Class Reference

converts a vtkTable into a sparse array. More...

#include <vtkTableToSparseArray.h>

Inherits vtkArrayDataAlgorithm.

Public Types

typedef vtkArrayDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTableToSparseArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ClearCoordinateColumns ()
 
void AddCoordinateColumn (const char *name)
 
void SetValueColumn (const char *name)
 
const char * GetValueColumn ()
 
void ClearOutputExtents ()
 
void SetOutputExtents (const vtkArrayExtents &extents)
 

Static Public Member Functions

static vtkTableToSparseArrayNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTableToSparseArraySafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTableToSparseArray ()
 
 ~vtkTableToSparseArray ()
 
int FillInputPortInformation (int, vtkInformation *)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Detailed Description

converts a vtkTable into a sparse array.

Converts a vtkTable into a sparse array. Use AddCoordinateColumn() to designate one-to-many table columns that contain coordinates for each array value, and SetValueColumn() to designate the table column that contains array values.

Thus, the number of dimensions in the output array will equal the number of calls to AddCoordinateColumn().

The coordinate columns will also be used to populate dimension labels in the output array.

By default, the extent of the output array will be set to the range [0, largest coordinate + 1) along each dimension. In some situations you may prefer to set the extents explicitly, using the SetOutputExtents() method. This is useful when the output array should be larger than its largest coordinates, or when working with partitioned data.

Thanks:
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.
Tests:
vtkTableToSparseArray (Tests)

Definition at line 57 of file vtkTableToSparseArray.h.

Member Typedef Documentation

typedef vtkArrayDataAlgorithm vtkTableToSparseArray::Superclass

Definition at line 61 of file vtkTableToSparseArray.h.

Constructor & Destructor Documentation

vtkTableToSparseArray::vtkTableToSparseArray ( )
protected
vtkTableToSparseArray::~vtkTableToSparseArray ( )
protected

Member Function Documentation

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

Specify the set of input table columns that will be mapped to coordinates in the output sparse array.

void vtkTableToSparseArray::AddCoordinateColumn ( const char *  name)

Specify the set of input table columns that will be mapped to coordinates in the output sparse array.

void vtkTableToSparseArray::SetValueColumn ( const char *  name)

Specify the input table column that will be mapped to values in the output array.

const char* vtkTableToSparseArray::GetValueColumn ( )

Specify the input table column that will be mapped to values in the output array.

void vtkTableToSparseArray::ClearOutputExtents ( )

Explicitly specify the extents of the output array.

void vtkTableToSparseArray::SetOutputExtents ( const vtkArrayExtents &  extents)

Explicitly specify the extents of the output array.

int vtkTableToSparseArray::FillInputPortInformation ( int  ,
vtkInformation *   
)
protected
int vtkTableToSparseArray::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

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