From 2f05cca47ea120cf11c583a96032078a4b922f5d Mon Sep 17 00:00:00 2001 From: William Joye Date: Tue, 1 Aug 2017 12:00:13 -0400 Subject: update doc --- ds9/doc/ref/command.html | 117 ++++++++++++++++++++++- ds9/doc/ref/samp.html | 116 ++++++++++++++++++++++- ds9/doc/ref/xpa.html | 238 +++++++++++++++++++++-------------------------- 3 files changed, 336 insertions(+), 135 deletions(-) diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html index 88f6687..be5b87e 100644 --- a/ds9/doc/ref/command.html +++ b/ds9/doc/ref/command.html @@ -501,6 +501,9 @@ + + + [crosshair]
        [<ref>] [dec <col>]
@@ -600,6 +603,9 @@ + + + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -682,6 +688,9 @@ + + + [match function 1and2|1not2|2not1]
        [<ref>] @@ -764,6 +773,9 @@ + + + [match return 1and2|1only|2only]
        [<ref>] @@ -846,6 +858,9 @@ + + + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -985,6 +1000,9 @@ + + + [update]
        [<ref>] [x <col>]
@@ -1217,7 +1235,7 @@

Set current image display area.

Syntax:
-crop [<x> <y> <width> <height> -[<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]
+ [<coordsys>][<skyframe>][degrees|arcmin|arcsec]
      [match <coordsys>]
      [lock <coordsys>|none]
@@ -1242,7 +1260,7 @@ set.

Syntax:
-crosshair [<x> <h> <coordsys> - [<skyframe>][<skyformat>]]
+ [<skyframe>]]
           @@ -1364,6 +1382,9 @@ + + + [match <coordsys>]
           [lock <coordsys>|none]
@@ -1642,7 +1663,7 @@ $ds9 -frame 3 # goto frame 'Frame3', create if needed
$ds9 -frame lock wcs

gif

-

Import gif file.

+

Load GIF image into current frame.

Syntax:
-gif <filename>
 
@@ -2237,6 +2258,9 @@ + + + [pan]
            @@ -2362,6 +2386,9 @@ + + + [crosshair]
            @@ -2487,6 +2514,9 @@ + + + [open|close]
 
Example:
@@ -2715,6 +2745,9 @@ + + + [yes|open]
            [no|close]
@@ -2810,6 +2843,9 @@ + + + duplicate
   @@ -2867,6 +2903,9 @@ + + +    [<plotname>] stats
      [<plotname>] @@ -2924,6 +2963,9 @@ + + + list
      [<plotname>] @@ -2981,6 +3023,9 @@ + + + loadconfig <filename>
      [<plotname>] saveconfig <filename>
@@ -3045,6 +3090,9 @@ + + +    [<plotname>] print
      [<plotname>] print destination [printer|file]
@@ -3111,6 +3159,9 @@ + + + mode [pointer|zoom]

# configure graph
@@ -3204,6 +3255,9 @@ + + + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
      [<plotname>] @@ -3262,6 +3316,9 @@ + + + shape fill [yes|no]
      [<plotname>] @@ -3322,6 +3379,9 @@ + + +     [<plotname>] @@ -3378,6 +3438,9 @@ + + + smooth [step|linear|cubic|quadratic|catrom]
   @@ -3436,6 +3499,9 @@ + + +    [<plotname>] @@ -3493,6 +3559,9 @@ + + + color <value>
    @@ -3551,6 +3620,9 @@ + + +   [<plotname>] @@ -3607,6 +3679,9 @@ + + + width <value>
  @@ -3665,6 +3740,9 @@ + + +     @@ -3722,6 +3800,9 @@ + + + [<plotname>] @@ -3778,6 +3859,9 @@ + + + dash [yes|no]
   @@ -3835,6 +3919,9 @@ + + +    [<plotname>] @@ -3892,6 +3979,9 @@ + + + error [yes|no]
  @@ -3949,6 +4039,9 @@ + + +     [<plotname>] @@ -4006,6 +4099,9 @@ + + + error color <value>
   @@ -4064,6 +4160,9 @@ + + +    [<plotname>] @@ -4121,6 +4220,9 @@ + + + error width <value>
    @@ -4179,6 +4281,9 @@ + + +   [<plotname>] @@ -4235,6 +4340,9 @@ + + + name <string>
# select current dataset
@@ -4724,6 +4832,9 @@ + + + <filename> [image|table|slice]
 
Example:
diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html index ec17a6a..dff035d 100644 --- a/ds9/doc/ref/samp.html +++ b/ds9/doc/ref/samp.html @@ -553,6 +553,8 @@ + + [crosshair]
        [<ref>] [dec <col>]
@@ -651,6 +653,8 @@ + + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -732,6 +736,8 @@ + + [match function 1and2|1not2|2not1]
        [<ref>] @@ -813,6 +819,8 @@ + + [match return 1and2|1only|2only]
        [<ref>] @@ -894,6 +902,8 @@ + + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1031,6 +1041,8 @@ + + [update]
        [<ref>] [x <col>]
@@ -1305,7 +1317,7 @@

