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
vtkRCalculatorFilter Class Reference

#include <vtkRCalculatorFilter.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRCalculatorFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void PutArray (const char *NameOfVTKArray, const char *NameOfRvar)
 
void GetArray (const char *NameOfVTKArray, const char *NameOfRvar)
 
void RemoveAllPutVariables ()
 
void RemoveAllGetVariables ()
 
void PutTable (const char *NameOfRvar)
 
void GetTable (const char *NameOfRvar)
 
void PutTree (const char *NameOfRvar)
 
void GetTree (const char *NameOfRvar)
 
virtual void SetRscript (const char *)
 
virtual char * GetRscript ()
 
virtual void SetScriptFname (const char *)
 
virtual char * GetScriptFname ()
 
virtual void SetRoutput (int)
 
virtual int GetRoutput ()
 
virtual void SetTimeOutput (int)
 
virtual int GetTimeOutput ()
 
virtual void SetBlockInfoOutput (int)
 
virtual int GetBlockInfoOutput ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Static Public Member Functions

static vtkRCalculatorFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRCalculatorFilterSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
int SetRscriptFromFile (const char *fname)
 
virtual int RequestData (vtkInformation *vtkNotUsed(request), vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
 vtkRCalculatorFilter ()
 
 ~vtkRCalculatorFilter ()
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Detailed Description

This class functions as an array calculator for vtkDataArrays and VTKarray objects, using GNU R as the calculation engine.

See Also
vtkRInterface vtkRadapter
Thanks:
Developed by Thomas Otahal at Sandia National Laboratories.
Examples:
vtkRCalculatorFilter (Examples)
Tests:
vtkRCalculatorFilter (Tests)

Definition at line 59 of file vtkRCalculatorFilter.h.

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkRCalculatorFilter::Superclass

Definition at line 66 of file vtkRCalculatorFilter.h.

Constructor & Destructor Documentation

vtkRCalculatorFilter::vtkRCalculatorFilter ( )
protected
vtkRCalculatorFilter::~vtkRCalculatorFilter ( )
protected

Member Function Documentation

static vtkRCalculatorFilter* vtkRCalculatorFilter::New ( )
static
static int vtkRCalculatorFilter::IsTypeOf ( const char *  type)
static
virtual int vtkRCalculatorFilter::IsA ( const char *  type)
virtual
static vtkRCalculatorFilter* vtkRCalculatorFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRCalculatorFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkRCalculatorFilter* vtkRCalculatorFilter::NewInstance ( ) const
void vtkRCalculatorFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkRCalculatorFilter::PutArray ( const char *  NameOfVTKArray,
const char *  NameOfRvar 
)

Copies vtkDataArray named NameOfVTKArray to R with variable name NameOfRvar. The array must exist in the input data set. Note: for vtkArray use "0","1","2",... for NameOfVTKArray to specify the index of the vtkArray to pass to R.

void vtkRCalculatorFilter::GetArray ( const char *  NameOfVTKArray,
const char *  NameOfRvar 
)

Copies R variable NameOfRvar from R to the vtkDataArray named NameOfVTKArray. Will replace existing vtkDataArray with the same name. Note: for vtkArray use any string for NameOfVTKArray. The array will be appended to the list of vtkArrays on the output.

void vtkRCalculatorFilter::RemoveAllPutVariables ( )

Clears the list of variables to be copied to R.

void vtkRCalculatorFilter::RemoveAllGetVariables ( )

Clears the list of variables to be copied from R.

void vtkRCalculatorFilter::PutTable ( const char *  NameOfRvar)

For vtkTable input to the filter. An R list variable is created for the vtkTable input using PutTable(). The output of the filter can be set from a list variable in R using GetTable()

void vtkRCalculatorFilter::GetTable ( const char *  NameOfRvar)

For vtkTable input to the filter. An R list variable is created for the vtkTable input using PutTable(). The output of the filter can be set from a list variable in R using GetTable()

void vtkRCalculatorFilter::PutTree ( const char *  NameOfRvar)

For vtkTree input to the filter. An R phylo tree variable is created for the vtkTree input using PutTree(). The output of the filter can be set from a phylo tree variable in R using GetTree()

void vtkRCalculatorFilter::GetTree ( const char *  NameOfRvar)

For vtkTree input to the filter. An R phylo tree variable is created for the vtkTree input using PutTree(). The output of the filter can be set from a phylo tree variable in R using GetTree()

virtual void vtkRCalculatorFilter::SetRscript ( const char *  )
virtual

Script executed by R. Can also be set from a file.

virtual char* vtkRCalculatorFilter::GetRscript ( )
virtual

Script executed by R. Can also be set from a file.

virtual void vtkRCalculatorFilter::SetScriptFname ( const char *  )
virtual

Provide the R script executed by R from an input file.

virtual char* vtkRCalculatorFilter::GetScriptFname ( )
virtual

Provide the R script executed by R from an input file.

virtual void vtkRCalculatorFilter::SetRoutput ( int  )
virtual

Write R output to standard output.

virtual int vtkRCalculatorFilter::GetRoutput ( )
virtual

Write R output to standard output.

virtual void vtkRCalculatorFilter::SetTimeOutput ( int  )
virtual

Pass VTK time information to R. If turned turned on, the filter will create three variables in R. The variables will be update automatically as time changes in the VTK pipeline. VTK_TIME_STEPS - array of all available time values. VTK_TIME_RANGE- array of minimum and maximum time values. VTK_CURRENT_TIME - floating point time value at the current time index.

virtual int vtkRCalculatorFilter::GetTimeOutput ( )
virtual

Pass VTK time information to R. If turned turned on, the filter will create three variables in R. The variables will be update automatically as time changes in the VTK pipeline. VTK_TIME_STEPS - array of all available time values. VTK_TIME_RANGE- array of minimum and maximum time values. VTK_CURRENT_TIME - floating point time value at the current time index.

virtual void vtkRCalculatorFilter::SetBlockInfoOutput ( int  )
virtual

Create VTK_BLOCK_ID variable in R when processing composite data sets.

virtual int vtkRCalculatorFilter::GetBlockInfoOutput ( )
virtual

Create VTK_BLOCK_ID variable in R when processing composite data sets.

virtual int vtkRCalculatorFilter::ProcessRequest ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
virtual

This is required to capture REQUEST_DATA_OBJECT requests.

int vtkRCalculatorFilter::SetRscriptFromFile ( const char *  fname)
protected
virtual int vtkRCalculatorFilter::RequestData ( vtkInformation *  vtkNotUsedrequest,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual int vtkRCalculatorFilter::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Creates the same output type as the input type.


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