-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_sn__scale__estimator_8h_source.html
168 lines (166 loc) · 17.9 KB
/
_sn__scale__estimator_8h_source.html
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
<!-- HTML header for doxygen 1.8.11-->
<!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"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<title>MRtrix: core/math/Sn_scale_estimator.h Source File</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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 id="projectlogo"><a href=http://www.mrtrix.org><img alt="Logo" src="logo.png"/></a></td>
<td id="projectalign" style="padding-left: 2em;">
<div id="projectname">Developer documentation</div>
<div id="projectbrief">Version 3.0.3-105-gd3941f44</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_sn__scale__estimator_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle"><div class="title">Sn_scale_estimator.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_sn__scale__estimator_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/* Copyright (c) 2008-2022 the MRtrix3 contributors.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> *</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * Covered Software is provided under this License on an "as is"</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * basis, without warranty of any kind, either expressed, implied, or</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * statutory, including, without limitation, warranties that the</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * Covered Software is free of defects, merchantable, fit for a</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * particular purpose or non-infringing.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * See the Mozilla Public License v. 2.0 for more details.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * For more details, see http://www.mrtrix.org/.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> */</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#ifndef __math_Sn_scale_estimator_h__</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#define __math_Sn_scale_estimator_h__</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "types.h"</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "<a class="code" href="math_2median_8h.html">math/median.h</a>"</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_m_r.html">MR</a> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span>Math {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Sn robust estimator of scale to get solid estimate of standard deviation:</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// for details, see: Rousseeuw PJ, Croux C. Alternatives to the Median Absolute Deviation. Journal of the American Statistical Association 1993;88:1273–1283. </span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span> <<span class="keyword">typename</span> value_type = default_type> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html"> 32</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html">Sn_scale_estimator</a> { <a class="code hl_define" href="memory_8h.html#a5d1aa93e600a93cee8523d1d34c1ace5">NOMEMALIGN</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">template</span> <<span class="keyword">class</span> VectorType></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a7553c0aa948b401fd36acb065d095926"> 35</a></span> <a class="code hl_typedef" href="namespace_m_r_1_1_math_1_1_stats.html#a5e7ca9d7689e3c74384e428ec1d9d9a9">value_type</a> <a class="code hl_function" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a7553c0aa948b401fd36acb065d095926">operator() </a>(<span class="keyword">const</span> VectorType& vec)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5">diff</a>.resize (vec.size());</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a70f6c2069527875795d39bad892d99ea">med_diff</a>.resize (vec.size());</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">for</span> (ssize_t j = 0; j < vec.size(); ++j) {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">for</span> (ssize_t i = 0; i < vec.size(); ++i) </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5">diff</a>[i] = <a class="code hl_function" href="namespace_m_r.html#a72cf6689eb81a895e6b9f80a49d3732c">abs</a> (vec[i] - vec[j]);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a70f6c2069527875795d39bad892d99ea">med_diff</a>[j] = <a class="code hl_function" href="namespace_m_r_1_1_math.html#aaf669a58d9721e99938e232f90af93b1">Math::median</a> (<a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5">diff</a>);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> 1.1926 * <a class="code hl_function" href="namespace_m_r_1_1_math.html#aaf669a58d9721e99938e232f90af93b1">Math::median</a> (<a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a70f6c2069527875795d39bad892d99ea">med_diff</a>);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5"> 48</a></span> <a class="code hl_class" href="class_m_r_1_1vector.html">vector<value_type></a> <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5">diff</a>, <a class="code hl_variable" href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a70f6c2069527875795d39bad892d99ea">med_diff</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> };</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>}</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="ttc" id="aclass_m_r_1_1_math_1_1_sn__scale__estimator_html"><div class="ttname"><a href="class_m_r_1_1_math_1_1_sn__scale__estimator.html">MR::Math::Sn_scale_estimator</a></div><div class="ttdef"><b>Definition:</b> <a href="_sn__scale__estimator_8h_source.html#l00032">Sn_scale_estimator.h:32</a></div></div>
<div class="ttc" id="aclass_m_r_1_1_math_1_1_sn__scale__estimator_html_a70f6c2069527875795d39bad892d99ea"><div class="ttname"><a href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a70f6c2069527875795d39bad892d99ea">MR::Math::Sn_scale_estimator::med_diff</a></div><div class="ttdeci">vector< value_type > med_diff</div><div class="ttdef"><b>Definition:</b> <a href="_sn__scale__estimator_8h_source.html#l00048">Sn_scale_estimator.h:48</a></div></div>
<div class="ttc" id="aclass_m_r_1_1_math_1_1_sn__scale__estimator_html_a7553c0aa948b401fd36acb065d095926"><div class="ttname"><a href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#a7553c0aa948b401fd36acb065d095926">MR::Math::Sn_scale_estimator::operator()</a></div><div class="ttdeci">value_type operator()(const VectorType &vec)</div><div class="ttdef"><b>Definition:</b> <a href="_sn__scale__estimator_8h_source.html#l00035">Sn_scale_estimator.h:35</a></div></div>
<div class="ttc" id="aclass_m_r_1_1_math_1_1_sn__scale__estimator_html_aff4e6d63c4c1ad1d09b40850b9b928a5"><div class="ttname"><a href="class_m_r_1_1_math_1_1_sn__scale__estimator.html#aff4e6d63c4c1ad1d09b40850b9b928a5">MR::Math::Sn_scale_estimator::diff</a></div><div class="ttdeci">vector< value_type > diff</div><div class="ttdef"><b>Definition:</b> <a href="_sn__scale__estimator_8h_source.html#l00048">Sn_scale_estimator.h:48</a></div></div>
<div class="ttc" id="aclass_m_r_1_1vector_html"><div class="ttname"><a href="class_m_r_1_1vector.html">MR::vector< value_type ></a></div></div>
<div class="ttc" id="amath_2median_8h_html"><div class="ttname"><a href="math_2median_8h.html">median.h</a></div></div>
<div class="ttc" id="amemory_8h_html_a5d1aa93e600a93cee8523d1d34c1ace5"><div class="ttname"><a href="memory_8h.html#a5d1aa93e600a93cee8523d1d34c1ace5">NOMEMALIGN</a></div><div class="ttdeci">#define NOMEMALIGN</div><div class="ttdef"><b>Definition:</b> <a href="memory_8h_source.html#l00022">memory.h:22</a></div></div>
<div class="ttc" id="anamespace_m_r_1_1_math_1_1_stats_html_a5e7ca9d7689e3c74384e428ec1d9d9a9"><div class="ttname"><a href="namespace_m_r_1_1_math_1_1_stats.html#a5e7ca9d7689e3c74384e428ec1d9d9a9">MR::Math::Stats::value_type</a></div><div class="ttdeci">MR::default_type value_type</div><div class="ttdef"><b>Definition:</b> <a href="typedefs_8h_source.html#l00033">typedefs.h:33</a></div></div>
<div class="ttc" id="anamespace_m_r_1_1_math_html_aaf669a58d9721e99938e232f90af93b1"><div class="ttname"><a href="namespace_m_r_1_1_math.html#aaf669a58d9721e99938e232f90af93b1">MR::Math::median</a></div><div class="ttdeci">Container::value_type median(Container &list)</div><div class="ttdef"><b>Definition:</b> <a href="math_2median_8h_source.html#l00045">median.h:45</a></div></div>
<div class="ttc" id="anamespace_m_r_html"><div class="ttname"><a href="namespace_m_r.html">MR</a></div><div class="ttdef"><b>Definition:</b> <a href="core_2adapter_2base_8h_source.html#l00023">base.h:24</a></div></div>
<div class="ttc" id="anamespace_m_r_html_a72cf6689eb81a895e6b9f80a49d3732c"><div class="ttname"><a href="namespace_m_r.html#a72cf6689eb81a895e6b9f80a49d3732c">MR::abs</a></div><div class="ttdeci">constexpr std::enable_if< std::is_arithmetic< X >::value &&std::is_unsigned< X >::value, X >::type abs(X x)</div><div class="ttdef"><b>Definition:</b> <a href="src_2surface_2types_8h_source.html#l00297">types.h:297</a></div></div>
</div><!-- fragment --></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="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_e07ac01d65d17e829451634057f91345.html">math</a></li><li class="navelem"><a class="el" href="_sn__scale__estimator_8h.html">Sn_scale_estimator.h</a></li>
<li class="footer">Generated on Mon Jul 4 2022 08:00:06 for MRtrix by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
</html>