From 4781e982ab072d80667c382bb69280ab16ab0e42 Mon Sep 17 00:00:00 2001 From: William Joye Date: Tue, 30 Apr 2019 15:26:35 -0400 Subject: clean up doc --- ds9/doc/ref/analysis.html | 100 +++++++++++++++++++++++----------------------- 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/ds9/doc/ref/analysis.html b/ds9/doc/ref/analysis.html index bf64138..651d2c5 100644 --- a/ds9/doc/ref/analysis.html +++ b/ds9/doc/ref/analysis.html @@ -73,93 +73,93 @@ file:/home/joye/index.html
$height
$depth

Substitute the width, height, or depth of the data file in the command line.

-Syntax:
     $width
+Syntax:
    $width
    $height

-Example:
     echo "$width $height $depth" | $text
+Example:
    echo "$width $height $depth" | $text

$bitpix

Substitute the bitpix of the data file in the command line.

-Syntax:
     $bitpix
+Syntax:
    $bitpix

-Example:
     echo "$bitpix" | $text +Example:
    echo "$bitpix" | $text

$data

Data from the current frame becomes the input data to the command string. This data is in the form of a FITS image. This macro can only used at the beginning of the command string.

-Syntax:
     $data
+Syntax:
    $data

-Example:
     $data | dosomething | $text +Example:
    $data | dosomething | $text

$entry

Display an entry modal dialog. The returned string is substituted. If cancel is selected, the command line is not executed.

-Syntax:
     $entry(<message>)
+Syntax:
    $entry(<message>)

-Example:
     echo "$entry(Enter something here)" | $text +Example:
    echo "$entry(Enter something here)" | $text

$env

Substitute the value of a shell environment variable.

-Syntax:
     $env(<shell variable>)
+Syntax:
    $env(<shell variable>)

-Example:
     echo "$env(PATH)" | $text +Example:
    echo "$env(PATH)" | $text

$filedialog

Display the standard file dialog. Substitutes the returned pathname. Argument specifies if an open file or save file dialog is invoked.

-Syntax:
     $filedialog([open|save])
+Syntax:
    $filedialog([open|save])

-Example:
     echo "$filedialog(open)" | $text
+Example:
    echo "$filedialog(open)" | $text

$filename

Substitute the filename of the data file in the command line. A full filename includes any absolute or relative path. A root filename contains no path. A (2D) subsection defines a subimage from xmin,ymin to xmax,ymax. For Frame3D, a 2D subsection will also include the current slice (PLANE=) parameter if not 1. A 3D subsection defines a subimage from xmin,ymin,zmin to xmax,ymax,zmax and no PLANE parameter.

-Syntax:
     $filename # filename with extname, (2d) subsections, filters
-    $filename(root|root,base) # root filename with with extname, no subsections, no filters)
-    $filename(full|full,base) # full filename with extname, no subsections, no filters)
+Syntax:
    $filename # filename with extname, (2d) subsections, filters
+    $filename(root|root,base) # root filename withwith extname,no subsections, no filters)
+    $filename(full|full,base) # full filenamewith extname,no subsections, no filters)

-Example:
     dosomething $filename | $text
+Example:
    dosomething $filename | $text
    dosomething $filename(root) | $text

$filename[$regions]

Combination of $filename and $regions macros. Generates a series of filenames, each with a region.

-Syntax:
     $filename[$regions]
+Syntax:
    $filename[$regions]
    $filename[$regions(<options>)]

-Example:
     dosomething $filename[$regions] | $text +Example:
    dosomething $filename[$regions] | $text

$geturl

This macro differs from all other macros, including $url, in that no subprocess pipe is created. Only HTTP is supported. The contents of the url are retrieved and sent to $text, $plot, or $image. No other processing is allowed. The primary purpose of this macro is to support external analysis for the Windows platform, which has no subprocess support.

