This is a utility class to convert VTK array data to and from the Matlab mxArray format. More...

#include <vtkMatlabMexAdapter.h>

Inheritance diagram for vtkMatlabMexAdapter:

Collaboration diagram for vtkMatlabMexAdapter:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkMatlabMexAdapter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

mxArray *	vtkDataArrayToMxArray (vtkDataArray *aa, bool ShallowCopy=false)
	Create a mxArray copy of a vtkDataArray (Allocates memory by default) More...

vtkDataArray *	mxArrayTovtkDataArray (const mxArray *mxa, bool ShallowCopy=false)
	Create a vtkDataArray copy of a Matlab mxArray (Allocates memory by default) More...

mxArray *	vtkArrayToMxArray (vtkArray *va)
	Create a mxArray copy of a vtkArray (Allocates memory by default) More...

vtkArray *	mxArrayTovtkArray (mxArray *mxa)
	Create a vtkArray copy of a mxArray (Allocates memory by default) More...

mxArray *	vtkGraphToMxArray (vtkGraph *ga)
	Create a mxArray copy of a vtkGraph (Allocates memory by default) The result is an n by n connectivity matrix, where n is the number of nodes in the graph. More...

vtkGraph *	mxArrayTovtkGraph (mxArray *mxa)
	Create a vtkGraph copy of a mxArray (Allocates memory by default) Input mxArray should be a n by n connectivity matrix, where n is the number of nodes in the graph. 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 ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. 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...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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)
	This method invokes an event and return whether the event was aborted or not. More...

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	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...

void	PrintRevisions (ostream &)
	Legacy. 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 int	IsTypeOf (const char *type)

static vtkMatlabMexAdapter *	SafeDownCast (vtkObjectBase *o)

static vtkMatlabMexAdapter *	New ()

static mxClassID	GetMatlabDataType (vtkDataArray *da)
	Match Matlab and VTK data types for conversion. More...

static vtkDataArray *	GetVTKDataType (mxClassID cid)
	Match Matlab and VTK data types for conversion. 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 (int 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 int	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMatlabMexAdapter ()

	~vtkMatlabMexAdapter ()

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=NULL)
	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 ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

This is a utility class to convert VTK array data to and from the Matlab mxArray format.

It is used with the Matlab Mex and Matlab Engine interfaces.

The default behavior of each function is to perform a deep copy of the data. Set the ShallowCopy argument to true to use the block of memory that has already been allocated by either VTK or Matlab. The result of a shallow copy will produce the transpose of the data in the new system, because VTK uses row major ordering and Matlab uses column major ordering for data.

VTK data structures created by this class from Matlab types are stored in array collections and freed when the class destructor is called. Use the Register() method on a returned object to increase its reference count by one, in order keep the object around after this classes destructor has been called. The code calling Register() must eventually call Delete() on the object to free memory.

See also: vtkMatlabEngineInterface vtkMatlabEngineFilter

Thanks:: Developed by Thomas Otahal at Sandia National Laboratories.

Definition at line 69 of file vtkMatlabMexAdapter.h.

Member Typedef Documentation

typedef vtkObject vtkMatlabMexAdapter::Superclass

Definition at line 74 of file vtkMatlabMexAdapter.h.

Constructor & Destructor Documentation

vtkMatlabMexAdapter::vtkMatlabMexAdapter ( )

protected

vtkMatlabMexAdapter::~vtkMatlabMexAdapter ( )

protected

Member Function Documentation

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

static

virtual int vtkMatlabMexAdapter::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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkMatlabMexAdapter::NewInstanceInternal ( ) const

protectedvirtual

vtkMatlabMexAdapter* vtkMatlabMexAdapter::NewInstance ( ) const

void vtkMatlabMexAdapter::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 vtkObject.

static vtkMatlabMexAdapter* vtkMatlabMexAdapter::New ( )

static

mxArray* vtkMatlabMexAdapter::vtkDataArrayToMxArray	(	vtkDataArray *	aa,
		bool	ShallowCopy = `false`
	)

Create a mxArray copy of a vtkDataArray (Allocates memory by default)

vtkDataArray* vtkMatlabMexAdapter::mxArrayTovtkDataArray	(	const mxArray *	mxa,
		bool	ShallowCopy = `false`
	)

Create a vtkDataArray copy of a Matlab mxArray (Allocates memory by default)

mxArray* vtkMatlabMexAdapter::vtkArrayToMxArray ( vtkArray * va )

Create a mxArray copy of a vtkArray (Allocates memory by default)

vtkArray* vtkMatlabMexAdapter::mxArrayTovtkArray ( mxArray * mxa )

Create a vtkArray copy of a mxArray (Allocates memory by default)

mxArray* vtkMatlabMexAdapter::vtkGraphToMxArray ( vtkGraph * ga )

Create a mxArray copy of a vtkGraph (Allocates memory by default) The result is an n by n connectivity matrix, where n is the number of nodes in the graph.

vtkGraph* vtkMatlabMexAdapter::mxArrayTovtkGraph ( mxArray * mxa )

Create a vtkGraph copy of a mxArray (Allocates memory by default) Input mxArray should be a n by n connectivity matrix, where n is the number of nodes in the graph.

static mxClassID vtkMatlabMexAdapter::GetMatlabDataType ( vtkDataArray * da )

static

Match Matlab and VTK data types for conversion.

static vtkDataArray* vtkMatlabMexAdapter::GetVTKDataType ( mxClassID cid )

static

Match Matlab and VTK data types for conversion.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Filters/Matlab/vtkMatlabMexAdapter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation