-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
372 lines (351 loc) · 30.5 KB
/
index.html
File metadata and controls
372 lines (351 loc) · 30.5 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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<!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>Home — 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="1. Introduction" href="introduction.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="#" 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>
<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"><a class="reference internal" href="quickstart_guide.html">5. Quickstart Guide</a></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="#">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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Home</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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">
<div class="line-block">
<div class="line"><br /></div>
</div>
<img alt="_images/RaysectLogo_small.png" class="align-center" src="_images/RaysectLogo_small.png" />
<div class="line-block">
<div class="line"><br /></div>
<div class="line"><br /></div>
</div>
<section id="welcome">
<h1>Welcome<a class="headerlink" href="#welcome" title="Link to this heading">¶</a></h1>
<p>Welcome to Raysect, an OOP ray-tracing framework for Python. Raysect has been built with scientific ray-tracing in mind. Some of its features include:</p>
<ul class="simple">
<li><p>Fully spectral, high precision. Supports scientific ray-tracing of spectra from physical light sources such as plasmas.</p></li>
<li><p>All core loops are written in cython for speed.</p></li>
<li><p>Easily extensible, written with user customisation of materials and emissive sources in mind.</p></li>
<li><p>Different observer types supported such as Pinhole cameras and optical fibres.</p></li>
</ul>
<img alt="_images/prism_720x405.png" class="align-center" src="_images/prism_720x405.png" />
<section id="the-raysect-development-team">
<h2>The Raysect Development Team:<a class="headerlink" href="#the-raysect-development-team" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Dr Alex Meakins</p></li>
<li><p>Dr Matthew Carr</p></li>
</ul>
</section>
<section id="quick-installation">
<h2>Quick Installation<a class="headerlink" href="#quick-installation" title="Link to this heading">¶</a></h2>
<p>The easiest way to install Raysect is using <a class="reference external" href="https://pip.pypa.io/en/stable/">pip</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">raysect</span>
</pre></div>
</div>
<p>For more detailed installation instructions see <a class="reference internal" href="installation.html"><span class="doc">Downloading and Installation</span></a>.</p>
</section>
<section id="need-help">
<h2>Need Help?<a class="headerlink" href="#need-help" title="Link to this heading">¶</a></h2>
<p>Please post a question on the <a class="reference external" href="https://github.com/raysect/source/issues">github issue queue</a>.</p>
<div class="toctree-wrapper compound" id="mastertoc">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-raysect">1.1. What is raysect</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#feature-set">1.2. Feature set</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#structure-architecture">1.3. Structure/Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#contributions">1.4. Contributions</a></li>
</ul>
</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><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#prerequisites">3.1. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation">3.2. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#testing">3.3. Testing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how_it_works.html">4. How it works</a><ul>
<li class="toctree-l2"><a class="reference internal" href="how_it_works.html#what-is-a-ray-tracer">4.1. What is a ray tracer?</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_it_works.html#key-concepts">4.2. Key Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_it_works.html#process-of-raytracing">4.3. Process of raytracing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart_guide.html">5. Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart_guide.html#create-primitives">5.1. Create Primitives</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart_guide.html#add-observer">5.2. Add Observer</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart_guide.html#build-scenegraph">5.3. Build Scenegraph</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart_guide.html#observe">5.4. Observe()</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart_guide.html#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><ul>
<li class="toctree-l2"><a class="reference internal" href="observers.html#primer-on-monte-carlo-integration">6.1. Primer on Monte-Carlo Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="observers.html#observing-surfaces">6.2. Observing Surfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="observers.html#material-surfaces">6.3. Material Surfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="observers.html#participating-media">6.4. Participating Media</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="primitives.html">7. Primitives</a><ul>
<li class="toctree-l2"><a class="reference internal" href="primitives.html#geometric-primitives">7.1. Geometric Primitives</a></li>
<li class="toctree-l2"><a class="reference internal" href="primitives.html#csg-operations">7.2. CSG Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="primitives.html#meshes">7.3. Meshes</a></li>
</ul>
</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><ul>
<li class="toctree-l2"><a class="reference internal" href="references.html#books">10.1. Books</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#papers-reports">10.2. Papers & Reports</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#conference-proceedings">10.3. Conference Proceedings</a></li>
<li class="toctree-l2"><a class="reference internal" href="references.html#websites">10.4. Websites</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">11. Glossary</a></li>
</ul>
</div>
<div class="toctree-wrapper compound" id="demonstrations">
<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>
</div>
<div class="toctree-wrapper compound" id="apireferenceto">
<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><ul>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/core_classes.html">1.1. Core Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/core_classes.html#raysect.core.ray.Ray"><code class="docutils literal notranslate"><span class="pre">Ray</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/core_classes.html#raysect.core.intersection.Intersection"><code class="docutils literal notranslate"><span class="pre">Intersection</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/math.html">1.2. Math Module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/points_and_vectors.html">1.2.1. Points and Vectors</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/affinematrix.html">1.2.2. Affine Matricies</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/functions.html">1.2.3. Functions and Interpolators</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/random.html">1.2.4. Random</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/statistics_arrays.html">1.2.5. Statistics Arrays</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/units.html">1.2.6. Unit Conversions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html">1.3. Scenegraph Module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.node.Node"><code class="docutils literal notranslate"><span class="pre">Node</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.observer.Observer"><code class="docutils literal notranslate"><span class="pre">Observer</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.primitive.Primitive"><code class="docutils literal notranslate"><span class="pre">Primitive</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.world.World"><code class="docutils literal notranslate"><span class="pre">World</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/raysect_core_scenegraph.html#raysect.core.scenegraph.utility.print_scenegraph"><code class="docutils literal notranslate"><span class="pre">print_scenegraph()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/spatial_acceleration.html">1.4. Spatial Acceleration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/spatial_acceleration.html#raysect.core.boundingbox.BoundingBox2D"><code class="docutils literal notranslate"><span class="pre">BoundingBox2D</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/spatial_acceleration.html#raysect.core.boundingbox.BoundingBox3D"><code class="docutils literal notranslate"><span class="pre">BoundingBox3D</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/spatial_acceleration.html#raysect.core.boundingsphere.BoundingSphere3D"><code class="docutils literal notranslate"><span class="pre">BoundingSphere3D</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/render_engines.html">1.5. Render Engines</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/render_engines.html#raysect.core.workflow.RenderEngine"><code class="docutils literal notranslate"><span class="pre">RenderEngine</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/render_engines.html#raysect.core.workflow.SerialEngine"><code class="docutils literal notranslate"><span class="pre">SerialEngine</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/render_engines.html#raysect.core.workflow.MulticoreEngine"><code class="docutils literal notranslate"><span class="pre">MulticoreEngine</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/core/utilities.html">1.6. Utilities</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/core/utilities.html#containers">1.6.1. Containers</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/primitives/primitives.html">2. Primitives Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html">2.1. Geometric Primitives</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Box"><code class="docutils literal notranslate"><span class="pre">Box</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Sphere"><code class="docutils literal notranslate"><span class="pre">Sphere</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Cylinder"><code class="docutils literal notranslate"><span class="pre">Cylinder</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Cone"><code class="docutils literal notranslate"><span class="pre">Cone</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Parabola"><code class="docutils literal notranslate"><span class="pre">Parabola</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/geometric_primitives.html#raysect.primitive.Torus"><code class="docutils literal notranslate"><span class="pre">Torus</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/primitives/meshes.html">2.2. Meshes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.mesh.Mesh"><code class="docutils literal notranslate"><span class="pre">Mesh</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.obj.import_obj"><code class="docutils literal notranslate"><span class="pre">import_obj()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.obj.export_obj"><code class="docutils literal notranslate"><span class="pre">export_obj()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.stl.import_stl"><code class="docutils literal notranslate"><span class="pre">import_stl()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.stl.export_stl"><code class="docutils literal notranslate"><span class="pre">export_stl()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.ply.import_ply"><code class="docutils literal notranslate"><span class="pre">import_ply()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.ply.export_ply"><code class="docutils literal notranslate"><span class="pre">export_ply()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.vtk.import_vtk"><code class="docutils literal notranslate"><span class="pre">import_vtk()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/meshes.html#raysect.primitive.mesh.vtk.export_vtk"><code class="docutils literal notranslate"><span class="pre">export_vtk()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/primitives/csg_operations.html">2.3. CSG Operations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/csg_operations.html#raysect.primitive.csg.CSGPrimitive"><code class="docutils literal notranslate"><span class="pre">CSGPrimitive</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/csg_operations.html#raysect.primitive.csg.Union"><code class="docutils literal notranslate"><span class="pre">Union</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/csg_operations.html#raysect.primitive.csg.Intersect"><code class="docutils literal notranslate"><span class="pre">Intersect</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/csg_operations.html#raysect.primitive.csg.Subtract"><code class="docutils literal notranslate"><span class="pre">Subtract</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/primitives/optical_elements.html">2.4. Optical Elements</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/primitives/optical_elements.html#spherical-lenses">2.4.1. Spherical Lenses</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/optical/optical.html">3. Optical Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/main_optical_classes.html">3.1. Main Optical Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/main_optical_classes.html#optical-rays">3.1.1. Optical Rays</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/main_optical_classes.html#spectral-functions">3.1.2. Spectral Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/main_optical_classes.html#colours">3.1.3. Colours</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/main_optical_classes.html#optical-scenegraph">3.1.4. Optical Scenegraph</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/observers.html">3.2. Observers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/observers.html#raysect.optical.observer.base.observer._ObserverBase"><code class="docutils literal notranslate"><span class="pre">_ObserverBase</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/observers.html#d-observers">3.2.1. 0D Observers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/observers.html#id11">3.2.2. 1D Observers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/observers.html#id16">3.2.3. 2D Observers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/pipelines.html">3.3. Frame Samples and Pipelines</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#base-classes">3.3.1. Base Classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#rgb">3.3.2. RGB</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#bayer">3.3.3. Bayer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#power">3.3.4. Power</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#radiance">3.3.5. Radiance</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#spectral">3.3.6. Spectral</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/pipelines.html#frame-samplers">3.3.7. Frame Samplers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html">3.4. Optical Material Base Classes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.Material"><code class="docutils literal notranslate"><span class="pre">Material</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.NullSurface"><code class="docutils literal notranslate"><span class="pre">NullSurface</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.NullVolume"><code class="docutils literal notranslate"><span class="pre">NullVolume</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.DiscreteBSDF"><code class="docutils literal notranslate"><span class="pre">DiscreteBSDF</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_material_base_classes.html#raysect.optical.material.material.ContinuousBSDF"><code class="docutils literal notranslate"><span class="pre">ContinuousBSDF</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/optical_surfaces.html">3.5. Optical Surface Materials</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#absorber">3.5.1. Absorber</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#emitters">3.5.2. Emitters</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#lambertian">3.5.3. Lambertian</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#conductors">3.5.4. Conductors</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#dielectrics">3.5.5. Dielectrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#modifiers">3.5.6. Modifiers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_surfaces.html#debugging">3.5.7. Debugging</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/optical/optical_volumes.html">3.6. Optical Volume Materials</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.UnityVolumeEmitter"><code class="docutils literal notranslate"><span class="pre">UnityVolumeEmitter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.UniformVolumeEmitter"><code class="docutils literal notranslate"><span class="pre">UniformVolumeEmitter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.HomogeneousVolumeEmitter"><code class="docutils literal notranslate"><span class="pre">HomogeneousVolumeEmitter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.InhomogeneousVolumeEmitter"><code class="docutils literal notranslate"><span class="pre">InhomogeneousVolumeEmitter</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.inhomogeneous.VolumeIntegrator"><code class="docutils literal notranslate"><span class="pre">VolumeIntegrator</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api_reference/optical/optical_volumes.html#raysect.optical.material.emitter.inhomogeneous.NumericalIntegrator"><code class="docutils literal notranslate"><span class="pre">NumericalIntegrator</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="introduction.html" class="btn btn-neutral float-right" title="1. Introduction" 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>