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
|
<!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: vtkStatisticsAlgorithm</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 Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related 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('vtkinfovis_vtkstatisticsalgorithm.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkStatisticsAlgorithm </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkinfovis.html">Visualization Toolkit Infovis Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>All statistics algorithms can conceptually be operated with several options: Learn: given an input data set, calculate a minimal statistical model (e.g., sums, raw moments, joint probabilities). Derive: given an input minimal statistical model, derive the full model (e.g., descriptive statistics, quantiles, correlations, conditional probabilities). NB: It may be, or not be, a problem that a full model was not derived. For instance, when doing parallel calculations, one only wants to derive the full model after all partial calculations have completed. On the other hand, one can also directly provide a full model, that was previously calculated or guessed, and not derive a new one. Assess: given an input data set, input statistics, and some form of threshold, assess a subset of the data set. Test: perform at least one statistical test. Therefore, a vtkStatisticsAlgorithm has the following vtkTable ports 3 input ports: Data (mandatory) Parameters to the learn phase (optional) Input model (optional) 3 output port (called Output): Data (annotated with assessments when the Assess option is ON). Output model (identical to the the input model when Learn option is OFF). Meta information about the model and/or the overall fit of the data to the model; is filled only when the Assess option is ON.</p>
<p>.SECTION Thanks Thanks to Philippe Pebay and David Thompson from Sandia National Laboratories for implementing this class.</p>
<p>To create an instance of class vtkStatisticsAlgorithm, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkStatisticsAlgorithm
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkStatisticsAlgorithm 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 vtkStatisticsAlgorithm class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkStatisticsAlgorithm = obj.NewInstance ()</code> </li>
<li>
<code>vtkStatisticsAlgorithm = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetLearnOptionParameterConnection (vtkAlgorithmOutput params)</code> - A convenience method for setting learn input parameters (if one is expected or allowed). It is equivalent to calling SetInput( 1, params ); </li>
<li>
<code>obj.SetLearnOptionParameters (vtkDataObject params)</code> - A convenience method for setting the input model (if one is expected or allowed). It is equivalent to calling SetInputConnection( 2, model ); </li>
<li>
<code>obj.SetInputModelConnection (vtkAlgorithmOutput model)</code> - // <code>obj.SetInputModel (vtkDataObject model)</code> - Set/Get the Learn option. </li>
<li>
<code>obj.SetLearnOption (bool )</code> - Set/Get the Learn option. </li>
<li>
<code>bool = obj.GetLearnOption ()</code> - Set/Get the Learn option. </li>
<li>
<code>obj.SetDeriveOption (bool )</code> - Set/Get the Derive option. </li>
<li>
<code>bool = obj.GetDeriveOption ()</code> - Set/Get the Derive option. </li>
<li>
<code>obj.SetAssessOption (bool )</code> - Set/Get the Assess option. </li>
<li>
<code>bool = obj.GetAssessOption ()</code> - Set/Get the Assess option. </li>
<li>
<code>obj.SetTestOption (bool )</code> - Set/Get the Test option. </li>
<li>
<code>bool = obj.GetTestOption ()</code> - Set/Get the Test option. </li>
<li>
<code>obj.SetAssessParameters (vtkStringArray )</code> - Set/get assessment parameters. </li>
<li>
<code>vtkStringArray = obj.GetAssessParameters ()</code> - Set/get assessment parameters. </li>
<li>
<code>obj.SetAssessNames (vtkStringArray )</code> - Set/get assessment names. </li>
<li>
<code>vtkStringArray = obj.GetAssessNames ()</code> - Set/get assessment names. </li>
<li>
<p class="startli"><code>obj.SetColumnStatus (string namCol, int status)</code> - Add or remove a column from the current analysis request. Once all the column status values are set, call RequestSelectedColumns() before selecting another set of columns for a different analysis request. The way that columns selections are used varies from algorithm to algorithm.</p>
<p class="endli">Note: the set of selected columns is maintained in vtkStatisticsAlgorithmPrivate::Buffer until RequestSelectedColumns() is called, at which point the set is appended to vtkStatisticsAlgorithmPrivate::Requests. If there are any columns in vtkStatisticsAlgorithmPrivate::Buffer at the time RequestData() is called, RequestSelectedColumns() will be called and the selection added to the list of requests. </p>
</li>
<li>
<code>obj.ResetAllColumnStates ()</code> - Set the the status of each and every column in the current request to OFF (0). </li>
<li>
<code>int = obj.RequestSelectedColumns ()</code> - Use the current column status values to produce a new request for statistics to be produced when RequestData() is called. See SetColumnStatus() for more information. </li>
<li>
<code>obj.ResetRequests ()</code> - Empty the list of current requests. </li>
<li>
<code>vtkIdType = obj.GetNumberOfRequests ()</code> - Return the number of requests. This does not include any request that is in the column-status buffer but for which RequestSelectedColumns() has not yet been called (even though it is possible this request will be honored when the filter is run – see SetColumnStatus() for more information). </li>
<li>
<code>vtkIdType = obj.GetNumberOfColumnsForRequest (vtkIdType request)</code> - Return the number of columns for a given request. </li>
<li>
<p class="startli"><code>string = obj.GetColumnForRequest (vtkIdType r, vtkIdType c)</code> - Provide the name of the <em>c-th</em> column for the <em>r-th</em> request.</p>
<p>For the version of this routine that returns an integer, if the request or column does not exist because <em>r</em> or <em>c</em> is out of bounds, this routine returns 0 and the value of <em>columnName</em> is unspecified. Otherwise, it returns 1 and the value of <em>columnName</em> is set.</p>
<p class="endli">For the version of this routine that returns const char*, if the request or column does not exist because <em>r</em> or <em>c</em> is out of bounds, the routine returns NULL. Otherwise it returns the column name. This version is not thread-safe. </p>
</li>
<li>
<code>obj.Aggregate (vtkDataObjectCollection , vtkDataObject )</code> - Given a collection of models, calculate aggregate model </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_vtkinfovis.html">Visualization Toolkit Infovis Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:34 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>
|
