map field data to dataset attribute data More...

#include <vtkFieldDataToAttributeDataFilter.h>

Inheritance diagram for vtkFieldDataToAttributeDataFilter:

Collaboration diagram for vtkFieldDataToAttributeDataFilter:

Public Types
typedef vtkDataSetAlgorithm	Superclass

Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkFieldDataToAttributeDataFilter *	NewInstance () const

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	If output does not need exact extent, the I do not either. More...


virtual void	SetInputField (int)
	Specify which field data to use to generate the output attribute data. More...

virtual int	GetInputField ()
	Specify which field data to use to generate the output attribute data. More...

void	SetInputFieldToDataObjectField ()
	Specify which field data to use to generate the output attribute data. More...

void	SetInputFieldToPointDataField ()
	Specify which field data to use to generate the output attribute data. More...

void	SetInputFieldToCellDataField ()
	Specify which field data to use to generate the output attribute data. More...


virtual void	SetOutputAttributeData (int)
	Specify which attribute data to output: point or cell data attributes. More...

virtual int	GetOutputAttributeData ()
	Specify which attribute data to output: point or cell data attributes. More...

void	SetOutputAttributeDataToCellData ()
	Specify which attribute data to output: point or cell data attributes. More...

void	SetOutputAttributeDataToPointData ()
	Specify which attribute data to output: point or cell data attributes. More...


void	SetScalarComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
	Define the component(s) of the field to be used for the scalar components. More...

void	SetScalarComponent (int comp, const char *arrayName, int arrayComp)
	Define the component(s) of the field to be used for the scalar components. More...

const char *	GetScalarComponentArrayName (int comp)
	Define the component(s) of the field to be used for the scalar components. More...

int	GetScalarComponentArrayComponent (int comp)
	Define the component(s) of the field to be used for the scalar components. More...

int	GetScalarComponentMinRange (int comp)
	Define the component(s) of the field to be used for the scalar components. More...

int	GetScalarComponentMaxRange (int comp)
	Define the component(s) of the field to be used for the scalar components. More...

int	GetScalarComponentNormalizeFlag (int comp)
	Define the component(s) of the field to be used for the scalar components. More...


void	SetVectorComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
	Define the component(s) of the field to be used for the vector components. More...

void	SetVectorComponent (int comp, const char *arrayName, int arrayComp)
	Define the component(s) of the field to be used for the vector components. More...

const char *	GetVectorComponentArrayName (int comp)
	Define the component(s) of the field to be used for the vector components. More...

int	GetVectorComponentArrayComponent (int comp)
	Define the component(s) of the field to be used for the vector components. More...

int	GetVectorComponentMinRange (int comp)
	Define the component(s) of the field to be used for the vector components. More...

int	GetVectorComponentMaxRange (int comp)
	Define the component(s) of the field to be used for the vector components. More...

int	GetVectorComponentNormalizeFlag (int comp)
	Define the component(s) of the field to be used for the vector components. More...


void	SetNormalComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
	Define the component(s) of the field to be used for the normal components. More...

void	SetNormalComponent (int comp, const char *arrayName, int arrayComp)
	Define the component(s) of the field to be used for the normal components. More...

const char *	GetNormalComponentArrayName (int comp)
	Define the component(s) of the field to be used for the normal components. More...

int	GetNormalComponentArrayComponent (int comp)
	Define the component(s) of the field to be used for the normal components. More...

int	GetNormalComponentMinRange (int comp)
	Define the component(s) of the field to be used for the normal components. More...

int	GetNormalComponentMaxRange (int comp)
	Define the component(s) of the field to be used for the normal components. More...

int	GetNormalComponentNormalizeFlag (int comp)
	Define the component(s) of the field to be used for the normal components. More...


void	SetTensorComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
	Define the components of the field to be used for the tensor components. More...

void	SetTensorComponent (int comp, const char *arrayName, int arrayComp)
	Define the components of the field to be used for the tensor components. More...

