VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkRearrangeFields Class Reference

Move/copy fields between field data, point data and cell data. More...

#include <vtkRearrangeFields.h>

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

Classes

struct  Operation
 

Public Types

enum  OperationType { COPY =0, MOVE =1 }
 
enum  FieldLocation { DATA_OBJECT =0, POINT_DATA =1, CELL_DATA =2 }
 
enum  FieldType { NAME, ATTRIBUTE }
 
typedef vtkDataSetAlgorithm Superclass
 
- Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int AddOperation (int operationType, int attributeType, int fromFieldLoc, int toFieldLoc)
 
int AddOperation (int operationType, const char *name, int fromFieldLoc, int toFieldLoc)
 
int AddOperation (const char *operationType, const char *attributeType, const char *fromFieldLoc, const char *toFieldLoc)
 
int RemoveOperation (int operationId)
 
int RemoveOperation (int operationType, int attributeType, int fromFieldLoc, int toFieldLoc)
 
int RemoveOperation (int operationType, const char *name, int fromFieldLoc, int toFieldLoc)
 
int RemoveOperation (const char *operationType, const char *attributeType, const char *fromFieldLoc, const char *toFieldLoc)
 
void RemoveAllOperations ()
 
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataObjectGetInput ()
 
vtkPolyDataGetPolyDataOutput ()
 
vtkStructuredPointsGetStructuredPointsOutput ()
 
vtkImageDataGetImageDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 
vtkRectilinearGridGetRectilinearGridOutput ()
 
vtkDataSetGetOutput ()
 
vtkDataSetGetOutput (int)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
void SetInput (vtkDataSet *)
 
void SetInput (int, vtkDataSet *)
 
void AddInput (vtkDataObject *)
 
void AddInput (vtkDataSet *)
 
void AddInput (int, vtkDataSet *)
 
