VTK: vtkFiberSurface Class Reference

| VTK 9.3.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFiberSurface Class Reference

Given a fiber surface control polygon (FSCP) and an unstructured grid composed of tetrahedral cells with two scalar arrays, this filter computes the corresponding fiber surfaces. More...

`#include <vtkFiberSurface.h>`

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

## Public Types
enum | BaseVertexType { bv_not_used , bv_vertex_0 , bv_vertex_1 , bv_vertex_2 , bv_vertex_3 , bv_edge_01 , bv_edge_02 , bv_edge_03 , bv_edge_12 , bv_edge_13 , bv_edge_23 }
| This structure lists the vertices to use for the marching tetrahedra, Some of these vertices need to be interpolated, but others are the vertices of the tetrahedron already, and for this we need to store the type of vertex. More...
enum | ClipVertexType { not_used , vertex_0 , vertex_1 , vertex_2 , edge_0_parm_0 , edge_1_parm_0 , edge_2_parm_0 , edge_0_parm_1 , edge_1_parm_1 , edge_2_parm_1 }
| After generating the base fiber surface in each cell, we need a further clipping process to obtain the accurate fiber surface. More...
typedef vtkPolyDataAlgorithm | Superclass
Public Types inherited from vtkPolyDataAlgorithm
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
virtual vtkTypeBool | IsA (const char *type)
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkFiberSurface * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
void | SetField1 (const char *fieldName)
| Specify the first field name to be used in this filter. More...
void | SetField2 (const char *fieldName)
| Specify the second field name to be used in the filter. More...
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm * | NewInstance () const
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| see vtkAlgorithm for details More...
vtkDataObject * | GetInput ()
vtkDataObject * | GetInput (int port)
vtkPolyData * | GetPolyDataInput (int port)
vtkPolyData * | GetOutput ()
| Get the output data object for a port on this algorithm. More...
vtkPolyData * | GetOutput (int)
| Get the output data object for a port on this algorithm. More...
virtual void | SetOutput (vtkDataObject *d)
| Get the output data object for a port on this algorithm. More...
void | SetInputData (vtkDataObject *)
| Assign a data object as input. More...
void | SetInputData (int, vtkDataObject *)
| Assign a data object as input. More...
void | AddInputData (vtkDataObject *)
| Assign a data object as input. More...
void | AddInputData (int, vtkDataObject *)
| Assign a data object as input. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | HasExecutive ()
| Check whether this algorithm has an assigned executive. More...
vtkExecutive * | GetExecutive ()
| Get this algorithm's executive. More...
virtual void | SetExecutive (vtkExecutive *executive)
| Set this algorithm's executive. More...
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
| Version of ProcessRequest() that is wrapped. More...
virtual int | ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
| A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
virtual int | ModifyRequest (vtkInformation *request, int when)
| This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
vtkInformation * | GetInputPortInformation (int port)
| Get the information object associated with an input port. More...
vtkInformation * | GetOutputPortInformation (int port)
| Get the information object associated with an output port. More...
int | GetNumberOfInputPorts ()
| Get the number of input ports used by the algorithm. More...
int | GetNumberOfOutputPorts ()
| Get the number of output ports provided by the algorithm. More...
void | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. More...
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
| String based versions of SetInputArrayToProcess(). More...
vtkInformation * | GetInputArrayInformation (int idx)
| Get the info object for the specified input array to this algorithm. More...
void | RemoveAllInputs ()
| Remove all the input data. More...
vtkDataObject * | GetOutputDataObject (int port)
| Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject * | GetInputDataObject (int port, int connection)
| Get the data object that will contain the algorithm input for the given port and given connection. More...
virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput *input)
| Remove a connection from the given input port index. More...
virtual void | RemoveInputConnection (int port, int idx)
| Remove a connection given by index idx. More...
virtual void | RemoveAllInputConnections (int port)
| Removes all input connections. More...
virtual void | SetInputDataObject (int port, vtkDataObject *data)
| Sets the data-object as an input on the given port index. More...
virtual void | SetInputDataObject (vtkDataObject *data)
virtual void | AddInputDataObject (int port, vtkDataObject *data)
| Add the data-object as an input to this given port. More...
virtual void | AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput * | GetOutputPort (int index)
| Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput * | GetOutputPort ()
int | GetNumberOfInputConnections (int port)
| Get the number of inputs currently connected to a port. More...
int | GetTotalNumberOfInputConnections ()
| Get the total number of inputs for this algorithm. More...
vtkAlgorithmOutput * | GetInputConnection (int port, int index)
| Get the algorithm output port connected to an input port. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort)
| Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index)
| Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm ()
| Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive * | GetInputExecutive (int port, int index)
| Returns the executive associated with a particular input connection. More...
vtkExecutive * | GetInputExecutive ()
| Equivalent to GetInputExecutive(0, 0) More...
vtkInformation * | GetInputInformation (int port, int index)
| Return the information object that is associated with a particular input connection. More...
vtkInformation * | GetInputInformation ()
| Equivalent to GetInputInformation(0, 0) More...
vtkInformation * | GetOutputInformation (int port)
| Return the information object that is associated with a particular output port. More...
virtual 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). More...
virtual vtkTypeBool | Update (vtkInformation *requests)
| Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int | UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
| Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int | UpdateExtent (const int extents[6])
| Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int | UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
| Convenience method to update an algorithm after passing requests to its first output port. More...
virtual void | UpdateInformation ()
| Bring the algorithm's information up-to-date. More...
virtual void | UpdateDataObject ()
| Create output object(s). More...
virtual void | PropagateUpdateExtent ()
| Propagate meta-data upstream. More...
virtual void | UpdateWholeExtent ()
| Bring this algorithm's outputs up-to-date. More...
void | ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
| Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
virtual vtkInformation * | GetInformation ()
| Set/Get the information object associated with this algorithm. More...
virtual void | SetInformation (vtkInformation *)
| Set/Get the information object associated with this algorithm. More...
bool | UsesGarbageCollector () const override
| Participate in garbage collection. More...
virtual void | SetAbortExecute (vtkTypeBool)
| Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool | GetAbortExecute ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOn ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOff ()
| Set/Get the AbortExecute flag for the process object. More...
virtual double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
void | SetProgressShiftScale (double shift, double scale)
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressShift ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
void | SetProgressText (const char *ptext)
| Set the current text message associated with the progress state. More...
virtual char * | GetProgressText ()
| Set the current text message associated with the progress state. More...
virtual unsigned long | GetErrorCode ()
| The error code contains a possible error that occurred while reading or writing the file. More...
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | SetInputConnection (vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | AddInputConnection (vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | Update (int port)
| Bring this algorithm's outputs up-to-date. More...
virtual void | Update ()
| Bring this algorithm's outputs up-to-date. More...
virtual void | SetReleaseDataFlag (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | GetReleaseDataFlag ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOn ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOff ()
| Turn release data flag on or off for all output ports. More...
int | UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
int * | GetUpdateExtent ()
| These functions return the update extent for output ports that use 3D extents. More...
int * | GetUpdateExtent (int port)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
int | GetUpdatePiece ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdatePiece (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel (int port)
| These functions return the update extent for output ports that use piece extents. More...
void | SetProgressObserver (vtkProgressObserver *)
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver * | GetProgressObserver ()
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
Public Member Functions inherited from vtkObject
| vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void | DebugOn ()
| Turn debugging output on. More...
virtual void | DebugOff ()
| Turn debugging output off. More...
bool | GetDebug ()
| Get the value of the debug flag. More...
void | SetDebug (bool debugFlag)
| Set the value of the debug flag. More...
virtual void | Modified ()
| Update the modification time for this object. More...
virtual vtkMTimeType | GetMTime ()
| Return this object's modified time. More...
void | RemoveObserver (unsigned long tag)
void | RemoveObservers (unsigned long event)
void | RemoveObservers (const char *event)
void | RemoveAllObservers ()
vtkTypeBool | HasObserver (unsigned long event)
vtkTypeBool | HasObserver (const char *event)
vtkTypeBool | InvokeEvent (unsigned long event)
vtkTypeBool | InvokeEvent (const char *event)
std::string | GetObjectDescription () const override
| The object description printed in messages and PrintSelf output. More...
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand * | GetCommand (unsigned long tag)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObserver (vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
| Allow user to set the AbortFlagOn() with the return value of the callback method. More...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
Public Member Functions inherited from vtkObjectBase
const char * | GetClassName () const
| Return the class name as a string. More...
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). More...
virtual void | Delete ()
| Delete a VTK object. More...
virtual void | FastDelete ()
| Delete a reference to this object. More...
void | InitializeObjectBase ()
void | Print (ostream &os)
| Print an object to an ostream. More...
virtual void | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
int | GetReferenceCount ()
| Return the current reference count of this object. More...
void | SetReferenceCount (int)
| Sets the reference count. More...
bool | GetIsInMemkind () const
| A local state flag that remembers whether this object lives in the normal or extended memory space. More...
virtual void | PrintHeader (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | PrintTrailer (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...

## Static Public Member Functions
static vtkFiberSurface * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkFiberSurface * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkPolyDataAlgorithm * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAlgorithm * | SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL ()
| Keys used to specify input port requirements. More...
static vtkInformationIntegerKey * | INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * | INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * | INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * | INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * | INPUT_PORT ()
static vtkInformationIntegerKey * | INPUT_CONNECTION ()
static vtkInformationIntegerKey * | CAN_PRODUCE_SUB_EXTENT ()
| This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey * | CAN_HANDLE_PIECE_REQUEST ()
| Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static vtkInformationIntegerKey * | ABORTED ()
static void | SetDefaultExecutivePrototype (vtkExecutive *proto)
| If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
Static Public Member Functions inherited from vtkObject
static vtkObject * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void | BreakOnError ()
| This method is called when vtkErrorMacro executes. More...
static void | SetGlobalWarningDisplay (vtkTypeBool val)
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOn ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOff ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static vtkTypeBool | GetGlobalWarningDisplay ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool | IsTypeOf (const char *name)
| Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static 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). More...
static vtkObjectBase * | New ()
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void | SetMemkindDirectory (const char *directoryname)
| The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
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. More...

## Protected Member Functions
virtual vtkObjectBase * | NewInstanceInternal () const
| vtkFiberSurface ()
int | FillInputPortInformation (int port, vtkInformation *info) override
| Fill the input port information objects for this algorithm. More...
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| This is called by the superclass. More...
Protected Member Functions inherited from vtkPolyDataAlgorithm
| vtkPolyDataAlgorithm ()
| ~vtkPolyDataAlgorithm () override
virtual int | RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
| This is called by the superclass. More...
int | FillOutputPortInformation (int port, vtkInformation *info) override
| Fill the output port information objects for this algorithm. More...
Protected Member Functions inherited from vtkAlgorithm
| vtkAlgorithm ()
| ~vtkAlgorithm () override
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. More...
virtual void | SetNumberOfInputPorts (int n)
| Set the number of input ports used by the algorithm. More...
virtual void | SetNumberOfOutputPorts (int n)
| Set the number of output ports provided by the algorithm. More...
int | InputPortIndexInRange (int index, const char *action)
int | OutputPortIndexInRange (int index, const char *action)
int | GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
| Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
| This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive * | CreateDefaultExecutive ()
| Create a default executive. More...
void | ReportReferences (vtkGarbageCollector *) override
virtual void | SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
| Replace the Nth connection on the given input port. More...
virtual void | SetNumberOfInputConnections (int port, int n)
| Set the number of input connections on the given input port. More...
void | SetInputDataInternal (int port, vtkDataObject *input)
| These methods are used by subclasses to implement methods to set data objects directly as input. More...
void | AddInputDataInternal (int port, vtkDataObject *input)
int | GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
int | GetInputArrayAssociation (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
virtual void | SetErrorCode (unsigned long)
| The error code contains a possible error that occurred while reading or writing the file. More...
Protected Member Functions inherited from vtkObject
| vtkObject ()
| ~vtkObject () override
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
| These methods allow a command to exclusively grab all events. More...
void | InternalReleaseFocus ()
| These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
| vtkObjectBase ()
virtual | ~vtkObjectBase ()
| vtkObjectBase (const vtkObjectBase &)
void | operator= (const vtkObjectBase &)

## Protected Attributes
const char * | Fields [2]
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp | LastAbortCheckTime
vtkInformation * | Information
double | Progress
char * | ProgressText
vtkProgressObserver * | ProgressObserver
unsigned long | ErrorCode
| The error code contains a possible error that occurred while reading or writing the file. More...
Protected Attributes inherited from vtkObject
bool | Debug
vtkTimeStamp | MTime
vtkSubjectHelper * | SubjectHelper
std::string | ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > | ReferenceCount
vtkWeakPointerBase ** | WeakPointers

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * | PORT_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 vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

Given a fiber surface control polygon (FSCP) and an unstructured grid composed of tetrahedral cells with two scalar arrays, this filter computes the corresponding fiber surfaces.

# Introduction

Fiber surfaces are constructed from sets of fibers, the multivariate analogues of isolines. The original paper [0] offers a general purpose method that produces separating surfaces representing boundaries in bivariate fields. This filter is based on an improvement over [0] which computes accurate and exact fiber surfaces. It can handle arbitrary input polygons including open polygons or self-intersecting polygons. The current implementation can better captures sharp features induced by polygon bends [1].

[0] Hamish Carr, Zhao Geng, Julien Tierny, Amit Chattopadhyay and Aaron Knoll, Fiber Surfaces: Generalizing Isosurfaces to Bivariate Data, Computer Graphics Forum, Volume 34, Issue 3, Pages 241-250, (EuroVis 2015)

[1] Pavol Klacansky, Julien Tierny, Hamish Carr, Zhao Geng, Fast and Exact Fiber Surfaces for Tetrahedral Meshes, Paper in submission, 2015

# Algorithm For Extracting An Exact Fiber Surface

Require: R.1 A 3D domain space represented by an unstructured grid composed of tetrahedral cells R.2 Two scalar fields, f1 and f2, that map the domain space to a 2D range space. These fields are assumed to be known at vertices of the unstructured grid: i.e they are two fields associated with the unstructured grid. R.3 A Fiber Surface Control Polygon (FSCP) defined in the range space as a list of line segments (l1, l2, ..., ln). The FSCP may be an open polyline or a self-intersecting polygon.

1. For each line segment l in FSCP, we ignore the endpoints of the line and assume this line extends to infinity. This line will then separate the range and its inverse image, i.e fiber surfaces, will also separate the domain. Based on the signed distance d between the image of a cell vertex v and line l in the range, v can be classified as white (d < 0), grey (d == 0) or black (d>0). The interpolation parameter between two vertices v1 and v2 in a cell edge can be computed as |d1| / (|d2|+|d1|), where d1 and d2 are the signed distances between images of v1,v2 and line l in the range. Once the classification and interpolation parameters for all vertices in a cell are known, then we can apply the Marching Tetrahedra algorithm. For each tetrahedron, this produces a planar cut which we refer to as a base fiber surface.
2. After generating the base fiber surface in each cell, we need a further clipping process to obtain the accurate fiber surface. Clipping is based on classifying the vertices of each triangle as follows: Given a line segment in the fiber surface control polygon (FSCP) parameterised from 0 to 1, we know that every triangle vertex in the base fiber surface belongs to the fiber surface, and that the fiber through each vertex can be parameterised with respect to the line segment. Therefore, we compute the parameter t for each vertex and use it to classify the vertex as: 0: t < 0 Vertex is below the clipping range [0,1] and will be removed 1: 0 ≤ t ≤ 1 Vertex is inside the clipping range [0,1] and is retained 2: 1 < t Vertex is above the clipping range [0,1] and will be removed Based on the classification, we can further clip the triangle to obtain the final surface.
3. Repeating steps 1 and 2 for every line segment in FSCP and iterating through each cell will generate the final fiber surfaces in the domain.

# Filter Design

As stated in part B (R.1), we will compute the fiber surface over an unstructured grid. This grid will have to be an input of the VTK filter. The two scalar fields, however, are assumed to be stored in the VTK unstructured grid, and will be specified using the SetField1() and SetField2() accessors. The FSCP will be passed into the filter as a second input port. The data type of FSCP is required to be a vtkPolyData, with each of its cell defined as a line segment and its point coordinates defined in the range of the bivariate fields of the input grid.

# Tables

## tetrahedra with grey cases

In this filter, we have added one vertex classification in Marching Tetrahedra. The reason is because we need a grey classification to ensure that surfaces coincident with the boundary of the tetrahedra will also be included in the output. Given an iso-value, each vertex on the tetrahedron can be classified into three types, including equal-(G)rey, below-(W)hite or above-(B)lack the isovalue. The notation of the classifications are represented as: W or 0 — below an iso-value G or 1 — equal an iso-value B or 2 — above an iso-value The following illustration summarises all of the surface cases (Asterisk * is used to highlight the outline of the triangle): Case A (no triangles): 0000 No triangle is generated.

      W
     ...
    . . .

. . . . .W. . . . . . W...........W

Case B (one grey vertex): 0001, 0010, 0100, 1000 Only a vertex is kept, no triangle is generated. W ... . . . . . . . .G. . . . . . W...........W

Case C (one grey edge): 0011, 0101, 0110, 1001, 1010, 1100 Only an edge is kept, no triangle is generated. G ... . . . . . . . .G. . . . . . W...........W

Case D (standard triangle case): 0002, 0020, 0200, 2000 One triangle is generated W W ... ... . . . . * . . . . . *.* . . .B. . -> . * B * . . . . . . ** * ** . W...........W W...........W

Case E (one grey face): 0111, 1011, 1101, 1110 The triangle on one face of the tetra is generated. G G ... .** . . . . * * . . . -> . * * . .G. . . .G* * . . . . . . * * W...........G W...........G

Case F (triangle through vertex): 0012 0021 0102 0120 0201 0210 1002 1020 1200 2001 2010 2100 A triangle connecting one of the tetra vertex is generated. G G ... .*. . . . .*.*. . . . -> . *.* . . .B. . . *.B.* . . . . . . * * * * . W...........W W...........W

Case G (grey tet - treat as empty): 1111 No triangle is generated. G ... . . . . . . . .G. . . . . . G...........G

Case H (triangle through edge): 0112 0121 0211 1012 1021 1102 1120 1201 1210 2011 2101 2110 A triangle containing an edge of the tetra is generated.

      G                                      G
     ...                                    ..*
    . . .                                  . . *

. . . . *. * . . . . . * . . . -> . * . * . . W . . . . W . * . . . . . * . * . . . . . . * . * B.............. G B...............G

Case I (standard quad case): 0022 0202 0220 2002 2020 2200 A quand is generated, which can be split to two triangles.

       W                                      W
      ...                                    ...
     . . .                                  . . .
    .  .  .                                .  .  .

. . . * *. * * . . . -> .* . *. . . W . . . * . W . * . . . . . . * * * * . . . . . . . . . B.............. B B..................B

Case J (complement of Case E): 1112 1121 1211 2111 Case K (complement of Case F): 0122 0212 0221 1022 1202 1220 2012 2021 2102 2120 2201 2210 Case L (complement of Case C): 1122 1212 1221 2112 2121 2211 Case M (complement of Case D): 0222 2022 2202 2220 Case N (complement of Case B): 1222 2122 2212 2221 Case O (complement of Case A): 2222

## cases of the base fiber surface

After generating the base fiber surface in each cell, we need a further clipping process to obtain the accurate fiber surface. Clipping is based on classifying the vertices of each triangle to several cases, which will be described in this section. In order to keep things consistent, we assume that the vertices are ordered CCW, and that edges are numbered according to the opposing vertex:

     v0
    /  \

e2 e1 / \ v1—e0—v2

There are six cases for clipping the base fiber surface (subject to the usual

## symmetries & complementarity)

Case A (No triangles): Cases 000 & 222 Here, the entire triangle is discarded

000(A): 0 . . . . . . . . . . 0...........0

Case B (Point-triangle): Cases 001, 010, 100, 122, 212, 221 One vertex is kept, and a single triangle is extracted

001(B): 1 / \ / \ E--—E . . . . 0...........0

Case C (Edge Quad): Cases 011, 101, 110, 112, 121, 211 Two vertices are kept, and a quad is extracted based on the edge

011(C): 1 /|\ / | \ / | E / | / . / |/ . 1--—E.....0

Case D (Stripe): Cases 002, 020, 022, 200, 202, 220 No vertices are kept, but a stripe across the middle is generated

022(D): 2 . . . E . /|\ . / | E . / |/ . 2...E—E...0

Case E (Point-Stripe): Cases 012, 021, 102, 120, 201, 210 One vertex is kept, with a stripe through the triangle

021(E): 1 / \ E—E .|\ |. . | \ | . . | | . 2...E—E...0

Case F (Entire): Case 111 All three vertices are kept, along with the triangle

111(F): 1 / \ / \ / \ / \ / \ 1--------—1

# to use this filter

Suppose we have a tetrahedral mesh stored in a vtkUnstructuredGrid, we call this data set "inputData". This data set has two scalar arrays whose names are "f1" and "f2" respectively. Assume the "inputPoly" is a valid input polygon. Given these input above, this filter can be used as follows in c++ sample code:

    vtkSmartPointer<vtkFiberSurface> fiberSurface =
                           vtkSmartPointer<vtkFiberSurface>::New();
    fiberSurface->SetInputData(0,inputData);
    fiberSurface->SetInputData(1,inputPoly);
    fiberSurface->SetField1("f1");
    fiberSurface->SetField2("f2");
    fiberSurface->Update();

The filter output which can be called by "fiberSurface->GetOutput()", will be a vtkPolyData containing the output fiber surfaces.

Tests:
  vtkFiberSurface (Tests)

Definition at line 314 of file vtkFiberSurface.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkPolyDataAlgorithm vtkFiberSurface::Superclass

Definition at line 318 of file vtkFiberSurface.h.

## Member Enumeration Documentation

## ◆ BaseVertexType

enum vtkFiberSurface::BaseVertexType

This structure lists the vertices to use for the marching tetrahedra, Some of these vertices need to be interpolated, but others are the vertices of the tetrahedron already, and for this we need to store the type of vertex.

bv_not_used: Symbol for an unused entry bv_vertex_*: Vertices on a tetrahedron bv_edge_*: Vertices on the edges of a tetrahedron

Enumerator
bv_not_used |
bv_vertex_0 |
bv_vertex_1 |
bv_vertex_2 |
bv_vertex_3 |
bv_edge_01 |
bv_edge_02 |
bv_edge_03 |
bv_edge_12 |
bv_edge_13 |
bv_edge_23 |

Definition at line 339 of file vtkFiberSurface.h.

## ◆ ClipVertexType

enum vtkFiberSurface::ClipVertexType

After generating the base fiber surface in each cell, we need a further clipping process to obtain the accurate fiber surface.

Clipping is based on classifying the vertices of each triangle, this structure lists the type of vertices to be used for the clipping triangles. Some of these vertices need to be interpolated, but others are the vertices of the triangle already, and for this we need to store the type of vertex. Moreover, vertices along the edges of the triangle may be interpolated either at parameter value 0 or at parameter value 1. In other words, there are three classes of vertex with three choices of each, with a total of nine vertices. We therefore store an ID code for each possibility as follows:

Enumerator
not_used |
vertex_0 |
vertex_1 |
vertex_2 |
edge_0_parm_0 |
edge_1_parm_0 |
edge_2_parm_0 |
edge_0_parm_1 |
edge_1_parm_1 |
edge_2_parm_1 |

Definition at line 366 of file vtkFiberSurface.h.

## Constructor & Destructor Documentation

## ◆ vtkFiberSurface()

vtkFiberSurface::vtkFiberSurface | ( |  | ) |
| protected

## Member Function Documentation

## ◆ New()

static vtkFiberSurface* vtkFiberSurface::New | ( |  | ) |
| static

## ◆ IsTypeOf()

static vtkTypeBool vtkFiberSurface::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

virtual vtkTypeBool vtkFiberSurface::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 vtkPolyDataAlgorithm.

## ◆ SafeDownCast()

static vtkFiberSurface* vtkFiberSurface::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFiberSurface::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

## ◆ NewInstance()

vtkFiberSurface* vtkFiberSurface::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkFiberSurface::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 vtkPolyDataAlgorithm.

## ◆ SetField1()

void vtkFiberSurface::SetField1 | ( | const char * | fieldName | ) |

Specify the first field name to be used in this filter.

## ◆ SetField2()

void vtkFiberSurface::SetField2 | ( | const char * | fieldName | ) |

Specify the second field name to be used in the filter.

## ◆ FillInputPortInformation()

int vtkFiberSurface::FillInputPortInformation | ( | int | port,
|  | vtkInformation * | info
| ) |  |
| overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

## ◆ RequestData()

int vtkFiberSurface::RequestData | ( | vtkInformation * | request,
|  | vtkInformationVector ** | inputVector,
|  | vtkInformationVector * | outputVector
| ) |  |
| overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

## Member Data Documentation

## ◆ Fields

const char* vtkFiberSurface::Fields[2]
| protected

Definition at line 386 of file vtkFiberSurface.h.

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

- Filters/Topology/vtkFiberSurface.h