<!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>FunctionTransform — 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="GalacticCoordinates" href="astropy.coordinates.builtin_systems.GalacticCoordinates.html" />
<link rel="prev" title="FK5Coordinates" href="astropy.coordinates.builtin_systems.FK5Coordinates.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.builtin_systems.GalacticCoordinates.html" title="GalacticCoordinates">
next »
</a>
</li>
<li class="right">
<a href="astropy.coordinates.builtin_systems.FK5Coordinates.html" title="FK5Coordinates">
« 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>FunctionTransform</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="functiontransform">
<h1>FunctionTransform<a class="headerlink" href="#functiontransform" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="astropy.coordinates.transformations.FunctionTransform">
<em class="property">class </em><tt class="descclassname">astropy.coordinates.transformations.</tt><tt class="descname">FunctionTransform</tt><big>(</big><em>fromsys</em>, <em>tosys</em>, <em>func</em>, <em>copyobstime=True</em>, <em>priority=1</em>, <em>register=True</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/coordinates/transformations.py#L508" 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#FunctionTransform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.coordinates.transformations.FunctionTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">astropy.coordinates.transformations.CoordinateTransform</span></tt></p>
<p>A coordinate transformation defined by a function that simply
accepts a coordinate object and returns the transformed coordinate
object.</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>fromsys</strong> : class</p>
<blockquote>
<div><p>The coordinate system <em>class</em> to start from.</p>
</div></blockquote>
<p><strong>tosys</strong> : class</p>
<blockquote>
<div><p>The coordinate system <em>class</em> to transform into.</p>
</div></blockquote>
<p><strong>func</strong> : callable</p>
<blockquote>
<div><p>The transformation function.</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>
<div><p>The priority if this transform when finding the shortest
coordinate tranform path - large numbers are lower priorities.</p>
</div></blockquote>
<p><strong>register</strong> : bool</p>
<blockquote>
<div><p>Determines if this transformation will be registered in the
astropy master transform graph.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body"><p class="first"><strong>TypeError</strong> :</p>
<blockquote>
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">func</span></tt> is not callable.</p>
</div></blockquote>
<p><strong>ValueError</strong> :</p>
<blockquote class="last">
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">func</span></tt> cannot accept one argument.</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="#">FunctionTransform</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/_generated/astropy.coordinates.transformations.FunctionTransform.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>
