Skip to content

Commit

Permalink
Update documentation after module rename etc
Browse files Browse the repository at this point in the history
  • Loading branch information
chaubold committed Jun 20, 2016
1 parent 50fd5c2 commit f8ebfb7
Show file tree
Hide file tree
Showing 39 changed files with 14,651 additions and 23,185 deletions.
616 changes: 308 additions & 308 deletions toolbox/divisionfeatures.m.html → hytra/core/divisionfeatures.m.html

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions toolbox/fieldofview.m.html → hytra/core/fieldofview.m.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />

<title>toolbox.fieldofview API documentation</title>
<title>hytra.core.fieldofview API documentation</title>
<meta name="description" content="" />

<link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:400,300' rel='stylesheet' type='text/css'>
Expand Down Expand Up @@ -1041,12 +1041,12 @@ <h1>Index</h1>
<li class="set"><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li class="mono">
<span class="class_name"><a href="#toolbox.fieldofview.FieldOfView">FieldOfView</a></span>
<span class="class_name"><a href="#hytra.core.fieldofview.FieldOfView">FieldOfView</a></span>


<ul>
<li class="mono"><a href="#toolbox.fieldofview.FieldOfView.__init__">__init__</a></li>
<li class="mono"><a href="#toolbox.fieldofview.FieldOfView.spatial_distance_to_border">spatial_distance_to_border</a></li>
<li class="mono"><a href="#hytra.core.fieldofview.FieldOfView.__init__">__init__</a></li>
<li class="mono"><a href="#hytra.core.fieldofview.FieldOfView.spatial_distance_to_border">spatial_distance_to_border</a></li>
</ul>

</li>
Expand All @@ -1064,11 +1064,11 @@ <h1>Index</h1>


<header id="section-intro">
<h1 class="title"><span class="name">toolbox.fieldofview</span> module</h1>
<h1 class="title"><span class="name">hytra.core.fieldofview</span> module</h1>


<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-toolbox.fieldofview', this);">Show source &equiv;</a></p>
<div id="source-toolbox.fieldofview" class="source">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-hytra.core.fieldofview', this);">Show source &equiv;</a></p>
<div id="source-hytra.core.fieldofview" class="source">
<div class="codehilite"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="kn">as</span> <span class="nn">np</span>

<span class="k">class</span> <span class="nc">FieldOfView</span><span class="p">:</span>
Expand Down Expand Up @@ -1166,14 +1166,14 @@ <h1 class="title"><span class="name">toolbox.fieldofview</span> module</h1>
<h2 class="section-title" id="header-classes">Classes</h2>

<div class="item">
<p id="toolbox.fieldofview.FieldOfView" class="name">class <span class="ident">FieldOfView</span></p>
<p id="hytra.core.fieldofview.FieldOfView" class="name">class <span class="ident">FieldOfView</span></p>


<div class="desc"><p>Replacement for pgmlink's field of view by simply copy'n'pasting it and adjusting so that it works.
FIXME: Could be made much nicer in python, using more Numpy functionality...</p></div>
<div class="source_cont">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-toolbox.fieldofview.FieldOfView', this);">Show source &equiv;</a></p>
<div id="source-toolbox.fieldofview.FieldOfView" class="source">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-hytra.core.fieldofview.FieldOfView', this);">Show source &equiv;</a></p>
<div id="source-hytra.core.fieldofview.FieldOfView" class="source">
<div class="codehilite"><pre><span></span><span class="k">class</span> <span class="nc">FieldOfView</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Replacement for pgmlink&#39;s field of view by simply copy&#39;n&#39;pasting it and adjusting so that it works.</span>
Expand Down Expand Up @@ -1266,12 +1266,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<div class="class">
<h3>Ancestors (in MRO)</h3>
<ul class="class_list">
<li><a href="#toolbox.fieldofview.FieldOfView">FieldOfView</a></li>
<li><a href="#hytra.core.fieldofview.FieldOfView">FieldOfView</a></li>
</ul>
<h3>Methods</h3>

<div class="item">
<div class="name def" id="toolbox.fieldofview.FieldOfView.__init__">
<div class="name def" id="hytra.core.fieldofview.FieldOfView.__init__">
<p>def <span class="ident">__init__</span>(</p><p>self, lt, lx, ly, lz, ut, ux, uy, uz)</p>
</div>

Expand All @@ -1280,8 +1280,8 @@ <h3>Methods</h3>

<div class="desc"><p>Initialize this field of view with lower (l) and upper (u) values for t,x,y,z.</p></div>
<div class="source_cont">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-toolbox.fieldofview.FieldOfView.__init__', this);">Show source &equiv;</a></p>
<div id="source-toolbox.fieldofview.FieldOfView.__init__" class="source">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-hytra.core.fieldofview.FieldOfView.__init__', this);">Show source &equiv;</a></p>
<div id="source-hytra.core.fieldofview.FieldOfView.__init__" class="source">
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lt</span><span class="p">,</span> <span class="n">lx</span><span class="p">,</span> <span class="n">ly</span><span class="p">,</span> <span class="n">lz</span><span class="p">,</span> <span class="n">ut</span><span class="p">,</span> <span class="n">ux</span><span class="p">,</span> <span class="n">uy</span><span class="p">,</span> <span class="n">uz</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initialize this field of view with lower (l) and upper (u) values for t,x,y,z.</span>
Expand All @@ -1297,7 +1297,7 @@ <h3>Methods</h3>


<div class="item">
<div class="name def" id="toolbox.fieldofview.FieldOfView.spatial_distance_to_border">
<div class="name def" id="hytra.core.fieldofview.FieldOfView.spatial_distance_to_border">
<p>def <span class="ident">spatial_distance_to_border</span>(</p><p>self, t, x, y, z, relative=False)</p>
</div>

Expand All @@ -1308,8 +1308,8 @@ <h3>Methods</h3>
we take the planes with Z upper bound set to 1.0
and return the distances to the 4 corresponding planes</p></div>
<div class="source_cont">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-toolbox.fieldofview.FieldOfView.spatial_distance_to_border', this);">Show source &equiv;</a></p>
<div id="source-toolbox.fieldofview.FieldOfView.spatial_distance_to_border" class="source">
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-hytra.core.fieldofview.FieldOfView.spatial_distance_to_border', this);">Show source &equiv;</a></p>
<div id="source-hytra.core.fieldofview.FieldOfView.spatial_distance_to_border" class="source">
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">spatial_distance_to_border</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="p">,</span> <span class="n">relative</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> distance to 6 cuboid planes, in the 2D case where Z=0,</span>
Expand Down
Loading

0 comments on commit f8ebfb7

Please sign in to comment.