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 | Protected Attributes | List of all members
vtkStringToCategory Class Reference

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

#include <vtkStringToCategory.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkStringToCategoryNewInstance () 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 vtkStringToCategoryNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStringToCategorySafeDownCast (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

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
static int vtkStringToCategory::IsTypeOf ( const char *  type)
static
virtual int vtkStringToCategory::IsA ( const char *  type)
virtual
static vtkStringToCategory* vtkStringToCategory::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkStringToCategory::NewInstanceInternal ( ) const
protectedvirtual
vtkStringToCategory* vtkStringToCategory::NewInstance ( ) const
void vtkStringToCategory::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

virtual int vtkStringToCategory::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Creates the same output type as the input type.

int vtkStringToCategory::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
virtual int vtkStringToCategory::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

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: