Documentation for vtkExtractVectorComponents

vtkExtractVectorComponents - extract components of vector as separate scalars

Description:

vtkExtractVectorComponents is a filter that extracts vector components as separate scalars. This is accomplished by creating three different outputs. Each output is the same as the input, except that the scalar values will be one of the three components of the vector. These can be found in the VxComponent, VyComponent, and VzComponent.

Caveats:

This filter is unusual in that it creates multiple outputs. As a result, it cannot take advantage of the convenience classes (e.g., vtkPolyDataToPolyDataFilter) for deriving concrete filters. Instead, it overloads the Update() method of its superclasses and provides methods for retrieving the output. If you use the GetOutput() method, you will be retrieving the x vector component.

Methods:

	void vtkExtractVectorComponents ()
	void vtkExtractVectorComponents ()
	static vtkExtractVectorComponents *New ()
	const char *GetClassName ()
	void Update ()
	void SetInput (vtkDataSet *)
	vtkDataSet *GetVxComponent ()
	vtkDataSet *GetVyComponent ()
	vtkDataSet *GetVzComponent ()
	vtkDataSet *GetOutput (int )
	void SetInput (vtkDataSet &)
	void Execute ()

Detailed Method Descriptions:

Update input to this filter and the filter itself. Note that we are overloading this method because the output is an abstract dataset type. This requires special treatment.

void Update ()

Specify the input data or filter.

void SetInput (vtkDataSet *)

Get the output dataset representing velocity x-component. If output is NULL then input hasn't been set, which is necessary for abstract objects. (Note: this method returns the same information as the GetOutput() method with an index of 0.)

vtkDataSet *GetVxComponent ()

Get the output dataset representing velocity y-component. If output is NULL then input hasn't been set, which is necessary for abstract objects. (Note: this method returns the same information as the GetOutput() method with an index of 1.)

vtkDataSet *GetVyComponent ()

Get the output dataset representing velocity z-component. If output is NULL then input hasn't been set, which is necessary for abstract objects. (Note: this method returns the same information as the GetOutput() method with an index of 2.)

vtkDataSet *GetVzComponent ()

Get the output dataset containing the indicated component. The component is specified by an index between (0,2) corresponding to the x, y, or z vector component. By default, the x component is extracted.

vtkDataSet *GetOutput (int )

For legacy compatibility. Do not use.

void SetInput (vtkDataSet &)