File: vtkrendering_vtktesting.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (156 lines) | stat: -rw-r--r-- 7,987 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkTesting</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">FreeMat
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkrendering_vtktesting.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vtkTesting </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkrendering.html">Visualization Toolkit Rendering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>This is a VTK regression testing framework. Looks like this:</p>
<p>vtkTesting* t = vtkTesting::New();</p>
<p>Two options for setting arguments</p>
<p>Option 1: for ( cc = 1; cc &lt; argc; cc ++ ) { t-&gt;AddArgument(argv[cc]); }</p>
<p>Option 2: t-&gt;AddArgument("-D"); t-&gt;AddArgument(my_data_dir); t-&gt;AddArgument("-V"); t-&gt;AddArgument(my_valid_image);</p>
<p>...</p>
<p>Two options of doing testing:</p>
<p>Option 1: t-&gt;SetRenderWindow(renWin); int res = t-&gt;RegressionTest(threshold);</p>
<p>Option 2: int res = t-&gt;RegressionTest(test_image, threshold);</p>
<p>...</p>
<p>if ( res == vtkTesting::PASSED ) { Test passed } else { Test failed }</p>
<p>To create an instance of class vtkTesting, simply invoke its constructor as follows </p>
<pre class="fragment">  obj = vtkTesting
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkTesting has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkTesting class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code>  </li>
<li>
<code>int = obj.IsA (string name)</code>  </li>
<li>
<code>vtkTesting = obj.NewInstance ()</code>  </li>
<li>
<code>vtkTesting = obj.SafeDownCast (vtkObject o)</code>  </li>
<li>
<code>obj.SetFrontBuffer (int )</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>int = obj.GetFrontBufferMinValue ()</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>int = obj.GetFrontBufferMaxValue ()</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>obj.FrontBufferOn ()</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>obj.FrontBufferOff ()</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>int = obj.GetFrontBuffer ()</code> - Use front buffer for tests. By default use back buffer.  </li>
<li>
<code>int = obj.RegressionTest (double thresh)</code> - Perform the test and return result. At the same time the output will be written cout  </li>
<li>
<code>int = obj.RegressionTest (vtkImageData image, double thresh)</code> - Compare the image with the valid image.  </li>
<li>
<code>int = obj.CompareAverageOfL2Norm (vtkDataSet pdA, vtkDataSet pdB, double tol)</code> - Compute the average L2 norm between all point data data arrays of types float and double present in the data sets "dsA" and "dsB" (this includes instances of vtkPoints) Compare the result of each L2 comutation to "tol".  </li>
<li>
<code>int = obj.CompareAverageOfL2Norm (vtkDataArray daA, vtkDataArray daB, double tol)</code> - Compute the average L2 norm between two data arrays "daA" and "daB" and compare against "tol".  </li>
<li>
<code>obj.SetRenderWindow (vtkRenderWindow rw)</code> - Set and get the render window that will be used for regression testing.  </li>
<li>
<code>vtkRenderWindow = obj.GetRenderWindow ()</code> - Set and get the render window that will be used for regression testing.  </li>
<li>
<code>obj.SetValidImageFileName (string )</code> - Set/Get the name of the valid image file  </li>
<li>
<code>string = obj.GetValidImageFileName ()</code> - Set/Get the name of the valid image file  </li>
<li>
<code>double = obj.GetImageDifference ()</code> - Get the image difference.  </li>
<li>
<code>obj.AddArgument (string argv)</code> - Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line  </li>
<li>
<code>obj.CleanArguments ()</code>  </li>
<li>
<code>string = obj.GetDataRoot ()</code> - Get some paramters from the command line arguments, env, or defaults  </li>
<li>
<code>obj.SetDataRoot (string )</code> - Get some paramters from the command line arguments, env, or defaults  </li>
<li>
<code>string = obj.GetTempDirectory ()</code> - Get some paramters from the command line arguments, env, or defaults  </li>
<li>
<code>obj.SetTempDirectory (string )</code> - Get some paramters from the command line arguments, env, or defaults  </li>
<li>
<code>int = obj.IsValidImageSpecified ()</code> - Is a valid image specified on the command line areguments?  </li>
<li>
<code>int = obj.IsInteractiveModeSpecified ()</code> - Is the interactive mode specified?  </li>
<li>
<code>int = obj.IsFlagSpecified (string flag)</code> - Is some arbitrary user flag ("-X", "-Z" etc) specified  </li>
<li>
<code>obj.SetBorderOffset (int )</code> - Number of pixels added as borders to avoid problems with window decorations added by some window managers.  </li>
<li>
<code>int = obj.GetBorderOffset ()</code> - Number of pixels added as borders to avoid problems with window decorations added by some window managers.  </li>
<li>
<code>obj.SetVerbose (int )</code> - Get/Set verbosity level. A level of 0 is quiet.  </li>
<li>
<code>int = obj.GetVerbose ()</code> - Get/Set verbosity level. A level of 0 is quiet.  </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkrendering.html">Visualization Toolkit Rendering Classes</a></li>
    <li class="footer">Generated on Thu Jul 25 2013 17:18:35 for FreeMat by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>