const char *	GetTensorComponentArrayName (int comp)
	Define the components of the field to be used for the tensor components. More...

int	GetTensorComponentArrayComponent (int comp)
	Define the components of the field to be used for the tensor components. More...

int	GetTensorComponentMinRange (int comp)
	Define the components of the field to be used for the tensor components. More...

int	GetTensorComponentMaxRange (int comp)
	Define the components of the field to be used for the tensor components. More...

int	GetTensorComponentNormalizeFlag (int comp)
	Define the components of the field to be used for the tensor components. More...


void	SetTCoordComponent (int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
	Define the components of the field to be used for the cell texture coord components. More...

void	SetTCoordComponent (int comp, const char *arrayName, int arrayComp)
	Define the components of the field to be used for the cell texture coord components. More...

const char *	GetTCoordComponentArrayName (int comp)
	Define the components of the field to be used for the cell texture coord components. More...

int	GetTCoordComponentArrayComponent (int comp)
	Define the components of the field to be used for the cell texture coord components. More...

int	GetTCoordComponentMinRange (int comp)
	Define the components of the field to be used for the cell texture coord components. More...

int	GetTCoordComponentMaxRange (int comp)
	Define the components of the field to be used for the cell texture coord components. More...

int	GetTCoordComponentNormalizeFlag (int comp)
	Define the components of the field to be used for the cell texture coord components. More...


virtual void	SetDefaultNormalize (vtkTypeBool)
	Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents). More...

virtual vtkTypeBool	GetDefaultNormalize ()
	Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents). More...

virtual void	DefaultNormalizeOn ()
	Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents). More...

virtual void	DefaultNormalizeOff ()
	Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents). More...

Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()
	Get the input data object. More...

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData. More...

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints. More...

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints. More...

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid. More...

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid. More...

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid. More...

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details More...

vtkDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (vtkDataSet *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataSet *)
	Assign a data object as input. More...

void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (vtkDataSet *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataSet *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkFieldDataToAttributeDataFilter *	SafeDownCast (vtkObjectBase *o)

static vtkFieldDataToAttributeDataFilter *	New ()
	Construct object with input field set to the data object field, and the output attribute data set to generate point data. More...

static int	GetComponentsType (int numComp, vtkDataArray **arrays)
	Given an array of names of arrays in field data, return the common type for these arrays. More...

static int	ConstructArray (vtkDataArray da, int comp, vtkDataArray frray, int fieldComp, vtkIdType min, vtkIdType max, int normalize)
	Construct a portion of a data array (the comp portion) from another data array and its component. More...

static vtkDataArray *	GetFieldArray (vtkFieldData fd, const char name, int comp)
	Return an array of a particular name from field data and do error checking. More...

static void	SetArrayName (vtkObject self, char &name, const char *newName)
	Specify an array name for one of the components. More...

static int	UpdateComponentRange (vtkDataArray *da, vtkIdType compRange[2])
	Update the maximum and minimum component range values. More...

Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkFieldDataToAttributeDataFilter ()

	~vtkFieldDataToAttributeDataFilter () override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks the algorithm to do its work. More...

void	ConstructScalars (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[4][2], char *arrays[4], int arrayComponents[4], int normalize[4], int numComp)

void	ConstructVectors (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])

void	ConstructGhostLevels (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[2], char *array, int arrayComponent, int normalize)

void	ConstructNormals (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])

void	ConstructTCoords (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3], int numComp)

void	ConstructTensors (int num, vtkFieldData fd, vtkDataSetAttributes attr, vtkIdType componentRange[9][2], char *arrays[9], int arrayComponents[9], int normalize[9])

void	ConstructFieldData (int num, vtkDataSetAttributes *attr)

Protected Member Functions inherited from vtkDataSetAlgorithm
	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () override

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks for Information. More...

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...

vtkDataObject *	GetInput (int port)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	InputField

int	OutputAttributeData

