<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>README — AstroLib Coords 0.39 (2009-01-06) documentation</title>
<link rel="stylesheet" href="_static/stsci_sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.39 (2009-01-06)',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="AstroLib Coords 0.39 (2009-01-06) documentation" href="index.html" />
<link rel="next" title="coords.position.Position" href="position.html" />
<link rel="prev" title="Welcome to AstroLib Coords’s documentation!" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="position.html" title="coords.position.Position"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to AstroLib Coords’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">AstroLib Coords 0.39 (2009-01-06) documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/stsci_logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">README</a><ul>
<li><a class="reference internal" href="#purpose">Purpose</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#tpm-citation">TPM Citation</a></li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to AstroLib Coords’s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="position.html"
title="next chapter">coords.position.Position</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/intro.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="readme">
<h1>README<a class="headerlink" href="#readme" title="Permalink to this headline">¶</a></h1>
<div class="section" id="purpose">
<h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this headline">¶</a></h2>
<p>This package aims to provide much of the IDL “astron” functionality that
pertains to coordinate manipulations in an OO framework. Our target user is
a typical astronomer who needs to analyze data, work with catalogs, prepare
observing proposals, and prepare for observing runs.</p>
<p>The initial version will provide simple functionality for working with
positions in the same reference frame, without having to worry about units.</p>
</div>
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p>numpy</p>
<p>pytpm – a Python wrapper for the TPM library graciously contributed
by Jeff Percival</p>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">astrolib.coords</span> <span class="kn">as</span> <span class="nn">C</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">C</span><span class="o">.</span><span class="n">__version__</span>
<span class="go">0.39</span>
</pre></div>
</div>
<p>Unit conversions</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">ob</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">'12:34:45.34 -23:42:32.6'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">hmsdms</span><span class="p">()</span>
<span class="go">'12:34:45.340 -23:42:32.600'</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">dd</span><span class="p">()</span>
<span class="go">(188.68891666666667, -23.709055555555555)</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">rad</span><span class="p">()</span>
<span class="go">(3.2932428578545374, -0.41380108198269777)</span>
</pre></div>
</div>
<p>Angular separations</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">p1</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"01:23:45.300 +65:43:31.240"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p2</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"01:23:45.62 +65:43:31.20"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">angsep</span><span class="p">(</span><span class="n">p2</span><span class="p">)</span>
<span class="go">0.000548 degrees</span>
<span class="gp">>>> </span><span class="n">delta</span> <span class="o">=</span> <span class="n">p1</span><span class="o">.</span><span class="n">angsep</span><span class="p">(</span><span class="n">p2</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">delta</span><span class="o">.</span><span class="n">arcsec</span><span class="p">()</span>
<span class="go">1.973739377865491</span>
<span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">within</span><span class="p">(</span><span class="n">p2</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">,</span> <span class="n">units</span><span class="o">=</span><span class="s">'arcsec'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">epsilon</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">AngSep</span><span class="p">(</span><span class="mf">5.0</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">epsilon</span>
<span class="go">5.000000 arcsec</span>
<span class="gp">>>> </span><span class="n">delta</span> <span class="o">></span> <span class="n">epsilon</span>
<span class="go">False</span>
</pre></div>
</div>
<p>Astronomical Date specifications</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">d</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">AstroDate</span><span class="p">(</span><span class="s">'1997.3'</span><span class="p">)</span> <span class="c"># Defaults to Julian year; J or B prefix also ok</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">year</span>
<span class="go">1997.3</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">jd</span>
<span class="go">2450558.8250000002</span>
<span class="gp">>>> </span><span class="n">d</span><span class="o">.</span><span class="n">mjd</span>
<span class="go">50558.325000000186</span>
<span class="gp">>>> </span><span class="n">d2</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">AstroDate</span><span class="p">(</span><span class="s">'MJD50658.25'</span><span class="p">)</span> <span class="c"># JD also ok for plain Julian Date</span>
<span class="gp">>>> </span><span class="n">d2</span><span class="o">.</span><span class="n">year</span>
<span class="go">1997.5735797399041</span>
<span class="gp">>>> </span><span class="n">d2</span> <span class="o"><</span> <span class="n">d</span>
<span class="go">False</span>
</pre></div>
</div>
<p>Coordinate conversions</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">j2000</span><span class="p">()</span>
<span class="go">(188.68891666666667, -23.709055555555555)</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">b1950</span><span class="p">()</span>
<span class="go">(188.03056480942405, -23.433637283819877)</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">galactic</span><span class="p">()</span>
<span class="go">(298.01638938748795, 39.003358150874568)</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">ecliptic</span><span class="p">(</span><span class="n">timetag</span><span class="o">=</span><span class="n">C</span><span class="o">.</span><span class="n">AstroDate</span><span class="p">(</span><span class="s">'J2000'</span><span class="p">))</span>
<span class="go">(197.5848634558852, -18.293964120804738)</span>
<span class="gp">>>> </span><span class="n">p3</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"01:23:45 -65:43:21.4"</span><span class="p">,</span><span class="n">equinox</span><span class="o">=</span><span class="s">'J2000'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p4</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"01:23:45 -65:43:21.4"</span><span class="p">,</span><span class="n">equinox</span><span class="o">=</span><span class="s">'B1950'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p3</span><span class="o">.</span><span class="n">j2000</span><span class="p">()</span>
<span class="go">(20.9375, -65.722611111111107)</span>
<span class="gp">>>> </span><span class="n">p4</span><span class="o">.</span><span class="n">j2000</span><span class="p">()</span>
<span class="go">(21.356870704681981, -65.462921080444147)</span>
<span class="gp">>>> </span><span class="n">p3</span><span class="o">.</span><span class="n">angsep</span><span class="p">(</span><span class="n">p4</span><span class="p">)</span>
<span class="go">0.312199 degrees</span>
<span class="gp">>>> </span><span class="n">p5</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">((</span><span class="mf">0.0</span><span class="p">,</span><span class="mf">0.0</span><span class="p">),</span><span class="n">system</span><span class="o">=</span><span class="s">'galactic'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p5</span><span class="o">.</span><span class="n">j2000</span><span class="p">()</span>
<span class="go">(266.40499571858879, -28.936169261309555)</span>
</pre></div>
</div>
<p>Specify position in hmsdms</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">polaris</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"02:31:49.08 +89:15:50.8"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">polaris</span><span class="o">.</span><span class="n">dd</span><span class="p">()</span>
<span class="go">(37.954500000000003, 89.264111111111106)</span>
<span class="gp">>>> </span><span class="n">polaris</span><span class="o">.</span><span class="n">hmsdms</span><span class="p">()</span>
<span class="go">'02:31:49.080 +89:15:50.800'</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">polaris</span><span class="o">.</span><span class="n">details</span><span class="p">()</span>
<span class="go">System: celestial</span>
<span class="go">Equinox: j2000</span>
</pre></div>
</div>
<p>Specify position in decimal degrees</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">ob</span> <span class="o">=</span> <span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">((</span><span class="mf">52.9860209</span><span class="p">,</span> <span class="o">-</span><span class="mf">27.7510006</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">hmsdms</span><span class="p">()</span>
<span class="go">'03:31:56.645 -27:45:03.602'</span>
<span class="gp">>>> </span><span class="n">ob</span><span class="o">.</span><span class="n">dd</span><span class="p">()</span>
<span class="go">(52.9860209, -27.751000600000001)</span>
</pre></div>
</div>
<p>Use as calculator without saving the intermediate object</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">C</span><span class="o">.</span><span class="n">Position</span><span class="p">(</span><span class="s">"12:34:45.4 -22:21:45.4"</span><span class="p">)</span><span class="o">.</span><span class="n">dd</span><span class="p">()</span>
<span class="go">(188.68916666666667, -22.362611111111111)</span>
</pre></div>
</div>
</div>
<div class="section" id="tpm-citation">
<h2>TPM Citation<a class="headerlink" href="#tpm-citation" title="Permalink to this headline">¶</a></h2>
<p>Investigators using this software for their research are requested to
explicitly acknowledge “use of the TPM software library, by Jeffrey W.
Percival” in any appropriate publications.</p>
</div>
<div class="section" id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="http://www.scipy.org/AstroLibCoordsHome">http://www.scipy.org/AstroLibCoordsHome</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="position.html" title="coords.position.Position"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to AstroLib Coords’s documentation!"
>previous</a> |</li>
<li><a href="index.html">AstroLib Coords 0.39 (2009-01-06) documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, Vicki Laidler.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
