VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFieldDataToAttributeDataFilter Class Reference

map field data to dataset attribute data More...

#include <vtkFieldDataToAttributeDataFilter.h>

Inheritance diagram for vtkFieldDataToAttributeDataFilter:
[legend]
Collaboration diagram for vtkFieldDataToAttributeDataFilter:
[legend]

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.
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkFieldDataToAttributeDataFilterNewInstance () const
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 If output does not need exact extent, the I do not either.
 
virtual void SetInputField (int)
 Specify which field data to use to generate the output attribute data.
 
virtual int GetInputField ()
 Specify which field data to use to generate the output attribute data.
 
void SetInputFieldToDataObjectField ()
 Specify which field data to use to generate the output attribute data.
 
void SetInputFieldToPointDataField ()
 Specify which field data to use to generate the output attribute data.
 
void SetInputFieldToCellDataField ()
 Specify which field data to use to generate the output attribute data.
 
virtual void SetOutputAttributeData (int)
 Specify which attribute data to output: point or cell data attributes.
 
virtual int GetOutputAttributeData ()
 Specify which attribute data to output: point or cell data attributes.
 
void SetOutputAttributeDataToCellData ()
 Specify which attribute data to output: point or cell data attributes.
 
void SetOutputAttributeDataToPointData ()
 Specify which attribute data to output: point or cell data attributes.
 
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.
 
void SetScalarComponent (int comp, const char *arrayName, int arrayComp)
 Define the component(s) of the field to be used for the scalar components.
 
const char * GetScalarComponentArrayName (int comp)
 Define the component(s) of the field to be used for the scalar components.
 
int GetScalarComponentArrayComponent (int comp)
 Define the component(s) of the field to be used for the scalar components.
 
int GetScalarComponentMinRange (int comp)
 Define the component(s) of the field to be used for the scalar components.
 
int GetScalarComponentMaxRange (int comp)
 Define the component(s) of the field to be used for the scalar components.
 
int GetScalarComponentNormalizeFlag (int comp)
 Define the component(s) of the field to be used for the scalar components.
 
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.
 
void SetVectorComponent (int comp, const char *arrayName, int arrayComp)
 Define the component(s) of the field to be used for the vector components.
 
const char * GetVectorComponentArrayName (int comp)
 Define the component(s) of the field to be used for the vector components.
 
int GetVectorComponentArrayComponent (int comp)
 Define the component(s) of the field to be used for the vector components.
 
int GetVectorComponentMinRange (int comp)
 Define the component(s) of the field to be used for the vector components.
 
int GetVectorComponentMaxRange (int comp)
 Define the component(s) of the field to be used for the vector components.
 
int GetVectorComponentNormalizeFlag (int comp)
 Define the component(s) of the field to be used for the vector components.
 
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.
 
void SetNormalComponent (int comp, const char *arrayName, int arrayComp)
 Define the component(s) of the field to be used for the normal components.
 
const char * GetNormalComponentArrayName (int comp)
 Define the component(s) of the field to be used for the normal components.
 
int GetNormalComponentArrayComponent (int comp)
 Define the component(s) of the field to be used for the normal components.
 
int GetNormalComponentMinRange (int comp)
 Define the component(s) of the field to be used for the normal components.
 
int GetNormalComponentMaxRange (int comp)
 Define the component(s) of the field to be used for the normal components.
 
int GetNormalComponentNormalizeFlag (int comp)
 Define the component(s) of the field to be used for the normal components.
 
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.
 
void SetTensorComponent (int comp, const char *arrayName, int arrayComp)
 Define the components of the field to be used for the tensor components.
 
const char * GetTensorComponentArrayName (int comp)
 Define the components of the field to be used for the tensor components.
 
int GetTensorComponentArrayComponent (int comp)
 Define the components of the field to be used for the tensor components.
 
int GetTensorComponentMinRange (int comp)
 Define the components of the field to be used for the tensor components.
 
int GetTensorComponentMaxRange (int comp)
 Define the components of the field to be used for the tensor components.
 
int GetTensorComponentNormalizeFlag (int comp)
 Define the components of the field to be used for the tensor components.
 
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.
 
void SetTCoordComponent (int comp, const char *arrayName, int arrayComp)
 Define the components of the field to be used for the cell texture coord components.
 