int	NumberOfScalarComponents

char *	ScalarArrays [4]

int	ScalarArrayComponents [4]

vtkIdType	ScalarComponentRange [4][2]

int	ScalarNormalize [4]

char *	VectorArrays [3]

int	VectorArrayComponents [3]

vtkIdType	VectorComponentRange [3][2]

int	VectorNormalize [3]

char *	GhostLevelArray

int	GhostLevelArrayComponent

vtkIdType	GhostLevelComponentRange [2]

int	GhostLevelNormalize

char *	NormalArrays [3]

int	NormalArrayComponents [3]

vtkIdType	NormalComponentRange [3][2]

int	NormalNormalize [3]

char *	TensorArrays [9]

int	TensorArrayComponents [9]

vtkIdType	TensorComponentRange [9][2]

int	TensorNormalize [9]

int	NumberOfTCoordComponents

char *	TCoordArrays [3]

int	TCoordArrayComponents [3]

vtkIdType	TCoordComponentRange [3][2]

int	TCoordNormalize [3]

vtkTypeBool	DefaultNormalize

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

map field data to dataset attribute data

vtkFieldDataToAttributeDataFilter is a class that maps field data into dataset attributes. The input to this filter is any type of dataset and the output is the same dataset (geometry/topology) with new attribute data (attribute data is passed through if not replaced during filter execution).

To use this filter you must specify which field data from the input dataset to use. There are three possibilities: the cell field data, the point field data, or the field data associated with the data object superclass. Then you specify which attribute data to create: either cell attribute data or point attribute data. Finally, you must define how to construct the various attribute data types (e.g., scalars, vectors, normals, etc.) from the arrays and the components of the arrays from the field data. This is done by associating components in the input field with components making up the attribute data. For example, you would specify a scalar with three components (RGB) by assigning components from the field for the R, then G, then B values of the scalars. You may also have to specify component ranges (for each R-G-B) to make sure that the number of R, G, and B values is the same. Also, you may want to normalize the components which helps distribute the data uniformly.

This filter is often used in conjunction with vtkDataObjectToDataSetFilter. vtkDataObjectToDataSetFilter filter generates dataset topology and geometry and passes its input field data along to its output. Then this filter is used to generate the attribute data to go along with the dataset.

Warning: Make sure that the data you extract is consistent. That is, if you have N points, extract N point attributes (scalars, vectors, etc.).

See also: vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray

Tests:: vtkFieldDataToAttributeDataFilter (Tests)

Definition at line 75 of file vtkFieldDataToAttributeDataFilter.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkFieldDataToAttributeDataFilter::Superclass

Definition at line 79 of file vtkFieldDataToAttributeDataFilter.h.

Constructor & Destructor Documentation

vtkFieldDataToAttributeDataFilter::vtkFieldDataToAttributeDataFilter ( )

protected

vtkFieldDataToAttributeDataFilter::~vtkFieldDataToAttributeDataFilter ( )

overrideprotected

Member Function Documentation

void vtkFieldDataToAttributeDataFilter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkTypeBool vtkFieldDataToAttributeDataFilter::IsTypeOf ( const char * type )

static

virtual vtkTypeBool vtkFieldDataToAttributeDataFilter::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 vtkFieldDataToAttributeDataFilter* vtkFieldDataToAttributeDataFilter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkFieldDataToAttributeDataFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

vtkFieldDataToAttributeDataFilter* vtkFieldDataToAttributeDataFilter::NewInstance ( ) const

static vtkFieldDataToAttributeDataFilter* vtkFieldDataToAttributeDataFilter::New ( )

static

Construct object with input field set to the data object field, and the output attribute data set to generate point data.

virtual void vtkFieldDataToAttributeDataFilter::SetInputField ( int )

virtual

Specify which field data to use to generate the output attribute data.

There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

virtual int vtkFieldDataToAttributeDataFilter::GetInputField ( )

virtual

