-
Notifications
You must be signed in to change notification settings - Fork 0
/
giant.catalogues.html
210 lines (180 loc) · 12.4 KB
/
giant.catalogues.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
208
209
210
<!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>catalogues — 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_catalogue" href="catalogues/giant.catalogues.giant_catalogue.html" />
<link rel="prev" title="UnresolvedCenterFinding.target_generator" href="relative_opnav/estimators/unresolved/giant.relative_opnav.estimators.unresolved.UnresolvedCenterFinding.target_generator.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="reference internal" href="giant.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="giant.html#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><a href="giant.html">API Reference</a><ul>
<li>Previous: <a href="relative_opnav/estimators/unresolved/giant.relative_opnav.estimators.unresolved.UnresolvedCenterFinding.target_generator.html" title="previous chapter">UnresolvedCenterFinding.target_generator</a></li>
<li>Next: <a href="catalogues/giant.catalogues.giant_catalogue.html" title="next chapter">giant_catalogue</a></li>
</ul></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="relative_opnav/estimators/unresolved/giant.relative_opnav.estimators.unresolved.UnresolvedCenterFinding.target_generator.html" title="Previous document">UnresolvedCenterFinding.target_generator</a>
</li>
<li>
<a href="catalogues/giant.catalogues.giant_catalogue.html" title="Next document">giant_catalogue</a>
→
</li>
</ul>
</nav>
</div>
<div class="body" role="main">
<section id="module-giant.catalogues">
<span id="catalogues"></span><h1>catalogues<a class="headerlink" href="#module-giant.catalogues" title="Permalink to this heading">¶</a></h1>
<p>This package provides access to star catalogues for doing stellar OpNav and calibration in GIANT.</p>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
<p>A star catalogue in GIANT is primarily responsible for telling us the location of stars in the inertial frame (at a
specific date), the uncertainty on that position (if available), and the magnitude of the star (or how bright it is).
This data is then packaged into a
<a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html">Pandas DataFrame</a> with specific
columns from which GIANT can determine this information.</p>
<p>To get this information, we can use an existing star catalogue, like the Tycho 2 and UCAC4 catalogues, or we can use
the provided GIANT catalogue, which is a merging of the Tycho 2 and UCAC4 catalogues into an efficient SQL format. For
most OpNav scenarios the default GIANT catalogue is sufficient, as it includes stars down to about 18th visual magnitude
and is very efficient for querying data, making stellar OpNav and calibration proceed faster. In some cases, you may
have other requirements for your catalogue (perhaps dimmer stars or you would like to use a different magnitude for your
stars) in which case you can rebuild the GIANT catalogue using the script <a class="reference internal" href="scripts/giant.scripts.build_catalogue.html#module-giant.scripts.build_catalogue" title="giant.scripts.build_catalogue"><code class="xref py py-mod docutils literal notranslate"><span class="pre">build_catalogue</span></code></a>. Just be
aware that rebuilding the catalogue will require you to download the UCAC4 and Tycho 2 catalogues to your computer,
which can take up significant space and can take a long time to download.</p>
</section>
<section id="use">
<h2>Use<a class="headerlink" href="#use" title="Permalink to this heading">¶</a></h2>
<p>Star catalogues in GIANT are accessed through a class, which queries the data from wherever it is stored (normally
locally on your machine.) Typically, you will use the method <code class="xref py py-meth docutils literal notranslate"><span class="pre">query_catalogue()</span></code> with filtering options
for right ascension, declination, and magnitude. This will then return a pandas dataframe with the requested data with
columns of <code class="xref py py-attr docutils literal notranslate"><span class="pre">GIANT_COLUMNS</span></code>, which can then be used however you need. Some catalogues may also provide a method
to return the full dataset for each star (what the full data set it varies from catalogue to catalogue). You will need
to see the documentation for the particular catalogue you care about if you need this information.</p>
<p>If you need to project the queried stars to get their location on an image, then you can use
<code class="xref py py-func docutils literal notranslate"><span class="pre">project_stars_onto_image()</span></code>, from the <a class="reference internal" href="catalogues/giant.catalogues.utilities.html#module-giant.catalogues.utilities" title="giant.catalogues.utilities"><code class="xref py py-mod docutils literal notranslate"><span class="pre">catalogues.utilities</span></code></a> package, which will give you the location of
the stars in pixels.</p>
<p>If you want to add a new star catalogue as a source for GIANT, then first reach out to the developers. We may already
be working on it. If this doesn’t work out, you can also see the <a class="reference internal" href="catalogues/giant.catalogues.meta_catalogue.html#module-giant.catalogues.meta_catalogue" title="giant.catalogues.meta_catalogue"><code class="xref py py-mod docutils literal notranslate"><span class="pre">meta_catalogue</span></code></a> module documentation for more
details on how to define your own catalogue class.</p>
<p>In addition to the Catalogue classes provided in this package, there is also the <a class="reference internal" href="catalogues/giant.catalogues.utilities.html#module-giant.catalogues.utilities" title="giant.catalogues.utilities"><code class="xref py py-mod docutils literal notranslate"><span class="pre">catalogues.utilities</span></code></a> module
which provides utilities for unit/epoch/representation conversions and applying proper motion to star tables. These are
generally useful functions so you may occasionally find yourself using tools from this module as well.</p>
</section>
<p class="rubric">Modules</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="catalogues/giant.catalogues.giant_catalogue.html#module-giant.catalogues.giant_catalogue" title="giant.catalogues.giant_catalogue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">giant_catalogue</span></code></a></p></td>
<td><p>This module defines the interface to the default GIANT star catalogue.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="catalogues/giant.catalogues.meta_catalogue.html#module-giant.catalogues.meta_catalogue" title="giant.catalogues.meta_catalogue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">meta_catalogue</span></code></a></p></td>
<td><p>This module defines the abstract base class (abc) for defining GIANT star catalogues that will work for Stellar OpNav and camera calibration as well as the column definitions for the dataframe used to contain stars in GIANT.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="catalogues/giant.catalogues.tycho.html#module-giant.catalogues.tycho" title="giant.catalogues.tycho"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tycho</span></code></a></p></td>
<td><p>This module defines the interface to the Tycho 2 star catalogue.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="catalogues/giant.catalogues.ucac.html#module-giant.catalogues.ucac" title="giant.catalogues.ucac"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ucac</span></code></a></p></td>
<td><p>This module defines the interface to the UCAC4 star catalogue.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="catalogues/giant.catalogues.utilities.html#module-giant.catalogues.utilities" title="giant.catalogues.utilities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">utilities</span></code></a></p></td>
<td><p>This submodule provides utility constants and functions for working with star data in GIANT.</p></td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
</section>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="relative_opnav/estimators/unresolved/giant.relative_opnav.estimators.unresolved.UnresolvedCenterFinding.target_generator.html" title="Previous document">UnresolvedCenterFinding.target_generator</a>
</li>
<li>
<a href="catalogues/giant.catalogues.giant_catalogue.html" title="Next document">giant_catalogue</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.catalogues.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>