vtkStringToCategory Class Reference

Creates a category array from a string array. More...

#include <vtkStringToCategory.h>

Inheritance diagram for vtkStringToCategory:

Collaboration diagram for vtkStringToCategory:

List of all members.

Public Types
typedef vtkDataObjectAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkStringToCategory *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetCategoryArrayName (const char *)
virtual char *	GetCategoryArrayName ()
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Static Public Member Functions
static vtkStringToCategory *	New ()
static int	IsTypeOf (const char *type)
static vtkStringToCategory *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStringToCategory ()
	~vtkStringToCategory ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Attributes
char *	CategoryArrayName

---

Detailed Description

Creates a category array from a string array.

vtkStringToCategory creates an integer array named "category" based on the values in a string array. You may use this filter to create an array that you may use to color points/cells by the values in a string array. Currently there is not support to color by a string array directly. The category values will range from zero to N-1, where N is the number of distinct strings in the string array. Set the string array to process with SetInputArrayToProcess(0,0,0,...). The array may be in the point, cell, or field data of the data object.

The list of unique strings, in the order they are mapped, can also be retrieved from output port 1. They are in a vtkTable, stored in the "Strings" column as a vtkStringArray.

Examples:

vtkStringToCategory (Examples)

Tests:

vtkStringToCategory (Tests)

Definition at line 50 of file vtkStringToCategory.h.

---

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkStringToCategory::Superclass

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 54 of file vtkStringToCategory.h.

---

Constructor & Destructor Documentation

vtkStringToCategory::vtkStringToCategory

(

)

[protected]

vtkStringToCategory::~vtkStringToCategory

(

)

[protected]

---

Member Function Documentation

static vtkStringToCategory* vtkStringToCategory::New

(

)

[static]

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

Reimplemented from vtkDataObjectAlgorithm.

static int vtkStringToCategory::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 vtkDataObjectAlgorithm.

virtual int vtkStringToCategory::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 vtkDataObjectAlgorithm.

static vtkStringToCategory* vtkStringToCategory::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkDataObjectAlgorithm.

virtual vtkObjectBase* vtkStringToCategory::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkDataObjectAlgorithm.

vtkStringToCategory* vtkStringToCategory::NewInstance

(

)

const

Reimplemented from vtkDataObjectAlgorithm.

void vtkStringToCategory::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 vtkDataObjectAlgorithm.

virtual void vtkStringToCategory::SetCategoryArrayName

(

const char *

)

[virtual]

The name to give to the output vtkIntArray of category values.

virtual char* vtkStringToCategory::GetCategoryArrayName

(

)

[virtual]

The name to give to the output vtkIntArray of category values.

virtual int vtkStringToCategory::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[virtual]

This is required to capture REQUEST_DATA_OBJECT requests.

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkStringToCategory::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

Creates the same output type as the input type.

Reimplemented from vtkDataObjectAlgorithm.

int vtkStringToCategory::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		[protected, virtual]

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkStringToCategory::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)		[protected, virtual]

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

Reimplemented from vtkDataObjectAlgorithm.

---

Member Data Documentation

char* vtkStringToCategory::CategoryArrayName [protected]

Definition at line 88 of file vtkStringToCategory.h.

---

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

• dox/Infovis/Core/vtkStringToCategory.h