acetvmark: display images with object filtered overlays
Package: ace
Synopsis
Usage
acetvmark image frame
Parameters
- image
- Image with catalog(s) or object mask(s) to be overlayed. The image may be a single image or multi-extension format (MEF) file.
- frame = 1
- Display frame to be used.
- catalog = "!catalog"
- Input catalog defining sources to be overlayed. A keyword pointer or substitution patterns may be used in addtion to any other IRAF list format. The catalog need not have been produced by ACE and may be any format supported by the tables package. However, if an object mask is to be overlayed the catalog must contain a field, specified by the acefilter.catomid parameter, with the object mask identification numbers.
- fields = "ra,dec"
- Fields defining the source coordinates and an optional third field for a label. The label is used only for the tvmark overlays. The coordinates may be world coordinates (with right ascension in hours if using an RA axis type) or in physical or logical pixel coordinates. The order of the coordinate elements must be pixel column and line or celestial longitude and latitude. Note that for simple text files the fields names are "c1", "c2", etc.
- catfilter = ""
- Catalog filter expression. If no expression is given then all input catalog records are selected. An expression must evaluate to a boolean value. Operands are case sensitive catalog field names. Field names are those defined by the tables package. In particular, simple text fields may be used as input catalogs and the field names are "c1", "c2", etc.
- wcs = "world" (logical|physical|world)
- Input coordinate type. The input coordinates must be transformed to image pixel coordinates for the overlay. If the coordinates are in image pixel coordinates the value "logical" is used. The "physical" type is used for pixel coordinates where either the image has been transformed from the catalog image or the catalog was created in physical coordinates. The "world" coordinate type is based on the world coordinate system (WCS) defined in the image. This is typically right ascension and declination but other types maybe used as well. Note that right ascension coordinates must be in hours.
- extnames = ""
- List of extension name patterns for MEF files. Note the patterns must match the entire name.
- mark = "circle"
- The overlay mark type. The type "objmask" invokes acedisplay
and all other types invokes tvmark. The options are:
- objmask
- Object mask isophote overlays.
- point
- A point. To ensure legibility point is actually a square dot whose size is specified by pointsize.
- plus
- A plus sign. The shape of the plus sign is determined by the raster font and its size is specified by txsize.
- cross
- An x. The shape of the x is determined by the raster font and its size is is specified by txsize.
- circle
- A set of concentric circles whose radii are specified by the radii parameter. The radii are in image pixel units. If the magnifications used by display are not equal in x and y circles will become ellipses when drawn.
- rectangle
- A set of concentric rectangles whose lengths and width/length ratio are specified by the lengths parameter. The lengths are specified in image pixel units. If the magnifications used by the display are not equal in x and y then squares will become rectangles when drawn.
- none
- No mark used to mark only labels.
- radii = "0"
- If the default mark type is "circle" than concentric circles of radii "r1,r2,...rN" are drawn around each selected point.
- lengths = "0"
- if the default mark type is "rectangle" then concentric rectangles of length and width / length ratio "l1,l2,...lN ratio" are drawn around each selected point. If ratio is not supplied, it defaults to 1.0 and squares are drawn.
- font = "raster"
- The name of the font. At present only a simple raster font is supported.
- color = 255
- The numerical value or color of the marks drawn. Any number between 0 and 255 may be specified. The meaning of the color is device dependent. In the current version of the IRAF display servers (XIMTOOL and DS9) numbers between 202 and 217 may be used to display graphics colors. The current color assignments are summarized later in this help page.
- label = no
- Label the marked coordinates with the string in the third field. label overrides number.
- number = no
- Label the marked objects with their sequence number in the coordinate list.
- nxoffset = 0, nyoffset = 0
- The x and y offset in display pixels of the numbers to be drawn. Numbers are drawn by default with the lower left corner of the first digit at the coordinate list position.
- pointsize = 3
- The size of the default mark type "point". Point size will be rounded up to the nearest odd number.
- txsize = 1
- The size of text, numbers and the plus and cross marks to be written. The size is in font units which are 6 display pixels wide and 7 display pixels high.