vtkMatlabEngineFilter Class Reference
#include <vtkMatlabEngineFilter.h>
Detailed Description
This VTK uses the vtkMatlabEngineInterface class to perform calculations on VTK array input using the Matlab Engine.
- See also:
- vtkMatlabMexAdapter vtkMatlabMexInterface
- Thanks:
- Developed by Thomas Otahal at Sandia National Laboratories.
- Examples:
- vtkMatlabEngineFilter (Examples)
Definition at line 52 of file vtkMatlabEngineFilter.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 *NameOfMatVar) |
| void | GetArray (const char *NameOfVTKArray, const char *NameOfMatVar) |
| void | RemoveAllPutVariables () |
| void | RemoveAllGetVariables () |
| virtual void | SetMatlabScript (const char *) |
| virtual char * | GetMatlabScript () |
| virtual void | SetScriptFname (const char *) |
| virtual char * | GetScriptFname () |
| virtual void | SetEngineVisible (int) |
| virtual int | GetEngineVisible () |
| virtual void | SetEngineOutput (int) |
| virtual int | GetEngineOutput () |
| 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 vtkMatlabEngineFilter * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkMatlabEngineFilter * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| int | SetMatlabScriptFromFile (const char *fname) |
| virtual int | RequestData (vtkInformation *vtkNotUsed(request), vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| vtkMatlabEngineFilter () | |
| ~vtkMatlabEngineFilter () | |
| virtual int | RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkMatlabEngineFilter::vtkMatlabEngineFilter | ( | ) | [protected] |
| vtkMatlabEngineFilter::~vtkMatlabEngineFilter | ( | ) | [protected] |
Member Function Documentation
| static vtkMatlabEngineFilter* vtkMatlabEngineFilter::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataObjectAlgorithm.
| virtual const char* vtkMatlabEngineFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObjectAlgorithm.
| static int vtkMatlabEngineFilter::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 vtkMatlabEngineFilter::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 vtkMatlabEngineFilter* vtkMatlabEngineFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataObjectAlgorithm.
| void vtkMatlabEngineFilter::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 vtkMatlabEngineFilter::PutArray | ( | const char * | NameOfVTKArray, | |
| const char * | NameOfMatVar | |||
| ) |
Copies vtkDataArray named NameOfVTKArray to the Matlab engine with Matlab variable name NameOfMatVar. 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 the Matlab Engine.
| void vtkMatlabEngineFilter::GetArray | ( | const char * | NameOfVTKArray, | |
| const char * | NameOfMatVar | |||
| ) |
Copies Matlab variable NameOfMatVar from the Matlab Engine 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 vtkMatlabEngineFilter::RemoveAllPutVariables | ( | ) |
Clears the list of variables to be copied to the Matlab engine.
| void vtkMatlabEngineFilter::RemoveAllGetVariables | ( | ) |
Clears the list of variables to be copied from the Matlab engine.
| virtual void vtkMatlabEngineFilter::SetMatlabScript | ( | const char * | ) | [virtual] |
Matlab script executed by the Matlab Engine. Can also be set from a file.
| virtual char* vtkMatlabEngineFilter::GetMatlabScript | ( | ) | [virtual] |
Matlab script executed by the Matlab Engine. Can also be set from a file.
| virtual void vtkMatlabEngineFilter::SetScriptFname | ( | const char * | ) | [virtual] |
Provide Matlab script executed by the Matlab Engine from an input file.
| virtual char* vtkMatlabEngineFilter::GetScriptFname | ( | ) | [virtual] |
Provide Matlab script executed by the Matlab Engine from an input file.
| virtual void vtkMatlabEngineFilter::SetEngineVisible | ( | int | ) | [virtual] |
Make Matlab Engine console visible. Default is off.
| virtual int vtkMatlabEngineFilter::GetEngineVisible | ( | ) | [virtual] |
Make Matlab Engine console visible. Default is off.
| virtual void vtkMatlabEngineFilter::SetEngineOutput | ( | int | ) | [virtual] |
Write Matlab Engine text output to standard output.
| virtual int vtkMatlabEngineFilter::GetEngineOutput | ( | ) | [virtual] |
Write Matlab Engine text output to standard output.
| virtual void vtkMatlabEngineFilter::SetTimeOutput | ( | int | ) | [virtual] |
Pass VTK time information to Matlab. If turned turned on, the filter will create three variables on the Matlab engine. 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 vtkMatlabEngineFilter::GetTimeOutput | ( | ) | [virtual] |
Pass VTK time information to Matlab. If turned turned on, the filter will create three variables on the Matlab engine. 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 vtkMatlabEngineFilter::SetBlockInfoOutput | ( | int | ) | [virtual] |
Create VTK_BLOCK_ID and VTK_NUMBER_OF_BLOCKS variables in Matlab when processing composite data sets.
| virtual int vtkMatlabEngineFilter::GetBlockInfoOutput | ( | ) | [virtual] |
Create VTK_BLOCK_ID and VTK_NUMBER_OF_BLOCKS variables in Matlab when processing composite data sets.
| virtual int vtkMatlabEngineFilter::ProcessRequest | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [virtual] |
This is required to capture REQUEST_DATA_OBJECT requests.
Reimplemented from vtkDataObjectAlgorithm.
| int vtkMatlabEngineFilter::SetMatlabScriptFromFile | ( | const char * | fname | ) | [protected] |
| virtual int vtkMatlabEngineFilter::RequestData | ( | vtkInformation * | vtkNotUsedrequest, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
| virtual int vtkMatlabEngineFilter::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/vtkMatlabEngineFilter.h