void AddInput (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkRearrangeFieldsSafeDownCast (vtkObject *o)
 
static vtkRearrangeFieldsNew ()
 
- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
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 vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkRearrangeFields ()
 
virtual ~vtkRearrangeFields ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
OperationGetNextOperation (Operation *op)
 
OperationGetFirst ()
 
void AddOperation (Operation *op)
 
void DeleteOperation (Operation *op, Operation *before)
 
OperationFindOperation (int id, Operation *&before)
 
OperationFindOperation (const char *name, Operation *&before)
 
OperationFindOperation (int operationType, const char *name, int fromFieldLoc, int toFieldLoc, Operation *&before)
 
OperationFindOperation (int operationType, int attributeType, int fromFieldLoc, int toFieldLoc, Operation *&before)
 
int CompareOperationsByType (const Operation *op1, const Operation *op2)
 
int CompareOperationsByName (const Operation *op1, const Operation *op2)
 
void DeleteAllOperations ()
 
void ApplyOperation (Operation *op, vtkDataSet *input, vtkDataSet *output)
 
vtkFieldDataGetFieldDataFromLocation (vtkDataSet *ds, int fieldLoc)
 
void PrintAllOperations (ostream &os, vtkIndent indent)
 
void PrintOperation (Operation *op, ostream &os, vtkIndent indent)
 
- Protected Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm ()
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
vtkDataObjectGetInput (int port)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

OperationHead
 
OperationTail
 
int LastId
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static char OperationTypeNames [2][5]
 
static char FieldLocationNames [3][12]
 
static char AttributeNames [vtkDataSetAttributes::NUM_ATTRIBUTES][10]
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Detailed Description

Move/copy fields between field data, point data and cell data.

vtkRearrangeFields is used to copy/move fields (vtkDataArrays) between data object's field data, point data and cell data. To specify which fields are copied/moved, the user adds operations. There are two types of operations: 1. the type which copies/moves an attribute's data (i.e. the field will be copied but will not be an attribute in the target), 2. the type which copies/moves fields by name. For example:

rf->AddOperation(vtkRearrangeFields::COPY, "foo", 
                 vtkRearrangeFields::DATA_OBJECT, 
                 vtkRearrangeFields::POINT_DATA);

adds an operation which copies a field (data array) called foo from the data object's field data to point data. From Tcl, the same operation can be added as follows:

rf AddOperation COPY foo DATA_OBJECT POINT_DATA

The same can be done using Python and Java bindings by passing strings as arguments.

Operation types: COPY, MOVE
AttributeTypes: SCALARS, VECTORS, NORMALS, TCOORDS, TENSORS
Field data locations: DATA_OBJECT, POINT_DATA, CELL_DATA
Warning
When using Tcl, Java, Python or Visual Basic bindings, the array name can not be one of the AttributeTypes when calling AddOperation() which takes strings as arguments. The Tcl (Java etc.) command will always assume the string corresponds to an attribute type when the argument is one of the AttributeTypes. In this situation, use the AddOperation() which takes enums.
See also
vtkFieldData vtkDataSet vtkDataObjectToDataSetFilter vtkDataSetAttributes vtkDataArray vtkAssignAttribute vtkSplitField vtkMergeFields
Examples:
vtkRearrangeFields (Examples)
Tests:
vtkRearrangeFields (Tests)

Definition at line 72 of file vtkRearrangeFields.h.

Member Typedef Documentation

Definition at line 75 of file vtkRearrangeFields.h.

Member Enumeration Documentation

Enumerator
COPY 
MOVE 

Definition at line 82 of file vtkRearrangeFields.h.

Enumerator
DATA_OBJECT 
POINT_DATA 
CELL_DATA 

Definition at line 87 of file vtkRearrangeFields.h.

Enumerator
NAME 
ATTRIBUTE 

Definition at line 146 of file vtkRearrangeFields.h.

Constructor & Destructor Documentation

vtkRearrangeFields::vtkRearrangeFields ( )
protected
virtual vtkRearrangeFields::~vtkRearrangeFields ( )
protectedvirtual

Member Function Documentation

virtual const char* vtkRearrangeFields::GetClassName ( )
virtual

Reimplemented from vtkDataSetAlgorithm.

static int vtkRearrangeFields::IsTypeOf ( const char *  type)
static
virtual int vtkRearrangeFields::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 vtkRearrangeFields* vtkRearrangeFields::SafeDownCast ( vtkObject o)
static
void vtkRearrangeFields::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSetAlgorithm.

static vtkRearrangeFields* vtkRearrangeFields::New ( )
static

Create a new vtkRearrangeFields with an empty operation list.

int vtkRearrangeFields::AddOperation ( int  operationType,
int  attributeType,
int  fromFieldLoc,
int  toFieldLoc 
)

Add an operation which copies an attribute's field (data array) from one field data to another. Returns an operation id which can later be used to remove the operation.

int vtkRearrangeFields::AddOperation ( int  operationType,
const char *  name,
int  fromFieldLoc,
int  toFieldLoc 
)

Add an operation which copies an attribute's field (data array) from one field data to another. Returns an operation id which can later be used to remove the operation.

int vtkRearrangeFields::AddOperation ( const char *  operationType,
const char *  attributeType,
const char *  fromFieldLoc,
const char *  toFieldLoc 
)

Add an operation which copies an attribute's field (data array) from one field data to another. Returns an operation id which can later be used to remove the operation.

int vtkRearrangeFields::RemoveOperation ( int  operationId)

Remove an operation with the given id.

int vtkRearrangeFields::RemoveOperation ( int  operationType,
int  attributeType,
int  fromFieldLoc,
int  toFieldLoc 
)

Remove an operation with the given id.

int vtkRearrangeFields::RemoveOperation ( int  operationType,
const char *  name,
int  fromFieldLoc,
int  toFieldLoc 
)

Remove an operation with the given id.

int vtkRearrangeFields::RemoveOperation ( const char *  operationType,
const char *  attributeType,
const char *  fromFieldLoc,
const char *  toFieldLoc 
)

Remove an operation with the given id.

void vtkRearrangeFields::RemoveAllOperations ( )
inline

Remove all operations.

Definition at line 137 of file vtkRearrangeFields.h.

int vtkRearrangeFields::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

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

Reimplemented from vtkDataSetAlgorithm.

Operation* vtkRearrangeFields::GetNextOperation ( Operation op)
inlineprotected

Definition at line 183 of file vtkRearrangeFields.h.

Operation* vtkRearrangeFields::GetFirst ( )
inlineprotected

Definition at line 185 of file vtkRearrangeFields.h.

void vtkRearrangeFields::AddOperation ( Operation op)
protected
void vtkRearrangeFields::DeleteOperation ( Operation op,
Operation before 
)
protected
Operation* vtkRearrangeFields::FindOperation ( int  id,
Operation *&  before 
)
protected
Operation* vtkRearrangeFields::FindOperation ( const char *  name,
Operation *&  before 
)
protected
Operation* vtkRearrangeFields::FindOperation ( int  operationType,
const char *  name,
int  fromFieldLoc,
int  toFieldLoc,
Operation *&  before 
)
protected
Operation* vtkRearrangeFields::FindOperation ( int  operationType,
int  attributeType,
int  fromFieldLoc,
int  toFieldLoc,
Operation *&  before 
)
protected
int vtkRearrangeFields::CompareOperationsByType ( const Operation op1,
const Operation op2 
)
protected
int vtkRearrangeFields::CompareOperationsByName ( const Operation op1,
const Operation op2 
)
protected
void vtkRearrangeFields::DeleteAllOperations ( )
protected
void vtkRearrangeFields::ApplyOperation ( Operation op,
vtkDataSet input,
vtkDataSet output 
)
protected
vtkFieldData* vtkRearrangeFields::GetFieldDataFromLocation ( vtkDataSet ds,
int  fieldLoc 
)
protected
void vtkRearrangeFields::PrintAllOperations ( ostream &  os,
vtkIndent  indent 
)
protected
void vtkRearrangeFields::PrintOperation ( Operation op,
ostream &  os,
vtkIndent  indent 
)
protected

Member Data Documentation

Operation* vtkRearrangeFields::Head
protected

Definition at line 176 of file vtkRearrangeFields.h.

Operation* vtkRearrangeFields::Tail
protected

Definition at line 177 of file vtkRearrangeFields.h.

int vtkRearrangeFields::LastId
protected

Definition at line 180 of file vtkRearrangeFields.h.

char vtkRearrangeFields::OperationTypeNames[2][5]
staticprotected

Definition at line 209 of file vtkRearrangeFields.h.

char vtkRearrangeFields::FieldLocationNames[3][12]
staticprotected

Definition at line 210 of file vtkRearrangeFields.h.

char vtkRearrangeFields::AttributeNames[vtkDataSetAttributes::NUM_ATTRIBUTES][10]
staticprotected

Definition at line 211 of file vtkRearrangeFields.h.


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