<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>WCSLIB 4.18: spx.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">WCSLIB 4.18
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_af99bb3c152a306abd27951285ad1127.html">C</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">spx.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="wcserr_8h_source.html">wcserr.h</a>"</code><br/>
</div>
<p><a href="spx_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structspxprm.html">spxprm</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Spectral variables and their derivatives. <a href="structspxprm.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a45f0db5bb967998f070cad30e5e68180"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a45f0db5bb967998f070cad30e5e68180">SPXLEN</a>   (sizeof(struct <a class="el" href="structspxprm.html">spxprm</a>)/sizeof(int))</td></tr>
<tr class="memdesc:a45f0db5bb967998f070cad30e5e68180"><td class="mdescLeft"> </td><td class="mdescRight">Size of the spxprm struct in <em>int</em> units. <a href="#a45f0db5bb967998f070cad30e5e68180">More...</a><br/></td></tr>
<tr class="separator:a45f0db5bb967998f070cad30e5e68180"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a777e5c4790da397aefcada61445a1bb3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a></td></tr>
<tr class="memdesc:a777e5c4790da397aefcada61445a1bb3"><td class="mdescLeft"> </td><td class="mdescRight">For use in declaring spectral conversion function prototypes. <a href="#a777e5c4790da397aefcada61445a1bb3">More...</a><br/></td></tr>
<tr class="separator:a777e5c4790da397aefcada61445a1bb3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad99a404f496d5b8ce3ef6e53c630ecaf"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecaf">spx_errmsg</a> { <br/>
  <a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecafa45313ec670a74e7effc1bcee16cb0b56">SPXERR_SUCCESS</a> = 0,
<a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecafa7342349cd1dc5b4581ae9c39f31d055e">SPXERR_NULL_POINTER</a> = 1,
<a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecafa23753b512249d3752a74ce7497d9c852">SPXERR_BAD_SPEC_PARAMS</a> = 2,
<a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecafa6b6639fb6d3683c9d356dbd7cf705de1">SPXERR_BAD_SPEC_VAR</a> = 3,
<br/>
  <a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecafae795e388e346496b34e57864af841ae2">SPXERR_BAD_INSPEC_COORD</a> = 4
