aboutsummaryrefslogtreecommitdiff
path: root/noao/rv/doc/keywpars.hlp
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /noao/rv/doc/keywpars.hlp
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'noao/rv/doc/keywpars.hlp')
-rw-r--r--noao/rv/doc/keywpars.hlp94
1 files changed, 94 insertions, 0 deletions
diff --git a/noao/rv/doc/keywpars.hlp b/noao/rv/doc/keywpars.hlp
new file mode 100644
index 00000000..5fd1aa9f
--- /dev/null
+++ b/noao/rv/doc/keywpars.hlp
@@ -0,0 +1,94 @@
+.help keywpars Dec90 noao.rv
+.ih
+NAME
+keywpars -- edit the image header keywords used by the package
+.ih
+USAGE
+keywpars
+.ih
+PARAMETERS
+.ls ra = "RA"
+Right Ascension keyword. (Value in HMS format).
+.le
+.ls dec = "DEC"
+Declination keyword. (Value in HMS format).
+.le
+.ls ut = "UT"
+UT of observation keyword. This field is the UT start of the observation.
+(Value in HMS Format).
+.le
+.ls utmiddle = "UTMIDDLE"
+UT mid-point of observation keyword. This field is the UT mid-point of
+the observation. (Value in HMS Format).
+.le
+.ls exptime = "EXPTIME"
+Exposure time keyword. (Value in Seconds).
+.le
+.ls epoch = "EPOCH"
+Epoch of coordinates keyword. (Value in Years).
+.le
+.ls date_obs = "DATE-OBS"
+Date of observation keyword. Format for this field should be
+dd/mm/yy, (old FITS format), yyyy-mm-dd (new FITS format), or
+yyyy-mm-ddThh:mm:ss.sss (new FITS format with time).
+.le
+
+.ce
+OUTPUT KEYWORDS
+.ls hjd = "HJD"
+Heliocentric Julian date keyword. (Value in Days).
+.le
+.ls mjd_obs = "MJD-OBS"
+Modified Julian Data keyword. The MJD is defined as the julian date of
+the mid-point of the observation - 2440000.5. (Value in Days).
+.le
+.ls vobs = "VOBS"
+Observed radial velocity keyword. (Value in Km/sec).
+.le
+.ls vrel = "VREL"
+Observed radial velocity keyword. (Value in Km/sec).
+.le
+.ls vhelio = "VHELIO"
+Corrected heliocentric radial velocity keyword. (Value in Km/sec).
+.le
+.ls vlsr = "VLSR"
+Local Standard of Rest velocity keyword. (Value in Km/sec).
+.le
+.ls vsun = "VSUN"
+Epoch of solar motion. (Character string with four real valued fields
+describing the solar velocity (km/sec), the RA of the solar velocity (hours),
+the declination of the solar velocity (degrees), and the epoch of solar
+coordinates (years)).
+.le
+.ih
+DESCRIPTION
+The image header keywords used by the \fIfxcor\fR task can be
+edited if they differ
+from the NOAO standard keywords. For example, if the image header keyword
+giving the exposure time for the image is written out as "EXP-TIME" instead
+of the standard "OTIME" at a given site, the keyword accessed for
+that information
+may be changed based on the value of the \fIexptime\fR parameter.
+
+The \fIvhelio\fR keywords must be added to the image header of the template
+spectrum and should contain the known radial velocity of the template star.
+The output keywords may be added to the object image header if the
+tasks \fIfxcor.imudate\fR parameter is set.
+
+.ih
+EXAMPLES
+1. List the image header keywords.
+
+.nf
+ rv> lpar keywpars
+.fi
+
+2. Edit the image header keywords
+
+.nf
+ rv> keywpars
+.fi
+.ih
+SEE ALSO
+fxcor
+.endhelp