-
Notifications
You must be signed in to change notification settings - Fork 0
/
giant.html
207 lines (177 loc) · 11.5 KB
/
giant.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
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>API Reference — GIANT 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="icon" href="_static/logo.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="giant.camera" href="giant.camera.html" />
<link rel="prev" title="Performing Optical Navigation" href="tutorial/opnav.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a>
</p>
<p class="blurb">A powerful API for Optical Navigation</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=nasa&repo=giant&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installing GIANT</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="#indices">Indices</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="tutorial/opnav.html" title="previous chapter">Performing Optical Navigation</a></li>
<li>Next: <a href="giant.camera.html" title="next chapter">giant.camera</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="tutorial/opnav.html" title="Previous document">Performing Optical Navigation</a>
</li>
<li>
<a href="giant.camera.html" title="Next document">giant.camera</a>
→
</li>
</ul>
</nav>
</div>
<div class="body" role="main">
<section id="api-reference">
<span id="id1"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading">¶</a></h1>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.camera.html#module-giant.camera" title="giant.camera"><code class="xref py py-obj docutils literal notranslate"><span class="pre">camera</span></code></a></p></td>
<td><p>This module defines the Camera object for GIANT, which collects information about a camera and images captured by that camera in a single place and provides some methods for filtering, sorting, and handling the images.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.image.html#module-giant.image" title="giant.image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">image</span></code></a></p></td>
<td><p>This module provides the OpNavImage class, which is the primary image type used by GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.point_spread_functions.html#module-giant.point_spread_functions" title="giant.point_spread_functions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">point_spread_functions</span></code></a></p></td>
<td><p>This package provides classes for creating/using point spread function is GIANT.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.image_processing.html#module-giant.image_processing" title="giant.image_processing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">image_processing</span></code></a></p></td>
<td><p>This module provides a number of image processing techniques for use throughout GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.rotations.html#module-giant.rotations" title="giant.rotations"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rotations</span></code></a></p></td>
<td><p>This module defines a number of useful routines for converting between various attitude and rotation representations as well as a class which acts as the primary way to express attitude and rotation data in GIANT.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.camera_models.html#module-giant.camera_models" title="giant.camera_models"><code class="xref py py-obj docutils literal notranslate"><span class="pre">camera_models</span></code></a></p></td>
<td><p>This package provides classes and functions for creating/using geometric camera models in GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.opnav_class.html#module-giant.opnav_class" title="giant.opnav_class"><code class="xref py py-obj docutils literal notranslate"><span class="pre">opnav_class</span></code></a></p></td>
<td><p>The opnav_class module provides an OpNav object that serves as the foundation for other high-level user interface objects throughout GIANT.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.stellar_opnav.html#module-giant.stellar_opnav" title="giant.stellar_opnav"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stellar_opnav</span></code></a></p></td>
<td><p>This package provides the required routines and objects to identify stars in an image and to estimate attitude based on those identified stars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.relative_opnav.html#module-giant.relative_opnav" title="giant.relative_opnav"><code class="xref py py-obj docutils literal notranslate"><span class="pre">relative_opnav</span></code></a></p></td>
<td><p>This package provides the required routines and objects to extract observables to targets in an image.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.catalogues.html#module-giant.catalogues" title="giant.catalogues"><code class="xref py py-obj docutils literal notranslate"><span class="pre">catalogues</span></code></a></p></td>
<td><p>This package provides access to star catalogues for doing stellar OpNav and calibration in GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.calibration.html#module-giant.calibration" title="giant.calibration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calibration</span></code></a></p></td>
<td><p>This package provides the required routines and objects to identify stars in an image and then estimate attitude, camera pointing alignment, and geometric camera model calibration using the observed stars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.ray_tracer.html#module-giant.ray_tracer" title="giant.ray_tracer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ray_tracer</span></code></a></p></td>
<td><p>This subpackage provides the ray tracing and rendering capabilities for GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.ufo.html#module-giant.ufo" title="giant.ufo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ufo</span></code></a></p></td>
<td><p>This package provides the required routines and objects to identify UFOs in monocular images and track them from frame to frame.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="giant.utilities.html#module-giant.utilities" title="giant.utilities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utilities</span></code></a></p></td>
<td><p>This package provides a few different utility routines for interfacing with external data and general data analysis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="giant.scripts.html#module-giant.scripts" title="giant.scripts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scripts</span></code></a></p></td>
<td><p>This subpackage provides a number of command line scripts to do various tasks in GIANT.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="indices">
<h1>Indices<a class="headerlink" href="#indices" title="Permalink to this heading">¶</a></h1>
<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>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="tutorial/opnav.html" title="Previous document">Performing Optical Navigation</a>
</li>
<li>
<a href="giant.camera.html" title="Next document">giant.camera</a>
→
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2023 United States Government |
NASA Official: <a href="mailto:[email protected]">Andrew Liounis</a> |
Curator: <a href="mailto:[email protected]">Andrew Liounis</a>
<br>
Last updated on Mar 08, 2023 |
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/giant.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>