From 5943ac30cb8ec59edd5bb977e9581e874b500f2b Mon Sep 17 00:00:00 2001 From: William Joye Date: Wed, 20 Jun 2018 13:46:18 -0400 Subject: update doc --- ds9/doc/ref/command.html | 58 ++++++++++++++++++++++++++++--- ds9/doc/ref/samp.html | 89 ++++++++++++++++++++++++++++++++++++++++++++++-- ds9/doc/ref/xpa.html | 83 ++++++++++++++++++++++++++++++++++++++++++-- 3 files changed, 221 insertions(+), 9 deletions(-) diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html index c8e42e5..2d5beea 100644 --- a/ds9/doc/ref/command.html +++ b/ds9/doc/ref/command.html @@ -259,14 +259,13 @@ $ds9 -analysis 0 # invoke first analysis task
$ds9 -analysis task 0
$ds9 -analysis task foobar
- $ds9 -analysis task "{foo bar}"
+ $ds9 -analysis task {foo bar}
$ds9 -analysis my.ans
$ds9 -analysis load my.ans
$ds9 -analysis clear
$ds9 -analysis clear load my.ans
- $ds9 -analysis message '{This is a message}'
- $ds9 -analysis message okcancel '{This is a message}'
- $ds9 -analysis text '{This is text}'
+ $ds9 -analysis message {This is a message}
+ $ds9 -analysis text {This is text}

array

