This is a utility class to convert VTK array data and VTK tables to and from Gnu R S expression (SEXP) data structures. It is used with the R .Call interface and the embedded R interpreter. More...

#include <vtkRAdapter.h>

Inheritance diagram for vtkRAdapter:

[legend]

Collaboration diagram for vtkRAdapter:

[legend]

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkRAdapter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

vtkDataArray *	RToVTKDataArray (SEXP variable)

vtkArray *	RToVTKArray (SEXP variable)

SEXP	VTKDataArrayToR (vtkDataArray *da)

SEXP	VTKArrayToR (vtkArray *da)

SEXP	VTKTableToR (vtkTable *table)

vtkTable *	RToVTKTable (SEXP variable)

SEXP	VTKTreeToR (vtkTree *tree)


vtkTree *	RToVTKTree (SEXP variable)

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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

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 int	IsTypeOf (const char *type)

static vtkRAdapter *	SafeDownCast (vtkObjectBase *o)

static vtkRAdapter *	New ()

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

	vtkRAdapter ()

	~vtkRAdapter ()

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 &)

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 and VTK tables to and from Gnu R S expression (SEXP) data structures. It is used with the R .Call interface and the embedded R interpreter.

This class creates deep copies of input data. Created R SEXP variables created by these functions can be freed by the R garbage collector by calling UNPROTECT(1). The conversions are performed for double and integer data types.

VTK data structures created by this class from R 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: vtkRinterface vtkRcalculatorFilter

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

Definition at line 69 of file vtkRAdapter.h.

Member Typedef Documentation

typedef vtkObject vtkRAdapter::Superclass

Definition at line 74 of file vtkRAdapter.h.

Constructor & Destructor Documentation

vtkRAdapter::vtkRAdapter ( )

protected

vtkRAdapter::~vtkRAdapter ( )

protected

Member Function Documentation

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

static

virtual int vtkRAdapter::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 vtkRAdapter* vtkRAdapter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRAdapter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkRAdapter* vtkRAdapter::NewInstance ( ) const

void vtkRAdapter::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 vtkRAdapter* vtkRAdapter::New ( )

static

vtkDataArray* vtkRAdapter::RToVTKDataArray ( SEXP variable )

Create a vtkDataArray copy of GNU R input matrix vaiable (deep copy, allocates memory) Input is a R matrix or vector of doubles or integers

vtkArray* vtkRAdapter::RToVTKArray ( SEXP variable )

Create a vtkArray copy of the GNU R input variable multi-dimensional array (deep copy, allocates memory) Input is a R multi-dimensional array of doubles or integers

SEXP vtkRAdapter::VTKDataArrayToR ( vtkDataArray * da )

Create a GNU R matrix copy of the input vtkDataArray da (deep copy, allocates memory)

SEXP vtkRAdapter::VTKArrayToR ( vtkArray * da )

Create a GNU R multi-dimensional array copy of the input vtkArray da (deep copy, allocates memory)

SEXP vtkRAdapter::VTKTableToR ( vtkTable * table )

Create a GNU R matrix copy of the input vtkTable table (deep copy, allocates memory)

vtkTable* vtkRAdapter::RToVTKTable ( SEXP variable )

Create a vtkTable copy of the GNU R input matrix variable (deep copy, allocates memory) Input is R list of equal length vectors or a matrix.

SEXP vtkRAdapter::VTKTreeToR ( vtkTree * tree )

Create a GNU R phylo tree copy of the input vtkTree tree (deep copy, allocates memory)

vtkTree* vtkRAdapter::RToVTKTree ( SEXP variable )

Create a vtkTree copy of the GNU R input phylo tree variable (deep copy, allocates memory)

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/StatisticsGnuR/vtkRAdapter.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