From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Wed, 8 Jul 2015 20:46:52 -0400
Subject: Initial commit

---
 noao/nproto/doc/irmosaic.hlp | 157 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 157 insertions(+)
 create mode 100644 noao/nproto/doc/irmosaic.hlp

(limited to 'noao/nproto/doc/irmosaic.hlp')

diff --git a/noao/nproto/doc/irmosaic.hlp b/noao/nproto/doc/irmosaic.hlp
new file mode 100644
index 00000000..6cdd400c
--- /dev/null
+++ b/noao/nproto/doc/irmosaic.hlp
@@ -0,0 +1,157 @@
+.help irmosaic Oct89 noao.nproto
+.ih
+NAME
+irmosaic -- mosaic a set of infrared ccd images
+.ih
+USAGE
+mosaic input output database 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 files task plus the editor 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 image.
+.le
+.ls database
+The name of the text file listing the operations performed by irmosaic.
+This list can be used as input for iralign.
+.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 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 null_input = ""
+The list of unobserved subrasters. For example if the subrasters 3 to 5 and
+10 of a sequence of observations were not observed then
+\fInull_input\fR = "3-5,10".
+This parameter follows the ranges notation convention. The number of unobserved
+subrasters plus the number of images must equal \fInxsub\fR *
+\fInysub\fR.
+.le
+.ls corner = "ll"
+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 subrasters to the output image in row or column order. The options are
+"row" for row order and "column" for column order.
+.le
+.ls raster = no
+Add subrasters to the output image in a raster pattern or return to the start
+of a column or a row?
+.le
+.ls median_section = ""
+The section of each input subraster for which the median is computed. If
+\fImedian_section\fR is the null string then the medians are not computed.
+If \fImedian_section\fR is "[*,*]" the whole input subraster is used to
+compute the median.
+.le
+.ls subtract = no
+Subtract the median value from each input subraster before placing the
+subraster in the output image.
+.le
+.ls nimcols = INDEF
+The number of columns in the output image. If \fInimcols\fR is INDEF then
+the program will compute the number of columns using the size of the input
+subrasters, \fInxsub\fR and \fInxoverlap\fR.
+.le
+.ls nimrows = INDEF
+The number of rows in the output image. If \fInimrows\fR is INDEF then
+the program will compute the number of rows using the size of the input
+subrasters, \fInysub\fR and \fInyoverlap\fR.
+.le
+.ls nxoverlap = -1
+The number of columns between adjacent frames. A negative value specifies 
+the amount of column space between adjacent subrasters.
+A positive value specifies the amount of column overlap on adjacent
+subrasters.
+.le
+.ls nyoverlap = -1
+The number of rows between adjacent frames. A negative value specifies
+the amount of row space between adjacent subrasters.
+A positive value specifies the amount of row overlap on adjacent subrasters.
+.le
+.ls oval = 0.0
+The output image pixel value in regions undefined by the by the list of input
+images.
+.le
+.ls opixtype = "r"
+The pixel type of the output image. The options are "s" (short integer),
+"i" (integer), "l" (long integer), "r" (real) and "d" for double
+precision.
+.le
+.ls verbose = yes
+Print messages about task progress and actions taken.
+.le
+.ih
+DESCRIPTION
+
+IRMOSAIC takes a the list of subrasters of identical dimensions specified
+by \fIinput\fR and combines them into a single
+output image \fIoutput\fR. The order in which the subrasters are placed
+in the output image is determined by the parameters \fIcorner\fR,
+\fIdirection\fR and \fIraster\fR. The orientation of each individual
+subraster in the output image may be altered by setting the \fItrim_section\fR
+parameter.
+
+IRMOSAIC uses the subraster size, the number of subrasters, the \fInxoverlap\fR
+and \fRnyoverlap\fI parameters and the \fInxsub\fR and \fInysub\fR partmeters
+to compute the size of the output image. An image of size larger than the
+minimum required can be specified by setting \fInimcols\fR and \fInimrows\fR. 
+The pixel type of the output image is specified by \fIopixtype\fR and undefined
+regions of the output image are given the value \fIoval\fR.
+
+The median of a section each subraster may be optionally computed
+and placed in the database file by setting \fImedian_section\fR.
+The computed median will be subtracted from the input subrasters if
+\fIsubtract\fR is set to yes.
+Task action messages will be printed on the standard output
+if \fIverbose\fR is set to yes.
+.ih
+EXAMPLES
+
+1. Mosaic a list of 64 infrared images onto an 8 by 8 grid in column order
+starting in the upper right hand corner. Allow one blank column and row
+between each subraster.
+
+.nf
+    pr> irmosaic @imlist mosaic mosaic.dat nxsub=8 nysub=8 \
+	nxoverlap=-1 nyoverlap=-1 corner="ur" direct="column"
+.fi
+
+2. Mosaic a list of 62 infrared images onto an 8 by 8 grid in column order
+starting in the upper right hand corner. Allow one blank column and row
+between each subraster. Subrasters 3 and 9 in the sequence do not exist
+and are to be replaced in the output image with an unknown value of -1.0.
+
+.nf
+    pr> irmosaic @imlist mosaic mosaic.dat nxsub=8 nysub=8 \
+	nxoverlap=-1 nyoverlap=-1 corner="ur" direct="column"\
+	null_input="3,9", oval=-1.0
+.fi
+
+.ih
+TIME REQUIREMENTS
+.ih
+BUGS
+At present only integral pixel overlaps are allowed in this routine.
+Fine tuning of the alignments can be done with iralign.
+.ih
+SEE ALSO
+iralign, irmatch1d, irmatch2d
+.endhelp
-- 
cgit 

