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

#include <vtkMatlabMexAdapter.h>

Inheritance diagram for vtkMatlabMexAdapter:

[legend]

Collaboration diagram for vtkMatlabMexAdapter:

[legend]

List of all members.

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
mxArray *	vtkDataArrayToMxArray (vtkDataArray *aa, bool ShallowCopy=false)
vtkDataArray *	mxArrayTovtkDataArray (const mxArray *mxa, bool ShallowCopy=false)
mxArray *	vtkArrayToMxArray (vtkArray *va)
vtkArray *	mxArrayTovtkArray (mxArray *mxa)
mxArray *	vtkGraphToMxArray (vtkGraph *ga)
vtkGraph *	mxArrayTovtkGraph (mxArray *mxa)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
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)
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)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &os)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMatlabMexAdapter *	SafeDownCast (vtkObject *o)
static vtkMatlabMexAdapter *	New ()
static mxClassID	GetMatlabDataType (vtkDataArray *da)
static vtkDataArray *	GetVTKDataType (mxClassID cid)
Static Public Member Functions inherited from vtkObject
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()

Protected Member Functions
	vtkMatlabMexAdapter ()
	~vtkMatlabMexAdapter ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	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 67 of file vtkMatlabMexAdapter.h.

Member Typedef Documentation

typedef vtkObject vtkMatlabMexAdapter::Superclass

Reimplemented from vtkObject.

Definition at line 72 of file vtkMatlabMexAdapter.h.

Constructor & Destructor Documentation

vtkMatlabMexAdapter::vtkMatlabMexAdapter ( )

protected

vtkMatlabMexAdapter::~vtkMatlabMexAdapter ( )

protected

Member Function Documentation

virtual const char* vtkMatlabMexAdapter::GetClassName ( )

virtual

Reimplemented from vtkObject.

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

static

Return 1 if this class type 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 vtkObject.

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

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

static

Reimplemented from vtkObject.

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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:

dox/Graphics/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