vtkMatlabEngineFilter Class Reference

#include <vtkMatlabEngineFilter.h>

Inheritance diagram for vtkMatlabEngineFilter:

Collaboration diagram for vtkMatlabEngineFilter:

Public Types
typedef vtkDataObjectAlgorithm	Superclass
Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkMatlabEngineFilter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	PutArray (const char *NameOfVTKArray, const char *NameOfMatVar)
void	GetArray (const char *NameOfVTKArray, const char *NameOfMatVar)
void	RemoveAllPutVariables ()
void	RemoveAllGetVariables ()
virtual void	SetMatlabScript (const char *)
virtual char *	GetMatlabScript ()
virtual void	SetScriptFname (const char *)
virtual char *	GetScriptFname ()
virtual void	SetEngineVisible (int)
virtual int	GetEngineVisible ()
virtual void	SetEngineOutput (int)
virtual int	GetEngineOutput ()
virtual void	SetTimeOutput (int)
virtual int	GetTimeOutput ()
virtual void	SetBlockInfoOutput (int)
virtual int	GetBlockInfoOutput ()
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm *	NewInstance () const
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetOutput ()
vtkDataObject *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
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)
vtkDataObject *	GetInputDataObject (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)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
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 ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkMatlabEngineFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkMatlabEngineFilter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
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 ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
int	SetMatlabScriptFromFile (const char *fname)
virtual int	RequestData (vtkInformation *vtkNotUsed(request), vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	vtkMatlabEngineFilter ()
	~vtkMatlabEngineFilter ()
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from vtkDataObjectAlgorithm
	vtkDataObjectAlgorithm ()
	~vtkDataObjectAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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 vtkExecutive *	CreateDefaultExecutive ()
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)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *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 &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

This VTK uses the vtkMatlabEngineInterface class to perform calculations on VTK array input using the Matlab Engine.

See also

vtkMatlabMexAdapter vtkMatlabMexInterface

Thanks:

Developed by Thomas Otahal at Sandia National Laboratories.

Examples:

vtkMatlabEngineFilter (Examples)

Tests:

vtkMatlabEngineFilter (Tests)

Definition at line 53 of file vtkMatlabEngineFilter.h.

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkMatlabEngineFilter::Superclass

Definition at line 60 of file vtkMatlabEngineFilter.h.

Constructor & Destructor Documentation

vtkMatlabEngineFilter::vtkMatlabEngineFilter ( )

protected

vtkMatlabEngineFilter::~vtkMatlabEngineFilter ( )

protected

Member Function Documentation

static vtkMatlabEngineFilter* vtkMatlabEngineFilter::New ( )

static

static int vtkMatlabEngineFilter::IsTypeOf ( const char *  type )

static

virtual int vtkMatlabEngineFilter::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 vtkDataObjectAlgorithm.

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

static

virtual vtkObjectBase* vtkMatlabEngineFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

vtkMatlabEngineFilter* vtkMatlabEngineFilter::NewInstance

(

)

const

void vtkMatlabEngineFilter::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 vtkDataObjectAlgorithm.

void vtkMatlabEngineFilter::PutArray	(	const char *	NameOfVTKArray,
		const char *	NameOfMatVar
	)

Copies vtkDataArray named NameOfVTKArray to the Matlab engine with Matlab variable name NameOfMatVar. The array must exist in the input data set. Note: for vtkArray use "0","1","2",... for NameOfVTKArray to specify the index of the vtkArray to pass to the Matlab Engine.

void vtkMatlabEngineFilter::GetArray	(	const char *	NameOfVTKArray,
		const char *	NameOfMatVar
	)

Copies Matlab variable NameOfMatVar from the Matlab Engine to the vtkDataArray named NameOfVTKArray. Will replace existing vtkDataArray with the same name. Note: for vtkArray use any string for NameOfVTKArray. The array will be appended to the list of vtkArrays on the output.

void vtkMatlabEngineFilter::RemoveAllPutVariables

(

)

Clears the list of variables to be copied to the Matlab engine.

void vtkMatlabEngineFilter::RemoveAllGetVariables

(

)

Clears the list of variables to be copied from the Matlab engine.

virtual void vtkMatlabEngineFilter::SetMatlabScript ( const char *  )

virtual

Matlab script executed by the Matlab Engine. Can also be set from a file.

virtual char* vtkMatlabEngineFilter::GetMatlabScript ( )

virtual

Matlab script executed by the Matlab Engine. Can also be set from a file.

virtual void vtkMatlabEngineFilter::SetScriptFname ( const char *  )

virtual

Provide Matlab script executed by the Matlab Engine from an input file.

virtual char* vtkMatlabEngineFilter::GetScriptFname ( )

virtual

Provide Matlab script executed by the Matlab Engine from an input file.

virtual void vtkMatlabEngineFilter::SetEngineVisible ( int  )

virtual

Make Matlab Engine console visible. Default is off.

virtual int vtkMatlabEngineFilter::GetEngineVisible ( )

virtual

Make Matlab Engine console visible. Default is off.

virtual void vtkMatlabEngineFilter::SetEngineOutput ( int  )

virtual

Write Matlab Engine text output to standard output.

virtual int vtkMatlabEngineFilter::GetEngineOutput ( )

virtual

Write Matlab Engine text output to standard output.

virtual void vtkMatlabEngineFilter::SetTimeOutput ( int  )

virtual

Pass VTK time information to Matlab. If turned turned on, the filter will create three variables on the Matlab engine. The variables will be update automatically as time changes in the VTK pipeline. VTK_TIME_STEPS - array of all available time values. VTK_TIME_RANGE- array of minimum and maximum time values. VTK_CURRENT_TIME - floating point time value at the current time index.

virtual int vtkMatlabEngineFilter::GetTimeOutput ( )

virtual

Pass VTK time information to Matlab. If turned turned on, the filter will create three variables on the Matlab engine. The variables will be update automatically as time changes in the VTK pipeline. VTK_TIME_STEPS - array of all available time values. VTK_TIME_RANGE- array of minimum and maximum time values. VTK_CURRENT_TIME - floating point time value at the current time index.

virtual void vtkMatlabEngineFilter::SetBlockInfoOutput ( int  )

virtual

Create VTK_BLOCK_ID and VTK_NUMBER_OF_BLOCKS variables in Matlab when processing composite data sets.

virtual int vtkMatlabEngineFilter::GetBlockInfoOutput ( )

virtual

Create VTK_BLOCK_ID and VTK_NUMBER_OF_BLOCKS variables in Matlab when processing composite data sets.

virtual int vtkMatlabEngineFilter::ProcessRequest ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

virtual

This is required to capture REQUEST_DATA_OBJECT requests.

Reimplemented from vtkDataObjectAlgorithm.

int vtkMatlabEngineFilter::SetMatlabScriptFromFile ( const char *  fname )

protected

virtual int vtkMatlabEngineFilter::RequestData ( vtkInformation *  vtkNotUsedrequest, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

virtual int vtkMatlabEngineFilter::RequestDataObject ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

Creates the same output type as the input type.

Reimplemented from vtkDataObjectAlgorithm.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Matlab/vtkMatlabEngineFilter.h