automos Documentation

automos - Mosaic a list of image files

"automos" will run the program MOSPDF, which creates a temporary PDF
procedure the name of which is specified by the PDFFILE parameter.
It then runs the temporary pdf, which runs the "mosaic"
program on all the images listed in the FROMLIST file and creates
a mosaic cube named whatever the user enters for the TO parameter.
When "mosaic" is run, the central latitude, center longitude, and
the scale is checked for each image and if they are not equal, an
error occurs.  The LAT and LON parameters in "mosaic" are calculated
by MOSPDF to be the minimum and maximum latitude and longitude range
of the input images.  The HIST and INIT parameters in "mosaic" are set
to "Y" by MOSPDF before running the program.  See mosaic.pdf for a
better description of the parameters used in the mosaic program.
The temporary pdf will NOT be deleted from your local directory after
it has been run.

PROGRAMMER:  Jim Mathews, U.S.G.S., Flagstaff, AZ

Filename of the list of input
  cube filenames to mosaic
  (No default extension)

NONE

Input subcube specifier

--

Output mosaic cube filename
  (No default extension)

NONE

Output band number

--

Check the BAND_BIN_CENTER
keyword in the input cube
and output mosaic to find
a match in the band dimension.
(YES, NO)

YES

Convert input pixel type to
output pixel type
(YES, NO)

NO

Mosaic positioning option
(RECT,MAP,TVREG)

MAP

Average the images
(YES, NO)

----------------------------

NO

Use if OPTION=RECT:
Starting line in mosaic

0

Starting sample in mosaic

0

Use if OPTION=TVREG:
TVREG data file name
----------------------------

NONE

Put input image on top of the
mosaic (YES,NO)

YES

NO=Perform standard mosaic
YES=Mosaic null data as well

----------------------------

NO

Number of images in final
mosaic

-----------------------------

Use the following parameters
only if OPTION=MAP:

50

Lat,lon,line,samp (Use only
to change output translation
values)

-------------------------------

Use the following parameters
only if OPTION=RECT:

NONE

Number of lines in mosaic

0

Number of samples in mosaic

0

Number of bands in mosaic

0

Backplane test
(RES,EMALO,EMAHI,INCLO,INCHI,
 MORPH,ALBEDO)

--

Temporary pdf filename

"temp.pdf"

User comment

" "

ADDITIONAL NOTES:

