1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkMatlabEngineFilter.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2009 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/**
* @class vtkMatlabEngineFilter
*
*
*
* This VTK uses the vtkMatlabEngineInterface class to perform calculations on
* VTK array input using the Matlab Engine.
*
* @sa
* vtkMatlabMexAdapter vtkMatlabMexInterface
*
* @par Thanks:
* Developed by Thomas Otahal at Sandia National Laboratories.
*
*/
#ifndef vtkMatlabEngineFilter_h
#define vtkMatlabEngineFilter_h
#include "vtkFiltersMatlabModule.h" // For export macro
#include "vtkDataObjectAlgorithm.h"
class vtkMatlabEngineInterface;
class vtkMatlabEngineFilterInternals;
class vtkDataSet;
class vtkDoubleArray;
class VTKFILTERSMATLAB_EXPORT vtkMatlabEngineFilter : public vtkDataObjectAlgorithm
{
public:
static vtkMatlabEngineFilter *New();
vtkTypeMacro(vtkMatlabEngineFilter, vtkDataObjectAlgorithm );
void PrintSelf(ostream& os, vtkIndent indent);
/**
* 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 PutArray(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 GetArray(const char* NameOfVTKArray, const char* NameOfMatVar);
/**
* Clears the list of variables to be copied to the Matlab engine.
*/
void RemoveAllPutVariables();
/**
* Clears the list of variables to be copied from the Matlab engine.
*/
void RemoveAllGetVariables();
//@{
/**
* Matlab script executed by the Matlab Engine. Can also be set from a file.
*/
vtkSetStringMacro(MatlabScript);
vtkGetStringMacro(MatlabScript);
//@}
//@{
/**
* Provide Matlab script executed by the Matlab Engine from an input file.
*/
vtkSetStringMacro(ScriptFname);
vtkGetStringMacro(ScriptFname);
//@}
//@{
/**
* Make Matlab Engine console visible. Default is off.
*/
vtkSetMacro(EngineVisible,int);
vtkGetMacro(EngineVisible,int);
//@}
//@{
/**
* Write Matlab Engine text output to standard output.
*/
vtkSetMacro(EngineOutput,int);
vtkGetMacro(EngineOutput,int);
//@}
//@{
/**
* 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.
*/
vtkSetMacro(TimeOutput,int);
vtkGetMacro(TimeOutput,int);
//@}
//@{
/**
* Create VTK_BLOCK_ID and VTK_NUMBER_OF_BLOCKS variables in Matlab
* when processing composite data sets.
*/
vtkSetMacro(BlockInfoOutput,int);
vtkGetMacro(BlockInfoOutput,int);
//@}
/**
* This is required to capture REQUEST_DATA_OBJECT requests.
*/
virtual int ProcessRequest(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
protected:
int SetMatlabScriptFromFile(const char* fname);
virtual int RequestData(vtkInformation *vtkNotUsed(request),
vtkInformationVector **inputVector,
vtkInformationVector *outputVector);
/**
* Creates the same output type as the input type.
*/
virtual int RequestDataObject(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
vtkMatlabEngineFilter();
~vtkMatlabEngineFilter();
private:
vtkMatlabEngineFilter(const vtkMatlabEngineFilter&) VTK_DELETE_FUNCTION;
void operator=(const vtkMatlabEngineFilter&) VTK_DELETE_FUNCTION;
// Implementation details
vtkMatlabEngineFilterInternals* mefi;
int ProcessDataSet(vtkDataSet* dsinp, vtkDataSet* dsout);
vtkMatlabEngineInterface* mengi;
char* MatlabScript;
char* MatlabFileScript;
char* ScriptFname;
int EngineVisible;
int EngineOutput;
int TimeOutput;
int BlockInfoOutput;
char* OutputBuffer;
vtkDoubleArray* CurrentTime;
vtkDoubleArray* TimeRange;
vtkDoubleArray* TimeSteps;
vtkDoubleArray* BlockId;
vtkDoubleArray* NumBlocks;
};
#endif
|
