a b/docs/utils/testing.html 

  1
  
<!doctype html>





  
  

  2
  
<html lang="en">





  
  

  3
  
<head>





  
  

  4
  
<meta charset="utf-8">





  
  

  5
  
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />





  
  

  6
  
<meta name="generator" content="pdoc 0.10.0" />





  
  

  7
  
<title>pymskt.utils.testing API documentation</title>





  
  

  8
  
<meta name="description" content="" />





  
  

  9
  
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>





  
  

  10
  
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>





  
  

  11
  
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>





  
  

  12
  
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>





  
  

  13
  
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>





  
  

  14
  
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>





  
  

  15
  
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>





  
  

  16
  
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>





  
  

  17
  
</head>





  
  

  18
  
<body>





  
  

  19
  
<main>





  
  

  20
  
<article id="content">





  
  

  21
  
<header>





  
  

  22
  
<h1 class="title">Module <code>pymskt.utils.testing</code></h1>





  
  

  23
  
</header>





  
  

  24
  
<section id="section-intro">





  
  

  25
  
<details class="source">





  
  

  26
  
<summary>





  
  

  27
  
<span>Expand source code</span>





  
  

  28
  
</summary>





  
  

  29
  
<pre><code class="python">from typing import Optional





  
  

  30
  
from numpy.testing import assert_allclose





  
  

  31
  
import SimpleITK as sitk





  
  

  32
  
import pymskt as mskt





  
  

  33
  
from vtk.util.numpy_support import vtk_to_numpy





  
  

  34
  
import vtk





  
  

  35
  





  
  

  36
  
def assert_images_same(image1, image2):





  
  

  37
  
    &#34;&#34;&#34;





  
  

  38
  
    Helper function to assert that 2 SimpleITK images are the same. 





  
  

  39
  





  
  

  40
  
    Parameters





  
  

  41
  
    ----------





  
  

  42
  
    image1 : SimpleITK.Image





  
  

  43
  
        Version 1 of the image. 





  
  

  44
  
    image2 : SimpleITK.Image





  
  

  45
  
        Version 2 of the image. 





  
  

  46
  
    &#34;&#34;&#34;    





  
  

  47
  
    image1_array = sitk.GetArrayFromImage(image1)





  
  

  48
  
    image2_array = sitk.GetArrayFromImage(image2)





  
  

  49
  





  
  

  50
  
    assert_allclose(image1_array, image2_array)





  
  

  51
  
    assert image1.GetOrigin() == image2.GetOrigin()





  
  

  52
  
    assert image1.GetSpacing() == image2.GetSpacing()





  
  

  53
  
    assert image1.GetDirection() == image2.GetDirection()





  
  

  54
  





  
  

  55
  
def assert_mesh_coordinates_same(mesh1, mesh2, rtol=1e-4):





  
  

  56
  
    &#34;&#34;&#34;





  
  

  57
  
    Helper function to assert that 2 vtkPolyData meshes points are the same. 





  
  

  58
  





  
  

  59
  
    Parameters





  
  

  60
  
    ----------





  
  

  61
  
    mesh1 : vtk.vtkPolyData





  
  

  62
  
        Version 1 of the mesh





  
  

  63
  
    mesh2 : vtk.vtkPolyData





  
  

  64
  
        Version 2 of the mesh





  
  

  65
  
    &#34;&#34;&#34;





  
  

  66
  





  
  

  67
  
    mesh1_pts = mskt.mesh.get_mesh_physical_point_coords(mesh1)





  
  

  68
  
    mesh2_pts = mskt.mesh.get_mesh_physical_point_coords(mesh2)





  
  

  69
  





  
  

  70
  
    assert_allclose(mesh1_pts, mesh2_pts, rtol=rtol)





  
  

  71
  





  
  

  72
  
def assert_mesh_scalars_same(mesh1, mesh2, scalarname, scalarname2=None, rtol=1e-4):





  
  

  73
  
    &#34;&#34;&#34;





  
  

  74
  
    Helper function to assert that the scalars on 2 vtkPolyData meshes as the same. 





  
  

  75
  





  
  

  76
  
    Parameters





  
  

  77
  
    ----------





  
  

  78
  
    mesh1 : vtk.vtkPolyData





  
  

  79
  
        Version 1 of the mesh





  
  

  80
  
    mesh2 : vtk.vtkPolyData





  
  

  81
  
        Version 2 of the mesh





  
  

  82
  
    scalarname : str





  
  

  83
  
        String of the name associated with the scalars we are comparing





  
  

  84
  
    scalarname2 : str, optional





  
  

  85
  
        String of the name associated with the scalars on the second mesh. 





  
  

  86
  
        This is only needed if the second mesh scarals have a different name than the first. 





  
  

  87
  
    &#34;&#34;&#34;





  
  

  88
  
    if scalarname2 is None:





  
  

  89
  
        scalarname2 = scalarname





  
  

  90
  
    scalars1 = vtk_to_numpy(mesh1.GetPointData().GetArray(scalarname))





  
  

  91
  
    scalars2 = vtk_to_numpy(mesh2.GetPointData().GetArray(scalarname2))





  
  

  92
  





  
  

  93
  
    assert_allclose(scalars1, scalars2, rtol=rtol)</code></pre>





  
  

  94
  