<br/>
}</td></tr>
<tr class="separator:ad99a404f496d5b8ce3ef6e53c630ecaf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a192c7ea1edb2fc79d391a51bec7442e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a192c7ea1edb2fc79d391a51bec7442e0">specx</a> (const char *type, double spec, double restfrq, double restwav, struct <a class="el" href="structspxprm.html">spxprm</a> *specs)</td></tr>
<tr class="memdesc:a192c7ea1edb2fc79d391a51bec7442e0"><td class="mdescLeft"> </td><td class="mdescRight">Spectral cross conversions (scalar). <a href="#a192c7ea1edb2fc79d391a51bec7442e0">More...</a><br/></td></tr>
<tr class="separator:a192c7ea1edb2fc79d391a51bec7442e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ee182e1185978bc6e7f69e4604fe341"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341">freqafrq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a6ee182e1185978bc6e7f69e4604fe341"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to angular frequency (vector). <a href="#a6ee182e1185978bc6e7f69e4604fe341">More...</a><br/></td></tr>
<tr class="separator:a6ee182e1185978bc6e7f69e4604fe341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0a5167b8e52a0cdc3990e35a324ba02"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#ad0a5167b8e52a0cdc3990e35a324ba02">afrqfreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:ad0a5167b8e52a0cdc3990e35a324ba02"><td class="mdescLeft"> </td><td class="mdescRight">Convert angular frequency to frequency (vector). <a href="#ad0a5167b8e52a0cdc3990e35a324ba02">More...</a><br/></td></tr>
<tr class="separator:ad0a5167b8e52a0cdc3990e35a324ba02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c2eb2d8649eaab21e71efcd25d9236c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a5c2eb2d8649eaab21e71efcd25d9236c">freqener</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a5c2eb2d8649eaab21e71efcd25d9236c"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to photon energy (vector). <a href="#a5c2eb2d8649eaab21e71efcd25d9236c">More...</a><br/></td></tr>
<tr class="separator:a5c2eb2d8649eaab21e71efcd25d9236c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89a689b848429cfa5780757a5eee9347"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a89a689b848429cfa5780757a5eee9347">enerfreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a89a689b848429cfa5780757a5eee9347"><td class="mdescLeft"> </td><td class="mdescRight">Convert photon energy to frequency (vector). <a href="#a89a689b848429cfa5780757a5eee9347">More...</a><br/></td></tr>
<tr class="separator:a89a689b848429cfa5780757a5eee9347"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9eb861d7c7437c5f974ad425da8b5664"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a9eb861d7c7437c5f974ad425da8b5664">freqwavn</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a9eb861d7c7437c5f974ad425da8b5664"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to wave number (vector). <a href="#a9eb861d7c7437c5f974ad425da8b5664">More...</a><br/></td></tr>
<tr class="separator:a9eb861d7c7437c5f974ad425da8b5664"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5eed4e6f2879b4607e60b4f77e2736bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a5eed4e6f2879b4607e60b4f77e2736bd">wavnfreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a5eed4e6f2879b4607e60b4f77e2736bd"><td class="mdescLeft"> </td><td class="mdescRight">Convert wave number to frequency (vector). <a href="#a5eed4e6f2879b4607e60b4f77e2736bd">More...</a><br/></td></tr>
<tr class="separator:a5eed4e6f2879b4607e60b4f77e2736bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51b714ff0ed788c20f1b273ec551b6f6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a51b714ff0ed788c20f1b273ec551b6f6">freqwave</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a51b714ff0ed788c20f1b273ec551b6f6"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to vacuum wavelength (vector). <a href="#a51b714ff0ed788c20f1b273ec551b6f6">More...</a><br/></td></tr>
<tr class="separator:a51b714ff0ed788c20f1b273ec551b6f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c79d97dcc410e1a7a3e6e26ba3dabe6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a6c79d97dcc410e1a7a3e6e26ba3dabe6">wavefreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a6c79d97dcc410e1a7a3e6e26ba3dabe6"><td class="mdescLeft"> </td><td class="mdescRight">Convert vacuum wavelength to frequency (vector). <a href="#a6c79d97dcc410e1a7a3e6e26ba3dabe6">More...</a><br/></td></tr>
<tr class="separator:a6c79d97dcc410e1a7a3e6e26ba3dabe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e86c3462619b4fdf0aeeeea9874757e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a3e86c3462619b4fdf0aeeeea9874757e">freqawav</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a3e86c3462619b4fdf0aeeeea9874757e"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to air wavelength (vector). <a href="#a3e86c3462619b4fdf0aeeeea9874757e">More...</a><br/></td></tr>
<tr class="separator:a3e86c3462619b4fdf0aeeeea9874757e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16bc2fef69c592c5bcdc695633f17df0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a16bc2fef69c592c5bcdc695633f17df0">awavfreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a16bc2fef69c592c5bcdc695633f17df0"><td class="mdescLeft"> </td><td class="mdescRight">Convert air wavelength to frequency (vector). <a href="#a16bc2fef69c592c5bcdc695633f17df0">More...</a><br/></td></tr>
<tr class="separator:a16bc2fef69c592c5bcdc695633f17df0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a497ffd57345f2f0bf1c9abc56842c4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a5a497ffd57345f2f0bf1c9abc56842c4">waveawav</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a5a497ffd57345f2f0bf1c9abc56842c4"><td class="mdescLeft"> </td><td class="mdescRight">Convert vacuum wavelength to air wavelength (vector). <a href="#a5a497ffd57345f2f0bf1c9abc56842c4">More...</a><br/></td></tr>
<tr class="separator:a5a497ffd57345f2f0bf1c9abc56842c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a413fa882d2b67a792a35938738214057"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a413fa882d2b67a792a35938738214057">awavwave</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a413fa882d2b67a792a35938738214057"><td class="mdescLeft"> </td><td class="mdescRight">Convert air wavelength to vacuum wavelength (vector). <a href="#a413fa882d2b67a792a35938738214057">More...</a><br/></td></tr>
<tr class="separator:a413fa882d2b67a792a35938738214057"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8aba8fe47efe098740991771e97fe756"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a8aba8fe47efe098740991771e97fe756">velobeta</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a8aba8fe47efe098740991771e97fe756"><td class="mdescLeft"> </td><td class="mdescRight">Convert relativistic velocity to relativistic beta (vector). <a href="#a8aba8fe47efe098740991771e97fe756">More...</a><br/></td></tr>
<tr class="separator:a8aba8fe47efe098740991771e97fe756"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09b951b08ac818b9da44389a3ddf614a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a09b951b08ac818b9da44389a3ddf614a">betavelo</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a09b951b08ac818b9da44389a3ddf614a"><td class="mdescLeft"> </td><td class="mdescRight">Convert relativistic beta to relativistic velocity (vector). <a href="#a09b951b08ac818b9da44389a3ddf614a">More...</a><br/></td></tr>
<tr class="separator:a09b951b08ac818b9da44389a3ddf614a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa626b0cad9206c62e7e265bdf8c92c31"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31">freqvelo</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:aa626b0cad9206c62e7e265bdf8c92c31"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to relativistic velocity (vector). <a href="#aa626b0cad9206c62e7e265bdf8c92c31">More...</a><br/></td></tr>
<tr class="separator:aa626b0cad9206c62e7e265bdf8c92c31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a974f799a8ee19dd23114ca01b225a02f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a974f799a8ee19dd23114ca01b225a02f">velofreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a974f799a8ee19dd23114ca01b225a02f"><td class="mdescLeft"> </td><td class="mdescRight">Convert relativistic velocity to frequency (vector). <a href="#a974f799a8ee19dd23114ca01b225a02f">More...</a><br/></td></tr>
<tr class="separator:a974f799a8ee19dd23114ca01b225a02f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4784a764fd0f36c82548ef755c470bd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#af4784a764fd0f36c82548ef755c470bd">freqvrad</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:af4784a764fd0f36c82548ef755c470bd"><td class="mdescLeft"> </td><td class="mdescRight">Convert frequency to radio velocity (vector). <a href="#af4784a764fd0f36c82548ef755c470bd">More...</a><br/></td></tr>
<tr class="separator:af4784a764fd0f36c82548ef755c470bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a772a14e27c613ea7b63697efdb765205"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a772a14e27c613ea7b63697efdb765205">vradfreq</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a772a14e27c613ea7b63697efdb765205"><td class="mdescLeft"> </td><td class="mdescRight">Convert radio velocity to frequency (vector). <a href="#a772a14e27c613ea7b63697efdb765205">More...</a><br/></td></tr>
<tr class="separator:a772a14e27c613ea7b63697efdb765205"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0459c65496512f270d3c569c346ce413"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a0459c65496512f270d3c569c346ce413">wavevelo</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a0459c65496512f270d3c569c346ce413"><td class="mdescLeft"> </td><td class="mdescRight">Conversions between wavelength and velocity types (vector). <a href="#a0459c65496512f270d3c569c346ce413">More...</a><br/></td></tr>
<tr class="separator:a0459c65496512f270d3c569c346ce413"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc02a893f538f5f0c0d1d9baae2b0e10"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#acc02a893f538f5f0c0d1d9baae2b0e10">velowave</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:acc02a893f538f5f0c0d1d9baae2b0e10"><td class="mdescLeft"> </td><td class="mdescRight">Convert relativistic velocity to vacuum wavelength (vector). <a href="#acc02a893f538f5f0c0d1d9baae2b0e10">More...</a><br/></td></tr>
<tr class="separator:acc02a893f538f5f0c0d1d9baae2b0e10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7a2d05c2db901488d68576343aad873"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#af7a2d05c2db901488d68576343aad873">awavvelo</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:af7a2d05c2db901488d68576343aad873"><td class="mdescLeft"> </td><td class="mdescRight">Convert air wavelength to relativistic velocity (vector). <a href="#af7a2d05c2db901488d68576343aad873">More...</a><br/></td></tr>
<tr class="separator:af7a2d05c2db901488d68576343aad873"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56a7d77413c654541fb29f58561c16f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a56a7d77413c654541fb29f58561c16f9">veloawav</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a56a7d77413c654541fb29f58561c16f9"><td class="mdescLeft"> </td><td class="mdescRight">Convert relativistic velocity to air wavelength (vector). <a href="#a56a7d77413c654541fb29f58561c16f9">More...</a><br/></td></tr>
<tr class="separator:a56a7d77413c654541fb29f58561c16f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61a1980ff0683231529b784af1c48eaa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a61a1980ff0683231529b784af1c48eaa">wavevopt</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a61a1980ff0683231529b784af1c48eaa"><td class="mdescLeft"> </td><td class="mdescRight">Convert vacuum wavelength to optical velocity (vector). <a href="#a61a1980ff0683231529b784af1c48eaa">More...</a><br/></td></tr>
<tr class="separator:a61a1980ff0683231529b784af1c48eaa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab23cb997ad699b59f91f4dfe4e8b28b0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#ab23cb997ad699b59f91f4dfe4e8b28b0">voptwave</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:ab23cb997ad699b59f91f4dfe4e8b28b0"><td class="mdescLeft"> </td><td class="mdescRight">Convert optical velocity to vacuum wavelength (vector). <a href="#ab23cb997ad699b59f91f4dfe4e8b28b0">More...</a><br/></td></tr>
<tr class="separator:ab23cb997ad699b59f91f4dfe4e8b28b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a544be13048057701c37a8e9c4f761be2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a544be13048057701c37a8e9c4f761be2">wavezopt</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:a544be13048057701c37a8e9c4f761be2"><td class="mdescLeft"> </td><td class="mdescRight">Convert vacuum wavelength to redshift (vector). <a href="#a544be13048057701c37a8e9c4f761be2">More...</a><br/></td></tr>
<tr class="separator:a544be13048057701c37a8e9c4f761be2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada5d4cf3e8791d64da68575da692e3f3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#ada5d4cf3e8791d64da68575da692e3f3">zoptwave</a> (<a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a>)</td></tr>
<tr class="memdesc:ada5d4cf3e8791d64da68575da692e3f3"><td class="mdescLeft"> </td><td class="mdescRight">Convert redshift to vacuum wavelength (vector). <a href="#ada5d4cf3e8791d64da68575da692e3f3">More...</a><br/></td></tr>
<tr class="separator:ada5d4cf3e8791d64da68575da692e3f3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a286f473d94247fbd7c2485e515fee67f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="spx_8h.html#a286f473d94247fbd7c2485e515fee67f">spx_errmsg</a> []</td></tr>
<tr class="separator:a286f473d94247fbd7c2485e515fee67f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="spx_8h.html#a192c7ea1edb2fc79d391a51bec7442e0" title="Spectral cross conversions (scalar). ">specx()</a> is a scalar routine that, given one spectral variable (e.g. frequency), computes all the others (e.g. wavelength, velocity, etc.) plus the required derivatives of each with respect to the others. The results are returned in the spxprm struct.</p>
<p>The remaining routines are all vector conversions from one spectral variable to another. The API of these functions only differ in whether the rest frequency or wavelength need be supplied.</p>
<p><b>Non-linear:</b> <br/>
</p>
<ul>
<li>
<a class="el" href="spx_8h.html#a51b714ff0ed788c20f1b273ec551b6f6" title="Convert frequency to vacuum wavelength (vector). ">freqwave()</a> frequency -> vacuum wavelength </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a6c79d97dcc410e1a7a3e6e26ba3dabe6" title="Convert vacuum wavelength to frequency (vector). ">wavefreq()</a> vacuum wavelength -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a3e86c3462619b4fdf0aeeeea9874757e" title="Convert frequency to air wavelength (vector). ">freqawav()</a> frequency -> air wavelength </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a16bc2fef69c592c5bcdc695633f17df0" title="Convert air wavelength to frequency (vector). ">awavfreq()</a> air wavelength -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> frequency -> relativistic velocity </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a974f799a8ee19dd23114ca01b225a02f" title="Convert relativistic velocity to frequency (vector). ">velofreq()</a> relativistic velocity -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a5a497ffd57345f2f0bf1c9abc56842c4" title="Convert vacuum wavelength to air wavelength (vector). ">waveawav()</a> vacuum wavelength -> air wavelength </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a413fa882d2b67a792a35938738214057" title="Convert air wavelength to vacuum wavelength (vector). ">awavwave()</a> air wavelength -> vacuum wavelength</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a0459c65496512f270d3c569c346ce413" title="Conversions between wavelength and velocity types (vector). ">wavevelo()</a> vacuum wavelength -> relativistic velocity </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#acc02a893f538f5f0c0d1d9baae2b0e10" title="Convert relativistic velocity to vacuum wavelength (vector). ">velowave()</a> relativistic velocity -> vacuum wavelength</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#af7a2d05c2db901488d68576343aad873" title="Convert air wavelength to relativistic velocity (vector). ">awavvelo()</a> air wavelength -> relativistic velocity </li>
<li>
<a class="el" href="spx_8h.html#a56a7d77413c654541fb29f58561c16f9" title="Convert relativistic velocity to air wavelength (vector). ">veloawav()</a> relativistic velocity -> air wavelength </li>
</ul>
<p><b>Linear:</b> <br/>
</p>
<ul>
<li>
<a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> frequency -> angular frequency </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#ad0a5167b8e52a0cdc3990e35a324ba02" title="Convert angular frequency to frequency (vector). ">afrqfreq()</a> angular frequency -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a5c2eb2d8649eaab21e71efcd25d9236c" title="Convert frequency to photon energy (vector). ">freqener()</a> frequency -> energy </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a89a689b848429cfa5780757a5eee9347" title="Convert photon energy to frequency (vector). ">enerfreq()</a> energy -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a9eb861d7c7437c5f974ad425da8b5664" title="Convert frequency to wave number (vector). ">freqwavn()</a> frequency -> wave number </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a5eed4e6f2879b4607e60b4f77e2736bd" title="Convert wave number to frequency (vector). ">wavnfreq()</a> wave number -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#af4784a764fd0f36c82548ef755c470bd" title="Convert frequency to radio velocity (vector). ">freqvrad()</a> frequency -> radio velocity </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#a772a14e27c613ea7b63697efdb765205" title="Convert radio velocity to frequency (vector). ">vradfreq()</a> radio velocity -> frequency</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a61a1980ff0683231529b784af1c48eaa" title="Convert vacuum wavelength to optical velocity (vector). ">wavevopt()</a> vacuum wavelength -> optical velocity </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#ab23cb997ad699b59f91f4dfe4e8b28b0" title="Convert optical velocity to vacuum wavelength (vector). ">voptwave()</a> optical velocity -> vacuum wavelength</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a544be13048057701c37a8e9c4f761be2" title="Convert vacuum wavelength to redshift (vector). ">wavezopt()</a> vacuum wavelength -> redshift </li>
<li>
<p class="startli"><a class="el" href="spx_8h.html#ada5d4cf3e8791d64da68575da692e3f3" title="Convert redshift to vacuum wavelength (vector). ">zoptwave()</a> redshift -> vacuum wavelength</p>
<p class="endli"></p>
</li>
<li>
<a class="el" href="spx_8h.html#a8aba8fe47efe098740991771e97fe756" title="Convert relativistic velocity to relativistic beta (vector). ">velobeta()</a> relativistic velocity -> beta ( <img class="formulaInl" alt="$\beta = v/c$" src="form_52.png"/>) </li>
<li>
<a class="el" href="spx_8h.html#a09b951b08ac818b9da44389a3ddf614a" title="Convert relativistic beta to relativistic velocity (vector). ">betavelo()</a> beta ( <img class="formulaInl" alt="$\beta = v/c$" src="form_52.png"/>) -> relativistic velocity </li>
</ul>
<p>These are the workhorse routines, to be used for fast transformations. Conversions may be done "in place" by calling the routine with the output vector set to the input.</p>
<p><b>Argument checking:</b> <br/>
The input spectral values are only checked for values that would result in floating point exceptions. In particular, negative frequencies and wavelengths are allowed, as are velocities greater than the speed of light. The same is true for the spectral parameters - rest frequency and wavelength.</p>
<p><b>Accuracy:</b> <br/>
No warranty is given for the accuracy of these routines (refer to the copyright notice); intending users must satisfy for themselves their adequacy for the intended purpose. However, closure effectively to within double precision rounding error was demonstrated by test routine tspec.c which accompanies this software. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a45f0db5bb967998f070cad30e5e68180"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SPXLEN   (sizeof(struct <a class="el" href="structspxprm.html">spxprm</a>)/sizeof(int))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the spxprm struct in <em>int</em> units, used by the Fortran wrappers. </p>
</div>
</div>
<a class="anchor" id="a777e5c4790da397aefcada61445a1bb3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SPX_ARGS</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">double</span> param, <span class="keywordtype">int</span> nspec, <span class="keywordtype">int</span> instep, <span class="keywordtype">int</span> outstep, \</div>
<div class="line"> const <span class="keywordtype">double</span> inspec[], <span class="keywordtype">double</span> outspec[], <span class="keywordtype">int</span> stat[]</div>
</div><!-- fragment --><p>Preprocessor macro used for declaring spectral conversion function prototypes. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecaf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecaf">spx_errmsg</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecafa45313ec670a74e7effc1bcee16cb0b56"></a>SPXERR_SUCCESS</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecafa7342349cd1dc5b4581ae9c39f31d055e"></a>SPXERR_NULL_POINTER</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecafa23753b512249d3752a74ce7497d9c852"></a>SPXERR_BAD_SPEC_PARAMS</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecafa6b6639fb6d3683c9d356dbd7cf705de1"></a>SPXERR_BAD_SPEC_VAR</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ad99a404f496d5b8ce3ef6e53c630ecafae795e388e346496b34e57864af841ae2"></a>SPXERR_BAD_INSPEC_COORD</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a192c7ea1edb2fc79d391a51bec7442e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int specx </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>spec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>restfrq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>restwav</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structspxprm.html">spxprm</a> * </td>
<td class="paramname"><em>specs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Given one spectral variable <b>specx</b>() computes all the others, plus the required derivatives of each with respect to the others.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of spectral variable given by spec, <code><b>FREQ</b></code>, <code><b>AFRQ</b></code>, <code><b>ENER</b></code>, <code><b>WAVN</b></code>, <code><b>VRAD</b></code>, <code><b>WAVE</b></code>, <code><b>VOPT</b></code>, <code><b>ZOPT</b></code>, <code><b>AWAV</b></code>, <code><b>VELO</b></code>, or <code><b>BETA</b></code> (case sensitive). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">spec</td><td>The spectral variable given, in SI units. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">restfrq,restwav</td><td>Rest frequency [Hz] or rest wavelength in vacuo [m], only one of which need be given. The other should be set to zero. If both are zero, only a subset of the spectral variables can be computed, the remainder are set to zero. Specifically, given one of <code><b>FREQ</b></code>, <code><b>AFRQ</b></code>, <code><b>ENER</b></code>, <code><b>WAVN</b></code>, <code><b>WAVE</b></code>, or <code><b>AWAV</b></code> the others can be computed without knowledge of the rest frequency. Likewise, <code><b>VRAD</b></code>, <code><b>VOPT</b></code>, <code><b>ZOPT</b></code>, <code><b>VELO</b></code>, and <code><b>BETA</b></code>.</td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">specs</td><td>Data structure containing all spectral variables and their derivatives, in SI units.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status return value:<ul>
<li>0: Success.</li>
<li>1: Null spxprm pointer passed.</li>
<li>2: Invalid spectral parameters.</li>
<li>3: Invalid spectral variable.</li>
</ul>
For returns > 1, a detailed error message is set in <a class="el" href="structspxprm.html#ab232cb470b7f96330512dea46791644e">spxprm::err</a> if enabled, see <a class="el" href="wcserr_8h.html#a1691b8bd184d40ca6fda255be078fa53" title="Enable/disable error messaging. ">wcserr_enable()</a>.</dd></dl>
<p><a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a>, <a class="el" href="spx_8h.html#ad0a5167b8e52a0cdc3990e35a324ba02" title="Convert angular frequency to frequency (vector). ">afrqfreq()</a>, <a class="el" href="spx_8h.html#a5c2eb2d8649eaab21e71efcd25d9236c" title="Convert frequency to photon energy (vector). ">freqener()</a>, <a class="el" href="spx_8h.html#a89a689b848429cfa5780757a5eee9347" title="Convert photon energy to frequency (vector). ">enerfreq()</a>, <a class="el" href="spx_8h.html#a9eb861d7c7437c5f974ad425da8b5664" title="Convert frequency to wave number (vector). ">freqwavn()</a>, <a class="el" href="spx_8h.html#a5eed4e6f2879b4607e60b4f77e2736bd" title="Convert wave number to frequency (vector). ">wavnfreq()</a>, <a class="el" href="spx_8h.html#a51b714ff0ed788c20f1b273ec551b6f6" title="Convert frequency to vacuum wavelength (vector). ">freqwave()</a>, <a class="el" href="spx_8h.html#a6c79d97dcc410e1a7a3e6e26ba3dabe6" title="Convert vacuum wavelength to frequency (vector). ">wavefreq()</a>, <a class="el" href="spx_8h.html#a3e86c3462619b4fdf0aeeeea9874757e" title="Convert frequency to air wavelength (vector). ">freqawav()</a>, <a class="el" href="spx_8h.html#a16bc2fef69c592c5bcdc695633f17df0" title="Convert air wavelength to frequency (vector). ">awavfreq()</a>, <a class="el" href="spx_8h.html#a5a497ffd57345f2f0bf1c9abc56842c4" title="Convert vacuum wavelength to air wavelength (vector). ">waveawav()</a>, <a class="el" href="spx_8h.html#a413fa882d2b67a792a35938738214057" title="Convert air wavelength to vacuum wavelength (vector). ">awavwave()</a>, <a class="el" href="spx_8h.html#a8aba8fe47efe098740991771e97fe756" title="Convert relativistic velocity to relativistic beta (vector). ">velobeta()</a>, and <a class="el" href="spx_8h.html#a09b951b08ac818b9da44389a3ddf614a" title="Convert relativistic beta to relativistic velocity (vector). ">betavelo()</a> implement vector conversions between wave-like or velocity-like spectral types (i.e. conversions that do not need the rest frequency or wavelength). They all have the same API. </p>
</div>
</div>
<a class="anchor" id="a6ee182e1185978bc6e7f69e4604fe341"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqafrq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqafrq</b>() converts frequency to angular frequency.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Ignored. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nspec</td><td>Vector length. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">instep,outstep</td><td>Vector strides. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inspec</td><td>Input spectral variables, in SI units.</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">outspec</td><td>Output spectral variables, in SI units. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">stat</td><td>Status return value for each vector element:<ul>
<li>0: Success.</li>
<li>1: Invalid value of inspec.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status return value:<ul>
<li>0: Success.</li>
<li>2: Invalid spectral parameters.</li>
<li>4: One or more of the inspec coordinates were invalid, as indicated by the stat vector. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ad0a5167b8e52a0cdc3990e35a324ba02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int afrqfreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>afrqfreq</b>() converts angular frequency to frequency.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a5c2eb2d8649eaab21e71efcd25d9236c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqener</b>() converts frequency to photon energy.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a89a689b848429cfa5780757a5eee9347"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int enerfreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>enerfreq</b>() converts photon energy to frequency.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a9eb861d7c7437c5f974ad425da8b5664"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqwavn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqwavn</b>() converts frequency to wave number.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a5eed4e6f2879b4607e60b4f77e2736bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wavnfreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>wavnfreq</b>() converts wave number to frequency.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a51b714ff0ed788c20f1b273ec551b6f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqwave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqwave</b>() converts frequency to vacuum wavelength.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a6c79d97dcc410e1a7a3e6e26ba3dabe6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wavefreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>wavefreq</b>() converts vacuum wavelength to frequency.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a3e86c3462619b4fdf0aeeeea9874757e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqawav </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqawav</b>() converts frequency to air wavelength.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a16bc2fef69c592c5bcdc695633f17df0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int awavfreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>awavfreq</b>() converts air wavelength to frequency.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a5a497ffd57345f2f0bf1c9abc56842c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int waveawav </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>waveawav</b>() converts vacuum wavelength to air wavelength.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a413fa882d2b67a792a35938738214057"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int awavwave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>awavwave</b>() converts air wavelength to vacuum wavelength.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a8aba8fe47efe098740991771e97fe756"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int velobeta </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>velobeta</b>() converts relativistic velocity to relativistic beta.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a09b951b08ac818b9da44389a3ddf614a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int betavelo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>betavelo</b>() converts relativistic beta to relativistic velocity.</p>
<p>See <a class="el" href="spx_8h.html#a6ee182e1185978bc6e7f69e4604fe341" title="Convert frequency to angular frequency (vector). ">freqafrq()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="aa626b0cad9206c62e7e265bdf8c92c31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqvelo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqvelo</b>() converts frequency to relativistic velocity.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Rest frequency [Hz]. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nspec</td><td>Vector length. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">instep,outstep</td><td>Vector strides. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inspec</td><td>Input spectral variables, in SI units.</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">outspec</td><td>Output spectral variables, in SI units. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">stat</td><td>Status return value for each vector element:<ul>
<li>0: Success.</li>
<li>1: Invalid value of inspec.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status return value:<ul>
<li>0: Success.</li>
<li>2: Invalid spectral parameters.</li>
<li>4: One or more of the inspec coordinates were invalid, as indicated by the stat vector. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a974f799a8ee19dd23114ca01b225a02f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int velofreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>velofreq</b>() converts relativistic velocity to frequency.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="af4784a764fd0f36c82548ef755c470bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int freqvrad </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>freqvrad</b>() converts frequency to radio velocity.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a772a14e27c613ea7b63697efdb765205"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vradfreq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>vradfreq</b>() converts radio velocity to frequency.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a0459c65496512f270d3c569c346ce413"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wavevelo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>wavevelo</b>() converts vacuum wavelength to relativistic velocity.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Rest wavelength in vacuo [m]. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nspec</td><td>Vector length. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">instep,outstep</td><td>Vector strides. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inspec</td><td>Input spectral variables, in SI units.</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">outspec</td><td>Output spectral variables, in SI units. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">stat</td><td>Status return value for each vector element:<ul>
<li>0: Success.</li>
<li>1: Invalid value of inspec.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Status return value:<ul>
<li>0: Success.</li>
<li>2: Invalid spectral parameters.</li>
<li>4: One or more of the inspec coordinates were invalid, as indicated by the stat vector. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="acc02a893f538f5f0c0d1d9baae2b0e10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int velowave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>velowave</b>() converts relativistic velocity to vacuum wavelength.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="af7a2d05c2db901488d68576343aad873"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int awavvelo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>awavvelo</b>() converts air wavelength to relativistic velocity.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a56a7d77413c654541fb29f58561c16f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int veloawav </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>veloawav</b>() converts relativistic velocity to air wavelength.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a61a1980ff0683231529b784af1c48eaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wavevopt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>wavevopt</b>() converts vacuum wavelength to optical velocity.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="ab23cb997ad699b59f91f4dfe4e8b28b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int voptwave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>voptwave</b>() converts optical velocity to vacuum wavelength.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="a544be13048057701c37a8e9c4f761be2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wavezopt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>wavevopt</b>() converts vacuum wavelength to redshift.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<a class="anchor" id="ada5d4cf3e8791d64da68575da692e3f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int zoptwave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="spx_8h.html#a777e5c4790da397aefcada61445a1bb3">SPX_ARGS</a> </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><b>zoptwave</b>() converts redshift to vacuum wavelength.</p>
<p>See <a class="el" href="spx_8h.html#aa626b0cad9206c62e7e265bdf8c92c31" title="Convert frequency to relativistic velocity (vector). ">freqvelo()</a> for a description of the API. </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a286f473d94247fbd7c2485e515fee67f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="spx_8h.html#ad99a404f496d5b8ce3ef6e53c630ecaf">spx_errmsg</a>[]</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jul 13 2013 20:00:26 for WCSLIB 4.18 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