-Syntax:
     $geturl(http://<hostname>:<port>/<query>)
+Syntax:
    $geturl(http://<hostname>:<port>/<query>)

-Example:
     $geturl(http://foo.bar.edu/foo.html) | $text
+Example:
    $geturl(http://foo.bar.edu/foo.html) | $text

$image

The resulting image data is display in a DS9 frame. This macro should be the last macro of a command line. Optional parameter indicates if a new frame and what type of frame is created for the new data. The macro is removed from the command line before execution.

-Syntax:
     $image
+Syntax:
    $image
    $image([new|rgb|3d|current])

-Example:
     doit | $image(new) +Example:
    doit | $image(new)

$message

Display a message dialog box, with option buttons.  After displaying the message, the macro is removed from the command line before execution. If cancel or no is selected, the command line is not executed.

-Syntax:
     $message(<message>)
+Syntax:
    $message(<message>)
    $message([ok|okcancel|yesno],<message>)

-Example:
     $message(okcancel,This is a Message)| doit | $text +Example:
    $message(okcancel,This is a Message)| doit | $text

$null

Expect no output or results from analysis task. Note: no error message will be returned if the analysis task fails to execute correctly.

-Syntax:
     $null
+Syntax:
    $null

-Example:
     echo "Hello, world" > foo | $null +Example:
    echo "Hello, world" > foo | $null

$pan

Substitute current pan location of the particular data file are returned. The default coordinate system is physical.

-Syntax:
     $pan
     $pan(<coordinate system>,<format>)
+Syntax:
    $pan
    $pan(<coordinate system>,<format>)

where:

    coordinate system = [image|physical|detector|amplifier|wcs|wcsa...wcsz]
    sky frame         = [fk4|fk5|icrs|galactic|ecliptic]
    sky format        = [hms|sexagesimal|degrees]

-Example:
     echo $pan(fk5,sexagesimal) | $text
+Example:
    echo $pan(fk5,sexagesimal) | $text

$plot

Display data in plot window. This macro should be the last macro of a command line. The data is read via STDIN and consist of a pair of coordinates, with option error values. (xy, xyex, xyey, xyexey) Default dimension is xy. The macro is removed from the command line before execution.

For $plot(stdin) only:

The title, x axis label, and y axis label are assumed to be on the first line of input, delimited with a new-line. However, if the data starts with $BEGINTEXT, all text between $BEGINTEXT and $ENDTEXT will be removed from the data and displayed in a separate text dialog window, with the remaining data, including the title, x axis label, and y axis label, will be displayed in a plot window. Furthermore, if the data contains the string $ERROR, an error is assumed to have occurred and a text dialog window is displayed only.

-Syntax:
     $plot
+Syntax:
    $plot
    $plot(,,,)
    $plot(<title>,<x axis label>,<y axis label>,[xy|xyex|xyey|xyexey])
    $plot(stdin)

-Example:
     doit | $plot(This is aTitle,X Axis,Y Axis)
     doit | $plot(stdin) +Example:
    doit | $plot(This is aTitle,X Axis,Y Axis)
    doit | $plot(stdin)

$regions

Substitute region definition in specified region format, coordinate system, and coordinate format. The default coordinate system is physical, default coordinate format degrees, and default region format DS9. Arguments may appear in any order, as long as they are separated by ',' and no spaces. If one or  more properties are specified, only regions with all of the specified properties will be substituted.

-Syntax:
     $regions
+Syntax:
    $regions
    $regions(<options>)

where options are one of the following:

    regions format    = [ds9|ciao|saotng|saoimage|pros|xy]
@@ -179,31 +179,31 @@ $depth

    $exclude_regions_pixels
    $exclude_regions_degrees
    $exclude_regions_hms

-Example:
     dosomething $regions | $text
+Example:
    dosomething $regions | $text
    dosomething $regions(pros) | $text
    dosomething $regions(source,wcs,fk5) | $text
    dosomething $regions(saotng,background,exclude,ecliptic,sexagesimal) | $text

$text

Display text in a text dialog window. This macro should be the last macro of a command line. To display text from only STDOUT use '|' as the pipe command. To display text from both STDOUT and STDERR, use '|&' as the pipe command. No parameters are required. The macro is removed from the command line before execution.

-Syntax:
     $text
+Syntax:
    $text

-Example:
     doit | $text # stdout
+Example:
    doit | $text # stdout
    doit |& $text # stdout and stderr

$url

URLs are processed and stored in a temporary file. Only HTTP and anonymous FTP are supported.

-Syntax:
     $url(http://<hostname>:<port>/<query>)
+Syntax:
    $url(http://<hostname>:<port>/<query>)
    $url(ftp://<hostname>/<filename>)

-Example:
     $url(http://legacy.gsfc.nasa.gov/rosat/data/p000s26b.img.Z) | uncompress | $image
+Example:
    $url(http://legacy.gsfc.nasa.gov/rosat/data/p000s26b.img.Z) | uncompress | $image
    $url(ftp://legacy.gsfc.nasa.gov/rosat/data/hri/images/rh100193_img.fits) | $image

$vo_method

Returns the vo method.

-Syntax:
     $vo_method
+Syntax:
    $vo_method

-Example:
     echo '$vo_method' | $text
+Example:
    echo '$vo_method' | $text

$value

Substitute the value at the location of the cursor of an bind event.

-Syntax:
     $value
+Syntax:
    $value

Example:
    echo "$value" | $text
@@ -211,7 +211,7 @@ Example:
$y
$z

Substitute coordinates of an bind event. When a bind event is triggered, the x,y coordinates of the mouse of the particular data file are returned. The default coordinate system is physical. This macro is only available for bind commands. For datacubes, the z coordinate is returned based on the current slice selected.

-Syntax:
     $x
+Syntax:
    $x
    $x(<coordinate system>,<format>)
    $y
    $y(<coordinate system>,<format>)
@@ -222,19 +222,19 @@ $z

    sky frame         = [fk4|fk5|icrs|galactic|ecliptic]
    sky format        = [hms|sexagesimal|degrees]

-Example:
     echo "$x $y" | $text
+Example:
    echo "$x $y" | $text
    echo "$x $y $z" | $text
-    echo "$x(fk5,sexagesimal) $y(fk5,sexagesimal)" | $text
     echo "$x(wcs) $y(wcs) $z(wcs)" | $text
+    echo "$x(fk5,sexagesimal) $y(fk5,sexagesimal)" | $text
    echo "$x(wcs) $y(wcs) $z(wcs)" | $text

$xpa

Returns the xpa access point name.

-Syntax:
     $xpa
+Syntax:
    $xpa

-Example:
     echo '$xpa' | $text +Example:
    echo '$xpa' | $text

$xpa_method

Returns the xpa method.

-Syntax:
     $xpa_method
+Syntax:
    $xpa_method

-Example:
     echo '$xpa_method' | $text +Example:
    echo '$xpa_method' | $text

Help

The user may define his own HELP message. This message will be available to the user as a menu item. An optional label maybe specified. The default label is Help. When invoked, an text dialog window will appear, containing the message. Multiple HELP items maybe defined within a menu or across hierarchical menus.

Example: @@ -364,12 +364,12 @@ hmenu Test Basics
    Test $xpa_method
    *
    menu
-    echo $xpa_method | $text
+    echo $xpa_method | $text

    Test $vo_method
    *
    menu
    echo $vo_method | $text
-
     Test $filename
+
    Test $filename
    *.fits
    menu
    echo $filename | $text
@@ -383,11 +383,11 @@ hmenu Test Basics
    *.fits
    menu
    echo "$xdim $ydim $bitpix" | $text
-
     Test $xcen $ycen
+
    Test $xcen $ycen
    *.fits
    menu
    echo "$xcen $ycen" | $text
-
     Test $env
+
    Test $env
    *
    menu
    echo $env(PATH) | $text
-- cgit v0.12