const char * GetTCoordComponentArrayName (int comp)
 Define the components of the field to be used for the cell texture coord components.
 
int GetTCoordComponentArrayComponent (int comp)
 Define the components of the field to be used for the cell texture coord components.
 
int GetTCoordComponentMinRange (int comp)
 Define the components of the field to be used for the cell texture coord components.
 
int GetTCoordComponentMaxRange (int comp)
 Define the components of the field to be used for the cell texture coord components.
 
int GetTCoordComponentNormalizeFlag (int comp)
 Define the components of the field to be used for the cell texture coord components.
 
virtual void SetDefaultNormalize (vtkTypeBool)
 Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents).
 
virtual vtkTypeBool GetDefaultNormalize ()
 Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents).
 
virtual void DefaultNormalizeOn ()
 Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents).
 
virtual void DefaultNormalizeOff ()
 Set the default Normalize() flag for those methods setting a default Normalize value (e.g., SetScalarComponents).
 
- Public Member Functions inherited from vtkDataSetAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataSetAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkDataObjectGetInput ()
 Get the input data object.
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData.
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as vtkStructuredPoints.
 
vtkImageDataGetImageDataOutput ()
 Get the output as vtkStructuredPoints.
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid.
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid.
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as vtkRectilinearGrid.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkDataSetGetOutput (int)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (vtkDataSet *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataSet *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
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.
 
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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetProgress (double)
 SetProgress is deprecated.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool 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).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection.
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports.
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
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.
 
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.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
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.
 
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.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFieldDataToAttributeDataFilterSafeDownCast (vtkObjectBase *o)
 
static vtkFieldDataToAttributeDataFilterNew ()
 Construct object with input field set to the data object field, and the output attribute data set to generate point data.
 
static int GetComponentsType (int numComp, vtkDataArray **arrays)
 Given an array of names of arrays in field data, return the common type for these arrays.
 
