Skip to content

Commit

Permalink
Updates mid-flight
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorris3 committed Nov 12, 2017
1 parent 6050896 commit 39dc5ee
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 2 deletions.
34 changes: 34 additions & 0 deletions docs/details.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. include:: references.txt

.. _details:

**********************
Implementation details
**********************

``mrspoc`` uses two methods to compute astrometric stellar centroid offsets due
to starspots. The *analytic method* computes the approximate missing flux
due to starspots, normalized by the total flux. The *numerical method* creates a
grid of pixels which simulate the star and its spots. We summarize the two
methods in more detal below.

Contents
========

* :ref:`details-analytic`
* :ref:`details-numerical`

.. _details-analytic:

Analytic method
---------------

The analytic solution


.. _details-numerical:

Numerical method
----------------

The numerical solution
20 changes: 19 additions & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,25 @@ You can compute the galactic latitude ``b`` for a target given its
>>> from astropy.coordinates import SkyCoord, Galactic
>>> import astropy.units as u
>>> from mrspoc import Nprime_fov
>>> coord = SkyCoord(ra=30*u.deg, dec=80*u.deg, frame='icrs')
>>> coord_gal = coord.transform_to(Galactic)
>>> print(coord_gal.b) # doctest: +FLOAT_CMP
17d32m24.9039s
17d32m24.9039s
>>> print(Nprime_fov(coord_gal.b))
55.6
You can compute the expected astrometric precision on a given target as a
function of its Gaia bandpass ``G`` magnitude with `~mrspoc.sigma_fov`, again
taking from `Perryman et al. 2014 <http://arxiv.org/abs/1411.1173>`_, this time
from Equations 1-3:

.. code-block:: python
>>> from mrspoc import sigma_fov
>>> sigma_fov(6.5)
<Quantity 34.2301167881504 uarcsec>
>>> sigma_fov(15)
<Quantity 81.99593485858512 uarcsec>
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ magnetic activity cycles for Gaia target stars.


Indices and tables
==================
------------------

* :ref:`genindex`
* :ref:`modindex`
Expand Down

0 comments on commit 39dc5ee

Please sign in to comment.