summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhack <hack@stsci.edu>2012-09-20 14:11:59 -0400
committerhack <hack@stsci.edu>2012-09-20 14:11:59 -0400
commit7888ef96fec3ff971fab5e970a2949cbb9236632 (patch)
tree84046e74a35474a66c32fc25fd69d83215bb42a5 /doc
parent951f43155c1d77ee7493d9903d7b69b16345964e (diff)
downloadstwcs_hcf-7888ef96fec3ff971fab5e970a2949cbb9236632.tar.gz
Added a paragraph to the FITS Conventions TSR explaining the inclusion of the TDD correction.
git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@19564 fe389314-cf27-0410-b35b-8c050e845b92
Diffstat (limited to 'doc')
-rw-r--r--doc/source/fits_conventions.rst51
-rw-r--r--doc/source/headerlet_def.rst12
2 files changed, 42 insertions, 21 deletions
diff --git a/doc/source/fits_conventions.rst b/doc/source/fits_conventions.rst
index 803070f..002aeaa 100644
--- a/doc/source/fits_conventions.rst
+++ b/doc/source/fits_conventions.rst
@@ -120,6 +120,17 @@ keywords actually get populated for an image. The current implementation does n
take advantage of the A_DMAX, B_DMAX, SIPREFi or SIPSCLi keywords, so these keywords
are not written out to the SCI header.
+Time-Dependent Distortion
+-------------------------
+
+Calibration of HST/ACS imaging data required the addition of a time dependent skew in addition
+to the other distortion terms. This skew represented a linear correction to the polynomial model
+and its residuals. This correction gets applied to the polynomial coefficients and
+the residuals from the polynomial model when they are evaluated for each image. As a result, the
+SIP keywords and the corresponding non-polynomial residuals as written out to each HST/ACS image header
+reflects this time-dependent correction without the need for any further evaluation of this skew.
+
+
FITS Distortion Proposal
=========================
@@ -337,9 +348,10 @@ the CTYPE keyword.
.. _Appendix1:
-**********************************
+==================================
Appendix 1 - Sample ACS/WFC Image
-**********************************
+==================================
+
The WCS of a single chip from an ACS/WFC exposure illustrates how the SIP keywords are
populated based on the coefficients from the external IDCTAB reference file. In addition,
this header includes the keywords referring to additional distortion corrections
@@ -352,7 +364,8 @@ use the new reference information. The old WCS gets stored using WCS key 'O' and
to indicate it was originally computed by OPUS, the HST pipeline system.
FITS File extensions
---------------------
+==================================
+
The FITS file for this ACS/WFC image now contains extra extensions for the NPOLFILE and D2IMFILE
corrections.
@@ -380,7 +393,8 @@ solutions that have been applied to this file and does not act as an active part
or its interpretation.
Primary Header
---------------
+==================================
+
The PRIMARY header of HST data contains keywords specifying information general to
the entire file, such as what calibration steps were applied and what reference files
should be used. No active WCS keywords (keywords interpreted for coordinate transformations)
@@ -407,7 +421,8 @@ The remainder of the PRIMARY header specifies the general characteristics of the
SCI Header Keywords
--------------------
+==================================
+
The following keywords only represent the WCS keywords from a sample ACS/WFC SCI header with 4-th order
polynomial distortion correction from the IDCTAB reference file, along with NPOLFILE and
D2IMFILE corrections from the specific reference files used as examples in :ref:`Appendix2`
@@ -542,15 +557,16 @@ from this SCI header listing for the sake of brevity.
.. _Appendix2:
-*************************************
+==================================
Appendix 2 - NPOLFILE Example
-*************************************
+==================================
The NPOLFILE reference file format includes a PRIMARY header describing what kind of
image should be corrected by this file, along with extensions containing the corrections
for each chip.
FITS File Extensions
---------------------
+==================================
+
A sample NPOLFILE applicable to ACS/WFC F475W images has the FITS extensions::
Filename: /grp/hst/cdbs/jref/v971826aj_npl.fits
@@ -565,7 +581,8 @@ The extensions with the name 'DX' provide the corrections in X for each of the
ACS/WFC's 2 chips, while the 'DY' extensions provide the corrections in Y for each chip.
Primary Header
---------------
+==================================
+
The PRIMARY header of this file only includes the minimum information necessary to describe
what exposures should be corrected by this reference file and how it was generated. A full
listing of the PRIMARY header includes::
@@ -603,7 +620,8 @@ listing of the PRIMARY header includes::
Data Extension Header
----------------------
+==================================
+
Each ACS/WFC chip has a shape of 4096 x 2048 pixels,
yet the data arrays in this specific reference file only have 65x33 values.
Each data extension ('DX' and 'DY') contains only those keywords necessary to
@@ -640,15 +658,16 @@ pixel in the full ACS/WFC exposure. The full header for the ['DX',1] extension c
.. _Appendix3:
-*************************************
+==================================
Appendix 3 - D2IMFILE Example
-*************************************
+==================================
The D2IMFILE reference file only contains a single 1-D array that should correct the
column (row) values based on the value of the 'AXISCORR' keyword in the SCI header.
FITS File Extensions
----------------------
+==================================
+
This simple reference file, therefore, contains only 2 extensions; namely,
::
@@ -659,7 +678,8 @@ This simple reference file, therefore, contains only 2 extensions; namely,
1 DX ImageHDU 18 (4096,) float32
PRIMARY Header
---------------
+==================================
+
The PRIMARY header only needs to contain information on what detector this file corrects,
along with any available information on how this file was generated. The ACS/WFC D2IMFILE
PRIMARY header only includes::
@@ -704,7 +724,8 @@ In this case, most of the keywords not required by FITS describe how this file
was computed while also describing how it should be applied.
Data Extension Header
----------------------
+==================================
+
The header keywords for the actual DX array simply needs to provide the information
necessary to apply the values to the data; namely,
diff --git a/doc/source/headerlet_def.rst b/doc/source/headerlet_def.rst
index 32a9e66..8200b83 100644
--- a/doc/source/headerlet_def.rst
+++ b/doc/source/headerlet_def.rst
@@ -31,17 +31,17 @@ All users get their copy of an image from the HST Archive (OTFR) after being pro
The WCS information in the FLT images has been updated to include the full distortion model, including the full polynomial solution from the IDCTAB and all the corrections formerly combined into the DGEOFILE. The :ref:`FITS Conventions Report <fits_conventions_tsr>` report by Dencheva contains the full description of the conventions used to describe all these components in a FITS file. The header now contains the following set of keywords and extensions to fully describe the WCS with distortion:
- * **Linear WCS keywords**: specifically, CRPIX, CRVAL, CTYPE, CD matrix keywords
- * **SIP coefficients**: A_*_* and B_*_*, A_ORDER, B_ORDER,
+* **Linear WCS keywords**: specifically, CRPIX, CRVAL, CTYPE, CD matrix keywords
+* **SIP coefficients**: A_*_* and B_*_*, A_ORDER, B_ORDER,
OCX10, OCX11, OCY10, and OCY11 keywords
- * **NPOL file**: if an NPOLFILE has been specified for the image,
+* **NPOL file**: if an NPOLFILE has been specified for the image,
CPDIS and DP record-value keywords to point to WCSDVARR extensions (FITS Distortion Paper convention)
- * **Column correction file**: if a D2IMFILE has been specified for use with the image,
+* **Column correction file**: if a D2IMFILE has been specified for use with the image,
the D2IMEXT and D2IMERR keywords signify the use of a D2IM file extension
- * **WCSDVARR extensions**: 2 extensions for each chip with lookup tables containing
+* **WCSDVARR extensions**: 2 extensions for each chip with lookup tables containing
the NPOLFILE corrections, with each extension corresponding to an axis of
the image (X correction or Y correction) (if an NPOLFILE has been applied to the image)
- * **D2IMVARR extension**: an extension with a lookup table containing the
+* **D2IMVARR extension**: an extension with a lookup table containing the
column-correction for that chip from the D2IMFILE.