</details>





  
  

  95
  
</section>





  
  

  96
  
<section>





  
  

  97
  
</section>





  
  

  98
  
<section>





  
  

  99
  
</section>





  
  

  100
  
<section>





  
  

  101
  
<h2 class="section-title" id="header-functions">Functions</h2>





  
  

  102
  
<dl>





  
  

  103
  
<dt id="pymskt.utils.testing.assert_images_same"><code class="name flex">





  
  

  104
  
<span>def <span class="ident">assert_images_same</span></span>(<span>image1, image2)</span>





  
  

  105
  
</code></dt>





  
  

  106
  
<dd>





  
  

  107
  
<div class="desc"><p>Helper function to assert that 2 SimpleITK images are the same. </p>





  
  

  108
  
<h2 id="parameters">Parameters</h2>





  
  

  109
  
<dl>





  
  

  110
  
<dt><strong><code>image1</code></strong> :&ensp;<code>SimpleITK.Image</code></dt>





  
  

  111
  
<dd>Version 1 of the image.</dd>





  
  

  112
  
<dt><strong><code>image2</code></strong> :&ensp;<code>SimpleITK.Image</code></dt>





  
  

  113
  
<dd>Version 2 of the image.</dd>





  
  

  114
  
</dl></div>





  
  

  115
  
<details class="source">





  
  

  116
  
<summary>





  
  

  117
  
<span>Expand source code</span>





  
  

  118
  
</summary>





  
  

  119
  
<pre><code class="python">def assert_images_same(image1, image2):





  
  

  120
  
    &#34;&#34;&#34;





  
  

  121
  
    Helper function to assert that 2 SimpleITK images are the same. 





  
  

  122
  





  
  

  123
  
    Parameters





  
  

  124
  
    ----------





  
  

  125
  
    image1 : SimpleITK.Image





  
  

  126
  
        Version 1 of the image. 





  
  

  127
  
    image2 : SimpleITK.Image





  
  

  128
  
        Version 2 of the image. 





  
  

  129
  
    &#34;&#34;&#34;    





  
  

  130
  
    image1_array = sitk.GetArrayFromImage(image1)





  
  

  131
  
    image2_array = sitk.GetArrayFromImage(image2)





  
  

  132
  





  
  

  133
  
    assert_allclose(image1_array, image2_array)





  
  

  134
  
    assert image1.GetOrigin() == image2.GetOrigin()





  
  

  135
  
    assert image1.GetSpacing() == image2.GetSpacing()





  
  

  136
  
    assert image1.GetDirection() == image2.GetDirection()</code></pre>





  
  

  137
  
</details>





  
  

  138
  
</dd>





  
  

  139
  
<dt id="pymskt.utils.testing.assert_mesh_coordinates_same"><code class="name flex">





  
  

  140
  
<span>def <span class="ident">assert_mesh_coordinates_same</span></span>(<span>mesh1, mesh2, rtol=0.0001)</span>





  
  

  141
  
</code></dt>





  
  

  142
  
<dd>





  
  

  143
  
<div class="desc"><p>Helper function to assert that 2 vtkPolyData meshes points are the same. </p>





  
  

  144
  
<h2 id="parameters">Parameters</h2>





  
  

  145
  
<dl>





  
  

  146
  
<dt><strong><code>mesh1</code></strong> :&ensp;<code>vtk.vtkPolyData</code></dt>





  
  

  147
  
<dd>Version 1 of the mesh</dd>





  
  

  148
  
<dt><strong><code>mesh2</code></strong> :&ensp;<code>vtk.vtkPolyData</code></dt>





  
  

  149
  
<dd>Version 2 of the mesh</dd>





  
  

  150
  
</dl></div>





  
  

  151
  
<details class="source">





  
  

  152
  
<summary>





  
  

  153
  
<span>Expand source code</span>





  
  

  154
  
</summary>





  
  

  155
  
<pre><code class="python">def assert_mesh_coordinates_same(mesh1, mesh2, rtol=1e-4):





  
  

  156
  
    &#34;&#34;&#34;





  
  

  157
  
    Helper function to assert that 2 vtkPolyData meshes points are the same. 





  
  

  158
  





  
  

  159
  
    Parameters





  
  

  160
  
    ----------





  
  

  161
  
    mesh1 : vtk.vtkPolyData





  
  

  162
  
        Version 1 of the mesh





  
  

  163
  
    mesh2 : vtk.vtkPolyData





  
  

  164
  
        Version 2 of the mesh





  
  

  165
  
    &#34;&#34;&#34;





  
  

  166
  





  
  

  167
  
    mesh1_pts = mskt.mesh.get_mesh_physical_point_coords(mesh1)





  
  

  168
  
    mesh2_pts = mskt.mesh.get_mesh_physical_point_coords(mesh2)





  
  

  169
  





  
  

  170
  
    assert_allclose(mesh1_pts, mesh2_pts, rtol=rtol)</code></pre>





  
  

  171
  
</details>





  
  

  172
  
</dd>





  
  

  173
  