Parm	Description
FROMLIST	A file that lists the cube filenames to be mosaicked. Enter the filenames one per line, and you must include the exact filename with any extensions. The images will be mosaicked in the order they are listed.
SFROM	SFROM specifies the subcube using a single string for all three dimensions of the cube. The order of the three dimensions is always "samples:lines:bands". If a dimension is left blank, all the data for that dimension is selected. The default value of NULL for SFROM selects the entire cube. Any application below can be used for any dimension. To select specific data from any dimension: "10-100(3):11,12,15-20:1-10(2)" = This example will select every third sample starting with sample 10 thru 100. It selects lines 11 and 12, and 15-20. It selects every other band, starting with band 1 thru 10. There are special characters that can be used for selecting a subcube efficiently, such as "*","#", and "~". For examples type "help sfrom" in TAE. **NOTE** For more examples and explanation of the many features of the SFROM parameter, tutor the sfrom.pdf or refer to Introduction To ISIS, Section 6, of the ISIS User's Manual **
TO	The full name of the output mosaic cube file with any extensions.
OBAND	This is the band in the output mosaic cube that an individual band from the input cube will be mosaicked into. If this parameter is not NULL, then MOSAIC will not check the BAND_BIN_CENTER keyword to insure the that the input band is being mosaicked into the correct output band.
BANDCHK	If this is set MOSAIC will check the BAND_BIN_CENTER keyword of the input cube and output mosaic cube to find the correct band to mosaic into. If this is turned off, MOSAIC assumes a one to one correspondence in the band dimension between the input cube and the mosaic cube. In other words band 1 of the input cube will be mosaicked into band 1 of the mosaic cube and so on up to the nth band.
CONV	If this is set and the pixel type of the input cube is different from the output mosaic cube, MOSAIC will convert the input cube to the output cube's pixel type. Use this option with caution.
OPTION	If OPTION=MAP, the mapping parameters from the labels are used to position input cube. If OPTION=RECT, the SLM and SSM of where the input cube is to be placed in the mosaic must be entered. If OPTION=TVREG, a data file created by TVREG is used to position the input cube.
AVERAGE	If AVERAGE=YES, the images are averaged instead of overlayed or underlayed. A running sum of the images input to MOSAIC is kept and the average is done when the final image is input. You must set LAST=YES to complete the average. When LAST=YES, the standard deviation is stored in a backplane named, STANDARD_DEVIATION. The sums, counts, and sum of squares are also saved in backplanes so that you can add more images onto the mosaic after you have set LAST=YES. At this time, the input images must have only a single band in the core region. If the input images have backplanes they are not preserved. The processing of backplanes with this option will be added in the future.
SLM	This parameter is used when OPTION=RECT. This is the starting line for the FROM cube to be placed on the TO cube. If SLM = 1 then the FROM cube would be placed at the top of the TO cube. The SLM can be negative, so that the FROM cube would start off the edge of the TO cube. For instance if SLM were -10 then the first 10 lines of the FROM cube would be cut off and line 11 would be the first line of the TO cube.
SSM	This parameter is used when OPTION=RECT. This is the starting sample for the FROM cube to be placed on the TO cube. If SSM = 1 then the FROM cube would be placed at the top of the TO cube. The SSM can be negative, so that the FROM cube would start off the edge of the TO cube. For instance if SSM were -10 then the first 10 samples of the FROM cube would be cut off and sample 11 would be the first sample of the TO cube.
TVREG	This parameter is used only if OPTION=TVREG. This is the name of a file that is created by the TVREG program that contains a line and sample in the input cube and the matching line and sample in the mosaic. This file is only used if there was a problem with the geometry of the input cube and the starting line and sample must be redefined. A file can be created with an editor if necessary. The format of the TVREG data file is: Line,Samp (of input cube), Line,Samp (of mosaic) (9X,I6,3X,I6,18X,I6,3X,I6)
TOP	This option specifies whether to put the FROM cube on top of the mosaic or underneath the mosaic. If TOP=Y, the program will overlay all non-empty pixels on top of the existing data in the mosaic cube. An empty pixel is one which is 0 DN for 8-bit data, the NULL value for 16-bit data, and the null flag (all bits on) for 32-bit real data. For example, if the FROM cube had a blank area around the outside of the actual data which was zeroes, then any data that was already in the TO cube would "show through" this blank area even though the FROM cube goes on top. NOTE: When TOP=N MOSALL will be set to "N".
MOSALL	This option will specify to mosaic null data as well as non-null data. Thus, with this option all of the data in the input cube, regardless of whether the data is null or not, is moved to the output cube. NOTE: When TOP=N, MOSALL will be set to "N".
NIMGS	This is the number of input images which will make up the final mosaic. This is used to allocate enough room in the history object. If there is no room in the history object when mosaicking an input image, a warning will be issued indicating that no history entry for this image will be entered, but the image will be put into the mosaic.
NLM	For OPTION=RECT or OPTION=TVREG, this defines the number of lines needed in the TO cube. This cube should be made big enough to hold all of the images to be mosaicked. For OPTION=MAP, this parameter will override the computed number of lines for the mosaic that is done during intialization. In the polar example give for OUTPNT below, if the image is in the upper left corner NLM can be used to cut down the number of lines in the mosaic.
NSM	For OPTION=RECT or OPTION=TVREG, this defines the number of samples needed in the TO cube. This cube should be made big enough to hold all the images to be mosaicked. For OPTION=MAP, this parameter will override the computed number of samples for the mosaic that is done during intialization. In the polar example give for OUTPNT below, if the image is in the upper left corner NSM can be used to cut down the number of samples in the mosaic.
NBM	This defines the number of bands needed in the TO cube. The default will intialize a mosaic cube with the same number of bands as the input cube. If you want the mosaic cube to have more bands than the input cube, you must use the Table File option.
OUTPNT	This parameter is used only if OPTION=MAP. It is used to change the LINE_PROJECTION_OFFSET and SAMPLE_PROJECTION_OFFSET of the mosaic during initialization. These keywords indicate the position of line 1, sample 1 relative to the projection origin. PROJ_TRANSLATION is calculated using the given latitude and longitude range. In some special cases a very large cube will be created that is mostly empty. For example: a polar stereographic mosaic that includes the pole but most of the cube is between 0. and 90. degrees longitude. Almost three fourths of that mosaic would be empty. OUTPNT can be used to redefine the position of line 1, sample 1 and make a smaller cube. The requested string must contain a latitude and longitude and the line and sample of where that latitude and longitude is to be placed. For example: OUTPNT="90.,0.,100,300" will place the pole at line 100, sample 300.
BACKCHK	This parameter will check values of resolution, emission angle and incidence angle to decide which pixel to keep (input cube or mosaic cube). The default will do no backplane testing. If BACKCHK=RES, the better resolution will be kept. If BACKCHK=EMALO, the lower emission angle will be kept. If BACKCHK=EMAHI, the higher emission angle will be kept. If BACKCHK=INCLO, the lower incidence angle will be kept. If BACKCHK=INCHI, the higher incidence angle will be kept. If BACKCHK=MORPH, the lower value of the equation: resolution/cos(emission angle) will be kept. If BACKCHK=ALBEDO, the lower value of the equation: resolution*[1/cos(emission angle)+1/cos(incidence angle)] will be kept.
PDFFILE	The name of the temporary pdf procedure.
USERNOTE	Comment from the user. This will be recorded in the ISIS session log file and also in the History entry that is put into the History object of the output file.