vtkTokenValueFilter Class Reference

#include <vtkTokenValueFilter.h>

Inheritance diagram for vtkTokenValueFilter:

[legend]

Collaboration diagram for vtkTokenValueFilter:

[legend]

List of all members.

---

Detailed Description

Filters tokens based on their value.

vtkTokenValueFilter removes tokens from the pipeline based on whether they match a list of token values. Typically, this is useful for handling lists of "stop words" that should be removed from the token stream before further analysis.

Inputs: Input port 0: (required) A vtkTable containing a column of text.

Outputs: Output port 0: The same table, with (potentally) fewer rows.

Use SetInputArrayToProcess(0, ...) to specify the "text" array.

Use AddValue() to append a new token value to the list of values to be discarded. By default, the list of values to be discarded is empty, so you must call AddValue() before using vtkTokenValueFilter to see any changes in output!

Thanks:

Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

Events:

vtkCommand::ProgressEvent

Tests:

vtkTokenValueFilter (Tests)

Definition at line 58 of file vtkTokenValueFilter.h.

Public Types
typedef vtkTableAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddStopWordValues ()
void	AddValue (const vtkUnicodeString &value)
void	ClearValues ()
Static Public Member Functions
static vtkTokenValueFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkTokenValueFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTokenValueFilter ()
	~vtkTokenValueFilter ()
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

---

Member Typedef Documentation

typedef vtkTableAlgorithm vtkTokenValueFilter::Superclass

Reimplemented from vtkTableAlgorithm.

Definition at line 63 of file vtkTokenValueFilter.h.

---

Constructor & Destructor Documentation

vtkTokenValueFilter::vtkTokenValueFilter

(

)

[protected]

vtkTokenValueFilter::~vtkTokenValueFilter

(

)

[protected]

---

Member Function Documentation

static vtkTokenValueFilter* vtkTokenValueFilter::New

(

)

[static]

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

Reimplemented from vtkTableAlgorithm.

virtual const char* vtkTokenValueFilter::GetClassName

(

)

[virtual]

Reimplemented from vtkTableAlgorithm.

static int vtkTokenValueFilter::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 vtkTableAlgorithm.

virtual int vtkTokenValueFilter::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 vtkTokenValueFilter* vtkTokenValueFilter::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkTableAlgorithm.

void vtkTokenValueFilter::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.

void vtkTokenValueFilter::AddStopWordValues

(

)

Convenience function that adds a list of typical stop-words to the list of token values that will be discarded.

void vtkTokenValueFilter::AddValue

(

const vtkUnicodeString &

value

)

Convenience function that adds a list of typical stop-words to the list of token values that will be discarded.

void vtkTokenValueFilter::ClearValues

(

)

Convenience function that adds a list of typical stop-words to the list of token values that will be discarded.

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

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

Reimplemented from vtkTableAlgorithm.

---

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

• dox/TextAnalysis/vtkTokenValueFilter.h