ISIS 3 Application Documentation
Create a mosaic using map projected cubes
Description
This program allows the user to create a mosaic using a map projected cube (Level2).
A mosaic can be created from an initial cube or the input cube can be placed in a pre-existing mosaic.
REQUIREMENT: The input cube must be map projected (Level2).
The input cube is required to be projected to the EXACT SAME ProjectionName,
PixelResolution (or MapScale), EquatorialRadius, PolarRadius, LatitudeType,
LongitudeDirection, as well as specific map projection keywords (e.g., CenterLatitude,
CenterLongitude). If these map projection requirements are not met, an error will be
encountered.
Note: The latitude and longitude range of the individual input cubes may vary.
If a new mosaic is to be created, it must be intialized with an input cube and CREATE=YES. The
default size of the output mosaic will be the SAME latitude and longitude extents of the input
file. The size of the output mosaic can be entered by the user through the any or all four
boundary parameters: MINLAT, MAXLAT, MINLON, MAXLON. The input cube also establishes the
number of bands and BandBin Group of the output mosaic. If there are list of input cubes to
mosaic together refer to the similiar application called automos.
Integrity-check Parameters:
MATCHBANDBIN = TRUE, the default is to require all the bandbin group and wavelength
keywords of the input cube files exactly match the output mosaic.
MATCHDEM = FALSE, the default does not check the SHAPEMODEL keyword of the input cube
files and does not propogate what DEM Shapemodel that was used when the input files were
projected.
The PRIORITY parameter will determine how each input cube is combined with the current
output mosaic cube. The process involves replacing an output mosaic pixel (or not) with
an input pixel at the same location. There are many user options and criteria that
influence the pixel replacement. Use of the PRIORITY parameter with and without other
options is explained in the tables and descriptions below.
The Track feature creates a band in the output mosaic file containing the index
values for every pixel in the output mosaic. The Track-band can only be used appropriately through
the QVIEW-AdvancedTracking tool. As the user interactively pans across the displayed
mosaic band (Band1), for every mosaic pixel location QVIEW-AdvancedTracking will report
the source cube filename that was input to automos. The Track-band cannot be used outside
the QVIEW-AdvancedTracking tool. Hence the file (byte) size of the mosaic is increased due to
the track-band.
The Track feature works with Priority options ONTOP (with HIGHSATURATION and
LOWSATURATION parameters) and BENEATH for single band input cubes. It does NOT support
multiple band input cubes with these priority options. It does work for multiband cubes
when PRIORITY=BAND. Furthermore, this feature is NOT supported when PRIORITY=AVERAGE.
The following table describes how the program will determine the pixel value in the output
mosaic for areas of image overlap.
| PRIORITY | RESULT |
| ONTOP |
This is the default. The current input image will be placed on top of the
output mosaic. Thus in any area of overlap, the Valid pixel values for the
current input image will appear in the output mosaic (it replaces the output mosaic
pixel). Invalid input Special Pixels
(NULL,HRS,HIS,LRS,LIS) will NOT
replace an existing Valid output mosaic pixel. Refer to parameters HIGHSATURATION,
LOWSATURATION, and NULL to override replacement of Valid output mosaic pixels.
|
| BENEATH |
The current input image will be placed beneath the output mosaic. Thus in
any area of overlap, the Valid pixel values for the current mosaic will remain in
the output mosaic. The Valid pixel values for the current input image will only
replace the NULL pixels values in the output mosaic. The HRS,HIS,LRS and LIS special
pixel values in the output mosaic will NOT be replaced by the Valid input pixel.
The parameters HIGHSATURATION, LOWSATURATION and NULL are not supported under this
priority.
|
| BAND |
The input image pixels will be placed in the output mosaic based on the "Lesser" or
"Greater" criteria of a priority band defined by the user. Parameters that apply to
this priority feature are TYPE, NUMBER, KEYNAME, KEYVALUE, CRITERIA.
|
| AVERAGE |
Overlapping Valid pixel values from the current input image and output mosaic will be
averaged for the new mosaic pixel values. A count-band is created with the output
mosaic file. The count-band keeps track of the number of images involved in the
averaging of the input dn values for each pixel in the mosaic. Invalid input pixel
values will not be included in the average. In the case where only one Valid pixel
exists between the input image pixels or the current mosaic pixel, the Valid pixel is
retained in the current output mosaic. Refer to parameters HIGHSATURATION,
LOWSATURATION, and NULL to override replacement of valid output mosaic pixels.
Choosing this priority will cause the mosaic to have twice the number of bands of
the input image. Hence the file (byte) size of the mosaic is increased due to
the count-bands.
NOTE: If an existing mosaic does not already contain a count-band, an error
will be encountered.
|
Each of the following priority option tables indicates the resulting output pixel for a
particular input pixel, given the selected special pixel options (parameters
HIGHSATURATION for HRS, HIS; LOWSATURATION for LRS, LIS; and NULL) in each table row.
| PRIORITY=ONTOP |
| Options |
Images |
| High Saturation |
Low Saturation |
Null |
Input Pixel Value Type |
Current Mosaic Pixel Value Type |
Output Mosaic Pixel Value Source |
| False |
False |
False |
Valid |
Special or Valid |
Input |
| False |
False |
False |
Special |
High Saturation or Low Saturation or Valid |
Mosaic |
| False |
False |
False |
Special or Valid |
Null |
Input |
| True or False |
True or False |
True |
Valid |
Special or Valid |
Input |
| True or False |
True or False |
True |
Special |
Special or Valid |
Input |
| PRIORITY=BENEATH |
| Input Pixel Value Type |
Current Mosaic Pixel Value Type |
Output Mosaic Pixel Value Source |
| Special or Valid |
Null |
Input |
| Special or Valid |
High Saturation or Low Saturation or Valid |
Mosaic |
| PRIORITY=BAND |
| Options |
Images |
| High Saturation | Low Saturation | Null |
Input Pixel Value Type | Current Mosaic Pixel Value Type |
Output Mosaic Pixel Value Source |
| False |
False |
False |
Valid |
Valid |
Criteria based |
| False |
False |
False |
Valid |
Special |
Input |
| False |
False |
False |
Special |
High Saturation or Low Saturation or Valid |
Mosaic |
| False |
False |
False |
Special or Valid |
Null |
Input |
| True or False |
True or False |
True |
Special |
Special or Valid |
Input |
| True or False |
True or False |
True |
Valid |
Valid |
Criteria based |
| True or False |
True or False |
True |
Valid |
Special |
Input |
| PRIORITY=AVERAGE |
| Options |
Images |
| High Saturation | Low Saturation | Null |
Input Pixel Value Type | Current Mosaic Pixel Value Type |
Output Mosaic Pixel Value Source |
Count Band Pixel Value (# of images used for average) |
| False |
False |
False |
Valid |
Valid |
Average |
increment count by 1 |
| False |
False |
False |
Valid |
Special |
Input |
count = 1 |
| False |
False |
False |
Special |
Special |
Mosaic |
count = 0 |
| False |
False |
False |
Special |
Valid |
Mosaic |
count unchanged |
| True or False |
True or False |
True |
Special |
Special or Valid |
Input |
count = 0 |
| True or False |
True or False |
True |
Valid |
Valid |
Average |
increment count by 1 |
| True or False |
True or False |
True |
Valid |
Special |
Input |
count = 1 |
Refer to automos for additional information and examples.
Categories
Related Applications to Previous Versions of ISIS
This program replaces the following
application
existing in previous versions of ISIS:
Applications
History
| Eric Eliason | 1986-01-02 |
Original version
|
| Jeff Anderson | 2004-02-24 |
Converted to Isis 3.0
|
| Jeff Anderson | 2004-02-26 |
Modified to not propagate input labels to the output mosaic
|
| Jeff Anderson | 2005-11-15 |
Fixed bug with mapping groups not properly initialized or copied
|
| Jacob Danton | 2005-12-05 |
Added appTest
|
| Elizabeth Miller | 2006-05-18 |
Depricated CubeProjection and ProjectionManager to ProjectionFactory
|
| Elizabeth Miller | 2006-09-01 |
Added the MATCHBANDBIN option that checks to make sure the input cube bandbin group
matches the mosaic bandbin group. The default is true.
|
| Steven Lambright | 2008-05-13 |
This program now utilizes ProcessMapMosaic
|
| Christopher Austin | 2008-09-19 |
If the given cube falls outside the provided the mosaic, it will now be
logged. (Removed some unused header files.)
|
| Christopher Austin | 2008-12-11 |
Changed the parameters SLAT, ELAT, SLON, ELON to MINLAT, MAXLAT, MINLON,
MAXLON in correlation with automos.
|
| Sharmila Prasad | 2009-10-15 |
Added option "TRACK" to track pixel origin. Also added new priority called BAND where
specified input and mosaic band is compared for moving input to mosaic and to track the
pixel origin. Added parameter "TYPE" to choose Band "NUMBER" or PVL "KEYWORD" from the
BandBin group. If "BANDNUMBER" is chosen, then "NUMBER" is activated to enter band number.
If "KEYWORD" is chosen then parameter "KEYNAME" and "KEYVALUE" are activated to enter key
name and value from the BandBin group for band comparison. Band comparison "CRITERIA" are
"LESSER" or "GREATER" than. Also there are options "HIGHSATURATION", "LOWSATURATION" and
"NULL", set to true will cause HS, LS and NULL input pixels to be copied to the mosaic
regardless of the priorities and criteria. These options are not supported for "BENEATH"
priority.
|
| Sharmila Prasad | 2010-10-27 |
Process Input File Attributes
|
| Sharmila Prasad | 2011-01-19 |
Added "AVERAGE" priority where the mosaic will be average of valid input and mosaic pixels.
|
| Sharmila Prasad | 2011-01-24 |
Option to match DEM and also added new group "mosaic" to hold ShapeModel attributes for the
mosaic.
|
| Sharmila Prasad | 2011-11-07 |
Updated documentation for Average priority. Fixes #553.
|
| Kimberly Oyama | 2012-09-18 |
When an image is placed twice (usually because the longitude range is greater than 360 and
encompasses the image more than once) only the last occurance was written to the log file.
This has been fixed so that there is an entry in the log file for every image placement.
References #976.
|
| Kimberly Oyama | 2013-04-15 |
Made the default for the TYPE parameter BANDNUMBER because, when running the GUI and
PRIORITY=BAND, a blank "TYPE=" was added to the command line string. This no longer
occurs, there is either no TYPE parameter or it is set to "TYPE=BANDNUMBER". Fixes #1549.
|
| Kimberly Oyama | 2014-02-14 |
Removed the requirement that all four lat/lon extents be entered by the user. The user can
now enter as little as none if the input cube Mapping group has the extents. However, if
the input cube is missing any of the extents, the user must enter them. If any of the
extents are missing, an error will be thrown. Fixes #1550.
|
| Kimberly Oyama and Tammy Becker | 2014-04-05 |
Updated Documentation. Updated unit test for priority=band. Fixes #1620. References #1623. References #1550.
|
|
Parameter Groups
Files
|
Name
|
Description
|
| FROM |
Cube to be placed in the mosaic
|
| MOSAIC |
Mosaic cube
|
| PRIORITY |
The priority of pixel placement
|
Band Priority
|
Name
|
Description
|
| TYPE |
Indicate the Band name or number to be used for comparison.
|
| NUMBER |
Enter the Band Number
|
| KEYNAME |
Enter the Keyword name as it appears in the BandBin Group
|
| KEYVALUE |
Enter the value associated with the "KEYNAME"
|
| CRITERIA |
Determines pixel placement given a band
|
Initialization
|
Name
|
Description
|
| CREATE |
Create the output mosaic
|
| TRACK | Track the source filename for each mosaic pixel |
| MINLAT |
Minimum Latitude
|
| MAXLAT |
Maximum Latitude
|
| MINLON |
Minimum Longitude
|
| MAXLON |
Maximum Longitude
|
Options
|
Files:
FROM
Description
This cube will be placed in the mosaic. It must have the same ProjectionName,
PixelResolution, EquatorialRadius, PolarRadius, LatitudeType, and LongitudeDirection as
the mosaic. The projection specific keywords, such as CenterLatitude and CenterLongitude,
must match as well.
|
Type
| cube |
|
File Mode
| input |
|
Filter
|
*.cub
|
Files:
MOSAIC
Description
The ouput mosaic cube which will have the input cube placed in it. If the selected cube does
not already exist as a mosaic, the CREATE option must be selected and it will be created.
In this case the latitude and longitude range parameters must be entered.
|
Type
| cube |
|
File Mode
| output |
|
Filter
|
*.cub
|
Files:
PRIORITY
Description
This parameter determines how the pixels from the input cube will be placed
in the mosaic.
|
Type
| string |
|
Default
|
ONTOP
|
|
Option List:
|
|
Option |
Brief |
Description |
| ONTOP |
Input cube will be placed on top of the mosaic
|
Valid input pixels will always be copied onto the mosaic. Any input pixel will be
placed onto a NULL mosaic pixel. If the mosaic pixel is not NULL and the input pixel
is special, it will only be copied onto the mosaic if the special pixel flags are set.
Exclusions
- TYPE
- CRITERIA
- NUMBER
- KEYNAME
- KEYVALUE
|
| BENEATH |
Input cube will be placed beneath the mosaic
|
If the mosaic pixel is NULL, then the input pixel will be placed on top of the
mosaic. Otherwise, it remains unchanged.
Exclusions
- TYPE
- CRITERIA
- NUMBER
- KEYNAME
- KEYVALUE
- HIGHSATURATION
- LOWSATURATION
- NULL
|
| BAND |
Input pixel is placed based on the CRITERIA parameter
|
If the input and mosaic pixel of the priority band, specified by NUMBER or KEYNAME
and KEYVALUE, are valid, a less than or greater than comparison is done. Depending on
the CRITERIA selected, the lower or higher of the two pixels is placed on top.
Special and NULL pixels are not placed on top unless their flags are set. So, if the
comparison of the priority band says that the input pixel should be on top but the
input pixel on any other band is null, without the null option being selected, the
mosaic pixel will remain unchanged for that band.
Inclusions
|
| AVERAGE |
Average of valid input and the mosaic pixels
|
If the Input and Mosaic pixels are valid, the output will be the average of
the 2 values. A count band is created for each corresponding band in the mosaic and
holds the count of the images corresponding to the Average DN value of each pixel in
the mosaic.
Exclusions
- TYPE
- CRITERIA
- NUMBER
- KEYNAME
- KEYVALUE
- TRACK
|
|
Band Priority:
TYPE
Description
This option allows you to select the method to specify the band
to use for the pixel comparison.
|
Type
| string |
|
Default
|
BANDNUMBER
|
|
Option List:
|
|
Option |
Brief |
Description |
| BANDNUMBER | Band Number |
You can enter the band number to use in the pixel comparison.
Exclusions
Inclusions
|
| KEYWORD |
PVL Keyword in "BandBin" group
|
Selecting this option allows you to enter the Keyword name and value
corresponding to the band to use in the pixel comparison.
Exclusions
Inclusions
|
|
Band Priority:
NUMBER
Description
This is the number of the band to use for the pixel comparison.
Band Priority:
KEYNAME
Description
This is the keyword string. The entered keyword name must match the name in the
BandBin group in the image labels.
|
Type
| string |
|
Default
| OriginalBand |
Band Priority:
KEYVALUE
Description
This value must match the value associated with the KEYNAME parameter.
Band Priority:
CRITERIA
Description
Select which type of comparison to do on the pixels. You can choose whether the lesser
or greater of the two pixels will be placed on top of the mosaic.
|
Type
| string |
|
Default
|
LESSER
|
|
Option List:
|
|
Option |
Brief |
Description |
| LESSER |
The lower DN value between the input and mosaic pixels will be placed on top.
|
The lower DN value between the input and mosaic pixels will be placed on top of
the mosaic.
|
| GREATER |
The larger DN value between the input and mosaic pixels will be placed on top.
|
The larger DN value between the input and mosaic pixels will be placed on top of
the mosaic.
|
|
Initialization:
CREATE
Description
Select this parameter if the mosaic does not already exist.
|
Type
| boolean |
|
Default
|
NO
|
|
Inclusions
|
- MINLAT
- MAXLAT
- MINLON
- MAXLON
- TRACK
|
Initialization:
TRACK
Description
The Track feature creates a band in the output mosaic file containing the index
values for every pixel in the output mosaic. The Track-band can only be used
appropriately through the QVIEW-AdvancedTracking tool. As the user interactively
pans across the displayed mosaic band (Band1), for every mosaic pixel location
QVIEW-AdvancedTracking will report the source cube filename that was input to
automos. The Track-band cannot be used outside the QVIEW-AdvancedTracking tool.
TRACK must be set to TRUE at the time of mosaic creation only and cannot be turned
on after the mosaic is created. When a mosaic is created with TRACK=TRUE, all
subsequent runs will default to TRACK=TRUE. When a mosaic is created with
TRACK=FALSE, an error will be encountered if subsequent runs have TRACK=TRUE.
Hence the file (byte) size of the mosaic is increased due to
the track-band.
A table, called InputImages, containing the names of the images used in the mosaic
will be added to the cube when TRACK=TRUE.
WARNING:
If Tracking is turned on in a mosaic, any subsequent applications that modify "dn"
values will corrupt the track-band, for instance the application reduce.
|
Type
| boolean |
|
Default
| FALSE |
Initialization:
MINLAT
Description
This parameter specifies the minimum latitude of the mosaic.
|
Type
| double |
|
Internal Default
| Use Map Value |
|
Minimum
| -90.0
(inclusive)
|
Initialization:
MAXLAT
Description
This parameter specifies the maximum latitude of the mosaic.
|
Type
| double |
|
Internal Default
| Use Map Value |
|
Maximum
| 90.0
(inclusive)
|
|
Greater Than
| MINLAT
|
Initialization:
MINLON
Description
This parameter specifies the minimum longitude of the mosaic
|
Type
| double |
|
Internal Default
| Use Map Value |
Initialization:
MAXLON
Description
This parameter specifies the maximum longitude of the mosaic
|
Type
| double |
|
Internal Default
| Use Map Value |
|
Greater Than
| MINLON
|
Options:
MATCHBANDBIN
Description
This option causes the application to fail if the input
BandBin Group keywords do not
match the mosaic BandBin Group.
|
Type
| boolean |
|
Default
| TRUE |
Options:
MATCHDEM
Description
This option causes the application to fail if the input DEM
shapemodel file does not
match the filename value in the output mosaic ShapeModel.
|
Type
| boolean |
|
Default
| FALSE |
Options:
HIGHSATURATION
Description
This option causes an input High Saturation special pixel value
(both Instrument and Representation) to replace the output mosaic pixel
regardless of the priority set or the original value of the mosaic pixel.
|
Type
| boolean |
|
Default
| FALSE |
Options:
LOWSATURATION
Description
This option causes input NULL pixel values to replace the output mosaic pixel
regardless of the priority set or the original value of the mosaic pixel.
|
Type
| boolean |
|
Default
| FALSE |
Options:
NULL
Description
This option causes NULL values in the input image to be automatically
copied to the mosaic regardless of the priority
|
Type
| boolean |
|
Default
| FALSE |