Changeset 18283

Timestamp:

Jun 23, 2008, 5:57:11 AM (18 years ago)

Author:

mwv

Message:

Added information to the help messages giving units for most parameters.

Location:

branches/mwv/Ohana/src/opihi/dvo

Files:

• avextract.c (modified) (1 diff)
• mextract.c (modified) (1 diff)

branches/mwv/Ohana/src/opihi/dvo/avextract.c

@@ -151 +151 @@
   if ((argc > N + 1) && !strcasecmp (argv[N+1], "fields")) {
     gprint (GP_ERR, " USAGE: avextract field[,field,field...] where (expression)\n");
-    gprint (GP_ERR, "  RA : right ascension (J2000)\n");
-    gprint (GP_ERR, "  DEC : declination \n");
-    gprint (GP_ERR, "  dRA : ra scatter \n");
-    gprint (GP_ERR, "  dDEC : dec scatter\n");
-    gprint (GP_ERR, "  uRA : proper motion in ra\n");
-    gprint (GP_ERR, "  uDEC : proper motion in dec\n");
-    gprint (GP_ERR, "  duRA : proper motion error in ra\n");
-    gprint (GP_ERR, "  duDEC : proper motion error in dec\n");
+    gprint (GP_ERR, "  RA : right ascension (J2000) [degrees]\n");
+    gprint (GP_ERR, "  DEC : declination [degrees]\n");
+    gprint (GP_ERR, "  dRA : ra scatter [arcseconds]\n");
+    gprint (GP_ERR, "  dDEC : dec scatter[arcseconds]\n");
+    gprint (GP_ERR, "  uRA : proper motion in ra [mas/yr]\n");
+    gprint (GP_ERR, "  uDEC : proper motion in dec [mas/yr]\n");
+    gprint (GP_ERR, "  duRA : proper motion error in ra [mas/yr]\n");
+    gprint (GP_ERR, "  duDEC : proper motion error in dec [mas/yr]\n");
     gprint (GP_ERR, "  PAR : parallax\n");
     gprint (GP_ERR, "  dPAR : parallax error \n");
     gprint (GP_ERR, "  nmeas : number of measurements\n");
     gprint (GP_ERR, "  nmiss : number of non-detections\n");
-    gprint (GP_ERR, "  xp : positional chi-square\n");
+    gprint (GP_ERR, "  xp : positional raw chi-square\n");
     gprint (GP_ERR, "  flag : object flags\n");
-    gprint (GP_ERR, "  photocode:ave : average magnitude for photcode\n");
-    gprint (GP_ERR, "  photocode:ref : reference magnitude system for photcode\n");
-    gprint (GP_ERR, "  photocode:inst : first instrumental magnitude for photcode\n");
-    gprint (GP_ERR, "  photocode:cat : first catalog magnitude for photcode\n");
-    gprint (GP_ERR, "  photocode:sys : first system magnitude for photcode\n");
-    gprint (GP_ERR, "  photocode:rel : first relative magnitude for photcode\n");
-    gprint (GP_ERR, "  photocode:cal : first calibrated magnitude for photcode \n");
-    gprint (GP_ERR, "  photcode:err : magnitude error for photcode\n");
-    gprint (GP_ERR, "  photcode:chipsq : chi-square of magnitude fit\n");
+    gprint (GP_ERR, "  <photcode>:ave : average magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:ref : reference magnitude system for photcode\n");
+    gprint (GP_ERR, "  <photcode>:inst : first instrumental magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:cat : first catalog magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:sys : first system magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:rel : first relative magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:cal : first calibrated magnitude for photcode \n");
+    gprint (GP_ERR, "  <photcode>:err : magnitude error for photcode\n");
+    gprint (GP_ERR, "  <photcode>:chipsq : chi-square of magnitude fit\n");
     gprint (GP_ERR, "  type : dophot type (unused)\n");
     gprint (GP_ERR, "  typefrac : dophot type fraction (unused)\n");
-    gprint (GP_ERR, "  photcode:ncode : number of measurements in photcode \n");
-    gprint (GP_ERR, "  photcode:nphot : number of measurements used for photcode average\n");
+    gprint (GP_ERR, "  <photcode>:ncode : number of measurements in photcode \n");
+    gprint (GP_ERR, "  <photcode>:nphot : number of measurements used for photcode average\n");
     return (FALSE);
   }

branches/mwv/Ohana/src/opihi/dvo/mextract.c

