vtkRCalculatorFilter Class Reference
#include <vtkRCalculatorFilter.h>
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)
Definition at line 53 of file vtkRCalculatorFilter.h.
Public Types | |
| typedef vtkDataObjectAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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) |
| 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 vtkRCalculatorFilter * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkRCalculatorFilter * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| 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) |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkRCalculatorFilter::vtkRCalculatorFilter | ( | ) | [protected] |
| vtkRCalculatorFilter::~vtkRCalculatorFilter | ( | ) | [protected] |
Member Function Documentation
| static vtkRCalculatorFilter* vtkRCalculatorFilter::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObjectAlgorithm.
| virtual const char* vtkRCalculatorFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| static int vtkRCalculatorFilter::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 vtkDataObjectAlgorithm.
| virtual int vtkRCalculatorFilter::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 vtkDataObjectAlgorithm.
| static vtkRCalculatorFilter* vtkRCalculatorFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
| void vtkRCalculatorFilter::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 vtkDataObjectAlgorithm.
| 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()
| 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.
Reimplemented from vtkDataObjectAlgorithm.
| int vtkRCalculatorFilter::SetRscriptFromFile | ( | const char * | fname | ) | [protected] |
| virtual int vtkRCalculatorFilter::RequestData | ( | vtkInformation * | vtkNotUsedrequest, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
| virtual int vtkRCalculatorFilter::RequestDataObject | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
Creates the same output type as the input type.
Reimplemented from vtkDataObjectAlgorithm.
The documentation for this class was generated from the following file:
- dox/Graphics/vtkRCalculatorFilter.h