Load raw data array into current frame.
@@ -528,6 +527,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -647,6 +647,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -748,6 +749,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -849,6 +851,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -950,6 +953,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1006,6 +1010,7 @@ + [symbol shape circle @@ -1013,6 +1018,7 @@ + point|box point|diamond point|cross @@ -1020,6 +1026,7 @@ + point|x point|arrow point|boxcircle point]
         [<ref>] [symbol add| [#] remove]
@@ -1127,6 +1134,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1261,6 +1269,7 @@ + [match]
          [lock [yes|no]]
@@ -1530,6 +1539,7 @@ + [match <coordsys>]
           [lock <coordsys>|none]
@@ -1698,6 +1708,7 @@ + -envi foo.hdr foo.bsq

exit
@@ -2449,6 +2460,7 @@ + [pan]
            @@ -2593,6 +2605,7 @@ + [crosshair]
            @@ -2737,6 +2750,7 @@ + [open|close]
 
Example:
@@ -2985,6 +2999,7 @@ + [yes|open]
            [no|close]
@@ -3092,6 +3107,7 @@ + duplicate [#]]
   @@ -3099,6 +3115,7 @@ +    [[<plotname>] stats yes|no]
      [[<plotname>] @@ -3175,6 +3192,7 @@ + list yes|no]
      [[<plotname>] @@ -3250,6 +3268,7 @@ + loadconfig <filename>]
      [[<plotname>] saveconfig <filename>]
@@ -3357,6 +3376,7 @@ + legend yes|no]
      [[<plotname>] legend position right|left|top|bottom]
@@ -3443,6 +3463,7 @@ + barmode normal|stacked|aligned|overlap]

# configure current dataset
@@ -3521,6 +3542,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
      [[<plotname>] @@ -3597,6 +3619,7 @@ + shape fill yes|no]
      [[<plotname>] shape @@ -3607,6 +3630,7 @@ + [[<plotname>] @@ -3681,6 +3705,7 @@ + smooth step|linear|cubic|quadratic|catrom]
      @@ -3689,6 +3714,7 @@ + [[<plotname>] @@ -3763,6 +3789,7 @@ + color <value>]
      @@ -3771,6 +3798,7 @@ + [[<plotname>] @@ -3845,6 +3873,7 @@ + width <value>]
      @@ -3921,6 +3950,7 @@ + [[<plotname>] @@ -3995,6 +4025,7 @@ + dash yes|no]
      @@ -4071,6 +4102,7 @@ + [[<plotname>] @@ -4145,6 +4177,7 @@ + error yes|no]
      @@ -4221,6 +4254,7 @@ + [[<plotname>] @@ -4295,6 +4329,7 @@ + error color <value>]
      @@ -4372,6 +4407,7 @@ + [[<plotname>] @@ -4446,6 +4482,7 @@ + color <value>]
      @@ -4523,6 +4560,7 @@ + [[<plotname>] @@ -4597,6 +4635,7 @@ + error width <value>]
      @@ -4674,6 +4713,7 @@ + [[<plotname>] @@ -4748,6 +4788,7 @@ + name <string>]

@@ -4803,6 +4844,7 @@ + -plot title 'This is a Title'
$ds9 -plot title x 'X Axis'
$ds9 -plot title y 'Y Axis'
@@ -4875,6 +4917,7 @@ + <dms> <arcmin> <arcsec>

@@ -5279,6 +5322,7 @@ + <filename> [image|table|slice]
 
Example:
@@ -5528,6 +5572,7 @@ + [sigma <value>]
        @@ -5544,6 +5589,7 @@ + [sigmaminor <value>]
        @@ -5560,6 +5606,7 @@ + [angle <value>]
        @@ -5576,6 +5623,7 @@ + [match]
        [lock [yes|no]]
        @@ -5602,6 +5650,7 @@ + -smooth sigmaminor 2.0
$ds9 @@ -5618,6 +5667,7 @@ + -smooth angle 45
$ds9 -smooth match
diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html index 4883cac..924bb56 100644 --- a/ds9/doc/ref/samp.html +++ b/ds9/doc/ref/samp.html @@ -289,8 +289,8 @@ string value = ds9.get(string cmd)
analysis
analysis task
- analysis entry Please enter something
- analysis entry okcancel Please enter something
+ analysis entry {Please enter something}
+ analysis entry okcancel {Hello World}
ds9.set(string cmd)
analysis 0 # invoke first analysis task
analysis task 0
@@ -300,7 +300,7 @@ analysis load my.ans
analysis clear
analysis clear load my.ans
- analysis message ok {This is a message}
+ analysis message {This is a message}
analysis text {this is text}
 ds9.set(string cmd, string url)
analysis load
@@ -583,6 +583,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -702,6 +703,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -803,6 +805,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -904,6 +907,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -1005,6 +1009,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1062,6 +1067,7 @@ + [symbol shape circle @@ -1071,6 +1077,7 @@ + point|box point|diamond point|cross @@ -1080,6 +1087,7 @@ + point|x point|arrow point|boxcircle point]
        [<ref>] [symbol add| [#] remove]
@@ -1187,6 +1195,7 @@ + [update]
        [<ref>] [x <col>]
@@ -2238,6 +2247,7 @@ + Macros for more information.

Syntax:
iexam []
@@ -2364,6 +2374,7 @@ + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2814,6 +2825,7 @@ + [new name <plotname> line|bar|scatter]

# load data into existing plot from @@ -2902,6 +2914,7 @@ + duplicate [#]]
     @@ -2980,6 +2993,7 @@ + [[<plotname>] stats yes|no]
     [[<plotname>] @@ -3057,6 +3071,7 @@ + list yes|no]
     [[<plotname>] @@ -3134,6 +3149,7 @@ + loadconfig <filename>]
     [[<plotname>] saveconfig <filename>]
@@ -3213,6 +3229,7 @@ + [[<plotname>] pagesetup orient portrait|landscape]
     [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4]
@@ -3292,6 +3309,7 @@ + [[<plotname>] print]
     [[<plotname>] print destination printer|file]
@@ -3393,6 +3411,7 @@ + legend yes|no]
     [[<plotname>] legend position right|left|top|bottom]
@@ -3481,6 +3500,7 @@ + barmode normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3561,6 +3581,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
     [[<plotname>] @@ -3639,6 +3660,7 @@ + shape fill yes|no]
     [[<plotname>] @@ -3720,6 +3742,7 @@ + [[<plotname>] @@ -3796,6 +3819,7 @@ + smooth step|linear|cubic|quadratic|catrom]
     @@ -3875,6 +3899,7 @@ + [[<plotname>] @@ -3951,6 +3976,7 @@ + color <value>]
     @@ -4030,6 +4056,7 @@ + [[<plotname>] @@ -4106,6 +4133,7 @@ + width <value>]
     @@ -4185,6 +4213,7 @@ + [[<plotname>] @@ -4261,6 +4290,7 @@ + dash yes|no]
     @@ -4339,6 +4369,7 @@ + [[<plotname>] @@ -4415,6 +4446,7 @@ + error yes|no]
     @@ -4493,6 +4525,7 @@ + [[<plotname>] @@ -4569,6 +4602,7 @@ + error color <value>]
     @@ -4648,6 +4682,7 @@ + [[<plotname>] @@ -4724,6 +4759,7 @@ + color <value>]
     @@ -4803,6 +4839,7 @@ + [[<plotname>] @@ -4879,6 +4916,7 @@ + error width <value>]
     @@ -4958,6 +4996,7 @@ + [[<plotname>] @@ -5034,6 +5073,7 @@ + name <string>]

@@ -5130,6 +5170,7 @@ + value = ds9.get(string cmd)
plot stats
@@ -5234,6 +5275,7 @@ + axis x auto
plot @@ -5306,6 +5348,7 @@ + axis x min
plot @@ -5378,6 +5421,7 @@ + axis x max
plot @@ -5450,6 +5494,7 @@ + axis x format
plot @@ -5522,6 +5567,7 @@ + legend
plot legend position
@@ -5602,6 +5648,7 @@ + font numbers size
plot @@ -5678,6 +5725,7 @@ + font numbers weight
plot @@ -5754,6 +5802,7 @@ + font numbers slant
plot @@ -5830,6 +5879,7 @@ + title
plot @@ -5906,6 +5956,7 @@ + title x
plot barmode
 @@ -5932,6 +5983,7 @@ + cmd)
plot legend yes
plot legend position left
@@ -5944,6 +5996,7 @@ + value = ds9.get(string cmd)
plot font numbers font
@@ -5955,6 +6008,7 @@ + font numbers size
plot @@ -5964,6 +6018,7 @@ + font numbers weight
plot @@ -5973,6 +6028,7 @@ + font numbers slant
ds9.set(string @@ -5982,6 +6038,7 @@ + cmd)
plot font numbers font times
plot font numbers size 12
@@ -5996,6 +6053,7 @@ + value = ds9.get(string cmd)
plot @@ -6006,6 +6064,7 @@ + title
plot @@ -6015,6 +6074,7 @@ + title xaxis
plot @@ -6024,6 +6084,7 @@ + title yaxis
ds9.set(string @@ -6033,6 +6094,7 @@ + cmd)
plot title "This is a Title"
plot title x "X Axis"
@@ -6047,6 +6109,7 @@ + value = ds9.get(string cmd)
@@ -6058,6 +6121,7 @@ + barmode
 ds9.set(string @@ -6068,6 +6132,7 @@ + cmd)
plot barmode aligned

@@ -6157,6 +6222,7 @@ + dash
plot @@ -6233,6 +6299,7 @@ + error
plot @@ -6309,6 +6376,7 @@ + error color
plot @@ -6385,6 +6453,7 @@ + error width
plot @@ -6461,6 +6530,7 @@ + name
ds9.set(string @@ -6537,6 +6607,7 @@ + cmd)
plot show yes
plot shape circle
@@ -6588,6 +6659,7 @@ + <dms> <arcmin> <arcsec>

@@ -7210,6 +7282,7 @@ + [crosshair]
        [<ref>] [export sb|tsv <filename>]
@@ -7328,6 +7401,7 @@ + [update]
 
Example:
@@ -7452,6 +7526,7 @@ + [sigma <value>]
       @@ -7469,6 +7544,7 @@ + [sigmaminor <value>]
       @@ -7487,6 +7563,7 @@ + [angle <value>]
       @@ -7505,6 +7582,7 @@ + [match]
       [lock [yes|no]]
       [open|close]
@@ -7542,6 +7620,7 @@ + sigma 2.0
smooth @@ -7560,6 +7639,7 @@ + sigmaminor 2.0
smooth @@ -7578,6 +7658,7 @@ + angle 45
smooth @@ -7596,6 +7677,7 @@ + open
smooth close
smooth match
@@ -7723,6 +7805,7 @@ + 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 742fec6..444592f 100644 --- a/ds9/doc/ref/xpa.html +++ b/ds9/doc/ref/xpa.html @@ -220,6 +220,7 @@ + -p ds9 3d match
$xpaset -p ds9 3d lock yes
@@ -239,6 +240,7 @@ + -p ds9 3d open
$xpaset -p ds9 3d close
 @@ -286,7 +288,7 @@ $xpaget ds9 analysis
$xpaget ds9 analysis task
$xpaget ds9 analysis entry {Please enter something}
- $xpaget ds9 analysis entry okcancel {Please enter something}
+ $xpaget ds9 analysis message okcancel {Hello World}
$xpaset -p ds9 analysis 0 # invoke first analysis task
$xpaset -p ds9 analysis task 0
$xpaset -p ds9 analysis task foobar
@@ -295,7 +297,7 @@ $xpaset -p ds9 analysis load my.ans
$xpaset -p ds9 analysis clear
$xpaset -p ds9 analysis clear load my.ans
- $xpaset -p ds9 analysis message ok {This is a message}
+ $xpaset -p ds9 analysis message {This is a message}
$xpaset -p ds9 analysis text {this is text}
$cat my.ans | xpaset ds9 analysis load
$cat foo.txt | xpaset ds9 analysis text
@@ -578,6 +580,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -702,6 +705,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -808,6 +812,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -914,6 +919,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -1020,6 +1026,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1076,6 +1083,7 @@ + [symbol shape circle point|box point|diamond point|cross point|x point|arrow point|boxcircle point]
@@ -1190,6 +1198,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1785,6 +1794,7 @@ + -p ds9 export envi foo.hdr foo.bsq little
$xpaset -p ds9 export tiff foo.tiff jpeg
@@ -2325,6 +2335,7 @@ + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2750,6 +2761,7 @@ + [new name <plotname> line|bar|scatter]

# create new plot with data from stdin
@@ -2762,6 +2774,7 @@ + [new <title> <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]
@@ -2779,6 +2792,7 @@ + [new name @@ -2788,6 +2802,7 @@ + <plotname> <title> @@ -2797,6 +2812,7 @@ + <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]
     [new name @@ -2807,6 +2823,7 @@ + <plotname> line|bar|scatter @@ -2816,6 +2833,7 @@ + <title> <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]

@@ -2832,6 +2850,7 @@ + [line|bar|scatter] @@ -2841,6 +2860,7 @@ + stdin]
     @@ -2852,6 +2872,7 @@ + [new name <plotname> stdin]
     @@ -2864,6 +2885,7 @@ + stdin]

# load data into existing plot from @@ -2953,6 +2975,7 @@ + duplicate [#]]
     @@ -3032,6 +3055,7 @@ + [[<plotname>] stats yes|no]
     [[<plotname>] @@ -3110,6 +3134,7 @@ + list yes|no]
     [[<plotname>] @@ -3188,6 +3213,7 @@ + loadconfig <filename>]
     [[<plotname>] saveconfig <filename>]
@@ -3268,6 +3294,7 @@ + [[<plotname>] pagesetup orient portrait|landscape]
     [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4]
@@ -3348,6 +3375,7 @@ + [[<plotname>] print]
     [[<plotname>] print destination printer|file]
@@ -3450,6 +3478,7 @@ + legend yes|no]
     [[<plotname>] legend position right|left|top|bottom]
