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

scale and orient glyph(s) according to eigenvalues and eigenvectors of symmetrical part of tensor More...

#include <vtkTensorGlyph.h>

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

Public Types

enum  { COLOR_BY_SCALARS, COLOR_BY_EIGENVALUES }
 
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...
 
vtkTensorGlyphNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSourceData (vtkPolyData *source)
 Specify the geometry to copy to each point. More...
 
vtkPolyDataGetSource ()
 
void SetSourceConnection (int id, vtkAlgorithmOutput *algOutput)
 Specify a source object at a specified table location. More...
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetScaling (vtkTypeBool)
 Turn on/off scaling of glyph with eigenvalues. More...
 
virtual vtkTypeBool GetScaling ()
 
virtual void ScalingOn ()
 
virtual void ScalingOff ()
 
virtual void SetScaleFactor (double)
 Specify scale factor to scale object by. More...
 
virtual double GetScaleFactor ()
 
virtual void SetThreeGlyphs (vtkTypeBool)
 Turn on/off drawing three glyphs. More...
 
virtual vtkTypeBool GetThreeGlyphs ()
 
virtual void ThreeGlyphsOn ()
 
virtual void ThreeGlyphsOff ()
 
virtual void SetSymmetric (vtkTypeBool)
 Turn on/off drawing a mirror of each glyph. More...
 
virtual vtkTypeBool GetSymmetric ()
 
virtual void SymmetricOn ()
 
virtual void SymmetricOff ()
 
virtual void SetLength (double)
 Set/Get the distance, along x, from the origin to the end of the source glyph. More...
 
virtual double GetLength ()
 
virtual void SetExtractEigenvalues (vtkTypeBool)
 Turn on/off extraction of eigenvalues from tensor. More...
 
virtual void ExtractEigenvaluesOn ()
 
virtual void ExtractEigenvaluesOff ()
 
virtual vtkTypeBool GetExtractEigenvalues ()
 
virtual void SetColorGlyphs (vtkTypeBool)
 Turn on/off coloring of glyph with input scalar data or eigenvalues. More...
 
virtual vtkTypeBool GetColorGlyphs ()
 
virtual void ColorGlyphsOn ()
 
virtual void ColorGlyphsOff ()
 
virtual void SetColorMode (int)
 Set the color mode to be used for the glyphs. More...
 
virtual int GetColorMode ()
 
void SetColorModeToScalars ()
 
void SetColorModeToEigenvalues ()
 
virtual void SetClampScaling (vtkTypeBool)
 Turn on/off scalar clamping. More...
 
virtual vtkTypeBool GetClampScaling ()
 
virtual void ClampScalingOn ()
 
virtual void ClampScalingOff ()
 
virtual void SetMaxScaleFactor (double)
 Set/Get the maximum allowable scale factor. More...
 
virtual double GetMaxScaleFactor ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 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...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
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...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTensorGlyphSafeDownCast (vtkObjectBase *o)
 
static vtkTensorGlyphNew ()
 Construct object with scaling on and scale factor 1.0. More...
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTensorGlyph ()
 
 ~vtkTensorGlyph () override
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
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
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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)
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool Scaling
 
double ScaleFactor
 
vtkTypeBool ExtractEigenvalues
 
vtkTypeBool ColorGlyphs
 
int ColorMode
 
vtkTypeBool ClampScaling
 
double MaxScaleFactor
 
vtkTypeBool ThreeGlyphs
 
vtkTypeBool Symmetric
 
double Length
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- 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 Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

scale and orient glyph(s) according to eigenvalues and eigenvectors of symmetrical part of tensor

vtkTensorGlyph is a filter that copies a geometric representation (specified as polygonal data) to every input point. The geometric representation, or glyph, can be scaled and/or rotated according to the tensor at the input point. Scaling and rotation is controlled by the eigenvalues/eigenvectors of the symmetrical part of the tensor as follows: For each tensor, the eigenvalues (and associated eigenvectors) are sorted to determine the major, medium, and minor eigenvalues/eigenvectors. The eigenvalue decomposition only makes sense for symmetric tensors, hence the need to only consider the symmetric part of the tensor, which is 1/2 (T + T.transposed()).

If the boolean variable ThreeGlyphs is not set the major eigenvalue scales the glyph in the x-direction, the medium in the y-direction, and the minor in the z-direction. Then, the glyph is rotated so that the glyph's local x-axis lies along the major eigenvector, y-axis along the medium eigenvector, and z-axis along the minor.

If the boolean variable ThreeGlyphs is set three glyphs are produced, each of them oriented along an eigenvector and scaled according to the corresponding eigenvector.

If the boolean variable Symmetric is set each glyph is mirrored (2 or 6 glyphs will be produced)

The x-axis of the source glyph will correspond to the eigenvector on output. Point (0,0,0) in the source will be placed in the data point. Variable Length will normally correspond to the distance from the origin to the tip of the source glyph along the x-axis, but can be changed to produce other results when Symmetric is on, e.g. glyphs that do not touch or that overlap.

