vtkTableToSparseArray Class Reference

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

#include <vtkTableToSparseArray.h>

Inheritance diagram for vtkTableToSparseArray:

Collaboration diagram for vtkTableToSparseArray:

List of all members.

Public Types
typedef vtkArrayDataAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkTableToSparseArray *	NewInstance () 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 vtkTableToSparseArray *	New ()
static int	IsTypeOf (const char *type)
static vtkTableToSparseArray *	SafeDownCast (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

Reimplemented from vtkArrayDataAlgorithm.

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]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkArrayDataAlgorithm.

static int vtkTableToSparseArray::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 vtkArrayDataAlgorithm.

virtual int vtkTableToSparseArray::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 vtkArrayDataAlgorithm.

static vtkTableToSparseArray* vtkTableToSparseArray::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkArrayDataAlgorithm.

virtual vtkObjectBase* vtkTableToSparseArray::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkArrayDataAlgorithm.

vtkTableToSparseArray* vtkTableToSparseArray::NewInstance

(

)

const

Reimplemented from vtkArrayDataAlgorithm.

void vtkTableToSparseArray::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 vtkArrayDataAlgorithm.

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	port,
		vtkInformation *	info
	)		[protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkArrayDataAlgorithm.

int vtkTableToSparseArray::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

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

Reimplemented from vtkArrayDataAlgorithm.

---

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

• dox/Infovis/Core/vtkTableToSparseArray.h