VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkRInterface Class Reference

#include <vtkRInterface.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRInterfaceNewInstance () const
 
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)
 
void AssignVTKTreeToRVariable (vtkTree *tr, const char *RVariableName)
 
vtkTree * AssignRVariableToVTKTree (const char *RVariableName)
 
vtkDataArray * AssignRVariableToVTKDataArray (const char *RVariableName)
 
vtkArray * AssignRVariableToVTKArray (const char *RVariableName)
 
vtkTableAssignRVariableToVTKTable (const char *RVariableName)
 
void AssignVTKTableToRVariable (vtkTable *table, const char *RVariableName)
 

Static Public Member Functions

static vtkRInterfaceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRInterfaceSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkRInterface ()
 
 ~vtkRInterface ()
 

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 58 of file vtkRInterface.h.

Member Typedef Documentation

typedef vtkObject vtkRInterface::Superclass

Definition at line 63 of file vtkRInterface.h.

Constructor & Destructor Documentation

vtkRInterface::vtkRInterface ( )
protected
vtkRInterface::~vtkRInterface ( )
protected

Member Function Documentation

static vtkRInterface* vtkRInterface::New ( )
static
static int vtkRInterface::IsTypeOf ( const char *  type)
static
virtual int vtkRInterface::IsA ( const char *  type)
virtual
static vtkRInterface* vtkRInterface::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRInterface::NewInstanceInternal ( ) const
protectedvirtual
vtkRInterface* vtkRInterface::NewInstance ( ) const
void vtkRInterface::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

void vtkRInterface::AssignVTKTreeToRVariable ( vtkTree *  tr,
const char *  RVariableName 
)

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

vtkTree* vtkRInterface::AssignRVariableToVTKTree ( const char *  RVariableName)

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

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: