summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhack <hack@stsci.edu>2012-10-31 16:58:08 -0400
committerhack <hack@stsci.edu>2012-10-31 16:58:08 -0400
commit475f8d3c9764bc7b2b2d4db80676b47f2e2fcb55 (patch)
tree847e085398319585a993e5042e26a73cf4df0dd3 /doc
parentbfc0125dac0b0612cdff9b8239e8040f2bd287dc (diff)
downloadstwcs_hcf-475f8d3c9764bc7b2b2d4db80676b47f2e2fcb55.tar.gz
Cleaned up the References in the headerlet TSR so that they get reported correctly in the PDF, and the HTML pages.
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@20142 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'doc')
-rw-r--r--doc/headerlet_tsr/source/hdrlet_tsr.rst20
-rw-r--r--doc/headerlet_tsr/source/index.rst3
2 files changed, 11 insertions, 12 deletions
diff --git a/doc/headerlet_tsr/source/hdrlet_tsr.rst b/doc/headerlet_tsr/source/hdrlet_tsr.rst
index 398e58f..4791c1b 100644
--- a/doc/headerlet_tsr/source/hdrlet_tsr.rst
+++ b/doc/headerlet_tsr/source/hdrlet_tsr.rst
@@ -34,7 +34,7 @@ We describe as an example the type of WCS information of a typical HST ACS/WFC i
is distributed by the HST archive (OTFR) after being processed with the latest image
calibrations, including applying the latest available distortion
models. The full description of the WCS is available in the
-"Distortion Correction In HST Files" report [1]_ by Hack et al.
+"Distortion Correction In HST Files" report [Hack]_ by Hack et al.
The science header now contains the following set of keywords and extensions to fully
describe the WCS with distortion:
@@ -43,7 +43,7 @@ describe the WCS with distortion:
* **The first order coefficients from the IDC table**: (needed by astrodrizzle) OCX10, OCX11, OCY10, and OCY11 keywords
* **NPOL distortion**: if an NPOLFILE has been specified for the image,
CPDIS and DP record-value keywords to point to WCSDVARR extensions (Distortion
- Paper [2]_ )
+ Paper [Calabretta]_ )
* **Detector defect correction**: (for ACS/WFC this is a column defect)if a D2IMFILE has been
specified for use with the image, the D2IMEXT, D2IMERR and AXISCORR keywords point to the D2IMARR extension
@@ -82,7 +82,7 @@ Headerlet Definition
====================
A `headerlet` is a self-consistent definition of a single WCS
including all distortion for all chips/detectors of a single exposure.
-This is different from alternate WCS defined in Greisen, E. W., and Calabretta (Paper I) [3]_
+This is different from alternate WCS defined in Greisen, E. W., and Calabretta (Paper I) [Greisen]_
in that by definition all alternate WCSs share the same distortion model while headerlets
may be based on different distortion models. A headerlet does not include alternate WCSs.
It is stored as a multi-extension FITS file following the structure of the science file.
@@ -95,7 +95,7 @@ SIPWCS - A New FITS Extension
We introduce a new HDU with EXTNAME `SIPWCS`. It has no data and the header
contains all the WCS-related keywords from the SCI
-header. As a minimum it contains the basic WCS keywords described in Paper I [3]_
+header. As a minimum it contains the basic WCS keywords described in Paper I [Greisen]_
If the science observation has a SIP distortion model, the SIP keywords are included
in this extension. If the distortion includes a non-polynomial
part, the keywords describing the extensions with the lookup tables
@@ -923,14 +923,14 @@ write_headerlet
logging: boolean
enable file logging
"""
-
-References
-==========
-.. [1] Hack, et al, STScI 2012-01 TSR, http://stsdas.stsci.edu/tsr
-.. [2] (draft FITS WCS Distortion paper) Calabretta M. R., Valdes F. G., Greisen E. W., and Allen S. L., 2004,
+.. [Hack] Hack, et al, STScI 2012-01 TSR, http://stsdas.stsci.edu/tsr
+
+.. [Calabretta] (draft FITS WCS Distortion paper) Calabretta M. R., Valdes F. G., Greisen E. W., and Allen S. L., 2004,
"Representations of distortions in FITS world coordinate systems",[cited 2012 Sept 18],
Available from: http://www.atnf.csiro.au/people/mcalabre/WCS/dcs_20040422.pdf
-.. [3] Greisen, E. W., and Calabretta M.R. 2002, A&A, 395 (Paper I)
+.. [Greisen] Greisen, E. W., and Calabretta M.R. 2002, A&A, 395 (Paper I)
+
+
diff --git a/doc/headerlet_tsr/source/index.rst b/doc/headerlet_tsr/source/index.rst
index cec192c..90c608c 100644
--- a/doc/headerlet_tsr/source/index.rst
+++ b/doc/headerlet_tsr/source/index.rst
@@ -28,10 +28,9 @@ Contents:
hdrlet_tsr
-
+
Indices and tables
==================
-* :ref:`genindex`
* :ref:`search`