From 13bc8589b9894287ba611151db6f482ea98cdb7d Mon Sep 17 00:00:00 2001 From: William Joye Date: Tue, 1 Aug 2017 11:46:28 -0400 Subject: update crop command doc --- ds9/doc/ref/command.html | 50 +++++++++++++++++++++++++++++++++--- ds9/doc/ref/samp.html | 67 +++++++++++++++++++++++++++++++++++++++++++++++- ds9/doc/ref/xpa.html | 63 ++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 175 insertions(+), 5 deletions(-) diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html index d26ab0d..88f6687 100644 --- a/ds9/doc/ref/command.html +++ b/ds9/doc/ref/command.html @@ -500,6 +500,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -598,6 +599,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -679,6 +681,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -760,6 +763,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -841,6 +845,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -979,6 +984,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1214,14 +1220,21 @@ [<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]
      [match <coordsys>]
      [lock <coordsys>|none] -
-  
- Example:
+
+       [reset]
+       [3d zmin zmax <coordsys>]
+       [open|close]
+
+ Example:
$ds9 foo.fits -crop 40 30 10 20 # set crop in physical coords
$ds9 foo.fits -crop +104:51:06.915 +68:33:40.761  28.144405 22.000204 wcs galactic arcsec
$ds9 foo.fits -crop match wcs
$ds9 foo.fits -crop lock wcs
+ $ds9 foo.fits -crop reset
+ $ds9 foo.fits -crop 3d .25 .5 wcs
+ $ds9 foo.fits -crop open
+ $ds9 foo.fits -crop close

crosshair

Controls the current position of the crosshair in the current @@ -1350,6 +1363,7 @@ + [match <coordsys>]
           [lock <coordsys>|none]
@@ -2222,6 +2236,7 @@ + [pan]
            @@ -2346,6 +2361,7 @@ + [crosshair]
            @@ -2470,6 +2486,7 @@ + [open|close]
 
Example:
@@ -2697,6 +2714,7 @@ + [yes|open]
            [no|close]
@@ -2791,6 +2809,7 @@ + duplicate
   @@ -2847,6 +2866,7 @@ +    [<plotname>] stats
      [<plotname>] @@ -2903,6 +2923,7 @@ + list
      [<plotname>] @@ -2959,6 +2980,7 @@ + loadconfig <filename>
      [<plotname>] saveconfig <filename>
@@ -3022,6 +3044,7 @@ +    [<plotname>] print
      [<plotname>] print destination [printer|file]
@@ -3087,6 +3110,7 @@ + mode [pointer|zoom]

# configure graph
@@ -3179,6 +3203,7 @@ + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
      [<plotname>] @@ -3236,6 +3261,7 @@ + shape fill [yes|no]
      [<plotname>] @@ -3295,6 +3321,7 @@ +     [<plotname>] @@ -3350,6 +3377,7 @@ + smooth [step|linear|cubic|quadratic|catrom]
   @@ -3407,6 +3435,7 @@ +    [<plotname>] @@ -3463,6 +3492,7 @@ + color <value>
    @@ -3520,6 +3550,7 @@ +   [<plotname>] @@ -3575,6 +3606,7 @@ + width <value>
  @@ -3632,6 +3664,7 @@ +     @@ -3688,6 +3721,7 @@ + [<plotname>] @@ -3743,6 +3777,7 @@ + dash [yes|no]
   @@ -3799,6 +3834,7 @@ +    [<plotname>] @@ -3855,6 +3891,7 @@ + error [yes|no]
  @@ -3911,6 +3948,7 @@ +     [<plotname>] @@ -3967,6 +4005,7 @@ + error color <value>
   @@ -4024,6 +4063,7 @@ +    [<plotname>] @@ -4080,6 +4120,7 @@ + error width <value>
    @@ -4137,6 +4178,7 @@ +   [<plotname>] @@ -4192,6 +4234,7 @@ + name <string>
# select current dataset
@@ -4680,6 +4723,7 @@ + <filename> [image|table|slice]
 
Example:
diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html index 80d4330..ec17a6a 100644 --- a/ds9/doc/ref/samp.html +++ b/ds9/doc/ref/samp.html @@ -552,6 +552,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -649,6 +650,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -729,6 +731,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -809,6 +812,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -889,6 +893,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1025,6 +1030,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1302,6 +1308,10 @@ [<coordsys>][<skyframe>][<skyformat>][degrees|arcmin|arcsec]
      [match <coordsys>]
      [lock <coordsys>|none]
+       [reset]
+       [3d zmin zmax + <coordsys>]
+       [open|close]
 
Example:
string value = ds9.get(string cmd)
@@ -1313,7 +1323,12 @@ crop +104:51:06.915 +68:33:40.761  28.144405 22.000204 wcs galactic arcsec
crop match wcs
- crop lock wcs
+ crop lock wcs
+ crop reset
+ crop 3d .25 .5 wcs
+ crop open
+ crop close
+