Set current image display area.

Syntax:
crop [<x> <y> <width> <height> -[<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]
+ [<coordsys>][<skyframe>][degrees|arcmin|arcsec]
      [match <coordsys>]
      [lock <coordsys>|none]
      [reset]
@@ -1335,7 +1347,7 @@ set.

Syntax:
crosshair [<x> <y> <coordsys> - [<skyframe>][<skyformat>]]
+ [<skyframe>]]
          [match <coordsys>]
          [lock @@ -2067,6 +2079,8 @@ + + Macros for more information.

Syntax:
iexam []
@@ -2173,6 +2187,8 @@ + + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2666,6 +2682,8 @@ + + # title, title xaxis, title yaxis, dimension on line 1
     [new [name <plotname>] [line|bar|scatter] <title> <xaxis label> <yaxis @@ -2734,6 +2752,8 @@ + + duplicate
     @@ -2791,6 +2811,8 @@ + + [<plotname>] stats
     [<plotname>] @@ -2847,6 +2869,8 @@ + + list
     [<plotname>] @@ -2903,6 +2927,8 @@ + + loadconfig <filename>
     [<plotname>] saveconfig <filename>
@@ -2961,6 +2987,8 @@ + + [<plotname>] pagesetup orient [portrait|landscape]
     [<plotname>] pagesetup size [letter|legal|tabloid|poster|a4]
@@ -3019,6 +3047,8 @@ + + [<plotname>] print
     [<plotname>] print destination [printer|file]
@@ -3099,6 +3129,8 @@ + + legend [yes|no]
     [<plotname>] legend position [right|left|top|bottom]
@@ -3174,6 +3206,8 @@ + + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
     [<plotname>] @@ -3231,6 +3265,8 @@ + + shape fill [yes|no]
     [<plotname>] @@ -3291,6 +3327,8 @@ + + [<plotname>] @@ -3346,6 +3384,8 @@ + + smooth [step|linear|cubic|quadratic|catrom]
     @@ -3404,6 +3444,8 @@ + + [<plotname>] @@ -3459,6 +3501,8 @@ + + color <value>
     @@ -3517,6 +3561,8 @@ + + [<plotname>] @@ -3572,6 +3618,8 @@ + + width <value>
     @@ -3630,6 +3678,8 @@ + + [<plotname>] @@ -3685,6 +3735,8 @@ + + dash [yes|no]
     @@ -3742,6 +3794,8 @@ + + [<plotname>] @@ -3797,6 +3851,8 @@ + + error [yes|no]
     @@ -3854,6 +3910,8 @@ + + [<plotname>] @@ -3909,6 +3967,8 @@ + + error color <value>
     @@ -3967,6 +4027,8 @@ + + [<plotname>] @@ -4022,6 +4084,8 @@ + + color <value>
     @@ -4080,6 +4144,8 @@ + + [<plotname>] @@ -4135,6 +4201,8 @@ + + error width <value>
     @@ -4193,6 +4261,8 @@ + + [<plotname>] @@ -4248,6 +4318,8 @@ + + name <string>

@@ -4330,6 +4402,8 @@ + + value = ds9.get(string cmd)
plot stats
@@ -4416,6 +4490,8 @@ + + axis x auto
plot @@ -4468,6 +4544,8 @@ + + axis x min
plot @@ -4520,6 +4598,8 @@ + + axis x max
plot @@ -4572,6 +4652,8 @@ + + axis x format
plot @@ -4624,6 +4706,8 @@ + + legend
plot legend position
@@ -4684,6 +4768,8 @@ + + font numbers size
plot @@ -4740,6 +4826,8 @@ + + font numbers weight
plot @@ -4796,6 +4884,8 @@ + + font numbers slant
plot @@ -4852,6 +4942,8 @@ + + title
plot @@ -4908,6 +5000,8 @@ + + title x
plot barmode
 @@ -4996,6 +5090,8 @@ + + dash
plot @@ -5052,6 +5148,8 @@ + + error
plot @@ -5108,6 +5206,8 @@ + + error color
plot @@ -5164,6 +5264,8 @@ + + error width
plot @@ -5220,6 +5322,8 @@ + + name
ds9.set(string @@ -5276,6 +5380,8 @@ + + cmd)
plot show yes
plot shape circle
@@ -5917,6 +6023,8 @@ + + [crosshair]
        [<ref>] [export sb|tsv <filename>]
@@ -6015,6 +6123,8 @@ + + [update]
 
Example:
@@ -6233,6 +6343,8 @@ + + compression method.

Syntax:
tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]
diff --git a/ds9/doc/ref/xpa.html b/ds9/doc/ref/xpa.html index 2d5f730..470ab9a 100644 --- a/ds9/doc/ref/xpa.html +++ b/ds9/doc/ref/xpa.html @@ -514,6 +514,8 @@ + + [crosshair]
        [<ref>] [dec <col>]
@@ -616,6 +618,8 @@ + + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -701,6 +705,8 @@ + + [match function 1and2|1not2|2not1]
        [<ref>] @@ -786,6 +792,8 @@ + + [match return 1and2|1only|2only]
        [<ref>] @@ -871,6 +879,8 @@ + + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1010,6 +1020,8 @@ + + [update]
        [<ref>] [x <col>]
@@ -1272,135 +1284,7 @@

Set current image display area.

Syntax:
crop [<x> <y> <width> <height> - [<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+ [<coordsys>][<skyframe>][degrees|arcmin|arcsec]
     [match <coordsys>]
     [lock <coordsys>|none]
     [reset]
@@ -1426,7 +1310,7 @@ set.

Syntax:
crosshair [<x> <y> <coordsys> - [<skyframe>][<skyformat>]]
+ [<skyframe>]]
          [match <coordsys>]
          [lock @@ -1711,6 +1595,8 @@ + + -p ds9 export envi foo.hdr foo.bsq little
$xpaset -p ds9 export tiff foo.tiff jpeg
@@ -2218,6 +2104,8 @@ + + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2687,6 +2575,8 @@ + + # title, title xaxis, title yaxis, dimension on line 1
     [new [name <plotname>] [line|bar|scatter] <title> <xaxis label> <yaxis @@ -2756,6 +2646,8 @@ + + duplicate
     @@ -2814,6 +2706,8 @@ + + [<plotname>] stats
     [<plotname>] @@ -2871,6 +2765,8 @@ + + list
     [<plotname>] @@ -2928,6 +2824,8 @@ + + loadconfig <filename>
     [<plotname>] saveconfig <filename>
@@ -2987,6 +2885,8 @@ + + [<plotname>] pagesetup orient [portrait|landscape]
     [<plotname>] pagesetup size [letter|legal|tabloid|poster|a4]
@@ -3046,6 +2946,8 @@ + + [<plotname>] print
     [<plotname>] print destination [printer|file]
@@ -3127,6 +3029,8 @@ + + legend [yes|no]
     [<plotname>] legend position [right|left|top|bottom]
@@ -3195,6 +3099,8 @@ + + barmode [normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3255,6 +3161,8 @@ + + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
     [<plotname>] @@ -3313,6 +3221,8 @@ + + shape fill [yes|no]
     [<plotname>] @@ -3374,6 +3284,8 @@ + + [<plotname>] @@ -3430,6 +3342,8 @@ + + smooth [step|linear|cubic|quadratic|catrom]
     @@ -3489,6 +3403,8 @@ + + [<plotname>] @@ -3545,6 +3461,8 @@ + + color <value>
     @@ -3604,6 +3522,8 @@ + + [<plotname>] @@ -3660,6 +3580,8 @@ + + width <value>
     @@ -3719,6 +3641,8 @@ + + [<plotname>] @@ -3775,6 +3699,8 @@ + + dash [yes|no]
     @@ -3833,6 +3759,8 @@ + + [<plotname>] @@ -3889,6 +3817,8 @@ + + error [yes|no]
     @@ -3947,6 +3877,8 @@ + + [<plotname>] @@ -4003,6 +3935,8 @@ + + error color <value>
     @@ -4062,6 +3996,8 @@ + + [<plotname>] @@ -4118,6 +4054,8 @@ + + color <value>
     @@ -4177,6 +4115,8 @@ + + [<plotname>] @@ -4233,6 +4173,8 @@ + + error width <value>
     @@ -4292,6 +4234,8 @@ + + [<plotname>] @@ -4348,6 +4292,8 @@ + + name <string>

@@ -4467,6 +4413,8 @@ + + ds9 plot axis x min
$xpaget @@ -4524,6 +4472,8 @@ + + ds9 plot axis x max
$xpaget ds9 plot axis x format
$xpaget @@ -4578,6 +4528,8 @@ + + ds9 plot legend
$xpaget ds9 plot legend position
@@ -4639,6 +4591,8 @@ + + ds9 plot font numbers size
$xpaget @@ -4696,6 +4650,8 @@ + + ds9 plot font numbers weight
$xpaget @@ -4753,6 +4709,8 @@ + + ds9 plot font numbers slant
$xpaget @@ -4810,6 +4768,8 @@ + + ds9 plot title
$xpaget @@ -4867,6 +4827,8 @@ + + ds9 plot title x
$xpaget ds9 plot barmode
 @@ -4953,6 +4915,8 @@ + + ds9 plot dash
$xpaget @@ -5010,6 +4974,8 @@ + + ds9 plot error
$xpaget @@ -5067,6 +5033,8 @@ + + ds9 plot error color
$xpaget @@ -5125,6 +5093,8 @@ + + ds9 plot error width
$xpaget @@ -5183,6 +5153,8 @@ + + ds9 plot name
$xpaset @@ -5240,6 +5212,8 @@ + + -p ds9 plot show yes
$xpaset -p ds9 plot shape circle
$xpaset -p ds9 plot shape fill no
@@ -5749,6 +5723,8 @@ + + method.

Syntax:
saveimage [fits|eps|gif|tiff|jpeg|png] <filename>
@@ -6081,6 +6057,8 @@ + + compression method.

Syntax:
tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]
-- cgit v0.12