Please note that when Symmetric is false it will generally be better to place the source glyph from (-0.5,0,0) to (0.5,0,0), i.e. centred at the origin. When symmetric is true the placement from (0,0,0) to (1,0,0) will generally be more convenient.

A scale factor is provided to control the amount of scaling. Also, you can turn off scaling completely if desired. The boolean variable ClampScaling controls the maximum scaling (in conjunction with MaxScaleFactor.) This is useful in certain applications where singularities or large order of magnitude differences exist in the eigenvalues.

If the boolean variable ColorGlyphs is set to true the glyphs are colored. The glyphs can be colored using the input scalars (SetColorModeToScalars), which is the default, or colored using the eigenvalues (SetColorModeToEigenvalues).

Another instance variable, ExtractEigenvalues, has been provided to control extraction of eigenvalues/eigenvectors. If this boolean is false, then eigenvalues/eigenvectors are not extracted, and the columns of the tensor are taken as the eigenvectors (the norm of column, always positive, is the eigenvalue). This allows additional capability over the vtkGlyph3D object. That is, the glyph can be oriented in three directions instead of one.

Thanks:
Thanks to Jose Paulo Moitinho de Almeida for enhancements.
See also
vtkGlyph3D vtkPointLoad vtkHyperStreamline

Definition at line 90 of file vtkTensorGlyph.h.

Member Typedef Documentation

◆ Superclass

Definition at line 93 of file vtkTensorGlyph.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
COLOR_BY_SCALARS 
COLOR_BY_EIGENVALUES 

Definition at line 192 of file vtkTensorGlyph.h.

Constructor & Destructor Documentation

◆ vtkTensorGlyph()

vtkTensorGlyph::vtkTensorGlyph ( )
protected

◆ ~vtkTensorGlyph()

vtkTensorGlyph::~vtkTensorGlyph ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTensorGlyph::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkTensorGlyph* vtkTensorGlyph::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkTensorGlyph* vtkTensorGlyph::New ( )
static

Construct object with scaling on and scale factor 1.0.

Eigenvalues are extracted, glyphs are colored with input scalar data, and logarithmic scaling is turned off.

◆ SetSourceData()

void vtkTensorGlyph::SetSourceData ( vtkPolyData source)

Specify the geometry to copy to each point.

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

◆ GetSource()

vtkPolyData* vtkTensorGlyph::GetSource ( )

◆ SetSourceConnection() [1/2]

void vtkTensorGlyph::SetSourceConnection ( int  id,
vtkAlgorithmOutput algOutput 
)

Specify a source object at a specified table location.

New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

◆ SetSourceConnection() [2/2]

void vtkTensorGlyph::SetSourceConnection ( vtkAlgorithmOutput algOutput)
inline

Definition at line 121 of file vtkTensorGlyph.h.

◆ SetScaling()

virtual void vtkTensorGlyph::SetScaling ( vtkTypeBool  )
virtual

Turn on/off scaling of glyph with eigenvalues.

◆ GetScaling()

virtual vtkTypeBool vtkTensorGlyph::GetScaling ( )
virtual

◆ ScalingOn()

virtual void vtkTensorGlyph::ScalingOn ( )
virtual

◆ ScalingOff()

virtual void vtkTensorGlyph::ScalingOff ( )
virtual

◆ SetScaleFactor()

virtual void vtkTensorGlyph::SetScaleFactor ( double  )
virtual

Specify scale factor to scale object by.

(Scale factor always affects output even if scaling is off.)

◆ GetScaleFactor()

virtual double vtkTensorGlyph::GetScaleFactor ( )
virtual

◆ SetThreeGlyphs()

virtual void vtkTensorGlyph::SetThreeGlyphs ( vtkTypeBool  )
virtual

Turn on/off drawing three glyphs.

◆ GetThreeGlyphs()

virtual vtkTypeBool vtkTensorGlyph::GetThreeGlyphs ( )
virtual

◆ ThreeGlyphsOn()

virtual void vtkTensorGlyph::ThreeGlyphsOn ( )
virtual

◆ ThreeGlyphsOff()

virtual void vtkTensorGlyph::ThreeGlyphsOff ( )
virtual

◆ SetSymmetric()

virtual void vtkTensorGlyph::SetSymmetric ( vtkTypeBool  )
virtual

Turn on/off drawing a mirror of each glyph.

◆ GetSymmetric()

virtual vtkTypeBool vtkTensorGlyph::GetSymmetric ( )
virtual

◆ SymmetricOn()

virtual void vtkTensorGlyph::SymmetricOn ( )
virtual

◆ SymmetricOff()

virtual void vtkTensorGlyph::SymmetricOff ( )
virtual

◆ SetLength()

virtual void vtkTensorGlyph::SetLength ( double  )
virtual

Set/Get the distance, along x, from the origin to the end of the source glyph.

It is used to draw the symmetric glyphs.

◆ GetLength()