<dt id="pymskt.utils.testing.assert_mesh_scalars_same"><code class="name flex">





  
  

  174
  
<span>def <span class="ident">assert_mesh_scalars_same</span></span>(<span>mesh1, mesh2, scalarname, scalarname2=None, rtol=0.0001)</span>





  
  

  175
  
</code></dt>





  
  

  176
  
<dd>





  
  

  177
  
<div class="desc"><p>Helper function to assert that the scalars on 2 vtkPolyData meshes as the same. </p>





  
  

  178
  
<h2 id="parameters">Parameters</h2>





  
  

  179
  
<dl>





  
  

  180
  
<dt><strong><code>mesh1</code></strong> :&ensp;<code>vtk.vtkPolyData</code></dt>





  
  

  181
  
<dd>Version 1 of the mesh</dd>





  
  

  182
  
<dt><strong><code>mesh2</code></strong> :&ensp;<code>vtk.vtkPolyData</code></dt>





  
  

  183
  
<dd>Version 2 of the mesh</dd>





  
  

  184
  
<dt><strong><code>scalarname</code></strong> :&ensp;<code>str</code></dt>





  
  

  185
  
<dd>String of the name associated with the scalars we are comparing</dd>





  
  

  186
  
<dt><strong><code>scalarname2</code></strong> :&ensp;<code>str</code>, optional</dt>





  
  

  187
  
<dd>String of the name associated with the scalars on the second mesh.





  
  

  188
  
This is only needed if the second mesh scarals have a different name than the first.</dd>





  
  

  189
  
</dl></div>





  
  

  190
  
<details class="source">





  
  

  191
  
<summary>





  
  

  192
  
<span>Expand source code</span>





  
  

  193
  
</summary>





  
  

  194
  
<pre><code class="python">def assert_mesh_scalars_same(mesh1, mesh2, scalarname, scalarname2=None, rtol=1e-4):





  
  

  195
  
    &#34;&#34;&#34;





  
  

  196
  
    Helper function to assert that the scalars on 2 vtkPolyData meshes as the same. 





  
  

  197
  





  
  

  198
  
    Parameters





  
  

  199
  
    ----------





  
  

  200
  
    mesh1 : vtk.vtkPolyData





  
  

  201
  
        Version 1 of the mesh





  
  

  202
  
    mesh2 : vtk.vtkPolyData





  
  

  203
  
        Version 2 of the mesh





  
  

  204
  
    scalarname : str





  
  

  205
  
        String of the name associated with the scalars we are comparing





  
  

  206
  
    scalarname2 : str, optional





  
  

  207
  
        String of the name associated with the scalars on the second mesh. 





  
  

  208
  
        This is only needed if the second mesh scarals have a different name than the first. 





  
  

  209
  
    &#34;&#34;&#34;





  
  

  210
  
    if scalarname2 is None:





  
  

  211
  
        scalarname2 = scalarname





  
  

  212
  
    scalars1 = vtk_to_numpy(mesh1.GetPointData().GetArray(scalarname))





  
  

  213
  
    scalars2 = vtk_to_numpy(mesh2.GetPointData().GetArray(scalarname2))





  
  

  214
  





  
  

  215
  
    assert_allclose(scalars1, scalars2, rtol=rtol)</code></pre>





  
  

  216
  
</details>





  
  

  217
  
</dd>





  
  

  218
  
</dl>





  
  

  219
  
</section>





  
  

  220
  
<section>





  
  

  221
  
</section>





  
  

  222
  
</article>





  
  

  223
  
<nav id="sidebar">





  
  

  224
  
<h1>Index</h1>





  
  

  225
  
<div class="toc">





  
  

  226
  
<ul></ul>





  
  

  227
  
</div>





  
  

  228
  
<ul id="index">





  
  

  229
  
<li><h3>Super-module</h3>





  
  

  230
  
<ul>





  
  

  231
  
<li><code><a title="pymskt.utils" href="index.html">pymskt.utils</a></code></li>





  
  

  232
  
</ul>





  
  

  233
  
</li>





  
  

  234
  
<li><h3><a href="#header-functions">Functions</a></h3>





  
  

  235
  
<ul class="">





  
  

  236
  
<li><code><a title="pymskt.utils.testing.assert_images_same" href="#pymskt.utils.testing.assert_images_same">assert_images_same</a></code></li>





  
  

  237
  
<li><code><a title="pymskt.utils.testing.assert_mesh_coordinates_same" href="#pymskt.utils.testing.assert_mesh_coordinates_same">assert_mesh_coordinates_same</a></code></li>





  
  

  238
  
<li><code><a title="pymskt.utils.testing.assert_mesh_scalars_same" href="#pymskt.utils.testing.assert_mesh_scalars_same">assert_mesh_scalars_same</a></code></li>





  
  

  239
  
</ul>





  
  

  240
  
</li>





  
  

  241
  
</ul>





  
  

  242
  
</nav>





  
  

  243
  
</main>





  
  

  244
  
<footer id="footer">





  
  

  245
  
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>





  
  

  246
  
</footer>





  
  

  247
  
</body>





  
  

  248
  
</html>