diff options
Diffstat (limited to 'noao/imred/irred/doc')
| -rw-r--r-- | noao/imred/irred/doc/center.hlp | 637 | ||||
| -rw-r--r-- | noao/imred/irred/doc/irlincor.hlp | 81 | ||||
| -rw-r--r-- | noao/imred/irred/doc/mosproc.hlp | 170 |
3 files changed, 888 insertions, 0 deletions
diff --git a/noao/imred/irred/doc/center.hlp b/noao/imred/irred/doc/center.hlp new file mode 100644 index 00000000..1171deb4 --- /dev/null +++ b/noao/imred/irred/doc/center.hlp @@ -0,0 +1,637 @@ +.help center May00 irred +.ih +NAME +center -- compute accurate centers for a list of objects +.ih +USAGE +center image +.ih +PARAMETERS +.ls image +The list of images containing the objects to be centered. +.le +.ls coords = "" +The list of text files containing initial coordinates for the objects to +be centered. Objects are listed in coords one object per line with the +initial coordinate values in columns one and two. The number of coordinate +files must be zero, one, or equal to the number of images. +If coords is "default", "dir$default", or a directory specification then an +coords file name of the form dir$root.extension.version is constructed and +searched for, where dir is the directory, root is the root image name, +extension is "coo" and version is the next available version number for the +file. +.le +.ls output = "default" +The name of the results file or results directory. If output is +"default", "dir$default", or a directory specification then an output file name +of the form dir$root.extension.version is constructed, where dir is the +directory, root is the root image name, extension is "ctr" and version is +the next available version number for the file. The number of output files +must be zero, one, or equal to the number of image files. In both interactive +and batch mode full output is written to output. In interactive mode +an output summary is also written to the standard output. +.le +.ls plotfile = "" +The name of the file containing radial profile plots of the stars written +to the output file. If plotfile is defined then a radial profile plot +is written to plotfile every time a record is written to \fIoutput\fR. +The user should be aware that this can be a time consuming operation. +.le +.ls datapars = "" +The name of the file containing the data dependent parameters. +The critical parameters \fIfwhmpsf\fR and \fIsigma\fR are located in +datapars. If datapars is undefined then the default parameter set in +uparm directory is used. +.le +.ls centerpars = "" +The name of the file containing the centering algorithm parameters. +The critical parameters \fIcalgorithm\fR and \fIcbox\fR are located in +centerpars. If centerpars is undefined then the default parameter +set in uparm is used. +.le +.ls interactive = yes +Interactive or non-interactive mode? +.le +.ls radplots = no +If \fIradplots\fR is "yes" and CENTER is run in interactive mode, a radial +profile of each star is plotted on the screen after the center is fit. +.le +.ls icommands = "" +The image display cursor or image cursor command file. +.le +.ls gcommands = "" +The graphics cursor or graphics cursor command file. +.le +.ls wcsin = "logical", wcsout = "logical" +The coordinate system of the input coordinates read from \fIcoords\fR and +of the output coordinates written to \fIoutput\fR respectively. The image +header coordinate system is used to transform from the input coordinate +system to the "logical" pixel coordinate system used internally, +and from the internal "logical" pixel coordinate system to the output +coordinate system. The input coordinate system options are "logical", tv", +"physical", and "world". The output coordinate system options are "logical", +"tv", and "physical". The image cursor coordinate system is assumed to +be the "tv" system. +.ls logical +Logical coordinates are pixel coordinates relative to the current image. +The logical coordinate system is the coordinate system used by the image +input/output routines to access the image data on disk. In the logical +coordinate system the coordinates of the first pixel of a 2D image, e.g. +dev$ypix and a 2D image section, e.g. dev$ypix[200:300,200:300] are +always (1,1). +.le +.ls tv +Tv coordinates are the pixel coordinates used by the display servers. Tv +coordinates include the effects of any input image section, but do not +include the effects of previous linear transformations. If the input +image name does not include an image section, then tv coordinates are +identical to logical coordinates. If the input image name does include a +section, and the input image has not been linearly transformed or copied from +a parent image, tv coordinates are identical to physical coordinates. +In the tv coordinate system the coordinates of the first pixel of a +2D image, e.g. dev$ypix and a 2D image section, e.g. dev$ypix[200:300,200:300] +are (1,1) and (200,200) respectively. +.le +.ls physical +Physical coordinates are pixel coordinates invariant with respect to linear +transformations of the physical image data. For example, if the current image +was created by extracting a section of another image, the physical +coordinates of an object in the current image will be equal to the physical +coordinates of the same object in the parent image, although the logical +coordinates will be different. In the physical coordinate system the +coordinates of the first pixel of a 2D image, e.g. dev$ypix and a 2D +image section, e.g. dev$ypix[200:300,200:300] are (1,1) and (200,200) +respectively. +.le +.ls world +World coordinates are image coordinates in any units which are invariant +with respect to linear transformations of the physical image data. For +example, the ra and dec of an object will always be the same no matter +how the image is linearly transformed. The units of input world coordinates +must be the same as those expected by the image header wcs, e. g. +degrees and degrees for celestial coordinate systems. +.le +The wcsin and wcsout parameters default to the values of the package +parameters of the same name. The default values of the package parameters +wcsin and wcsout are "logical" and "logical" respectively. +.le +.ls cache = no +Cache the image pixels in memory. Cache may be set to "yes", or "no". +By default cacheing is +disabled. +.le +.ls verify = yes +Verify the critical parameters in non-interactive mode ? Verify may be set to +or "no. +.le +.ls update = no +Update the critical parameters in non-interactive mode if \fIverify\fR is +set to yes? Update may be set to "yes" or "no. +.le +.ls verbose = yes +Print messages on the terminal in non-interactive mode ? Verbose may be set +to "yes" or "no. +.le +.ls graphics = ")_.graphics" +The default graphics device. +Graphics may be set to the apphot package parameter value (the default), "yes", +or "no. +.le +.ls display = ")_.display" +The default display device. Display may be set to the apphot package +parameter value (the default), "yes", or "no. By default graphics overlay +is disabled. Setting display to one of "imdr", "imdg", "imdb", or "imdy" +enables graphics overlay with the IMD graphics kernel. Setting display to +"stdgraph" enables CENTER to work interactively from a contour plot. +.le + +.ih +DESCRIPTION +CENTER computes accurate centers for a set of objects in the IRAF image +\fIimage\fR, whose initial coordinates are read from the image display cursor, +from the text file \fIcoords\fR, or from a cursor command file. +The computed x and y coordinates, the errors, and the fitting parameters +are written to the text file \fIoutput\fR. + +The coordinates read from \fIcoords\fR are assumed to be in coordinate +system defined by \fIwcsin\fR. The options are "logical", "tv", "physical", +and "world" and the transformation from the input coordinate system to +the internal "logical" system is defined by the image coordinate system. +The simplest default is the "logical" pixel system. Users working on with +image sections but importing pixel coordinate lists generated from the parent +image must use the "tv" or "physical" input coordinate systems. +Users importing coordinate lists in world coordinates, e.g. ra and dec, +must use the "world" coordinate system and may need to convert their +equatorial coordinate units from hours and degrees to degrees and degrees first. + +The coordinates written to \fIoutput\fR are in the coordinate +system defined by \fIwcsout\fR. The options are "logical", "tv", +and "physical". The simplest default is the "logical" system. Users +wishing to correlate the output coordinates of objects measured in +image sections or mosaic pieces with coordinates in the parent +image must use the "tv" or "physical" coordinate systems. + +If \fIcache\fR is yes and the host machine physical memory and working set size +are large enough, the input image pixels are cached in memory. If cacheing +is enabled and CENTER is run interactively the first measurement will appear +to take a long time as the entire image must be read in before the measurement +is actually made. All subsequent measurements will be very fast because CENTER +is accessing memory not disk. The point of cacheing is to speed up random +image access by making the internal image i/o buffers the same size as the +image itself. However if the input object lists are sorted in row order and +sparse cacheing may actually worsen not improve the execution time. Also at +present there is no point in enabling cacheing for images that are less than +or equal to 524288 bytes, i.e. the size of the test image dev$ypix, as the +default image i/o buffer is exactly that size. However if the size of dev$ypix +is doubled by converting it to a real image with the chpixtype task then the +effect of cacheing in interactive is can be quite noticeable if measurements +of objects in the top and bottom halves of the image are alternated. + +CENTER can be run either interactively or in batch mode by setting the +parameter \fIinteractive\fR. In interactive mode starting x and y positions +can either be read directly from the image cursor or read from the text +file \fIcoords\fR. In interactive mode the user can examine, adjust, and +save the algorithm parameters, change ojects interactively, query for +the next or nth object in the list, or fit the entire coordinate list with +the chosen parameter set. In batch mode the positions can be read from the +text file \fIcoords\fR or the image cursor can be redirected to a text file +containing a list of cursor commands as specified by the parameter +\fIicommands\fR. + +.ih +CURSOR COMMANDS + +The following cursor commands are currently available. + +.nf + Interactive Keystroke Commands + +? Print help +: Colon commands +v Verify the critical parameters +w Save the current parameters +d Plot radial profile of current star +i Interactively set parameters using current star +f Fit center of current star +spbar Fit center of current star, output results +m Move to next star in coordinate list +n Center next star in coordinate list, output results +l Center remaining stars in coordinate list, output results +e Print error messages +r Rewind the coordinate list +q Exit task + + + Colon Commands + +:show [data/center] List the parameters +:m [n] Move to next [nth] star in coordinate list +:n [n] Center next [nth] star in coordinate list, + output results + + + Colon Parameter Editing Commands + +# Image and file name parameters + +:image [string] Image name +:coords [string] Coordinate file name +:output [string] Output file name + +# Data dependent parameters + +:scale [value] Image scale (units per pixel) +:fwhmpsf [value] Full-width half-maximum of PSF (scale units) +:emission [y/n] Emission feature (y), absorption (n) +:sigma [value] Standard deviation of sky (counts) +:datamin [value] Minimum good data value (counts) +:datamax [value] Maximum good data value (counts) + +# Noise parameters + +:noise [string] Noise model (constant|poisson) +:gain [string] Gain image header keyword +:ccdread [string] Readout noise image header keyword +:epadu [value] Gain (electrons per adu) +:readnoise [value] Readout noise (electrons) + +# Observations parameters + +:exposure [string] Exposure time image header keyword +:airmass [string] Airmass image header keyword +:filter [string] Filter image header keyword +:obstime [string] Time of observation image header keyword +:itime [value] Exposure time (time units) +:xairmass [value] Airmass value (number) +:ifilter [string] Filter id string +:otime [string] Time of observation (time units) + +# Centering parameters + +:calgorithm [string] Centering algorithm +:cbox [value] Width of centering box (scale units) +:cthreshold [value] Centering intensity threshold (sigma) +:cmaxiter [value] Maximum number of iterations +:maxshift [value] Maximum center shift (scale units) +:minsnratio [value] Minimum signal to noise for centering +:clean [y/n] Clean subraster before centering +:rclean [value] Cleaning radius (scale units) +:rclip [value] Clipping radius (scale units) +:kclean [value] Clean K-sigma rejection limit (sigma) + +# Plotting and marking parameters + +:mkcenter [y/n] Mark computed centers on the display +:radplot [y/n] Plot radial profile of object + + +The following keystroke commands are available from the interactive setup +menu. + + Interactive Center Setup Menu + + v Mark and verify the critical center parameters (f,s,c) + + f Mark and verify the full-width half-maximum of the psf + s Mark and verify the standard deviation of the background + l Mark and verify the minimum good data value + u Mark and verify the maximum good data value + + c Mark and verify the centering box half-width + n Mark and verify the cleaning radius + p Mark and verify the clipping radius +.fi + +.ih +ALGORITHMS + +Descriptions of the data dependent parameters and the centering +algorithm parameters can be found in the online manual pages for +\fIdatapars\fR and \fIcenterpars\fR. + +.ih +OUTPUT + +In interactive mode the following quantities are written to the terminal +as each object is measured. Error is a simple string which indicates +whether an error condition has been flagged. The centers and their errors are +in pixel units. + +.nf + image xinit yinit xcenter ycenter xerr yerr error +.fi + +In both interactive and batch mode the full output is written to the +text file \fIoutput\fR. At the beginning of each file is a header +listing the current values of the parameters when the first stellar +record was written. These parameters can be subsequently altered. +For each star measured the following record is written + +.nf + image xinit yinit id coords lid + xcenter ycenter xshift yshift xerr yerr cier error +.fi + +Image and coords are the name of the image and coordinate file respectively. +Id and lid are the sequence numbers of stars in the output and coordinate +files respectively. Cier and error are the centering error code and accompanying +error message respectively. Xinit, yinit, xcenter, ycenter, xshift, yshift, +and xerr, yerr are self explanatory and output in pixel units. The sense of +the xshift and yshift definitions is the following. + +.nf + xshift = xcenter - xinit + yshift = ycenter - yinit +.fi + +In interactive mode a radial profile of each measured object is plotted +in the graphics window if \fIradplots\fR is "yes". + +In interactive and batchmode a radial profile plot is written to +\fIplotfile\fR if it is defined each time the result of an object +measurement is written to \fIoutput\fR . + +.ih +ERRORS + +If the object centering was error free then the field cier will be zero. +Non-zero values in the cier column flag the following error conditions. + +.nf + 0 # No error + 101 # The centering box is off the image + 102 # The centering box is partially off the image + 103 # The S/N ratio is low in the centering box + 104 # There are two few points for a good fit + 105 # The x or y center fit is singular + 106 # The x or y center fit did not converge + 107 # The x or y center shift is greater than maxshift + 108 # There is bad data in the centering box +.fi + +.ih +EXAMPLES + +1. Compute the centers for a few stars in dev$ypix using the image display +and the image cursor. Setup the task parameters using the interactive +setup menu defined by the i keystroke command and a radial profile plot. + +.nf + ap> display dev$ypix 1 fi+ + + ... display the image + + ap> center dev$ypix + + ... type ? to see help screen + + ... move image cursor to a star + ... type i to enter the interactive setup menu + ... enter the maximum radius in pixels for the radial profile or + accept the default with a CR + ... type v to get the default menu + ... set the fwhmpsf, sigma, and centering box half-width using the + graphics cursor and the stellar radial profile plot + ... typing <CR> after a prompt leaves the parameter at its default + value + ... type q to exit setup menu + + ... type the v key to verify the critical parameters + + ... type the w key to save the parameters in the parameter files + + ... move the image cursor to the stars of interest and tap + the space bar + + ... type q to quit followed by q to confirm the quit + + ... the output will appear in ypix.ctr.1 + +.fi + +2. Compute the centers for a few stars in dev$ypix using the contour plot +and the graphics cursor. This option is only useful for those (now very few) +users who have access to a graphics terminal but not to an image display +server. Setup the task parameters using the interactive setup menu defined by +the i key command as in example 1. + +.nf + ap> show stdimcur + + ... record the default value of stdimcur + + ap> set stdimcur = stdgraph + + ... define the image cursor to be the graphics cursor + + ap> contour dev$ypix + + ... make a contour plot of dev$ypix + + ap> contour dev$ypix >G ypix.plot1 + + ... store the contour plot of ypix in the file ypix.plot + + ap> center dev$ypix display=stdgraph + + ... type ? to see the help screen + + ... move graphics cursor to a star + ... type i to enter the interactive setup menu + ... enter the maximum radius in pixels for the radial profile or + accept the default with a CR + ... type v key to get the default setup menu + ... enter maximum radius in pixels of the radial profile + ... set the fwhmpsf, sigma, and centering box half-width + using the graphics cursor and the stellar radial profile plot + ... typing <CR> after the prompt leaves the parameter at its + default value + ... type q to quit the setup menu + + ... type the v key to verify critical parameters + + ... type the w key to save the parameters in the parameter files + + ... retype :.read ypix.plot1 to reload the contour plot + + ... move the graphics cursor to the stars of interest and tap + the space bar + + ... a one line summary of the answers will appear on the standard + output for each star measured + + ... type q to quit followed by q to confirm the quit + + ... full output will appear in the text file ypix.ctr.2 + + ap> set stdimcur = <default> + + ... reset stdimcur to its previous value +.fi + + +3. Setup and run CENTER interactively on a list of objects temporarily +overriding the fwhmpsf, sigma, and cbox parameters determined in examples +1 or 2. + +.nf + ap> daofind dev$ypix fwhmpsf=2.6 sigma=25.0 verify- + + ... make a coordinate list + + ... the output will appear in the text file ypix.coo.1 + + ap> center dev$ypix cbox=7.0 coords=ypix.coo.1 + + ... type ? for optional help + + + ... move the graphics cursor to the stars and tap space bar + + or + + ... select stars from the input coordinate list with m / :m # + and measure with spbar + + ... measure stars selected from the input coordinate list + with n / n # + + ... a one line summary of results will appear on the standard output + for each star measured + + ... the output will appear in ypix.ctr.3 ... +.fi + + +4. Display and measure some stars in an image section and write the output +coordinates in the coordinate system of the parent image. + +.nf + ap> display dev$ypix[150:450,150:450] 1 + + ... display the image section + + ap> center dev$ypix[150:450,150:450] wcsout=tv + + ... move cursor to stars and type spbar + + ... type q to quit and q again to confirm quit + + ... output will appear in ypix.ctr.4 + + ap> pdump ypix.ctr.4 xc,yc yes | tvmark 1 STDIN col=204 +.fi + + +5. Run CENTER in batch mode using the coordinate file and the previously +saved parameters. Verify the critical parameters. + +.nf + ap> center dev$ypix coords=ypix.coo.1 verify+ inter- + + ... output will appear in ypix.ctr.5 ... +.fi + + +6. Repeat example 5 but assume that the input coordinate are ra and dec +in degrees and degrees, turn off verification, and submit the task to to +the background. + +.nf + ap> display dev$ypix + + ap> rimcursor wcs=world > radec.coo + + ... move to selected stars and type any key + + ... type ^Z to quit + + ap> center dev$ypix coords=radec.coo wcsin=world verify- inter- & + + ... output will appear in ypix.ctr.6 + + ap> pdump ypix.ctr.6 xc,yc yes | tvmark 1 STDIN col=204 + + ... mark the stars on the display + + +7. Run CENTER interactively without using the image display. + +.nf + ap> show stdimcur + + ... record the default value of stdimcur + + ap> set stdimcur = text + + ... set the image cursor to the standard input + + ap> center dev$ypix coords=ypix.coo.1 + + ... type ? for optional help + + ... type :m 3 to set the initial coordinates to those of the + third star in the list + + ... type i to enter the interactive setup menu + ... enter the maximum radius in pixels for the radial profile or + accept the default with a CR + ... type v to enter the default menu + ... set the fwhmpsf, sigma, and centering box half-width + using the graphics cursor and the stellar radial profile plot + ... typing <CR> after the prompt leaves the parameter at its default + value + + ... type r to rewind the coordinate list + + ... type l to measure all the stars in the coordinate list + + ... a one line summary of the answers will appear on the standard + output for each star measured + + ... type q to quit followed by q to confirm the quit + + ... full output will appear in the text file ypix.ctr.7 + + ap> set stdimcur = <default> + + ... reset the value of stdimcur +.fi + +8. Use a image cursor command file to drive the CENTER task. The cursor command +file shown below sets the fwhmpsf, calgorithm, and cbox parameters, computes +the centers for 3 stars, updates the parameter files, and quits the task. + +.nf + ap> type cmdfile + : calgorithm gauss + : fwhmpsf 2.5 + : cbox 9.0 + 442 410 101 \040 + 349 188 101 \040 + 225 131 101 \040 + w + q + + ap> center dev$ypix icommands=cmdfile verify- + + ... full output will appear in ypix.ctr.8 +.fi + +.ih +BUGS + +It is the responsibility of the user to make sure that the image displayed +in the image display is the same as the image specified by the image parameter. + +Commands which draw to the image display are disabled by default. +To enable graphics overlay on the image display, set the display +parameter to "imdr", "imdg", "imdb", or "imdy" to get red, green, +blue or yellow overlays and set the centerpars mkcenter switch to +"yes". It may be necessary to run gflush and to redisplay the image +to get the overlays position correctly. + +.ih +SEE ALSO +datapars, centerpars +.endhelp diff --git a/noao/imred/irred/doc/irlincor.hlp b/noao/imred/irred/doc/irlincor.hlp new file mode 100644 index 00000000..630370a1 --- /dev/null +++ b/noao/imred/irred/doc/irlincor.hlp @@ -0,0 +1,81 @@ +.help irlincor Nov94 irred +.ih +NAME +irlincor -- Correct IR imager frames for non-linearity. +.ih +USAGE +irlincor input output +.ih +PARAMETERS +.ls input +The list of images to be corrected for non-linearity +.le +.ls output +The list of corrected output images +.le + +.ls coeff1 = 1.0 +The first coefficient of the correction function +.le + +.ls coeff2 = 0.0 +The second coefficient of the correction function +.le + +.ls coeff3 = 0.0 +The third coefficient of the correction function +.le + +.ih +DESCRIPTION +The IR imager frames specified by \fIinput\fR, which may be a general image +template including wild cards or an @list, are corrected for non-linearity +on a pixel by pixel basis and written to \fIoutput\fR. The number of output +images must match the number input. The pixel type of the output image(s) will +match that of the input image(s), however, internally all calculations are +performed as type real. The correction is performed assuming +that the non-linearity can be represented by the following simple relationship: +.nf + +ADU' = ADU * [ coeff1 + coeff2 * (ADU / 32767) + coeff3 * (ADU / 32767)**2 ] + +.fi +The coefficients which occur in this expression are specified by the +parameters \fIcoeff1\fR, \fIcoeff2\fR and \fIcoeff3\fR. Their values are +derived from periodic instrumental calibrations and are believed to be +fairly constant. The default values specify a \fBnull\fR correction. +You should consult \fBJay Elias\fR for the latest values. +Note that the coefficients are expressed in terms of ADU normalised to the +maximum possible value 32767, in order that their values can be input +more easily. +.ih +EXAMPLES +1. Correct input to output using the default values for the coefficients (not a very rewarding operation!) + +.nf + cl> irlincor input output + +.fi + +2. Correct a list of images in place using specified values for the coefficients + +.nf + cl> irlincor @list @list coeff1=1.0 coeff2=0.1 coeff3=0.01 + +.fi +.ih +TIME REQUIREMENTS +.ih +AUTHORS +The IRLINCOR task was originally written by Steve Heathcote as part of the +CTIO package. +.ih +BUGS +The form of the correction equation is currently experimental; +a higher order polynomial or a different functional form could be accommodated +very easily if required. +It may be advisable to carry out the calculations in double precision. +.ih +SEE ALSO +onedspec.coincor, proto.imfunction +.endhelp diff --git a/noao/imred/irred/doc/mosproc.hlp b/noao/imred/irred/doc/mosproc.hlp new file mode 100644 index 00000000..d0f5c931 --- /dev/null +++ b/noao/imred/irred/doc/mosproc.hlp @@ -0,0 +1,170 @@ +.help mosproc May89 irred +.ih +NAME +mosproc -- Prepare images for quick look mosaicing +.ih +USAGE +mosproc input output nxsub nysub +.ih +PARAMETERS +.ls input +The list of input images to be mosaiced. The images are assumed +to be ordered either by row, column, or in a raster pattern. If +the image list is not in order then the iraf \fBfiles\fR task plus +the \fBeditor\fR must be used to construct an image list. The images +in the input list are assumed to all be the same size. +.le +.ls output +The name of the output mosaiced image. +.le +.ls nxsub +The number of subrasters along a row of the output image. +.le +.ls nysub +The number of subrasters along a column of the output image. +.le +.ls skysubtract = yes +Subtract a sky image from all the input images. The sky image +to be subtracted is either \fIsky\fR or a sky image computed +by median filtering selected input images after weighting the images +by the exposure time.. +.le +.ls sky = "" +The name of the sky image. +.le +.ls exclude = "" +The input images to be excluded from the computation of the sky image. +For example if \fIexclude\fR="1,3-5" then input images 1, 3, 4, 5 are +not used for computing the sky frame. +.le +.ls expname = "exptime" +The image header exposure time keyword. If the sky frame is computed +internally by median filtering the input images, the individual images +are weighted by the exposure time defined by the exposure time +keyword \fIexpname\fR. Weights of 1 are assigned when no exposure time +is given. +.le +.ls flatten = yes +Divide all the images by a flat field image. Flat fielding is done +after sky subtraction. If the name of a flat field image \fIflat\fR +is supplied that image is divided directly into all the input images. +Otherwise the skyframe computed above is normalized by the mode of the +pixels and divided into all the input images. +.le +.ls flat = "" +The name of the flat field image. +.le +.ls transpose = no +Transpose the input images before inserting them into the mosaic. +.le +.ls trim_section = "[*,*]" +The section of the input images to be mosaiced into the output +image. Section can be used to flip and/or trim the individual +subrasters before adding them to the mosaic. For example if we +want to flip each subraster around the y axis before adding it +to the mosaic, then \fItrim_section\fR = "[*,-*]". +.le +.ls corner = "lr" +The starting position in the output image. The four options are "ll" for +lower left corner, "lr" for lower right corner, "ul" for upper left +corner and "ur" for upper right corner. +.le +.ls direction = "row" +Add input images to the output image in row or column order. The options +are "row" for row order and "column" for column order. The direction +specified must agree with the order of the input list. +.le +.ls raster = no +Add the columns or rows to the output image in a raster pattern or return +to the start of a column or a row. +.le +.ls median_section = "" +Compute the median of each input image inserted into the mosaic using the +specified section. +.le +.ls subtract = no +Subtract the computed median from each input image before inserting it +into the mosaic. +.le +.ls oval = -1.0 +The value of border pixels. +.le +.ls delete = yes +Delete sky subtracted, flat fielded and transposed images upon exit from +the script. +.le +.ls logfile = STDOUT +The name of the log file. +.le + +.ih +DESCRIPTION + +MOSPROC takes the list of input images \fIinput\fR of identical dimensions and +inserts them into a single output image \fIoutput\fR. Before mosaicing the user +can optionally sky subtract, flat field or transpose the input images. +If \fIskysubtract\fR = yes, a single sky +image is subtracted from all the input images. The sky image +may be the externally derived image \fIsky\fR or calculated internally +by computing the exposure time weighted median of the input images, minus +those input images specifically excluded by the \fIexclude\fR parameter. +If \fIflatten\fR = yes, the input images are flat fielded using either +the externally defined flat field image \fIflat\fR or the internally +derived sky image normalized by its mode. +If \fItranspose\fR is enabled all the input images are optionally transposed +before mosaicing. + +MOSPROC takes the list of processed images and inserts them into the +output image in positions determined by their order in the input list, +\fInxsub\fR, \fInysub\fR and the parameters \fIcorner\fR, \fIdirection\fR +and \fIraster\fR. +The orientation and size of each individual subraster in the output image +may be altered by setting the parameter \fItrim_section\fR. The size +of the output image is determined by nxsub and nysub and the size of +the individual input images. A one column wide border is drawn between +each of the output image subrasters with a pixel value of \fIoval\fR. +The user may optionally compute and subtract the median from each input +image before inserting it into the mosaic. + +MOSPROC produces an output mosaiced image \fIoutput\fR and an accompanying +database file \fIdboutput\fR. These two files plus an interactively +generated coordinate list comprise the necessary input for the IRALIGN, +IRMATCH1D and IRMATCH2D tasks. +The temporary images generated (sky substracted, flat fielded, and +transposed) +can be deleted automatically if \fBdelete=yes\fR, before the task completes. +Otherwise they will be left in the same directory of the input images. +The temporary sky and flat field images if created are not deleted. + +The computation of the sky frame is done with IMAGES.IMCOMBINE and the +subsequent sky subraction with IMAGES.IMARITH. The computation of +the flat field is done with PROTO.BSCALE and the flat field division +with FLATTEN. The task IMAGES.TRANSPOSE transpose the input. +The mosaicing itself is done with PROTO.IRMOSAIC. + +.ih +EXAMPLES + +1. Mosaic a list of 64 infrared images onto an 8 by 8 grid after sky + subtraction and flat fielding. Use an externally derived sky and + flat field image + + ir> mosproc @imlist mosaic 8 8 skysub+ sky=skyimage flatten+ \ + >>> flat=flatfield + +2. Mosaic a list of 64 infrared images onto an 8 by 8 grid after sky + subtraction and flat fielding. Derive the sky and flat field frames + from the data excluding image number 5 + + ir> mosproc @imlist mosaic 8 8 skysub+ exclude="5" flatten+ + +.ih +TIME REQUIREMENTS + +.ih +BUGS + +.ih +SEE ALSO +images.imcombine, images.imarith, proto.bscale, images.imtrans, proto.irmosaic +.endhelp |