virtual double vtkTensorGlyph::GetLength ( )
virtual

◆ SetExtractEigenvalues()

virtual void vtkTensorGlyph::SetExtractEigenvalues ( vtkTypeBool  )
virtual

Turn on/off extraction of eigenvalues from tensor.

◆ ExtractEigenvaluesOn()

virtual void vtkTensorGlyph::ExtractEigenvaluesOn ( )
virtual

◆ ExtractEigenvaluesOff()

virtual void vtkTensorGlyph::ExtractEigenvaluesOff ( )
virtual

◆ GetExtractEigenvalues()

virtual vtkTypeBool vtkTensorGlyph::GetExtractEigenvalues ( )
virtual

◆ SetColorGlyphs()

virtual void vtkTensorGlyph::SetColorGlyphs ( vtkTypeBool  )
virtual

Turn on/off coloring of glyph with input scalar data or eigenvalues.

If false, or input scalar data not present, then the scalars from the source object are passed through the filter.

◆ GetColorGlyphs()

virtual vtkTypeBool vtkTensorGlyph::GetColorGlyphs ( )
virtual

◆ ColorGlyphsOn()

virtual void vtkTensorGlyph::ColorGlyphsOn ( )
virtual

◆ ColorGlyphsOff()

virtual void vtkTensorGlyph::ColorGlyphsOff ( )
virtual

◆ SetColorMode()

virtual void vtkTensorGlyph::SetColorMode ( int  )
virtual

Set the color mode to be used for the glyphs.

This can be set to use the input scalars (default) or to use the eigenvalues at the point. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. The recognized values are: COLOR_BY_SCALARS = 0 (default) COLOR_BY_EIGENVALUES = 1

◆ GetColorMode()

virtual int vtkTensorGlyph::GetColorMode ( )
virtual

◆ SetColorModeToScalars()

void vtkTensorGlyph::SetColorModeToScalars ( )
inline

Definition at line 211 of file vtkTensorGlyph.h.

◆ SetColorModeToEigenvalues()

void vtkTensorGlyph::SetColorModeToEigenvalues ( )
inline

Definition at line 212 of file vtkTensorGlyph.h.

◆ SetClampScaling()

virtual void vtkTensorGlyph::SetClampScaling ( vtkTypeBool  )
virtual

Turn on/off scalar clamping.

If scalar clamping is on, the ivar MaxScaleFactor is used to control the maximum scale factor. (This is useful to prevent uncontrolled scaling near singularities.)

◆ GetClampScaling()

virtual vtkTypeBool vtkTensorGlyph::GetClampScaling ( )
virtual

◆ ClampScalingOn()

virtual void vtkTensorGlyph::ClampScalingOn ( )
virtual

◆ ClampScalingOff()

virtual void vtkTensorGlyph::ClampScalingOff ( )
virtual

◆ SetMaxScaleFactor()

virtual void vtkTensorGlyph::SetMaxScaleFactor ( double  )
virtual

Set/Get the maximum allowable scale factor.

This value is compared to the combination of the scale factor times the eigenvalue. If less, the scale factor is reset to the MaxScaleFactor. The boolean ClampScaling has to be "on" for this to work.

◆ GetMaxScaleFactor()

virtual double vtkTensorGlyph::GetMaxScaleFactor ( )
virtual

◆ RequestUpdateExtent()

int vtkTensorGlyph::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkTensorGlyph::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.

Member Data Documentation

◆ Scaling

vtkTypeBool vtkTensorGlyph::Scaling
protected

Definition at line 245 of file vtkTensorGlyph.h.

◆ ScaleFactor

double vtkTensorGlyph::ScaleFactor
protected

Definition at line 246 of file vtkTensorGlyph.h.

◆ ExtractEigenvalues

vtkTypeBool vtkTensorGlyph::ExtractEigenvalues
protected

Definition at line 247 of file vtkTensorGlyph.h.

◆ ColorGlyphs

vtkTypeBool vtkTensorGlyph::ColorGlyphs
protected

Definition at line 248 of file vtkTensorGlyph.h.

◆ ColorMode

int vtkTensorGlyph::ColorMode
protected

Definition at line 249 of file vtkTensorGlyph.h.

◆ ClampScaling

vtkTypeBool vtkTensorGlyph::ClampScaling
protected

Definition at line 250 of file vtkTensorGlyph.h.

◆ MaxScaleFactor

double vtkTensorGlyph::MaxScaleFactor
protected

Definition at line 251 of file vtkTensorGlyph.h.

◆ ThreeGlyphs

vtkTypeBool vtkTensorGlyph::ThreeGlyphs
protected

Definition at line 252 of file vtkTensorGlyph.h.

◆ Symmetric

vtkTypeBool vtkTensorGlyph::Symmetric
protected

Definition at line 253 of file vtkTensorGlyph.h.

◆ Length

double vtkTensorGlyph::Length
protected

Definition at line 254 of file vtkTensorGlyph.h.


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