@@ -184 +184 @@
   if ((argc > N + 1) && !strcasecmp (argv[N+1], "fields")) {
     gprint (GP_ERR, " USAGE: avextract field[,field,field...] where (expression)\n");
-    gprint (GP_ERR, "  RA : right ascension (J2000) for detection\n");
-    gprint (GP_ERR, "  DEC : declination for detection\n");
-    gprint (GP_ERR, "  RA:ave : average right ascension (J2000) for object\n");
-    gprint (GP_ERR, "  DEC:ave : average declination for object\n");
-    gprint (GP_ERR, "  RA:err : ra scatter \n");
-    gprint (GP_ERR, "  DEC:err : dec scatter\n");
-    gprint (GP_ERR, "  uRA : proper motion in ra\n");
-    gprint (GP_ERR, "  uDEC : proper motion in dec\n");
-    gprint (GP_ERR, "  duRA : proper motion error in ra\n");
-    gprint (GP_ERR, "  duDEC : proper motion error in dec\n");
+    gprint (GP_ERR, "  RA : right ascension (J2000) for detection [degrees] \n");
+    gprint (GP_ERR, "  DEC : declination for detection [degrees] \n");
+    gprint (GP_ERR, "  RA:ave : average right ascension (J2000) for object [degrees]\n");
+    gprint (GP_ERR, "  DEC:ave : average declination for object [degrees]\n");
+    gprint (GP_ERR, "  RA:err : ra scatter [degrees]\n");
+    gprint (GP_ERR, "  DEC:err : dec scatter [degrees]\n");
+    gprint (GP_ERR, "  uRA : proper motion in ra [mas/yr]\n");
+    gprint (GP_ERR, "  uDEC : proper motion in dec [mas/yr]\n");
+    gprint (GP_ERR, "  duRA : proper motion error in ra [mas/yr]\n");
+    gprint (GP_ERR, "  duDEC : proper motion error in dec [mas/yr]\n");
     gprint (GP_ERR, "  PAR : parallax\n");
     gprint (GP_ERR, "  dPAR : parallax error \n");
     gprint (GP_ERR, "  nmeas : number of measurements\n");
     gprint (GP_ERR, "  nmiss : number of non-detections\n");
-    gprint (GP_ERR, "  xp : positional chi-square\n");
+    gprint (GP_ERR, "  xp : positional raw chi-square\n");
     gprint (GP_ERR, "  objflag : object flags\n");
-    gprint (GP_ERR, "  photcode:ave : average magnitude for photcode (or equivalent)\n");
-    gprint (GP_ERR, "  photcode:ref : reference magnitude system for photcode (or equivalent)\n");
-    gprint (GP_ERR, "  photcode:inst : instrumental magnitude for photcode\n");
-    gprint (GP_ERR, "  photcode:cat :  catalog magnitude for photcode\n");
-    gprint (GP_ERR, "  photcode:sys :  system magnitude for photcode\n");
-    gprint (GP_ERR, "  photcode:rel :  relative magnitude for photcode\n");
-    gprint (GP_ERR, "  photcode:cal :  calibrated magnitude for photcode \n");
-    gprint (GP_ERR, "  photcode:err : magnitude error for photcode\n");
-    gprint (GP_ERR, "  photcode:chisq : chi-square of magnitude fit\n");
-    gprint (GP_ERR, "  photcode:ncode : number of measurements in photcode\n");
-    gprint (GP_ERR, "  photcode:nphot : number of measurements used for average magnitude\n");
+    gprint (GP_ERR, "  <photcode>:ave : average magnitude for photcode (or equivalent)\n");
+    gprint (GP_ERR, "  <photcode>:ref : reference magnitude system for photcode (or equivalent)\n");
+    gprint (GP_ERR, "  <photcode>:inst : instrumental magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:cat :  catalog magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:sys :  system magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:rel :  relative magnitude for photcode\n");
+    gprint (GP_ERR, "  <photcode>:cal :  calibrated magnitude for photcode \n");
+    gprint (GP_ERR, "  <photcode>:err : magnitude error for photcode\n");
+    gprint (GP_ERR, "  <photcode>:chisq : chi-square of magnitude fit\n");
+    gprint (GP_ERR, "  <photcode>:ncode : number of measurements in photcode\n");
+    gprint (GP_ERR, "  <photcode>:nphot : number of measurements used for average magnitude\n");
     gprint (GP_ERR, "  airmass : airmass of detection\n");
-    gprint (GP_ERR, "  exptime : exposure time\n");
+    gprint (GP_ERR, "  exptime : exposure time [s]\n");
     gprint (GP_ERR, "  photcode : photcode \n");
-    gprint (GP_ERR, "  time : time of exposure\n");
-    gprint (GP_ERR, "  dR : ra offset\n");
-    gprint (GP_ERR, "  dD : dec offset\n");
+    gprint (GP_ERR, "  time : time of exposure [Seconds since Jan 1, 1970]\n");
+    gprint (GP_ERR, "  dR : ra offset [arcseconds]\n");
+    gprint (GP_ERR, "  dD : dec offset [arcseconds]\n");
     gprint (GP_ERR, "  fwhm : fwhm (average)\n");
-    gprint (GP_ERR, "  fwhm_maj : fwhm (major axis)\n");
-    gprint (GP_ERR, "  fwhm_min : fwhm (minor axis)\n");
+    gprint (GP_ERR, "  fwhm_maj : fwhm (major axis) [pixels]\n");
+    gprint (GP_ERR, "  fwhm_min : fwhm (minor axis) [pixels]\n");
     gprint (GP_ERR, "  theta : position angle\n");
     gprint (GP_ERR, "  flags : detection flags\n");