static int ConstructArray (vtkDataArray *da, int comp, vtkDataArray *fieldArray, 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.
 
static vtkDataArrayGetFieldArray (vtkFieldData *fd, const char *name, int comp)
 Return an array of a particular name from field data and do error checking.
 
static void SetArrayName (vtkObject *self, char *&name, const char *newName)
 Specify an array name for one of the components.
 
static int UpdateComponentRange (vtkDataArray *da, vtkIdType compRange[2])
 Update the maximum and minimum component range values.
 
- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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.
 
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
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information.
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks the algorithm to do its work.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
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.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
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.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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
Online Examples:

Definition at line 101 of file vtkFieldDataToAttributeDataFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 105 of file vtkFieldDataToAttributeDataFilter.h.

Constructor & Destructor Documentation

◆ vtkFieldDataToAttributeDataFilter()

vtkFieldDataToAttributeDataFilter::vtkFieldDataToAttributeDataFilter ( )
protected

◆ ~vtkFieldDataToAttributeDataFilter()

vtkFieldDataToAttributeDataFilter::~vtkFieldDataToAttributeDataFilter ( )
overrideprotected

Member Function Documentation

◆ PrintSelf()

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.

◆ IsTypeOf()

static vtkTypeBool vtkFieldDataToAttributeDataFilter::IsTypeOf ( const char *  type)
static

◆ IsA()

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.

◆ SafeDownCast()

static vtkFieldDataToAttributeDataFilter * vtkFieldDataToAttributeDataFilter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkFieldDataToAttributeDataFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

◆ NewInstance()

vtkFieldDataToAttributeDataFilter * vtkFieldDataToAttributeDataFilter::NewInstance ( ) const

◆ New()

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.

◆ SetInputField()

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.

◆ GetInputField()

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.

◆ SetInputFieldToDataObjectField()

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 122 of file vtkFieldDataToAttributeDataFilter.h.

◆ SetInputFieldToPointDataField()

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 123 of file vtkFieldDataToAttributeDataFilter.h.

◆ SetInputFieldToCellDataField()

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 124 of file vtkFieldDataToAttributeDataFilter.h.

◆ SetOutputAttributeData()

virtual void vtkFieldDataToAttributeDataFilter::SetOutputAttributeData ( int  )
virtual

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

◆ GetOutputAttributeData()

virtual int vtkFieldDataToAttributeDataFilter::GetOutputAttributeData ( )
virtual

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

◆ SetOutputAttributeDataToCellData()

void vtkFieldDataToAttributeDataFilter::SetOutputAttributeDataToCellData ( )
inline

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

Definition at line 133 of file vtkFieldDataToAttributeDataFilter.h.

◆ SetOutputAttributeDataToPointData()

void vtkFieldDataToAttributeDataFilter::SetOutputAttributeDataToPointData ( )
inline

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

Definition at line 134 of file vtkFieldDataToAttributeDataFilter.h.

◆ SetScalarComponent() [1/2]

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.

◆ SetScalarComponent() [2/2]

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 147 of file vtkFieldDataToAttributeDataFilter.h.

◆ GetScalarComponentArrayName()

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.

◆ GetScalarComponentArrayComponent()

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.

◆ GetScalarComponentMinRange()

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.

◆ GetScalarComponentMaxRange()

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.

◆ GetScalarComponentNormalizeFlag()

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.

◆ SetVectorComponent() [1/2]

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.

◆ SetVectorComponent() [2/2]

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 168 of file vtkFieldDataToAttributeDataFilter.h.

◆ GetVectorComponentArrayName()

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.

◆ GetVectorComponentArrayComponent()

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.

◆ GetVectorComponentMinRange()

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.

◆ GetVectorComponentMaxRange()

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.

◆ GetVectorComponentNormalizeFlag()

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.

◆ SetNormalComponent() [1/2]

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.

◆ SetNormalComponent() [2/2]

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 189 of file vtkFieldDataToAttributeDataFilter.h.

◆ GetNormalComponentArrayName()

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.

◆ GetNormalComponentArrayComponent()

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.

◆ GetNormalComponentMinRange()

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.

◆ GetNormalComponentMaxRange()

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.

◆ GetNormalComponentNormalizeFlag()

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.

◆ SetTensorComponent() [1/2]

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.

Note that the parameter comp must lie between (0,9). 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.

◆ SetTensorComponent() [2/2]

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

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

Note that the parameter comp must lie between (0,9). 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 210 of file vtkFieldDataToAttributeDataFilter.h.

◆ GetTensorComponentArrayName()

const char * vtkFieldDataToAttributeDataFilter::GetTensorComponentArrayName ( int  comp)

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

Note that the parameter comp must lie between (0,9). 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.

◆ GetTensorComponentArrayComponent()

int vtkFieldDataToAttributeDataFilter::GetTensorComponentArrayComponent ( int  comp)

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

Note that the parameter comp must lie between (0,9). 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.

◆ GetTensorComponentMinRange()

int vtkFieldDataToAttributeDataFilter::GetTensorComponentMinRange ( int  comp)

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

Note that the parameter comp must lie between (0,9). 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.

◆ GetTensorComponentMaxRange()

int vtkFieldDataToAttributeDataFilter::GetTensorComponentMaxRange ( int  comp)

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

Note that the parameter comp must lie between (0,9). 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.

◆ GetTensorComponentNormalizeFlag()

int vtkFieldDataToAttributeDataFilter::GetTensorComponentNormalizeFlag ( int  comp)

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

Note that the parameter comp must lie between (0,9). 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.

◆ SetTCoordComponent() [1/2]

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

Note that the parameter comp must lie between (0,9). 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.

◆ SetTCoordComponent() [2/2]

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

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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 231 of file vtkFieldDataToAttributeDataFilter.h.

◆ GetTCoordComponentArrayName()

const char * vtkFieldDataToAttributeDataFilter::GetTCoordComponentArrayName ( int  comp)

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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.

◆ GetTCoordComponentArrayComponent()

int vtkFieldDataToAttributeDataFilter::GetTCoordComponentArrayComponent ( int  comp)

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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.

◆ GetTCoordComponentMinRange()

int vtkFieldDataToAttributeDataFilter::GetTCoordComponentMinRange ( int  comp)

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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.

◆ GetTCoordComponentMaxRange()

int vtkFieldDataToAttributeDataFilter::GetTCoordComponentMaxRange ( int  comp)

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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.

◆ GetTCoordComponentNormalizeFlag()

int vtkFieldDataToAttributeDataFilter::GetTCoordComponentNormalizeFlag ( int  comp)

Define the components of the field to be used for the cell texture coord components.

Note that the parameter comp must lie between (0,9). 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.

◆ SetDefaultNormalize()

virtual void vtkFieldDataToAttributeDataFilter::SetDefaultNormalize ( vtkTypeBool  )
virtual

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

◆ GetDefaultNormalize()

virtual vtkTypeBool vtkFieldDataToAttributeDataFilter::GetDefaultNormalize ( )
virtual

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

◆ DefaultNormalizeOn()

virtual void vtkFieldDataToAttributeDataFilter::DefaultNormalizeOn ( )
virtual

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

◆ DefaultNormalizeOff()

virtual void vtkFieldDataToAttributeDataFilter::DefaultNormalizeOff ( )
virtual

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

◆ GetComponentsType()

static int vtkFieldDataToAttributeDataFilter::GetComponentsType ( int  numComp,
vtkDataArray **  arrays 
)
static

Given an array of names of arrays in field data, return the common type for these arrays.

For example, if a vector is constructed of the three type (char,int,float), the return type is float.

◆ ConstructArray()

static int vtkFieldDataToAttributeDataFilter::ConstructArray ( vtkDataArray da,
int  comp,
vtkDataArray fieldArray,
int  fieldComp,
vtkIdType  min,
vtkIdType  max,
int  normalize 
)
static

Construct a portion of a data array (the comp portion) from another data array and its component.

The variables min and max control the range of the data to use from the other data array; normalize is a flag that when set will normalize the data between (0,1).

◆ GetFieldArray()

static vtkDataArray * vtkFieldDataToAttributeDataFilter::GetFieldArray ( vtkFieldData fd,
const char *  name,
int  comp 
)
static

Return an array of a particular name from field data and do error checking.

◆ SetArrayName()

static void vtkFieldDataToAttributeDataFilter::SetArrayName ( vtkObject self,
char *&  name,
const char *  newName 
)
static

Specify an array name for one of the components.

◆ UpdateComponentRange()

static int vtkFieldDataToAttributeDataFilter::UpdateComponentRange ( vtkDataArray da,
vtkIdType  compRange[2] 
)
static

Update the maximum and minimum component range values.

Returns a flag indicating whether the range was updated.

◆ RequestUpdateExtent()

int vtkFieldDataToAttributeDataFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overridevirtual

If output does not need exact extent, the I do not either.

Reimplemented from vtkDataSetAlgorithm.

◆ RequestData()

int vtkFieldDataToAttributeDataFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

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 final pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ ConstructScalars()

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

◆ ConstructVectors()

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

◆ ConstructGhostLevels()

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

◆ ConstructNormals()

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

◆ ConstructTCoords()

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

◆ ConstructTensors()

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

◆ ConstructFieldData()

void vtkFieldDataToAttributeDataFilter::ConstructFieldData ( int  num,
vtkDataSetAttributes attr 
)
protected

Member Data Documentation

◆ InputField

int vtkFieldDataToAttributeDataFilter::InputField
protected

Definition at line 298 of file vtkFieldDataToAttributeDataFilter.h.

◆ OutputAttributeData

int vtkFieldDataToAttributeDataFilter::OutputAttributeData
protected

Definition at line 299 of file vtkFieldDataToAttributeDataFilter.h.

◆ NumberOfScalarComponents

int vtkFieldDataToAttributeDataFilter::NumberOfScalarComponents
protected

Definition at line 301 of file vtkFieldDataToAttributeDataFilter.h.

◆ ScalarArrays

char* vtkFieldDataToAttributeDataFilter::ScalarArrays[4]
protected

Definition at line 302 of file vtkFieldDataToAttributeDataFilter.h.

◆ ScalarArrayComponents

int vtkFieldDataToAttributeDataFilter::ScalarArrayComponents[4]
protected

Definition at line 303 of file vtkFieldDataToAttributeDataFilter.h.

◆ ScalarComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::ScalarComponentRange[4][2]
protected

Definition at line 304 of file vtkFieldDataToAttributeDataFilter.h.

◆ ScalarNormalize

int vtkFieldDataToAttributeDataFilter::ScalarNormalize[4]
protected

Definition at line 305 of file vtkFieldDataToAttributeDataFilter.h.

◆ VectorArrays

char* vtkFieldDataToAttributeDataFilter::VectorArrays[3]
protected

Definition at line 307 of file vtkFieldDataToAttributeDataFilter.h.

◆ VectorArrayComponents

int vtkFieldDataToAttributeDataFilter::VectorArrayComponents[3]
protected

Definition at line 308 of file vtkFieldDataToAttributeDataFilter.h.

◆ VectorComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::VectorComponentRange[3][2]
protected

Definition at line 309 of file vtkFieldDataToAttributeDataFilter.h.

◆ VectorNormalize

int vtkFieldDataToAttributeDataFilter::VectorNormalize[3]
protected

Definition at line 310 of file vtkFieldDataToAttributeDataFilter.h.

◆ GhostLevelArray

char* vtkFieldDataToAttributeDataFilter::GhostLevelArray
protected

Definition at line 312 of file vtkFieldDataToAttributeDataFilter.h.

◆ GhostLevelArrayComponent

int vtkFieldDataToAttributeDataFilter::GhostLevelArrayComponent
protected

Definition at line 313 of file vtkFieldDataToAttributeDataFilter.h.

◆ GhostLevelComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::GhostLevelComponentRange[2]
protected

Definition at line 314 of file vtkFieldDataToAttributeDataFilter.h.

◆ GhostLevelNormalize

int vtkFieldDataToAttributeDataFilter::GhostLevelNormalize
protected

Definition at line 315 of file vtkFieldDataToAttributeDataFilter.h.

◆ NormalArrays

char* vtkFieldDataToAttributeDataFilter::NormalArrays[3]
protected

Definition at line 317 of file vtkFieldDataToAttributeDataFilter.h.

◆ NormalArrayComponents

int vtkFieldDataToAttributeDataFilter::NormalArrayComponents[3]
protected

Definition at line 318 of file vtkFieldDataToAttributeDataFilter.h.

◆ NormalComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::NormalComponentRange[3][2]
protected

Definition at line 319 of file vtkFieldDataToAttributeDataFilter.h.

◆ NormalNormalize

int vtkFieldDataToAttributeDataFilter::NormalNormalize[3]
protected

Definition at line 320 of file vtkFieldDataToAttributeDataFilter.h.

◆ TensorArrays

char* vtkFieldDataToAttributeDataFilter::TensorArrays[9]
protected

Definition at line 322 of file vtkFieldDataToAttributeDataFilter.h.

◆ TensorArrayComponents

int vtkFieldDataToAttributeDataFilter::TensorArrayComponents[9]
protected

Definition at line 323 of file vtkFieldDataToAttributeDataFilter.h.

◆ TensorComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::TensorComponentRange[9][2]
protected

Definition at line 324 of file vtkFieldDataToAttributeDataFilter.h.

◆ TensorNormalize

int vtkFieldDataToAttributeDataFilter::TensorNormalize[9]
protected

Definition at line 325 of file vtkFieldDataToAttributeDataFilter.h.

◆ NumberOfTCoordComponents

int vtkFieldDataToAttributeDataFilter::NumberOfTCoordComponents
protected

Definition at line 327 of file vtkFieldDataToAttributeDataFilter.h.

◆ TCoordArrays

char* vtkFieldDataToAttributeDataFilter::TCoordArrays[3]
protected

Definition at line 328 of file vtkFieldDataToAttributeDataFilter.h.

◆ TCoordArrayComponents

int vtkFieldDataToAttributeDataFilter::TCoordArrayComponents[3]
protected

Definition at line 329 of file vtkFieldDataToAttributeDataFilter.h.

◆ TCoordComponentRange

vtkIdType vtkFieldDataToAttributeDataFilter::TCoordComponentRange[3][2]
protected

Definition at line 330 of file vtkFieldDataToAttributeDataFilter.h.

◆ TCoordNormalize

int vtkFieldDataToAttributeDataFilter::TCoordNormalize[3]
protected

Definition at line 331 of file vtkFieldDataToAttributeDataFilter.h.

◆ DefaultNormalize

vtkTypeBool vtkFieldDataToAttributeDataFilter::DefaultNormalize
protected

Definition at line 333 of file vtkFieldDataToAttributeDataFilter.h.


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