Reference manual on Aladin script commands (v7.536)


PLANE:                          VIEW:
   get servers [target] [radius]  mview [1|2|4|9|16] [n]
   load filename                  cview [-plot] [[x] v]
   select x1 [x2..]               select v1 [v2..]
   set [x1] [x2..] prop=value     zoom ...
   hide|show [x1] [x2..]          northup|unnorthup [v1] [v2..]
   mv|copy x1 x2                  lock|unlock [v1] [v2..]
   rm [x1] [x2..] | -all          stick|unstick [v1] [v2..]
   export [-fmt] x filename       mv|copy v1 v2
                                  rm [v1] [v2..] | -lock
IMAGE:                            save [-fmt] [-lk] [WxH] [filename]
   cm [x1|v1...] [colorMap...]    coord|object
   RGB|RGBdiff [x1|v1...]
   blink|mosaic [x1] [x2...]      CATALOG:
   + | - | * | / ...              filter ...
   norm [-cut] [x]                addcol ...
   conv [x] ...                   xmatch x1 x2 [dist] ...
   kernel ...                     cplane [name]
   resamp x1 x2 ...               thumbnail [npix|radius"]
   crop [x|v] [[X,Y] WxH]         search {expr|+|-}
   flipflop [x|v] [V|H]           tag|untag

   contour [nn] [nosmooth] [zoom] select -tag
   grey
   bitpix [-cut] [x] BITPIX
  
GRAPHIC TOOL:                   FOLDER:
   draw [color] fct(param)        md [-localscope] [name]
   grid [on|off]                  mv|rm [name]
   reticle [on|off]               collapse|expand [name]
   overlay [on|off]               show|hide [name]
 
MISCELLANEOUS:
   backup filename     status       sync       demo [on|off|end]
   pause [nn]          trace        mem        info msg
   macro script param  call fct     list [fct] reset
   setconf prop=value  function ... quit       help ...


addcol - column generator

Synopsis:
addcol [plane index or plane name],[new column name],[expr of new col],[unit for new col],[UCD for new col],[nb of decimals to keep]

Description
Allow one to generate a new column for a tabular data plane. The new column will appear in red color in the measurement frame. The column references can be specified by their name: syntax ${name} or by the UCD associated to: syntax $[UCD]. Available operators are +,-,*,/,^(power). Available functions are "abs" (absolute value), "cos" (cosinus), "deg2rad" (degrees to radians), "exp" (exponential), "ln" (natural logarithm), "log" (base 10 logarithm), "rad2deg" (radians to degrees), "sin" (sinus), "tan" (tangent). UCD and unit parameters are optional and can be left blank.

Example:
addcol GSC2.2,B-V,${Bmag}-${Vmag},,PHOT_MAG addcol 1,flux,10^(0.4*(8.46-${Imag}))


backup - backup the Aladin stack

Synopsis:
backup filename

Description
Generate a backup of the Aladin plane stack in the specified file. The usual extension for this kind of file is ".AJ". The internal format is Aladin proprietary (XML syntax). Only image, tabular data and graphical overlays will be taken into account. The original pixels are lost: only the 8bit pixel values will be kept.

Example:
backup /home/M1.aj

See also: load, export, save


bitpix - Image pixel re-encoding

Synopsis:
[name=] bitpix [-cut] [x] BitpixCode

Description
The "bitpix" command re-encodes image pixel values. The target pixel format follows the FITS conventions: -64: double, -32: float, 64: long, 32: integer, 16: short, 8:byte With the -cut option, the visible range of pixel values is extended for the best in the target encoding space, otherwise, a simple "casting" is operated. In this last case, too large values (resp. too small values) are forced to the target range limits. If the image designation is omitted, Aladin will work on the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
bitpix -32
imgTgt = bitpix -cut imgSrc 16

See also: conv, +, -, *, /, norm


blink - create a blink sequence of images

Synopsis:
[name=] blink [x1|v1] [x2|v2...]

Description
Create a blink sequence of several images (at least 2 images). The images can be specified by their plane or by their view (in multiview mode). Each image is resampled according to the astrometrical solution of the first image.

Example:
blink 2 3 4 5
blink DSS1* DSS2*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: RGB, resamp, mosaic


call - script function call

Synopsis:
call fonctionName[(param,...)]

Description
For calling a script function previously defined via the function command

Example:
call data(m1)

See also: function, list, setconf


cm - set the color map and/or the cut parameters

Synopsis:
cm [x1|v1 ...] [colorMap | cutParams ...]

Description
Modify the colormap and/or the pixel cut parameters of the specified images. The color maps are: .gray: 256 gray levels (default color map) .BB: 256 orange levels (useful to improve contrast impression) .A: equal color areas .stern: helping for the distinction of hight pixel values .rainbow: RAINBOW color map from IDL .eosb: Eos B color map from IDL .fire: Fire color map from ImageJ The cut parameters are: log|sqrt|linear|pow2: transfer function reverse|noreverse: video mode autocut|noautocut:autocut apply or not min..max|all: original pixel range or all pixels.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
cm stern
cm DSS2* log
cm A1 B1 noreverse log 10..100 autocut


collapse - collapse folders

Synopsis:
collapse [FolderName1] [FolderName2...]

Description
Collapse the specified folders in the Aladin stack. Without FolderName, the current selected folder is collapsed.

Example:
collapse FoldA "Folder 1"

See also: expand, md, hide, show, mv, rm


conv - Image pixel convolution

Synopsis:
[name=] conv [x] kernelName
[name=] conv [x] gauss({fwhm|sigma}=angle[,radius=nn])
[name=] conv [x] n00 n01 n02... n10 n11 n12...

Description
The "conv" command applies a convolution on the specified image. The kernel can be designated either by its name, or a gaussian filter, or a specifical matrix. See kernel command for details. If the image designation is omitted, Aladin will work on the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
conv Gauss2.5
foo = conv @1 Mex5

See also: kernel, +, -, *, /, norm, bitpix


contour - Draw isocontours of the current image

Synopsis:
[name=] contour [ nn [nosmooth] [zoom] ]

Description
Draw nn isocontours for the current selected image. The result is set in a new plane which can be overlaid on other images of the same field. nn sets the number of contours to draw. If not defined, 4 contours are plotted by default. The parameter nosmooth allows one to switch the smoothing feature off. Smoothing allows a faster computation and reduces the number of control points. It is activated by default. The parameter zoom restricts the computation to the current view of the selected image plane. By default, contours are computed over the whole image.


coord|object - show a specifical position

Synopsis:
hh mm ss {+|-}dd mm ss - sexagesimal notation
dd.dddd {+|-}dd.dddd - decimal notation
xxxx - astronomical object identifier

Description
Show the specified position by moving the reticle (large magenta colored cross) on it. If the user indicates an astronomical object instead of coordinates, Aladin will automatically query CDS sesame resolver to have the corresponding coordinates.

Example:
05 34 31.97 +22 00 52.1
083.63131 +22.01160
M1

See also: lock, reticle


copy - copy planes or views

Synopsis:
1. copy [x] [foo]
2. copy v1 v2

Description
1. Allow one to create a copy of the plane x (the selected one by default) to a new plane called "foo". Another syntax for the same command can be "foo=x" (see [name=] for details).
2. Allow one to create a copy of the view v1 to v2 place (see multiview mode: mview). Notice that each view can have is own zoom factor but still share the same image properties notably the colormap. Copying a plane rather than a view allows one to modify the images independently (colormap, cropping...) but use more memory.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
copy "DSS2.J.SERC" foo
copy inOtherPlane
copy A2 C3

See also: cview, mv, cm, crop, zoom


cplane - source plane creation

Synopsis:
cplane [name]

Description
Create a new catalog plane in the Aladin stack with the current selected sources. This command is useful to extract a set of objets after applying a filter, or to merge two catalog planes together (select x1 x2; cplane).

Note - Notice that the select command on a catalog plane also selects its sources. The typical sequence could be: gsc = get Vizier(GSC2.2) HD1 filter mag { $[phot.mag*]<16.5 || $[phot.mag*]>17 { hide } } filter mag on select gsc cplane MySelection

See also: select, get, export


cview - creation of view

Synopsis:
cview [[x] v]
cview -plot x(columnName,columnName) [v]

Description
This command can only be used in multiview mode. It allows one to manually create a view at the position "v" of the Aladin plane stack "x". The "-plot" param allows you to create a scatter plot instead of a sky view. It is only relevant for catalogue planes. if a scatter plot is already existing in the specified view, Aladin will add the new catalogue to the existing plot.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
cview DSS1.V.SERC C3
cview 2 (use a default view place for the plane number 2)
cview -plot Simbad(PMRA,PMDEC)

See also: mview, mv, copy, rm


crop - Image cropping

Synopsis:
[name=] crop [x|v] [[X,Y] WxH]

Description
Crop the specified image to the area defined by the X,Y,W,H parameters, where X,Y determines the up-left corner and W,H determines the size. If X,Y is omitted, the area is centered on the reticle location. If both X,Y and W,H are omitted, the current zoom area is used. If the area is partially outside the image, the area is automatically adjust to the intersection. The crop applied on an "allsky" plane : - is only possible if this plane is activated and visible; - in case of true pixel display mode (FITS tiles) : applied a full bilinear resample on the best possible resolution of the survey => use it carefully in case of large area. The result is a Fits image; - otherwise, applied a simple dump of view. The result is a JPEG image

Example:
crop DSS2.J.SERC 100,50 300x200
crop 300x400

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: copy, mosaic, flipflop


demo - demonstration mode

Synopsis:
demo [on|off|end]

Description
Switch on or off the demonstration mode. If the demonstration mode is activated, the script commands will be "demonstrated" by explaining step by step how to obtain the same result with the Aladin graphical interface. A typical usage: demo on get Aladin(MAMA) galactic center

Note - Not all script command have a "demo" mode implemented. In this case, the command is simply executed.


draw - graphical overlay commands:draw fct(param)

Synopsis:
. draw [color] fct(param...) . draw newtool[(name)] . draw newfov(xcenter,ycenter[,name])

Description
Allows one to manually add graphical overlays on views. There are several graphical functions available: .string(x,y,text) .tag(x,y[,label,distance,angle,type,fontSize]) .line(x1,y1,x2,y2,...[,text]) .polygon(x1,y1,x2,y2,...[,text]) .vector(x,y,dx,dy) .dist(x1,y1,x2,y2) .box(x,y,dx,dy) .ellipse(x,y,semiMA,semiMI,angle) .circle(x,y,r) .phot(x,y,r) .arc(x,y,r,PA,angle) .pickle(x,y,r1,r2,PA,angle) The coordinates must be expressed in the current coordinate frame. It can be image XY coordinates (use &setconf frame=XY) By default, Aladin puts the new object in the last drawing plane in the stack. It is possible to create manually a new one by the "draw newtool(name)" or "drawfov(x,y,name)" commands. The optional color parameter follows these syntaxes: colorName or rgb(n,n,n) The tag types are: reticle, bigreticle, smallcircle, circle, bigcircle, arrow, bigarrow, nopole

Note - The parameter separator can be the comma or the space. In case of coordinates use the colon to group the subfields or quote them (see examples) All DS9 region commands are automatically translated in the corresponding Aladin commands.

Example:
draw string(300,200,"my favourite galaxy")
draw rgb(100,34,89) tag(10:12:13,+2:3:4,"Big galaxy",100,30,circle,22)
draw red circle("1 2 3" "+4 5 6" 3arcmin)


expand - expand folders

Synopsis:
expand [FolderName1] [FolderName2...]

Description
Expand the specified folders in the Aladin stack. Without FolderName, the current selected folder is expanded.

Example:
expand FoldA "Folder 1"

See also: collapse, md, hide, show, mv, rm


export - save images or tabular data

Synopsis:
export [-fmt] x filename
export -ROI filename

Description
Export the plane "x" in the specify filename. The optional "-fmt" parameter modifies the default format -Tables: default TSV, can be replaced by VOTable (-votable or ".xml" extension) -images: default FITS, can be replaced by JPEG (-jpg or ".jpg" extension) The "-ROI" parameter allows you to save in several FITS files (prefixed by "filename") the ROI views. Notice : The image pixels will be truncated to 8 bits if the original pixels are not available. Also, the recorded WCS calibration will be the last one used for this image. The Blink plane cannot be exported.

Example:
export DSS1.V.SERC C:\DSS2image.fits
export -votable GSC1.2 /home/gsc1.2.dat
export RGBimg m1RGB.fits

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

See also: load, save, backup, thumbnail, rm -ROI


filter - Define and activate a filter

Synopsis:
filter name { condition1 { draw|hide [color] [action1] } condition2 { draw|hide [color] [action2] } : }
filter [name] {on|off}

Description
A filter is a special plane constraining how the sources of the catalog planes beneath it in the Aladin stack will be displayed. The first syntax allows to define a new filter, the second syntax allows switching the specified filter on or off. Available operators are +,-,*,/,^(power). Available functions are "abs" (absolute value), "cos" (cosinus), "deg2rad" (degrees to radians), "exp" (exponential), "ln" (natural logarithm), "log" (base 10 logarithm), "rad2deg" (radians to degrees), "sin" (sinus), "tan" (tangent). The available actions are: square, cross, rhomb, plus, dot, microdot, circle(param,[min radius size, max radius size]), fillcircle(param,[min radius size, max radius size]), ellipse(semi-major axis,semi-minor axis,pos angle), pm(proper motion RA,proper motion Dec), rainbow(param) moreonfilter...


filter - continuation... The column references can be specified by their name: syntax ${name} or by the UCD associated to: syntax $[UCD]. The wildcard "*" can be used both for column name or UCD designation. In the case of multiple matching columns, the first one will be taken into account.

Example:
filter star { $[CLASS_OBJECT]="Star" { draw } }
filter flux { ${flux}>1000000 Jy/s { draw cyan plus draw circle(-$[PHOT*]) } }

Note - Refer to the Filters manual for more details.


function - script function definition

Synopsis:
function name[($param,...)] { code... }

Description
For defining a script function callable by the call command. The function name can be followed by a parameter list (syntax: $xxxx,$yyy,...) which will be subsituted by the call(xxx,yyy,...) values. Via the setconf bookmarks=[+|-]functionName,... any function can be used for defining a bookmark appearing in the Aladin bookmark bar.

Note - The dedicated parameter names $TARGET and $RADIUS will be substituted by the current view area parameters if these values are not specified in the call command.

Example:
function data($TARGET) { get simbad $TARGET;get NED $TARGET }

See also: call, list, setconf


flipflop - vertical or horizontal mirroring

Synopsis:
[name=] flipflop [x|v] [V|H|VH]

Description
Apply a vertical or horizontal mirroring of the specified image. The astrometrical solution is adapted accordingly.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
flipflop H
foo=flipflop DSS1* VH

See also: copy, mosaic, crop


get - call a remote image or tabular data server

Synopsis:
[name=] get Server([paramname=]keyword,...) [Target] [RadiusUnit]

Description
Allows one to query remote data providers. The result (images or tabular data) will be memorized in an Aladin stack plane and a view of this plane is automatically created. The get syntax is flexible in order to cover all kinds of servers. - Server: Aladin, Simbad, VizieR, NED, SkyView, DSS.ESO, DSS.STScI, ..., or even Fov or File (or any other server names displayed in the server frame). Each server name can be followed by a comma separated keyword list in parentheses (optionally precedeed by "paramName="). The number and order of the keywords does not matter. Aladin tries to automatically associate the keywords with the server query vocabulary. -Target: astronomical object identifier or J2000 coordinates in sexagesimal syntax (with blank separator). By default, Aladin takes into account the last specified target. -Radius: must be specified with units (deg,arcmin,arcsec or ' ") with no blanks between the figures or the units. By default, Aladin takes the most appropriate radius according to the current view.

Example:
get Aladin M99
get ESO(DSS2,FITS) M1 10'
get SkyView(pixels=800,Survey=2MASS) M1
foo=get File(http://myserver/myfile)

See also: load, show, cview, setconf timeout=...


grey - color image conversion

Synopsis:
grey

Description
Convert the current RGB image selected in the stack into a monochromatic image (grey levels)

Example:
grey

See also: cm, RGB


grid - coordinate grid management

Synopsis:
grid [on/off]

Description
Switch the coordinate grid on or off

Example:
grid on

See also: setconf overlays=..., reticle, overlay


help - in line help

Synopsis:
help [cmd|all|off]

Description
display this help for each command and a resume of all available commands if there is no parameter. The "off" parameter allows one to display the current view again. The "all" parameter allows one to print on the console help about all Aladin script commands.


hide - hide planes

Synopsis:
hide [x1] [x2..]

Description
Hide the specified planes (or the selected planes if there is no parameter).

Example:
hide DSS1.V.SERC
hide (hide the selected planes):
hide 1 2 DSS2*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

See also: show, select


hist - history

Synopsis:
hist [n]

Description
Display the script command history in the Aladin console and on the standard output. By default, the last 10 commands are displayed.

Example:
hist 20

See also: status


info - message status

Synopsis:
info msg

Description
Print a message in the status window (between the main frame and the measurement frame). If the demo mode is activated, the message will be displayed in a separated window

See also: demo


kernel - Convolution kernel definition

Synopsis:
kernel name=n00 n01 n02... n10 n11 n12...
kernel name=gauss({fwhm|sigma}=angle[,radius=nn])
kernel [mask]

Description
The "kernel" command allows you to define new convolution kernels which can be used on images via the conv command. The matrix can be fully provided (line after line), or defined by a gaussian filter. In this case, it is possible to specify the FWHM or the sigma (by default in arcmin but any angle unit can be added); The matrix radius can also be specified. If it is omitted, Aladin will find it automatically at 3 x sigma. A name must precede the matrix definition. Without matrix definition, kernel command displays the list of already available kernels or, if a specifical kernel name is given, the associated matrix.

Note - Aladin has a list of predefined kernels.

Example:
kernel myShift=1 0 0 0 0 0 0 0 0
kernel mygauss=gauss(fwhm=30')
kernel mygauss*

See also: conv, +, -, *, /, norm


list - function list and function edition

Synopsis:
list
list functionNameMask

Description
Provides the list of defined functions. If a functionNameMask is specified (with possible * and ? wilcards), the matching functions are totally edited

Example:
list
list data

See also: function, call, setconf


load - load a file

Synopsis:
[name=] load filename
[name=] load url

Description
Allows loading of a local or remote file containing either an image, a catalog or any other data type used by Aladin. The contents of the file is automatically detected by Aladin. The file may be gzipped. If the filename specifies a directory, Aladin automatically creates a MetaData Tree describing all the data in the directory and its sub-directories. A "metadata file" describes a set of data The supported formats are: -Images: FITS, Jpeg, PNG, MEF, Healpix maps -Tabular data: TSV, CSV, VOTable, FITS, S-extractor, CSV-Excel, ASCII -MetaData tree: SIA, IDHA -Script: Aladin script (.ajs), DS9 regions (.reg) -Backup: Aladin stack backup (AJ extension) -Healpix dir: directory containing Aladin Healpix tree -Glu dic: GLU server form description

Example:
load DSS1-M1.fits.gz

See also: get, export, save, backup


lock - lock the view

Synopsis:
lock [v1] [v2...]

Description
The "lock" behavior is interesting notably in multiview mode and if the view does not show all the image (depending of the zoom factor and the image size and the Aladin frame size in the screen). In this case, the zoom factor and the central position of a such view are locked until you unlock it

Note - "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
lock A2 C3

See also: unlock, stick, unstick, zoom, reticle


macro - execute a macro

Synopsis:
macro scriptFile paramFile

Description
Allow one to launch a macro via a script command (see manual for macro details). The scriptfile contains the list of commands, one per line. Use $1, $2 as parameters. The paramFile contains the list of parameters for each macro execution. The parameters for the first execution are provided by the first line, the parameters must be separated by "TAB" character. The second line contains the list of parameters for the second macro execution, etc. scriptFile and paramFile can be pathfile or url (remote access via web)

Example:
macro myscript.ajs myparams.txt
macro myscript.ajs http://myserver.org/getParamFor?M1


md - create a folder

Synopsis:
md [-localscope] [name]

Description
Create a folder on the top of the Aladin stack. The name can be omitted, in this case it will be automatically created following this syntax: "Fold~nn". The -localscope parameter means that the planes in the folder, and only these planes, can be projected on images in the same folder (useful in multiview mode only). You can move planes into a folder with the mv command.

Example:
md M1-folder

See also: mv, rm, hide, show


mem - memory status

Synopsis:
mem

Description
Display the java memory used (after a garbage collector).


northup - view north oriented

Synopsis:
northup [v1] [v2...]

Description
By default, an Aladin view is drawn according to the astrometrical solution of the reference plane (generally the background image). This function will force the view to draw North up, East left.

Note - "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
northup

See also: unnorthup, cview, grid


mosaic - create a mosaic image

Synopsis:
[name=] mosaic [x1|v1] [x2|v2...]

Description
Create a mosaic image of several images. The images can be specified by their plane or by their view (in multiview mode). Each image is resampled according to the astrometrical solution of the first image (closest pixel algorithm). The overlaying pixels will be averaged. The mosaic uses the 8 bits pixels of each image (take into account the cut level process). It is not possible to create mosaics from the original pixels.

Example:
mosaic @2 @3 @4 @5
mosaic DSS1* DSS2*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: blink, RGB, resamp, crop


mv - move planes or views

Synopsis:
mv x1 x2 - for stack manipulation
mv v1 v2 - for multiview manipulation
mv x1 [x2...] name - for folder manipulation

Description
The "mv" command behaviour depends of the nature of its parameters. If the parameters describe two planes (x1 and x2), Aladin will move x1 plane behind the x2 plane in the Aladin stack. If the parameters describes two views (v1 and v2) in multiview mode, Aladin will move the view v1 to the v2 place. The v2 view place will be overiden by v1 even if v2 was not empty. If the parameters describe planes and the last parameter describes a folder, the planes will be move into the folder.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: md, cview


norm - Image pixel normalisation

Synopsis:
[name=] norm [-cut] [x]

Description
The "norm" command normalizes the image pixels between 0 and 1 (float 32bits format). With the "-cut" parameter, the normalisation takes into account the min and max pixel values used by the current pixel mapping (see cm ), otherwise all original pixel range will be considered. If the image designation is omitted, Aladin will work on the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
norm
norm DSS1.SERC.J
foo = norm -cut @1

See also: +, -, *, /, conv, bitpix


overlay - Overlay information management

Synopsis:
overlay [on/off]

Description
Switch on or off the overlay information on the views (scale, plane name, North direction, field size).

See also: setconf overlays=..., grid, reticle


pause - script pause

Synopsis:
pause [nn.nnn]

Description
wait nn.nnn seconds, 1 by default. Very useful for demonstration...


print - print function

Synopsis:
print

Description
Allow one to print the current views. In case of multiview mode, the visible views will be printed on the same page

Note - Unfortunately, Java Printer method opens automatically a stupid driver window before printing. So this command CANNOT REALLY BE USED as a "script" command.


quit - end of Aladin session

Synopsis:
quit

Description
Stop Aladin


resamp - create a resampled image

Synopsis:
[name=] resamp x1|v1 x2|v2 [8|Full] [Closest|Bilinear]

Description
Resample a image according to the astrometrical solution of another image. Available parameters: -8: only on visual pixels (8 bits depth) - default -(F)ull:on the real pixels if they are avaiable -(C)losest: Closest pixel algorithm (the fastest) -(B)ilinear: Bilinear interpolation algorithm (better) - default

Example:
resamp 2 3
resamp DSS1* MAMA*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: RGB, blink


reset - reset Aladin

Synopsis:
reset

Description
Reset Aladin by removing all views and all planes. Restore one view mode and clean the memory.

See also: rm


reticle - reticle management

Synopsis:
reticle [on|off|large]

Description
Switch on or off the reticle designating the last click position. The reticle is displayed as a large magenta colored cross or two magenta (vertical & horizontal) lines. In this last case, you have to specify the "large" parameter instead of "on".

Note - - An astronomical object or sexagesimal J2000 coordinates simply written instead of an Aladin script command will automatically move the target (and the reticle) to the corresponding position

See also: lock, setconf overlays=..., grid, overlay


RGB - create a RGB image

Synopsis:
[name=] RGB [x1|v1 x2|v2 x3|v3]

Description
Create a colored composed image from three images. The images can be specified by their plane or by their view (in multiview mode). The first image provides the Red component, the second image provides the Green component and the last image the Blue component. Each image is resampled according to the astrometrical solution of the first image.

Example:
RGB @2 @3 4
RGB DSS1* DSS2* MAMA*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: RGBdiff, blink, resamp, mosaic


RGBdiff - create a RGB image with the difference of two images

Synopsis:
[name=] RGBdiff [x1|v1 x2|v2]

Description
Create a colored composed image from the subtraction of two images. The images can be specified by their plane or by their view (in multiview mode). The resulting pixels greater than zero are displayed in red color, the other pixels are displayed in green color. The second image is resampled according to the astrometrical solution of the first image.

Example:
RGBdiff @2 @3
RGBdiff DSS1* DSS2*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: RGB, blink, resamp, mosaic


rm - delete planes or views

Synopsis:
rm [x1] [x2..] - for stack manipulation
rm [v1] [v2..] - for multiview manipulation
rm name - for folder manipulation
rm -ROI|-all - for specifical usage

Description
The "rm" command behaviour depends of the nature of its parameters. If the parameters describe planes (x1...), Aladin will remove these planes in the Aladin stack and all the associated views. If the parameters describe views (v1...), Aladin will remove these views. If the parameter is the "-ROI" reserved keyword, Aladin will remove all ROI views (see thumbnail ). The "-all" parameter will remove all planes and all views.

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1). "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

See also: get, cview, thumbnail


save - save the current view

Synopsis:
save [-eps|-jpg[NN]|-png] [-lk] [WxH] [filename]

Description
Save the current view (image+overlays) in a file (BMP format by default or EPS, JPEG or PNG). The parameter -eps (resp. -jpg or -png) is optional if the proper filename extension is used (.eps, .jpg or .png). The jpg parameter can be followed by a quality indicator [0..100]. The astrometrical calibration is conserved for FITS, JPEG and PNG. In multiview mode, only the selected view will be saved. The -lk parameter generates an associated Tab-Separated-Value file (extension ".lk") containing the XY image coordinates, identifier and HTTP url for each overlaying astronomical source. This feature is dedicated for creating a clickable web map" page (see FAQ) The dimension of the output image can be specified (in pixels) only in "nogui" mode (Aladin session with no graphical interface (-nogui command line parameter). Use -1x-1 for avoiding any resizing. Also in nogui mode, if there is no filename, the result is written on the standard output.

Note - BMP is a simple bitmap format, JPEG is a lossy compressed format, PNG is a lossless compressed format, EPS (Encapsulated Postscript) is dedicated for publications (notably in latex documents).

Example:
save m1.eps
save -lk home\img.png
save -jpg97 300x300

See also: load, export, backup


!!! help error: command "scale" unknown !


search - Search and select specifical catalog sources

Synopsis:
search [-|+]expression
search {-|+}

Description
The search command selects all sources matching the parameter expression. The search is done amongst all sources in the stack catalog planes. With the prefix '+', the matched sources will be appended to a previous selection, with the prefix '-', the matched sources will be removed of the previous selection The expression can be .a keyword .a column name followed by a boolean expression (ex:Type=Star) .a column name embedeed in abs. characters followed by a boolean expression (ex: |PM|>10) The + or - parameter without any expression moves the reticle on the next source (resp. the previous source) of the previous search. With a hight zoom value, it provides a powerful tool for browsing quickly a list of sources.

Example:
search |Mag|>=10
search -OTYP*!=UV
search +

See also: zoom, select, tag, cplane


select - select views and/or planes

Synopsis:
1. select x1|v1 [x2|v2] ...
2. select [x|v] frame=nn
3. select -tag

Description
1. Select planes or views by their identifier in order to apply a function to them (see also section) A plane identifier can be the number of the plane in the Aladin stack (the bottom one is 1). It can be also the label of the plane, allowing use of the wildcard "*". In this case, the first plane matching the identifier will be taken into account. In multiview mode, you may select a view by its coordinates: a letter for the column and a digit for the line, (ex: B2). If a plane containing catalog sources is selected, its sources will be selected also. 2. Select a particular frame for a cube. 3. Select sources previously tagged.

Example:
select DSS1.V.SERC
select A1 A3 C2 1 3 4 DSS1*
select (unselect the previous selection)
select frame=10
select -tag

See also: cview, tag, cplane, thumbnail No default string for [Help.scale]


set - modify a plane property

Synopsis:
set [x1] [x2...] prop=value
set x/component prop=value
set x FITS:keyword=value

Description
Allow one to modify a propertie of the planes specified by "x" (or by default, the selected planes).The "prop" is a keyword describing a plane propertie. The keyword list for a given type of plane can be obtained by the status script command on this plane. If the propertie is concerning only a component of the plane (for instance a sub-FoV of a Field plane), the plane designation has to be suffixed by the component name (with / separator). The dedicated "FITS:" value prefix allows one to modify directly the FITS header associated to a plane, and by this way it is possible to modify the WCS keywords and the associated astrometrical calibration

Note - - Notice that the "value" can not contain the character "=".
- "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1)

Example:
set Sim* PlaneID=MyPlane
set Simbad filter=All objects
set HST/FGS2 Status=hide
set DSS1* FITS:CRPIX1=400

See also: status, setconf


setconf - modify a session property

Synopsis:
setconf prop=value

Description
Allow one to modify a configuration propertie. The available properties are: .frame coordinate frame (ICRS|ICRSd|J2000|J2000d|B1950|B1950d |Ecliptic|Gal|SGAL|XY image|XY linear); .bookmarks function name list (comma separated possibly precedeed by + or -); .overlays overlay list (scale,label,size,NE,grid,reticle,target,pixel) (comma separated possibly precedeed by + or -); .colormap pixel mapping (autocut|noautocut reverse|noreverse) gray|BB|linear|stern|rainbow|eosb|fire log|sqrt|linear|pow2); .dedicatedfilter dedicated filters (on|off); .fir default directory; .CSV character separator for CSV parsing .sync auto sync mode (on|off) .timeout plane loading timeout (in mn|off)

Example:
setconf Dir=/home/mydir
setconf frame=Gal
setconf bookmarks=DSS,Simbad,NED
setconf CSV=:
setconf colormap=autocut BB noreverse
setconf overlays=-NE

See also: set, sync, function, call, list, overlay


show - show planes

Synopsis:
show [x1] [x2..]

Description
Show the specified planes (or the selected planes if there is no parameter). If there is no view of a specified plane, a view will be created automatically. Also, if there is an existing view of the plane but it is not visible (outside the scroll panel), the view scroll bar will be automatically adapted to show it.

Example:
show DSS1.V.SERC
hide (hide the selected planes):
hide 1 2 DSS2*

Note - "x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

See also: hide, select


status - Aladin stack/views status

Synopsis:
status [{stack|views|x1 [x2...]}]

Description
display the stack status, or view status or the status of specified planes or views on the standard output (all planes and views by default).

Example:
status PlaneID Simbad PlaneNb 2 Type Catalog Status shown Url http://simbad.u-strasbg.fr/cgi-bin/simbad-xml.pl?Ident=m1 Target 05:34:31.97 +22:00:52.1 NbObj 43 Shape dot Color blue ViewID A1 Centre 05:34:31.61 +22:00:52.1 Size 28.06' x 28.0' Zoom 1x Proj [Simbad] TANGENTIAL Status selected

See also: set


stick - view "sticking"

Synopsis:
stick [v1] [v2...]

Description
By default, an Aladin view can be scrolled (according to the current multiview mode). A view may be sticked to keep it in the same place even if you scroll the view panels. This funtion is very useful in multiview mode in order to easely select a set of views amongst many views (typically generated by the ROI extraction mechanism), by moving the interesting view into a "sticked" view

Note - "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
stick A1 A2 A3

See also: unstick, lock, unlock, cview, mv, thumbnail


sync - manual plane synchronization

Synopsis:
sync

Description
Wait explicitely until all planes are ready (corresponding to a "not blinking status plane"). By default Aladin is running in auto sync mode meaning that script commands requiring previous results will automatically wait until all planes in the stack are ready. However, this sync command can force a synchronisation at any time or if the user has removed the auto sync mode via the setconf syncproperty.

Example:
setconf sync=off; A=get ESO M1; sync; A = A/2

See also: setconf


tag - tag all selected sources

Synopsis:
tag

Description
This command tags all current selected sources (the sources shown in the measurement frame). When a tagged catalog source is selected, it is displayed with a dedicated magenta color and its associated measurements shown a validated checkbox at the beginning of the line. Used with the search, select -tag and createplane commands, it provides a flexible method for generating catalog samples.

Example:
search Star tag search UV tag select -tag cplane

See also: untag, search, select, cplane


thumbnail - Thumbnail view generator

Synopsis:
thumbnail [npixels|radius"]

Description
Allows one to automatically create zoomed views around the current selected objects/sources for the selected images (one or more). In this way, it is possible to rapidly browse and/or compare a large set of objects. The size of the zoom views can be determined either in pixels (default 40) or in arcsec (do not forget to mention the " unit). The generated views are automatically locked: you will not be able to modify the position and the zoom factor of them.

Note - The typical usage should be mview 4 Img1=get aladin(dss2) hd2 Img2=get aladin(dss1) Cat=get vizier(gsc2.2) filter mag{ $[phot.mag*]>8 && $[phot.mag*]<13 { draw } } filter on select Img1 Img2 Cat thumbnail 30"

Example:
thumbnail

See also: select


trace - turn on (resp. off) the debug verbose mode

Synopsis:
trace {1|2|3|off}

Description
Aladin supports 3 trace mode levels. The trace messages are displaying in the Aladin console windows and on the standard output, typically the xterm or the window console in which you launched Aladin.


unlock - Unlock views from the reticule position

Synopsis:
unlock [v1] [v2...]

Description
The "lock" behavior is interesting notably in multiview mode and if the view does not show all the image (depending of the zoom factor and the image size and the Aladin frame size in the screen). In this case, the zoom factor and the central position of a such view are locked until you unlock it

Note - "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
unlock C1

See also: lock, stick, unstick, zoom, reticle


unstick - view "unsticking"

Synopsis:
unstick [v1] [v2...]

Description
By default, an Aladin view can be scrolled (according to the current multiview mode). You can stick a view to keep it in the same place even if you scroll the view panels. See stick command.

Note - "v" is the grid coordinate of a view with a letter for the column and a digit for the line, ex: B2

Example:
unstick B2
unstick (unstick all views)

See also: stick, lock, unlock, cview, mv, thumbnail


untag - untag all tagged sources

Synopsis:
tag

Description
This command removes all tags previously set on sources via the tag command (corresponding to the checkbox in source measurement line).

See also: tag, select


xmatch - Cross match tool

Synopsis:
[name=] xmatch x1 x2 [max dist in arcsec] [allmatch|bestmatch|nomatch] xmatch x1[(RAcol1,DECcol1)] x2[(RAcol2,DECcol2)] ...

Description
Allows one to cross match two tabular data planes. The result will be set in a new catalogue plane, including a column with the separation (in arcsec) between the 2 matching sources in arcsec, and all fields of both planes x1 and x2. The cross-match is positionnal. x1 contains the reference objects, for which we seek counterparts in x2. One object of x1 is considering match with an object of x2 if they are separated by a distance <="max dist". If the max distance is not set, a default value of 4 arcsec is used. - In "allmatch" mode, if an object in x1 has several matches in x2, all matches will be kept in the result plane. - In "bestmatch" mode, only the closest match will be kept. - In "nomatch" mode, we keep only sources of x1 having no match in x2. By default, the "bestmatch" mode is taken into account Coordinate fields are found according to proper UCDs (pos.eq.ra and pos.eq.dec for UCD1+, POS_EQ_RA and POS_EQ_DEC for UCD1). Optional parameters allow you to specify for each plane which coordinate fields should be used for the cross-match. If nothing is specified, and if proper UCDs are not found, we try in last resort to make a guess on the basis of the field names. moreonxmatch...


xmatch - continuation...

Note - "x1" and "x2" can be either a plane label (allowing use of "*" wildcard) or a plane number in the Aladin stack (the bottom one is 1).

Example:
xmatch 1 2 xmatch Simbad GSC2.2 10 allmatch xmatch 2MASS MyTable(colRA,colDEC) 15 xmatch T1(RA2000_tab2, DE2000_tab2) T2(RA_tab2, DE_tab2) 10 nomatch


zoom - change the zoom factor

Synopsis:
zoom 1/64x|...|64x
zoom -|+
zoom radius

Description
Change the zoom factor on the current view The available factors are the powers of two (1/64x ... 64x) plus the 2/3 factor The parameter + (resp. -) selects the next (resp. previous) zoom factor. It is also possible to specify a radius with a unit (deg,arcmin,arcsec - by default in arcmin). In this case, the resulting zoom factor will be the closest available zoom factor covering this celestian area

Note - The zoom command can only be applied on the current view(s)

Example:
zoom 2x
zoom 1/4x
zoom +
zoom 2 arcmin

See also: select


+ Image addition

Synopsis:
[name=] [x1] + x2
[name=] [x1] + value

Description
The "+" command allows you to add two images or one image and a specifical value. The addition will be done pixel per pixel. The resulting image will be coded in Float 32 bits. If the images do not have the same astrometrical solution, Aladin will resample the second image in the astrometrical solution of the first one (bilinear method) before adding the pixels. If the first operand is omitted, Aladin assumes the first operand is the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
DSS1.ESO.R + DSS2.SERC.J
foo = @1 + 100
+ 2MASS.J

See also: -, *, /, norm, conv, bitpix


- Image subtraction

Synopsis:
[name=] [x1] - x2
[name=] [x1] - value

Description
The "-" command allows you to subtract two images or one image and a specifical value. The subtraction will be done pixel per pixel. The resulting image will be coded in Float 32 bits. If the images do not have the same astrometrical solution, Aladin will resample the second image in the astrometrical solution of the first one (bilinear method) before subtracting the pixels. If the first operand is omitted, Aladin assumes the first operand is the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
DSS1.ESO.R - DSS2.SERC.J
foo = @1 - 100
- 2MASS.J

See also: +, *, /, norm, conv, bitpix


* Image multiplication

Synopsis:
[name=] [x1] * x2
[name=] [x1] * value

Description
The "*" command allows you to multiply two images or one image and a specifical value. The multiplication will be done pixel per pixel. The resulting image will be coded in Float 32 bits. If the images do not have the same astrometrical solution, Aladin will resample the second image in the astrometrical solution of the first one (bilinear method) before multiplying the pixels. If the first operand is omitted, Aladin assumes the first operand is the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
DSS1.ESO.R * DSS2.SERC.J
foo = @1 * 100
* 2MASS.J

See also: +, -, /, norm, conv, bitpix


/ Image division

Synopsis:
[name=] [x1] / x2
[name=] [x1] / value

Description
The "/" command allows you to divide two images or one image and a specifical value. The division will be done pixel per pixel. The resulting image will be coded in Float 32 bits. If the images do not have the same astrometrical solution, Aladin will resample the second image in the astrometrical solution of the first one (bilinear method) before dividing the pixels. If the first operand is omitted, Aladin assumes the first operand is the current image.

Note - This command can be prefixed by "PlaneName=" meaning that the result will be saved in this specifical plane. If this plane is already existing, it will be overwritten by the result.
"x" can be the plane label (allowing use of "*" wildcard) or the plane number in the stack prefixed by @ (the bottom one is @1).

Example:
DSS1.ESO.R + DSS2.SERC.J
foo = @1 + 100
+ 2MASS.J

See also: +, -, *, norm, conv, bitpix


© UDS/CNRS

Contact