Specify which field data to use to generate the output attribute data.

There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

void vtkFieldDataToAttributeDataFilter::SetInputFieldToDataObjectField ( )

inline

Specify which field data to use to generate the output attribute data.

There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

Definition at line 96 of file vtkFieldDataToAttributeDataFilter.h.

void vtkFieldDataToAttributeDataFilter::SetInputFieldToPointDataField ( )

inline

Specify which field data to use to generate the output attribute data.

There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

Definition at line 98 of file vtkFieldDataToAttributeDataFilter.h.

void vtkFieldDataToAttributeDataFilter::SetInputFieldToCellDataField ( )

inline

Specify which field data to use to generate the output attribute data.

There are three choices: the field data associated with the vtkDataObject superclass; the point field attribute data; and the cell field attribute data.

Definition at line 100 of file vtkFieldDataToAttributeDataFilter.h.

virtual void vtkFieldDataToAttributeDataFilter::SetOutputAttributeData ( int )

virtual

Specify which attribute data to output: point or cell data attributes.

virtual int vtkFieldDataToAttributeDataFilter::GetOutputAttributeData ( )

virtual

Specify which attribute data to output: point or cell data attributes.

void vtkFieldDataToAttributeDataFilter::SetOutputAttributeDataToCellData ( )

inline

Specify which attribute data to output: point or cell data attributes.

Definition at line 110 of file vtkFieldDataToAttributeDataFilter.h.

void vtkFieldDataToAttributeDataFilter::SetOutputAttributeDataToPointData ( )

inline

Specify which attribute data to output: point or cell data attributes.

Definition at line 112 of file vtkFieldDataToAttributeDataFilter.h.

void vtkFieldDataToAttributeDataFilter::SetScalarComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp,
		int	min,
		int	max,
		int	normalize
	)

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetScalarComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp
	)

inline

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

Definition at line 126 of file vtkFieldDataToAttributeDataFilter.h.

const char* vtkFieldDataToAttributeDataFilter::GetScalarComponentArrayName ( int comp )

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetScalarComponentArrayComponent ( int comp )

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetScalarComponentMinRange ( int comp )

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetScalarComponentMaxRange ( int comp )

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetScalarComponentNormalizeFlag ( int comp )

Define the component(s) of the field to be used for the scalar components.

Note that the parameter comp must lie between (0,4). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetVectorComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp,
		int	min,
		int	max,
		int	normalize
	)

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetVectorComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp
	)

inline

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

Definition at line 145 of file vtkFieldDataToAttributeDataFilter.h.

const char* vtkFieldDataToAttributeDataFilter::GetVectorComponentArrayName ( int comp )

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetVectorComponentArrayComponent ( int comp )

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetVectorComponentMinRange ( int comp )

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetVectorComponentMaxRange ( int comp )

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetVectorComponentNormalizeFlag ( int comp )

Define the component(s) of the field to be used for the vector components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetNormalComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp,
		int	min,
		int	max,
		int	normalize
	)

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetNormalComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp
	)

inline

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

Definition at line 164 of file vtkFieldDataToAttributeDataFilter.h.

const char* vtkFieldDataToAttributeDataFilter::GetNormalComponentArrayName ( int comp )

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetNormalComponentArrayComponent ( int comp )

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetNormalComponentMinRange ( int comp )

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetNormalComponentMaxRange ( int comp )

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

int vtkFieldDataToAttributeDataFilter::GetNormalComponentNormalizeFlag ( int comp )

Define the component(s) of the field to be used for the normal components.

Note that the parameter comp must lie between (0,3). To define the field component to use you specify an array name and the component in that array. The (min,max) values are the range of data in the component you wish to extract.

void vtkFieldDataToAttributeDataFilter::SetTensorComponent	(	int	comp,
		const char *	arrayName,
		int	arrayComp,
		int	min,
		int	max,
		int	normalize
	)

Define the components of the field to be used for the tensor components.