<!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>WCSBase — Astropy v0.2.4</title> <link rel="stylesheet" href="../_static/bootstrap-astropy.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.2.4', 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> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="shortcut icon" href="../_static/astropy_logo.ico"/> <link rel="top" title="Astropy v0.2.4" href="../index.html" /> <link rel="up" title="World Coordinate System (astropy.wcs)" href="../wcs/index.html" /> <link rel="next" title="Wcsprm" href="astropy.wcs.Wcsprm.html" /> <link rel="prev" title="WCS" href="astropy.wcs.wcs.WCS.html" /> </head> <body> <div class="topbar"> <a class="brand" title="Documentation Home" href="../index.html"></a> <ul> <li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li> <li><a title="General Index" href="../genindex.html">Index</a></li> <li><a title="Python Module Index" href="../py-modindex.html">Modules</a></li> <li> <form action="../search.html" method="get"> <input type="text" name="q" placeholder="Search" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </li> </ul> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right"> <a href="astropy.wcs.Wcsprm.html" title="Wcsprm"> next » </a> </li> <li class="right"> <a href="astropy.wcs.wcs.WCS.html" title="WCS"> « previous </a> | </li> <li> <a href="../index.html">Astropy v0.2.4</a> » </li> <li><a href="../wcs/index.html" accesskey="U">World Coordinate System (<tt class="docutils literal"><span class="pre">astropy.wcs</span></tt>)</a> »</li> <li>WCSBase</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="wcsbase"> <h1>WCSBase<a class="headerlink" href="#wcsbase" title="Permalink to this headline">¶</a></h1> <dl class="class"> <dt id="astropy.wcs.WCSBase"> <em class="property">class </em><tt class="descclassname">astropy.wcs.</tt><tt class="descname">WCSBase</tt><a class="headerlink" href="#astropy.wcs.WCSBase" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> <p>Wcs objects amalgamate basic WCS (as provided by <a class="reference external" href="http://www.atnf.csiro.au/~mcalabre/WCS/">wcslib</a>), with <a class="reference external" href="http://irsa.ipac.caltech.edu/data/SPITZER/docs/files/spitzer/shupeADASS.pdf">SIP</a> and <a class="reference external" href="http://www.atnf.csiro.au/people/mcalabre/WCS/index.html">Paper IV</a> distortion operations.</p> <p>To perform all distortion corrections and WCS tranformation, use <tt class="xref py py-obj docutils literal"><span class="pre">all_pix2world</span></tt>.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><p class="first"><strong>sip</strong> : <a class="reference internal" href="astropy.wcs.Sip.html#astropy.wcs.Sip" title="astropy.wcs.Sip"><tt class="xref py py-obj docutils literal"><span class="pre">Sip</span></tt></a> object or <tt class="xref py py-obj docutils literal"><span class="pre">None</span></tt></p> <p><strong>cpdis</strong> : A pair of <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> objects, or</p> <blockquote> <div><p><tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt>.</p> </div></blockquote> <p><strong>wcsprm</strong> : <a class="reference internal" href="astropy.wcs.Wcsprm.html#astropy.wcs.Wcsprm" title="astropy.wcs.Wcsprm"><tt class="xref py py-obj docutils literal"><span class="pre">Wcsprm</span></tt></a> object</p> <p><strong>det2im</strong> : A pair of <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> objects, or</p> <blockquote class="last"> <div><p><tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt>.</p> </div></blockquote> </td> </tr> </tbody> </table> <p class="rubric">Attributes Summary</p> <table border="1" class="longtable docutils"> <colgroup> <col width="10%" /> <col width="90%" /> </colgroup> <tbody valign="top"> <tr class="row-odd"><td><a class="reference internal" href="#astropy.wcs.WCSBase.cpdis1" title="astropy.wcs.WCSBase.cpdis1"><tt class="xref py py-obj docutils literal"><span class="pre">cpdis1</span></tt></a></td> <td><a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a></td> </tr> <tr class="row-even"><td><a class="reference internal" href="#astropy.wcs.WCSBase.cpdis2" title="astropy.wcs.WCSBase.cpdis2"><tt class="xref py py-obj docutils literal"><span class="pre">cpdis2</span></tt></a></td> <td><a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a></td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#astropy.wcs.WCSBase.det2im1" title="astropy.wcs.WCSBase.det2im1"><tt class="xref py py-obj docutils literal"><span class="pre">det2im1</span></tt></a></td> <td>A <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> object for detector to image plane correction in the <em>x</em>-axis.</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#astropy.wcs.WCSBase.det2im2" title="astropy.wcs.WCSBase.det2im2"><tt class="xref py py-obj docutils literal"><span class="pre">det2im2</span></tt></a></td> <td>A <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> object for detector to image plane correction in the <em>y</em>-axis.</td> </tr> <tr class="row-odd"><td><a class="reference internal" href="#astropy.wcs.WCSBase.sip" title="astropy.wcs.WCSBase.sip"><tt class="xref py py-obj docutils literal"><span class="pre">sip</span></tt></a></td> <td>Get/set the <a class="reference internal" href="astropy.wcs.Sip.html#astropy.wcs.Sip" title="astropy.wcs.Sip"><tt class="xref py py-obj docutils literal"><span class="pre">Sip</span></tt></a> object for performing <a class="reference external" href="http://irsa.ipac.caltech.edu/data/SPITZER/docs/files/spitzer/shupeADASS.pdf">SIP</a> distortion correction.</td> </tr> <tr class="row-even"><td><a class="reference internal" href="#astropy.wcs.WCSBase.wcs" title="astropy.wcs.WCSBase.wcs"><tt class="xref py py-obj docutils literal"><span class="pre">wcs</span></tt></a></td> <td>A <a class="reference internal" href="astropy.wcs.Wcsprm.html#astropy.wcs.Wcsprm" title="astropy.wcs.Wcsprm"><tt class="xref py py-obj docutils literal"><span class="pre">Wcsprm</span></tt></a> object to perform the basic <a class="reference external" href="http://www.atnf.csiro.au/~mcalabre/WCS/">wcslib</a> WCS transformation.</td> </tr> </tbody> </table> <p class="rubric">Attributes Documentation</p> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.cpdis1"> <tt class="descname">cpdis1</tt><a class="headerlink" href="#astropy.wcs.WCSBase.cpdis1" title="Permalink to this definition">¶</a></dt> <dd><p><a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a></p> <p>The pre-linear transformation distortion lookup table, <tt class="docutils literal"><span class="pre">CPDIS1</span></tt>.</p> </dd></dl> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.cpdis2"> <tt class="descname">cpdis2</tt><a class="headerlink" href="#astropy.wcs.WCSBase.cpdis2" title="Permalink to this definition">¶</a></dt> <dd><p><a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a></p> <p>The pre-linear transformation distortion lookup table, <tt class="docutils literal"><span class="pre">CPDIS2</span></tt>.</p> </dd></dl> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.det2im1"> <tt class="descname">det2im1</tt><a class="headerlink" href="#astropy.wcs.WCSBase.det2im1" title="Permalink to this definition">¶</a></dt> <dd><p>A <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> object for detector to image plane correction in the <em>x</em>-axis.</p> </dd></dl> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.det2im2"> <tt class="descname">det2im2</tt><a class="headerlink" href="#astropy.wcs.WCSBase.det2im2" title="Permalink to this definition">¶</a></dt> <dd><p>A <a class="reference internal" href="astropy.wcs.DistortionLookupTable.html#astropy.wcs.DistortionLookupTable" title="astropy.wcs.DistortionLookupTable"><tt class="xref py py-obj docutils literal"><span class="pre">DistortionLookupTable</span></tt></a> object for detector to image plane correction in the <em>y</em>-axis.</p> </dd></dl> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.sip"> <tt class="descname">sip</tt><a class="headerlink" href="#astropy.wcs.WCSBase.sip" title="Permalink to this definition">¶</a></dt> <dd><p>Get/set the <a class="reference internal" href="astropy.wcs.Sip.html#astropy.wcs.Sip" title="astropy.wcs.Sip"><tt class="xref py py-obj docutils literal"><span class="pre">Sip</span></tt></a> object for performing <a class="reference external" href="http://irsa.ipac.caltech.edu/data/SPITZER/docs/files/spitzer/shupeADASS.pdf">SIP</a> distortion correction.</p> </dd></dl> <dl class="attribute"> <dt id="astropy.wcs.WCSBase.wcs"> <tt class="descname">wcs</tt><a class="headerlink" href="#astropy.wcs.WCSBase.wcs" title="Permalink to this definition">¶</a></dt> <dd><p>A <a class="reference internal" href="astropy.wcs.Wcsprm.html#astropy.wcs.Wcsprm" title="astropy.wcs.Wcsprm"><tt class="xref py py-obj docutils literal"><span class="pre">Wcsprm</span></tt></a> object to perform the basic <a class="reference external" href="http://www.atnf.csiro.au/~mcalabre/WCS/">wcslib</a> WCS transformation.</p> </dd></dl> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"><h3>Page Contents</h3> <ul> <li><a class="reference internal" href="#">WCSBase</a></li> </ul> </div> </div> <div class="clearer"></div> </div> <footer class="footer"> <p class="pull-right"> <a href="../_sources/_generated/astropy.wcs.WCSBase.txt" rel="nofollow">Page Source</a> <a href="#">Back to Top</a></p> <p> © Copyright 2011-2013, The Astropy Developers.<br/> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. Last built 22 Oct 2013. <br/> </p> </footer> </body> </html>