crosshair

Controls the current position of the crosshair in the current frame. DS9 is placed in crosshair mode when the crosshair is @@ -2051,6 +2066,7 @@ + Macros for more information.

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

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2648,6 +2665,7 @@ + # title, title xaxis, title yaxis, dimension on line 1
     [new [name <plotname>] [line|bar|scatter] <title> <xaxis label> <yaxis @@ -2715,6 +2733,7 @@ + duplicate
     @@ -2771,6 +2790,7 @@ + [<plotname>] stats
     [<plotname>] @@ -2826,6 +2846,7 @@ + list
     [<plotname>] @@ -2881,6 +2902,7 @@ + loadconfig <filename>
     [<plotname>] saveconfig <filename>
@@ -2938,6 +2960,7 @@ + [<plotname>] pagesetup orient [portrait|landscape]
     [<plotname>] pagesetup size [letter|legal|tabloid|poster|a4]
@@ -2995,6 +3018,7 @@ + [<plotname>] print
     [<plotname>] print destination [printer|file]
@@ -3074,6 +3098,7 @@ + legend [yes|no]
     [<plotname>] legend position [right|left|top|bottom]
@@ -3148,6 +3173,7 @@ + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
     [<plotname>] @@ -3204,6 +3230,7 @@ + shape fill [yes|no]
     [<plotname>] @@ -3263,6 +3290,7 @@ + [<plotname>] @@ -3317,6 +3345,7 @@ + smooth [step|linear|cubic|quadratic|catrom]
     @@ -3374,6 +3403,7 @@ + [<plotname>] @@ -3428,6 +3458,7 @@ + color <value>
     @@ -3485,6 +3516,7 @@ + [<plotname>] @@ -3539,6 +3571,7 @@ + width <value>
     @@ -3596,6 +3629,7 @@ + [<plotname>] @@ -3650,6 +3684,7 @@ + dash [yes|no]
     @@ -3706,6 +3741,7 @@ + [<plotname>] @@ -3760,6 +3796,7 @@ + error [yes|no]
     @@ -3816,6 +3853,7 @@ + [<plotname>] @@ -3870,6 +3908,7 @@ + error color <value>
     @@ -3927,6 +3966,7 @@ + [<plotname>] @@ -3981,6 +4021,7 @@ + color <value>
     @@ -4038,6 +4079,7 @@ + [<plotname>] @@ -4092,6 +4134,7 @@ + error width <value>
     @@ -4149,6 +4192,7 @@ + [<plotname>] @@ -4203,6 +4247,7 @@ + name <string>

@@ -4284,6 +4329,7 @@ + value = ds9.get(string cmd)
plot stats
@@ -4369,6 +4415,7 @@ + axis x auto
plot @@ -4420,6 +4467,7 @@ + axis x min
plot @@ -4471,6 +4519,7 @@ + axis x max
plot @@ -4522,6 +4571,7 @@ + axis x format
plot @@ -4573,6 +4623,7 @@ + legend
plot legend position
@@ -4632,6 +4683,7 @@ + font numbers size
plot @@ -4687,6 +4739,7 @@ + font numbers weight
plot @@ -4742,6 +4795,7 @@ + font numbers slant
plot @@ -4797,6 +4851,7 @@ + title
plot @@ -4852,6 +4907,7 @@ + title x
plot barmode
 @@ -4939,6 +4995,7 @@ + dash
plot @@ -4994,6 +5051,7 @@ + error
plot @@ -5049,6 +5107,7 @@ + error color
plot @@ -5104,6 +5163,7 @@ + error width
plot @@ -5159,6 +5219,7 @@ + name
ds9.set(string @@ -5214,6 +5275,7 @@ + cmd)
plot show yes
plot shape circle
@@ -5854,6 +5916,7 @@ + [crosshair]
        [<ref>] [export sb|tsv <filename>]
@@ -5951,6 +6014,7 @@ + [update]
 
Example:
@@ -6168,6 +6232,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 320b689..2d5f730 100644 --- a/ds9/doc/ref/xpa.html +++ b/ds9/doc/ref/xpa.html @@ -513,6 +513,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -614,6 +615,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -698,6 +700,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -782,6 +785,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -866,6 +870,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1004,6 +1009,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1393,9 +1399,13 @@ +
     [match <coordsys>]
     [lock <coordsys>|none]
+      [reset]
+      [3d zmin zmax <coordsys>]
+      [open|close]
 
Example:
$xpaget ds9 crop # get crop in physical coords
@@ -1405,7 +1415,11 @@ $xpaset -p ds9 crop +104:51:06.915 +68:33:40.761  28.144405 22.000204 wcs galactic arcsec
$xpaset -p ds9 crop match wcs
- $xpaset -p ds9 crop lock wcs
+ $xpaset -p ds9 crop lock wcs
+ $xpaset -p ds9 crop reset
+ $xpaset -p ds9 crop 3d .25 .50 wcs
+ $xpaset -p ds9 crop open
+ $xpaset -p ds9 crop close

crosshair

Controls the current position of the crosshair in the current frame. DS9 is placed in crosshair mode when the crosshair is @@ -1696,6 +1710,7 @@ + -p ds9 export envi foo.hdr foo.bsq little
$xpaset -p ds9 export tiff foo.tiff jpeg
@@ -2202,6 +2217,7 @@ + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2670,6 +2686,7 @@ + # title, title xaxis, title yaxis, dimension on line 1
     [new [name <plotname>] [line|bar|scatter] <title> <xaxis label> <yaxis @@ -2738,6 +2755,7 @@ + duplicate
     @@ -2795,6 +2813,7 @@ + [<plotname>] stats
     [<plotname>] @@ -2851,6 +2870,7 @@ + list
     [<plotname>] @@ -2907,6 +2927,7 @@ + loadconfig <filename>
     [<plotname>] saveconfig <filename>
@@ -2965,6 +2986,7 @@ + [<plotname>] pagesetup orient [portrait|landscape]
     [<plotname>] pagesetup size [letter|legal|tabloid|poster|a4]
@@ -3023,6 +3045,7 @@ + [<plotname>] print
     [<plotname>] print destination [printer|file]
@@ -3103,6 +3126,7 @@ + legend [yes|no]
     [<plotname>] legend position [right|left|top|bottom]
@@ -3170,6 +3194,7 @@ + barmode [normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3229,6 +3254,7 @@ + shape [circle|square|diamond|plus|splus|scross|triangle|arrow]
     [<plotname>] @@ -3286,6 +3312,7 @@ + shape fill [yes|no]
     [<plotname>] @@ -3346,6 +3373,7 @@ + [<plotname>] @@ -3401,6 +3429,7 @@ + smooth [step|linear|cubic|quadratic|catrom]
     @@ -3459,6 +3488,7 @@ + [<plotname>] @@ -3514,6 +3544,7 @@ + color <value>
     @@ -3572,6 +3603,7 @@ + [<plotname>] @@ -3627,6 +3659,7 @@ + width <value>
     @@ -3685,6 +3718,7 @@ + [<plotname>] @@ -3740,6 +3774,7 @@ + dash [yes|no]
     @@ -3797,6 +3832,7 @@ + [<plotname>] @@ -3852,6 +3888,7 @@ + error [yes|no]
     @@ -3909,6 +3946,7 @@ + [<plotname>] @@ -3964,6 +4002,7 @@ + error color <value>
     @@ -4022,6 +4061,7 @@ + [<plotname>] @@ -4077,6 +4117,7 @@ + color <value>
     @@ -4135,6 +4176,7 @@ + [<plotname>] @@ -4190,6 +4232,7 @@ + error width <value>
     @@ -4248,6 +4291,7 @@ + [<plotname>] @@ -4303,6 +4347,7 @@ + name <string>

@@ -4421,6 +4466,7 @@ + ds9 plot axis x min
$xpaget @@ -4477,6 +4523,7 @@ + ds9 plot axis x max
$xpaget ds9 plot axis x format
$xpaget @@ -4530,6 +4577,7 @@ + ds9 plot legend
$xpaget ds9 plot legend position
@@ -4590,6 +4638,7 @@ + ds9 plot font numbers size
$xpaget @@ -4646,6 +4695,7 @@ + ds9 plot font numbers weight
$xpaget @@ -4702,6 +4752,7 @@ + ds9 plot font numbers slant
$xpaget @@ -4758,6 +4809,7 @@ + ds9 plot title
$xpaget @@ -4814,6 +4866,7 @@ + ds9 plot title x
$xpaget ds9 plot barmode
 @@ -4899,6 +4952,7 @@ + ds9 plot dash
$xpaget @@ -4955,6 +5009,7 @@ + ds9 plot error
$xpaget @@ -5011,6 +5066,7 @@ + ds9 plot error color
$xpaget @@ -5068,6 +5124,7 @@ + ds9 plot error width
$xpaget @@ -5125,6 +5182,7 @@ + ds9 plot name
$xpaset @@ -5181,6 +5239,7 @@ + -p ds9 plot show yes
$xpaset -p ds9 plot shape circle
$xpaset -p ds9 plot shape fill no
@@ -5689,6 +5748,7 @@ + method.

Syntax:
saveimage [fits|eps|gif|tiff|jpeg|png] <filename>
@@ -6020,6 +6080,7 @@ + compression method.

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