vtkRInterface Class Reference

#include <vtkRInterface.h>

Inheritance diagram for vtkRInterface:

[legend]

Collaboration diagram for vtkRInterface:

[legend]

List of all members.

---

Detailed Description

This class defines a VTK interface to an embedded GNU R intepreter instance. An instance of the R interpreter is created when this class is instantiated. Additional instances of this class will share access the same R interpreter. The R interpreter will be shutdown when the application using this class exits.

See also:

vtkRadapter vtkRcalculatorFilter

Thanks:

Developed by Thomas Otahal at Sandia National Laboratories.

Examples:

vtkRInterface (Examples)

Tests:

vtkRInterface (Tests)

Definition at line 56 of file vtkRInterface.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	EvalRcommand (const char *commandName, int param)
int	EvalRscript (const char *string, bool showRoutput=true)
int	OutputBuffer (char *p, int n)
void	AssignVTKDataArrayToRVariable (vtkDataArray *da, const char *RVariableName)
void	AssignVTKArrayToRVariable (vtkArray *da, const char *RVariableName)
vtkDataArray *	AssignRVariableToVTKDataArray (const char *RVariableName)
vtkArray *	AssignRVariableToVTKArray (const char *RVariableName)
vtkTable *	AssignRVariableToVTKTable (const char *RVariableName)
void	AssignVTKTableToRVariable (vtkTable *table, const char *RVariableName)
Static Public Member Functions
static vtkRInterface *	New ()
static int	IsTypeOf (const char *type)
static vtkRInterface *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkRInterface ()
	~vtkRInterface ()

---

Member Typedef Documentation

typedef vtkObject vtkRInterface::Superclass

Reimplemented from vtkObject.

Definition at line 61 of file vtkRInterface.h.

---

Constructor & Destructor Documentation

vtkRInterface::vtkRInterface

(

)

[protected]

vtkRInterface::~vtkRInterface

(

)

[protected]

---

Member Function Documentation

static vtkRInterface* vtkRInterface::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkRInterface::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkRInterface::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 vtkRInterface::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 vtkRInterface* vtkRInterface::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkRInterface::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.

int vtkRInterface::EvalRcommand	(	const char *	commandName,
		int	param
	)

Evaluate an R command on the embedded R interpreter that takes one integer argument.

int vtkRInterface::EvalRscript	(	const char *	string,
		bool	showRoutput = true
	)

Evaluate an R script given in string on the embedded R interpreter. Set showRoutput to turn on and off output from R.

int vtkRInterface::OutputBuffer	(	char *	p,
		int	n
	)

Provide a character buffer in p of length n. All output from the R interpreter instance will be written to p by default.

void vtkRInterface::AssignVTKDataArrayToRVariable	(	vtkDataArray *	da,
		const char *	RVariableName
	)

Copies vtkDataArray da into the R interpreter instance as a variable named RVariableName. If RVariableName already exists, it will be overwritten.

void vtkRInterface::AssignVTKArrayToRVariable	(	vtkArray *	da,
		const char *	RVariableName
	)

Copies vtkArray da into the R interpreter instance as a variable named RVariableName. If RVariableName already exists, it will be overwritten.

vtkDataArray* vtkRInterface::AssignRVariableToVTKDataArray

(

const char *

RVariableName

)

Copies the R variable RVariableName to the returned vtkDataArray. If the operation fails, the method will return NULL.

vtkArray* vtkRInterface::AssignRVariableToVTKArray

(

const char *

RVariableName

)

Copies the R variable RVariableName to the returned vtkArray. If the operation fails, the method will return NULL. The returned vtkArray is currently always a vtkDenseArray of type double.

vtkTable* vtkRInterface::AssignRVariableToVTKTable

(

const char *

RVariableName

)

Copies the R matrix or R list in RVariableName to the returned vtkTable. If the operation fails, the method will return NULL. If RVariableName is an R list, each list entry must be a vector of the same length.

void vtkRInterface::AssignVTKTableToRVariable	(	vtkTable *	table,
		const char *	RVariableName
	)

Copies the vtkTable given in table to an R list structure name RVariableName. The R list will be length of the number of columns in table. Each member of the list will contain a column of table.

---

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

• dox/Graphics/vtkRInterface.h