

<!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>pulsar – Creates/stores a pulsar object &mdash; PsrPopPy 1 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1',
        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="PsrPopPy 1 documentation" href="index.html" /> 
  </head>
  <body>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="index.html"><img src="_static/logo2.png" border="0" alt="py4sci"/></a>
</div>

    <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="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">home</a>|&nbsp;</li>
        <li><a href="search.html">search</a>|&nbsp;</li>
 
      </ul>
    </div>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/pulsar_module_docs.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="module-pulsar">
<span id="pulsar-creates-stores-a-pulsar-object"></span><h1><a class="reference internal" href="#module-pulsar" title="pulsar: The pulsar object"><tt class="xref py py-mod docutils literal"><span class="pre">pulsar</span></tt></a> &#8211; Creates/stores a pulsar object<a class="headerlink" href="#module-pulsar" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pulsar.Pulsar">
<em class="property">class </em><tt class="descclassname">pulsar.</tt><tt class="descname">Pulsar</tt><a class="headerlink" href="#pulsar.Pulsar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pulsar.Pulsar.__init__">
<tt class="descclassname">Pulsar.</tt><tt class="descname">__init__</tt><big>(</big><span class="optional">[</span><em>period</em>, <em>dm</em>, <em>gl</em>, <em>gb</em>, <em>galCoords</em>, <em>r0</em>, <em>dtrue</em>, <em>lum_1400</em>, <em>spindex</em>, <em>alpha</em>, <em>rho</em>, <em>width_degree</em>, <em>snr</em>, <em>beaming</em>, <em>scindex</em>, <em>gpsFlag</em>, <em>gpsA</em>, <em>brokenFlag</em>, <em>brokenSI</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#pulsar.Pulsar.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialise the pulsar object</p>
</dd></dl>

<dl class="method">
<dt id="pulsar.Pulsar.s_1400">
<tt class="descclassname">Pulsar.</tt><tt class="descname">s_1400</tt><big>(</big><big>)</big><a class="headerlink" href="#pulsar.Pulsar.s_1400" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the flux at 1400 MHz, calculated as</p>
<p><img class="math" src="_images/math/69c7d980648258e40d6d2ae8be42060fb81b5892.png" alt="S_{\rm{1400}} = \frac{L_{\rm{1400}}}{D_{\rm{true}}^2}"/></p>
</dd></dl>

<dl class="method">
<dt id="pulsar.Pulsar.width_ms">
<tt class="descclassname">Pulsar.</tt><tt class="descname">width_ms</tt><big>(</big><big>)</big><a class="headerlink" href="#pulsar.Pulsar.width_ms" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the pulse width in milliseconds, calculated as</p>
<p><img class="math" src="_images/math/e2c09b8c01108c1bf02533891146ee774111eb3d.png" alt="W_{\rm{ms}} = P_{\rm{ms}} \times W_{\rm{degree}} / 360"/></p>
</dd></dl>

</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="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="index.html">home</a>|&nbsp;</li>
        <li><a href="search.html">search</a>|&nbsp;</li>
 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, S Bates.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>