This is a utility class to convert VTK array data and VTK tables to and from Gnu R S expression (SEXP) data structures. More...

#include <vtkRAdapter.h>

Inheritance diagram for vtkRAdapter:

[legend]

Collaboration diagram for vtkRAdapter:

[legend]

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

vtkRAdapter *	NewInstance () const

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

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

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

SEXP	VTKDataArrayToR (vtkDataArray *da)
	Create a GNU R matrix copy of the input vtkDataArray da (deep copy, allocates memory) More...

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

SEXP	VTKTableToR (vtkTable *table)
	Create a GNU R matrix copy of the input vtkTable table (deep copy, allocates memory) More...

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

SEXP	VTKTreeToR (vtkTree *tree)
	Create a GNU R phylo tree copy of the input vtkTree tree (deep copy, allocates memory) More...

vtkTree *	RToVTKTree (SEXP variable)
	Create a vtkTree copy of the GNU R input phylo tree variable (deep copy, allocates memory) 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 vtkRAdapter *	SafeDownCast (vtkObjectBase *o)

static vtkRAdapter *	New ()

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

	vtkRAdapter ()

	~vtkRAdapter ()

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 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 70 of file vtkRAdapter.h.

Member Typedef Documentation

typedef vtkObject vtkRAdapter::Superclass

Definition at line 75 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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkRAdapter::NewInstanceInternal ( ) const

protectedvirtual

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/demarle/Builds/VTK/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