<!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>transform_function — 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="Astronomical Coordinate Systems (astropy.coordinates)" href="../coordinates/index.html" /> <link rel="next" title="Angle" href="astropy.coordinates.angles.Angle.html" /> <link rel="prev" title="static_transform_matrix" href="astropy.coordinates.transformations.static_transform_matrix.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.coordinates.angles.Angle.html" title="Angle"> next » </a> </li> <li class="right"> <a href="astropy.coordinates.transformations.static_transform_matrix.html" title="static_transform_matrix"> « previous </a> | </li> <li> <a href="../index.html">Astropy v0.2.4</a> » </li> <li><a href="../coordinates/index.html" accesskey="U">Astronomical Coordinate Systems (<tt class="docutils literal"><span class="pre">astropy.coordinates</span></tt>)</a> »</li> <li>transform_function</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="transform-function"> <h1>transform_function<a class="headerlink" href="#transform-function" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="astropy.coordinates.transformations.transform_function"> <tt class="descclassname">astropy.coordinates.transformations.</tt><tt class="descname">transform_function</tt><big>(</big><em>fromsys</em>, <em>tosys</em>, <em>copyobstime=True</em>, <em>priority=1</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/coordinates/transformations.py#L729" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/coordinates/transformations.html#transform_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.coordinates.transformations.transform_function" title="Permalink to this definition">¶</a></dt> <dd><p>A function decorator for defining transformations between coordinate systems.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If decorating a static method of a class, <tt class="docutils literal"><span class="pre">@staticmethod</span></tt> should be added <em>above</em> this decorator.</p> </div> <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>fromsys</strong> : class</p> <blockquote> <div><p>The coordinate system this function starts from.</p> </div></blockquote> <p><strong>tosys</strong> : class</p> <blockquote> <div><p>The coordinate system this function results in.</p> </div></blockquote> <p><strong>copyobstime</strong> : bool</p> <blockquote> <div><p>If True (default) the value of the <tt class="xref py py-obj docutils literal"><span class="pre">_obstime</span></tt> attribute will be copied to the newly-produced coordinate.</p> </div></blockquote> <p><strong>priority</strong> : number</p> <blockquote class="last"> <div><p>The priority if this transform when finding the shortest coordinate tranform path - large numbers are lower priorities.</p> </div></blockquote> </td> </tr> </tbody> </table> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"><h3>Page Contents</h3> <ul> <li><a class="reference internal" href="#">transform_function</a></li> </ul> </div> </div> <div class="clearer"></div> </div> <footer class="footer"> <p class="pull-right"> <a href="../_sources/_generated/astropy.coordinates.transformations.transform_function.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>