@@ -3539,6 +3568,7 @@ + barmode normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3620,6 +3650,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
     [[<plotname>] @@ -3699,6 +3730,7 @@ + shape fill yes|no]
     [[<plotname>] @@ -3781,6 +3813,7 @@ + [[<plotname>] @@ -3858,6 +3891,7 @@ + smooth step|linear|cubic|quadratic|catrom]
     @@ -3938,6 +3972,7 @@ + [[<plotname>] @@ -4015,6 +4050,7 @@ + color <value>]
     @@ -4095,6 +4131,7 @@ + [[<plotname>] @@ -4172,6 +4209,7 @@ + width <value>]
     @@ -4252,6 +4290,7 @@ + [[<plotname>] @@ -4329,6 +4368,7 @@ + dash yes|no]
     @@ -4408,6 +4448,7 @@ + [[<plotname>] @@ -4485,6 +4526,7 @@ + error yes|no]
     @@ -4564,6 +4606,7 @@ + [[<plotname>] @@ -4641,6 +4684,7 @@ + error color <value>]
     @@ -4721,6 +4765,7 @@ + [[<plotname>] @@ -4798,6 +4843,7 @@ + color <value>]
     @@ -4878,6 +4924,7 @@ + [[<plotname>] @@ -4955,6 +5002,7 @@ + error width <value>]
     @@ -5035,6 +5083,7 @@ + [[<plotname>] @@ -5112,6 +5161,7 @@ + name <string>]

@@ -5159,6 +5209,7 @@ + data into existing plot from stdin
$cat xy.dat | xpaset ds9 plot data xy
$cat xy.dat | xpaset ds9 plot foo data xy
@@ -5270,6 +5321,7 @@ + ds9 plot axis x min
$xpaget @@ -5348,6 +5400,7 @@ + ds9 plot axis x max
$xpaget ds9 plot axis x format
$xpaset @@ -5359,6 +5412,7 @@ + -p ds9 plot axis x grid yes
$xpaset -p ds9 plot axis x log yes
$xpaset -p ds9 plot axis x flip yes
@@ -5452,6 +5506,7 @@ + ds9 plot font numbers size
$xpaget @@ -5530,6 +5585,7 @@ + ds9 plot font numbers weight
$xpaget @@ -5608,6 +5664,7 @@ + ds9 plot font numbers slant
$xpaset @@ -5618,6 +5675,7 @@ + -p ds9 plot font numbers font times
$xpaset -p ds9 plot font numbers size 12
$xpaset -p ds9 plot font numbers weight bold
@@ -5701,6 +5759,7 @@ + ds9 plot title xaxis
$xpaget @@ -5779,6 +5838,7 @@ + ds9 plot title yaxis
$xpaset @@ -5789,6 +5849,7 @@ + -p ds9 plot title {This is a Title}
$xpaset -p ds9 plot title x {X Axis}
$xpaset -p ds9 plot title y {Y Axis}
@@ -5886,6 +5947,7 @@ + ds9 plot dash
$xpaget @@ -5964,6 +6026,7 @@ + ds9 plot error
$xpaget @@ -6042,6 +6105,7 @@ + ds9 plot error color
$xpaget @@ -6121,6 +6185,7 @@ + ds9 plot error width
$xpaget @@ -6200,6 +6265,7 @@ + ds9 plot name
$xpaset @@ -6278,6 +6344,7 @@ + -p ds9 plot show yes
$xpaset -p ds9 plot shape circle
$xpaset -p ds9 plot shape fill no
@@ -6327,6 +6394,7 @@ + <dms> <arcmin> <arcsec>

@@ -6826,6 +6894,7 @@ + method.

Syntax:
saveimage [fits|eps|gif|tiff|jpeg|png] <filename>
@@ -7061,6 +7130,7 @@ + [sigma <value>]
       @@ -7080,6 +7150,7 @@ + [sigmaminor <value>]
       @@ -7099,6 +7170,7 @@ + [angle <value>]
    @@ -7118,6 +7190,7 @@ +    [match]
       [lock [yes|no]]
       [open|close]
@@ -7145,6 +7218,7 @@ + ds9 smooth sigmaminor
$xpaget ds9 smooth lock
@@ -7172,6 +7246,7 @@ + -p ds9 smooth sigma 2.0
$xpaset @@ -7191,6 +7266,7 @@ + -p ds9 smooth sigmaminor 2.0
$xpaset @@ -7210,6 +7286,7 @@ + -p ds9 smooth angle 45
$xpaset @@ -7229,6 +7306,7 @@ + -p ds9 smooth match
$xpaset -p ds9 smooth lock yes
$xpaset -p ds9 smooth open
@@ -7356,6 +7434,7 @@ + compression method.

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