vtkArrayComponents.h File Reference

#include "vtkCommonCoreModule.h"
#include "vtkCompiler.h"
#include "vtkDataArray.h"
#include "vtkSmartPointer.h"
#include <string>

Include dependency graph for vtkArrayComponents.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	vtk
	Specialization of tuple ranges and iterators for vtkAOSDataArrayTemplate.

Enumerations
enum	vtkArrayComponents : int {   L1Norm = -1 , L2Norm = -2 , LInfNorm = -99 , AllComponents = -100 ,   Requested = -101 }
	An enumeration for specifying components of a vtkAbstractArray's tuples. More...

Functions
int VTKCOMMONCORE_EXPORT	vtk::ArrayComponents (const std::string &enumerantStr)
	Given a string, return an "array component" enumerant.
std::string VTKCOMMONCORE_EXPORT	vtk::to_string (vtkArrayComponents enumerant)
	Given an enumerant, return a human-presentable string with its value.
template<typename T >
T VTK_ALWAYS_EXPORT	vtk::to_enumerant (const std::string &)
	A generic template to convert strings to enumerant values.
template<>
vtkArrayComponents	vtk::to_enumerant< vtkArrayComponents > (const std::string &enumerantStr)
	A specialization of the generic template above.
vtkSmartPointer< vtkAbstractArray > VTKCOMMONCORE_EXPORT	vtk::ComponentOrNormAsArray (vtkAbstractArray *array, int compOrNorm)
	Return a new array with a single component whose tuple-values are either a component of the input array or a norm of each input tuple.
vtkSmartPointer< vtkDataArray > VTKCOMMONCORE_EXPORT	vtk::ComponentOrNormAsDataArray (vtkDataArray *array, int compOrNorm)
	Return a new array with a single component whose tuple-values are either a component of the input array or a norm of each input tuple.

Enumeration Type Documentation

vtkArrayComponents

enum vtkArrayComponents : int

An enumeration for specifying components of a vtkAbstractArray's tuples.

Values from this enumeration are passed to methods which expect a component index when you wish to indicate either (1) the entire tuple be considered instead of a single component or (2) a norm or other scalar function computed from the entire tuple be considered as a "virtual" component.

Values in this enumeration are accepted by the vtkAlgorithm::SetInputArrayToProcess() and vtkAlgorithm::GetInputArray() methods.

The Requested enumerant is used to indicate that the component specified by vtkAlgorithm::SetInputArrayToProcess() should be used rather than overriding it by a component-id passed to vtkAlgorithm::GetInputArray().

Enumerator
L1Norm
L2Norm
LInfNorm
AllComponents
Requested

Definition at line 33 of file vtkArrayComponents.h.