Split a field into single component fields. More...

#include <vtkSplitField.h>

Inheritance diagram for vtkSplitField:

Collaboration diagram for vtkSplitField:

Classes
struct	Component
Public Types
enum	FieldLocations { DATA_OBJECT = 0, POINT_DATA = 1, CELL_DATA = 2 }
typedef vtkDataSetAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkSplitField *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetInputField (int attributeType, int fieldLoc)
void	SetInputField (const char *name, int fieldLoc)
void	SetInputField (const char name, const char fieldLoc)
void	Split (int component, const char *arrayName)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSplitField *	SafeDownCast (vtkObjectBase *o)
static vtkSplitField *	New ()
Protected Types
enum	FieldTypes { NAME, ATTRIBUTE }
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSplitField ()
virtual	~vtkSplitField ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
vtkDataArray *	SplitArray (vtkDataArray *da, int component)
Component *	GetNextComponent (Component *op)
Component *	GetFirst ()
void	AddComponent (Component *op)
Component *	FindComponent (int index)
void	DeleteAllComponents ()
void	PrintComponent (Component *op, ostream &os, vtkIndent indent)
void	PrintAllComponents (ostream &os, vtkIndent indent)
Protected Attributes
char *	FieldName
int	FieldType
int	AttributeType
int	FieldLocation
Component *	Head
Component *	Tail
Static Protected Attributes
static char	FieldLocationNames [3][12]
static char	AttributeNames [vtkDataSetAttributes::NUM_ATTRIBUTES][10]

Detailed Description

Split a field into single component fields.

vtkSplitField is used to split a multi-component field (vtkDataArray) into multiple single component fields. The new fields are put in the same field data as the original field. The output arrays are of the same type as the input array. Example:

 sf->SetInputField("gradient", vtkSplitField::POINT_DATA);
 sf->Split(0, "firstcomponent");

tells vtkSplitField to extract the first component of the field called gradient and create an array called firstcomponent (the new field will be in the output's point data). The same can be done from Tcl:

 sf SetInputField gradient POINT_DATA
 sf Split 0 firstcomponent

 AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
 Field locations: DATA_OBJECT, POINT_DATA, CELL_DATA

Note that, by default, the original array is also passed through.

Warning:: When using Tcl, Java, Python or Visual Basic bindings, the array name can not be one of the AttributeTypes when calling Split() which takes strings as arguments. The Tcl (Java etc.) command will always assume the string corresponds to an attribute type when the argument is one of the AttributeTypes. In this situation, use the Split() which takes enums.

See also:: vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray vtkRearrangeFields vtkAssignAttribute vtkMergeFields

Tests:: vtkSplitField (Tests)

Definition at line 66 of file vtkSplitField.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkSplitField::Superclass

Reimplemented from vtkDataSetAlgorithm.

Definition at line 69 of file vtkSplitField.h.

Member Enumeration Documentation

enum vtkSplitField::FieldLocations

Enumerator:

DATA_OBJECT
POINT_DATA
CELL_DATA

Definition at line 91 of file vtkSplitField.h.

enum vtkSplitField::FieldTypes [protected]

Enumerator:

NAME
ATTRIBUTE

Definition at line 123 of file vtkSplitField.h.

Constructor & Destructor Documentation

vtkSplitField::vtkSplitField ( ) [protected]

virtual vtkSplitField::~vtkSplitField ( ) [protected, virtual]

Member Function Documentation

static int vtkSplitField::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 vtkDataSetAlgorithm.

virtual int vtkSplitField::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 vtkDataSetAlgorithm.

static vtkSplitField* vtkSplitField::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkDataSetAlgorithm.

virtual vtkObjectBase* vtkSplitField::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataSetAlgorithm.

vtkSplitField* vtkSplitField::NewInstance ( ) const

Reimplemented from vtkDataSetAlgorithm.

void vtkSplitField::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 vtkDataSetAlgorithm.

static vtkSplitField* vtkSplitField::New ( ) [static]

Create a new vtkSplitField.

Reimplemented from vtkDataSetAlgorithm.

void vtkSplitField::SetInputField	(	int	attributeType,
		int	fieldLoc
	)

Use the given attribute in the field data given by fieldLoc as input.

void vtkSplitField::SetInputField	(	const char *	name,
		int	fieldLoc
	)

Use the array with given name in the field data given by fieldLoc as input.

void vtkSplitField::SetInputField	(	const char *	name,
		const char *	fieldLoc
	)

Helper method used by other language bindings. Allows the caller to specify arguments as strings instead of enums.

void vtkSplitField::Split	(	int	component,
		const char *	arrayName
	)

Create a new array with the given component.

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

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.