-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathquickstart_guide.html
More file actions
222 lines (194 loc) · 17.2 KB
/
quickstart_guide.html
File metadata and controls
222 lines (194 loc) · 17.2 KB
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>5. Quickstart Guide — Raysect Documentation</title>
<link rel="stylesheet" href="_static/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/RaysectLogo_web.ico"/>
<script src="_static/documentation_options.js?v=39bb1c6d"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="6. Sampling and Observers" href="observers.html" />
<link rel="prev" title="4. How it works" href="how_it_works.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Raysect
<img src="_static/RaysectLogo_web.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">2. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">3. Downloading and Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_it_works.html">4. How it works</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#create-primitives">5.1. Create Primitives</a></li>
<li class="toctree-l2"><a class="reference internal" href="#add-observer">5.2. Add Observer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-scenegraph">5.3. Build Scenegraph</a></li>
<li class="toctree-l2"><a class="reference internal" href="#observe">5.4. Observe()</a></li>
<li class="toctree-l2"><a class="reference internal" href="#simulated-spectrum">5.5. Simulated Spectrum</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="observers.html">6. Sampling and Observers</a></li>
<li class="toctree-l1"><a class="reference internal" href="primitives.html">7. Primitives</a></li>
<li class="toctree-l1"><a class="reference internal" href="materials.html">8. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions.html">9. Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">10. References</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">11. Glossary</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Demonstrations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html">1. Core Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#materials">2. Materials</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#observers">3. Observers</a></li>
<li class="toctree-l1"><a class="reference internal" href="demonstrations/demonstrations.html#optics">4. Optics</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_reference/core/core.html">1. Raysect Core</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/primitives/primitives.html">2. Primitives Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/optical/optical.html">3. Optical Module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Raysect</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">5. </span>Quickstart Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/quickstart_guide.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="quickstart-guide">
<h1><span class="section-number">5. </span>Quickstart Guide<a class="headerlink" href="#quickstart-guide" title="Link to this heading">¶</a></h1>
<p>This example is based on the demo file demos/quickstart/demo_lambert.py. It outlines the typical workflow used in
raysect.</p>
<section id="create-primitives">
<h2><span class="section-number">5.1. </span>Create Primitives<a class="headerlink" href="#create-primitives" title="Link to this heading">¶</a></h2>
<p>Set-up your primitives by defining materials, meshes, etc:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Box defining the ground plane</span>
<span class="n">ground</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">lower</span><span class="o">=</span><span class="n">Point3D</span><span class="p">(</span><span class="o">-</span><span class="mi">50</span><span class="p">,</span> <span class="o">-</span><span class="mf">1.51</span><span class="p">,</span> <span class="o">-</span><span class="mi">50</span><span class="p">),</span> <span class="n">upper</span><span class="o">=</span><span class="n">Point3D</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span> <span class="o">-</span><span class="mf">1.5</span><span class="p">,</span> <span class="mi">50</span><span class="p">),</span> <span class="n">material</span><span class="o">=</span><span class="n">Lambert</span><span class="p">())</span>
<span class="c1"># checker board wall that acts as emitter</span>
<span class="n">emitter</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">lower</span><span class="o">=</span><span class="n">Point3D</span><span class="p">(</span><span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="o">-</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span> <span class="n">upper</span><span class="o">=</span><span class="n">Point3D</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mf">10.1</span><span class="p">),</span>
<span class="n">material</span><span class="o">=</span><span class="n">Checkerboard</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="n">d65_white</span><span class="p">,</span> <span class="n">d65_white</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">),</span> <span class="n">transform</span><span class="o">=</span><span class="n">rotate</span><span class="p">(</span><span class="mi">45</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
<span class="c1"># Sphere</span>
<span class="c1"># Note that the sphere must be displaced slightly above the ground plane to prevent numerically issues that could</span>
<span class="c1"># cause a light leak at the intersection between the sphere and the ground.</span>
<span class="n">sphere</span> <span class="o">=</span> <span class="n">Sphere</span><span class="p">(</span><span class="n">radius</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.0001</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">material</span><span class="o">=</span><span class="n">schott</span><span class="p">(</span><span class="s2">"N-BK7"</span><span class="p">))</span>
</pre></div>
</div>
</section>
<section id="add-observer">
<h2><span class="section-number">5.2. </span>Add Observer<a class="headerlink" href="#add-observer" title="Link to this heading">¶</a></h2>
<p>Add an observer and configure its sampling settings. All of these camera settings have sensible defaults, The camera
settings will be explained in detail in another section:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># processing pipeline (human vision like camera response)</span>
<span class="n">rgb</span> <span class="o">=</span> <span class="n">RGBPipeline2D</span><span class="p">()</span>
<span class="c1"># camera</span>
<span class="n">camera</span> <span class="o">=</span> <span class="n">PinholeCamera</span><span class="p">(</span><span class="n">pixels</span><span class="o">=</span><span class="p">(</span><span class="mi">512</span><span class="p">,</span> <span class="mi">512</span><span class="p">),</span> <span class="n">fov</span><span class="o">=</span><span class="mi">45</span><span class="p">,</span> <span class="n">pipeline</span><span class="o">=</span><span class="p">[</span><span class="n">rgb</span><span class="p">],</span> <span class="n">transform</span><span class="o">=</span><span class="n">translate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="o">-</span><span class="mi">10</span><span class="p">)</span> <span class="o">*</span> <span class="n">rotate</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">45</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
<span class="c1"># camera - pixel sampling settings</span>
<span class="n">camera</span><span class="o">.</span><span class="n">pixel_samples</span> <span class="o">=</span> <span class="mi">250</span>
<span class="n">camera</span><span class="o">.</span><span class="n">min_wavelength</span> <span class="o">=</span> <span class="mf">375.0</span>
<span class="n">camera</span><span class="o">.</span><span class="n">max_wavelength</span> <span class="o">=</span> <span class="mf">740.0</span>
<span class="n">camera</span><span class="o">.</span><span class="n">spectral_bins</span> <span class="o">=</span> <span class="mi">15</span>
<span class="n">camera</span><span class="o">.</span><span class="n">spectral_rays</span> <span class="o">=</span> <span class="mi">1</span>
</pre></div>
</div>
</section>
<section id="build-scenegraph">
<h2><span class="section-number">5.3. </span>Build Scenegraph<a class="headerlink" href="#build-scenegraph" title="Link to this heading">¶</a></h2>
<p>Assemble the scene-graph by linking primitives and observers to the World. Set their transforms:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">world</span> <span class="o">=</span> <span class="n">World</span><span class="p">()</span>
<span class="n">sphere</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">world</span>
<span class="n">ground</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">world</span>
<span class="n">emitter</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">world</span>
<span class="n">camera</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="n">world</span>
</pre></div>
</div>
</section>
<section id="observe">
<h2><span class="section-number">5.4. </span>Observe()<a class="headerlink" href="#observe" title="Link to this heading">¶</a></h2>
<p>Call observe() on an Observer or trace a ray manually:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">ion</span><span class="p">()</span>
<span class="n">camera</span><span class="o">.</span><span class="n">observe</span><span class="p">()</span>
<span class="n">plt</span><span class="o">.</span><span class="n">ioff</span><span class="p">()</span>
<span class="n">rgb</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s2">"render.png"</span><span class="p">)</span>
<span class="n">rgb</span><span class="o">.</span><span class="n">display</span><span class="p">()</span>
</pre></div>
</div>
<p>The resulting image should render like this.</p>
<img alt="_images/demo_lambert.png" class="align-center" src="_images/demo_lambert.png" />
</section>
<section id="simulated-spectrum">
<h2><span class="section-number">5.5. </span>Simulated Spectrum<a class="headerlink" href="#simulated-spectrum" title="Link to this heading">¶</a></h2>
<p>Lets simulate measuring a spectrum by launching a single ray:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ray</span> <span class="o">=</span> <span class="n">Ray</span><span class="p">(</span><span class="n">origin</span><span class="o">=</span><span class="n">Point3D</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">5</span><span class="p">),</span>
<span class="n">direction</span><span class="o">=</span><span class="n">Vector3D</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="n">min_wavelength</span><span class="o">=</span><span class="mi">375</span><span class="p">,</span>
<span class="n">max_wavelength</span><span class="o">=</span><span class="mi">785</span><span class="p">,</span>
<span class="n">bins</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="n">ray</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">world</span><span class="p">)</span>
</pre></div>
</div>
<p>The resulting plot should look something like this.</p>
<img alt="_images/example_spectra.png" class="align-center" src="_images/example_spectra.png" />
<p>Due to the statistical nature of the path tracer, you may need to run the trace command more than once until you find a path that intersects with the light source.</p>
<p>You can ask the ray to trace repeatedly using the sample method instead. This will combine the results of multiple paths:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ray</span><span class="o">.</span><span class="n">sample</span><span class="p">(</span><span class="n">world</span><span class="p">,</span> <span class="mi">10000</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="how_it_works.html" class="btn btn-neutral float-left" title="4. How it works" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="observers.html" class="btn btn-neutral float-right" title="6. Sampling and Observers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2025, Dr Alex Meakins.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>