Home
About ISIS
Support
Download

ISIS 3

Documentation
Tutorials
Technical Documents

ISIS 2

Documentation
Tutorials
Technical Documents

Search

USGS

ISIS 3 Application Documentation


ringsautomos

Printer Friendly View | TOC | Home

Create a mosaic using a list of map projected cubes

Overview Parameters

Description

This program uses a text-based list of cubes, all in the same map projection and equivalent projection parameters (PixelResolution, CenterRingLongitude, etc), to generate a mosaic. By default, The program automatically determines the size of the mosaic by examining each cube. The user also has the option of entering their own rad/az range to use for the mosaic.

There are four different ways/priorities (input, mosaic, band, average) for how the input image has to be placed on the mosaic.

Priority Input will place the input image on top of the mosaic.

Priority Mosaic will place the input image beneath the mosaic.

Priority Band will place the input image on the mosaic based on the "Lessser" or "Greater" criteria between user defined band in the input and the mosaic images.

Priority Average will average the valid pixels in the input and mosaic images. For each mosaic band, a count band is maintained. The count band keeps track of the number of images involved in the averaging of the dn value for each pixel in the mosaic. Choosing this priority will cause the mosaic to have twice the number of bands of the input image, with a count band for each band. Hence the file size of the mosaic is doubled due to the count band.

In case of special pixels and the special pixel flags being enabled, the details for each priority is described below.

Tracking can be set at the time of Mosaic creation only and cannot be turned on after the mosaic is created. But the tracking will be turned off for multiband ONTOP and BENEATH priority even though it was turned on while creating the mosaic. Tracking for multiband input with ONTOP priority is possible only if all the Special Pixel Flags are set to True else the Tracking will be turned off. ONTOP priority basically places all the valid input pixels onto the mosaic unless the special pixel flags are turned on or if mosaic has a NULL pixel. In a multi band scenario, a pixel origin in particular line and sample will not be the same in all the different bands, which means we have to keep track of every pixel in every band. i.e. the size of the tracking bands will be the same as the number of bands in the mosaic.i.e the number of bands will be doubled.

WARNING: If Tracking is turned on in a mosaic, any subsequent applications that modify "dn" values will corrupt the Tracking band. It may be necessary to remove the Tracking band from the mosaic and then add it back after all the processing is complete. See "crop" and "cubeit".

Priority BAND can track origin for multi band input image based on a specified band using LESSER or GREATER than criteria. Each pixel in the specified band is compared to the corresponding pixel in the chosen band in the mosaic based on the chosen criteria. This comparison true or false is used for all the other bands whether the input pixel is copied onto the mosaic and hence the origin for that pixel is stored. Band can be chosen by choosing the TYPE, BANDNUMBER or KEYWORD. If BANDNUMBER is chosen then the band number can be entered in the NUMBER field. If KEYWORD is chosen then PVL key name and value from the BANDBIN group can be entered in the KEYNAME and KEYVALUE fields.

For example, for a multi band input with BAND priority, if the BAND chosen is Emission Angle band(EMA), if input pixels are (30,30,30) in EMA Band for some sample, line and the corresponding pixels in the EMA band in the mosaic has (75, 75, 75) and the criteria is GREATER than, then since input pixels are not GREATER than corresponding mosaic pixels, then the input pixels are not copied to the mosaic, so also the corresponding pixels in all the other bands in the input. Hence the origin for those pixels remains unchanged. If LESSER than was the criteria, then all the corresponding pixels in all the input bands will be copied to the mosaic and the origin for those pixels is the current input image.

There are options like MATCHBANDIN, if set requires the specfied input bands to match the mosaic bands and the bands can be anywhere in the mosaic but must be contiguous for multi-band. If MATCHBANDIN is not set then any input image can be placed on the mosaic within it's boundaries.

Options HIGHSATURATION, LOWSATURATION and NULL if set will cause the the input pixels with these values to be copied to the mosaic for ONTOP and BAND priorities regardless of the CRITERIA for the BAND priority. These options are not supported for BENEATH priority.

Currently Tracking can be viewed in the Advanced Tool Tracking option of the qview application. Following are the Tracking info:

Index : Zero based and is in the order in which the image was placed on the mosaic. No origin is represented as -1.

FileName: File name of input image

Serial Number:Serial Number of the input image

Following are the values for the origin band depending on the pixel type

Pixel Type
(bits)
Default
(No Origin)
Start ValueMax ValueTotal Images
Supported
32-16777216-167772151677721633549932
16-32768-3276732767 65535
801255255

Following is the table for Special Pixel options, input, mosaic pixels and the resulting output for different priorities.
Tags: F(FALSE), T(TRUE), V(VALID), HS(HIGH SATURATION), LS(LOW SATURATION), S(SPECIAL PIXEL HS, LS, NULL), N(NULL), I(INPUT), M(MOSAIC), HL(HS,LS)

  • Priority Beneath
    Priority Beneath
    BENEATH
    InputMosaic Output
    S,VNI
    S,VHL,VM



  • Priority OnTop
    Priority OnTop
    ONTOP
    OptionsImages
    HSLSNULLInputMosaicOutput
    F F FVS,VI
    F F F S HL,VM
    F F F S,V N I
    T OR T OR TV S,VI
    T OR T OR TSS,VI (H,L,N)



  • Priority Band
    Priority Band
    BAND
    OptionsImages
    HSLSNULLInputMosaicOutput
    F FF VVCriteria based
    F F FVS I
    F F F S HL,VM
    F F FS,VNI
    T OR T OR T S S,V I(H,L,N)
    T OR T ORT VVCriteria based
    T OR T OR T V SI



  • Priority Average
    Priority Average
    AVERAGE
    OptionsImages
    HSLSNULLInputMosaicOutputCount
    F F FV VAveragecount++
    F FFVSI1
    F FFSSM0
    F FFSVMcount
    T OR T ORTSS,VI0
    T OR T ORTVVAveragecount++
    T OR T ORTVSI1

  • Categories


    History

    Jim Mathews1992-01-01 Original version
    Jeff Anderson2004-02-26 Converted to Isis 3.0
    Jeff Anderson2004-07-28 Fixed bug caused by PVL refactor
    Elizabeth Miller2005-11-15 Added appTest, and fixed fromlist filter
    Elizabeth Miller2006-05-18 Depricated CubeProjection and ProjectionManager to ProjectionFactory
    Elizabeth Miller2006-08-03 Added user entered range and helper button
    Elizabeth Miller2006-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.
    Sean Crosby2007-02-28 Added an exception that reports which input cube is causing a problem while mosaicking.
    Sean Crosby2007-03-06 Program no longer throws an exception when an input cube does not fit into the output mosaic. Instead, any files that are not included in the output are listed in the application log.
    Sean Crosby2007-03-20 Corrected bug in determining if an image fits into the output mosaic
    Sean Crosby2007-03-20 Fixed one of the application tests
    Stuart Sides2007-04-16 Fixed bug where input cubes where incorrectly not processed.
    Steven Lambright2008-05-13 This program now utilizes ProcessMapMosaic
    Sharmila Prasad2009-10-19 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. Track the origin for multiband ONTOP priority if all the Special Pixel flags are set. Store the Serial numbers of the input mosaic in the mosaic along with the file name.
    Sharmila Prasad2011-01-19 Added "AVERAGE" priority where the mosaic will be average of valid input and mosaic pixels.
    Sharmila Prasad2011-01-24 Option to match DEM and also added new group "mosaic" to hold ShapeModel attributes for the mosaic
    Sharmila Prasad2011-09-07 Fixed bug #0000390 - tracking should continue even if the first image does not map onto the mosaic
    Sharmila Prasad2011-10-25 Fixed bug #0000464 - add optional list TOLIST containing all the files names that were added onto the mosaic.
    Sharmila Prasad2011-11-07 Updated documentation for Average priority. Fixes #553
    Steven Lambright and Stuart Sides2012-07-16 Fixed a border condition that caused only a few samples of an input image to be put into an output mosaic. The trigger for this condition was an input image that spanned more than the 0-360 domain by just a sample or two on the 0 side (started at -0.000?? degrees longitude instead of zero). Other cases of spanning more than the world - or just crossing the seam - could have exhibited problems. Fixes #967.
    Kimberly Oyama2012-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. Also modified mapmos and handmos to do the same. Fixes #976.
    Debbie A. Cook2012-12-10 Changed to use TProjection instead of Projection. References #775
    Debbie A. Cook2013-04-03 Changed to work for ringplane projections and renamed to ringsautomos. Also fixed type in BANDNUMBER parameter default. References #775
    Jeannie Backer2013-03-12 Added appTests. Test coverage appears low (52% scope, 54% line, 50% function), however these tests cover 100% in all three categories for the code that does not apply to the GUI helper methods.

    Parameter Groups

    Files

    Name Description
    FROMLIST List of cubes to mosaic
    MOSAIC Mosaic output cube
    TOLIST List of images were added to the mosaic
    PRIORITYThe priority of pixel placement

    Band Priority

    Name Description
    TYPEIndicate the Band name or number to be used for comparison
    NUMBEREnter the Band Number
    KEYNAMEEnter the Key name as it appears in the PVL
    KEYVALUEEnter the value associated with the "KEYNAME"
    CRITERIAThe criteria (Lesser or Greater) of pixel placement in a chosen band

    Ground Range

    Name Description
    GRANGEGround Range Options
    MINRINGRADMinimum Ring Radius
    MAXRINGRADMaximum Ring Radius
    MINRINGLONMinimum Ring Longitude
    MAXRINGLONMaximum Ring Longitude

    Options

    Name Description
    TRACK Track the mosaic origin
    MATCHBANDBINEnforce BandBin Group Match
    MATCHDEMEnforce DEM Match
    HIGHSATURATIONCopy Input HS (Instrument and Representation) values
    LOWSATURATIONCopy Input LS (Instrument and Representation) values
    NULLCopy Input NULL values
    X

    Files: FROMLIST


    Description

    A list of map projected cubes to mosaic. The Mapping groups must match in order to mosaic the cubes.

    Type filename
    File Mode input
    Filter *.txt *.lis *.lst
    Close Window
    X

    Files: MOSAIC


    Description

    The mosaic cube which will have the input cube placed into it.

    Type cube
    File Mode output
    Filter *.cub
    Close Window
    X

    Files: TOLIST


    Description

    This optional output list contains the names of all images that were added onto the mosaic.

    Type filename
    File Mode output
    Internal Default None
    Filter *.lis
    Close Window
    X

    Files: PRIORITY


    Description

    This parameter is used to select one of four ways to mosaic the pixels in areas of overlap.

    Type string
    Default ONTOP
    Option List:
    Option Brief Description
    ONTOP Input cube will be placed on top of the mosaic An input pixel will always be copied onto a NULL mosaic pixel . Valid input pixel will also be always copied onto the mosaic. Special input pixel will be copied onto the mosaic only if the special pixel flags are set.

    Exclusions

    • TYPE
    • CRITERIA
    • NUMBER
    • KEYNAME
    • KEYVALUE
    BENEATHInput cube will be placed beneath the mosaic If the mosaic pixel is NULL, then the input pixel will be written onto the mosaic otherwise it remains unchanged.

    Exclusions

    • TYPE
    • CRITERIA
    • NUMBER
    • KEYNAME
    • KEYVALUE
    • HIGHSATURATION
    • LOWSATURATION
    • NULL

    Inclusions

    • TRACK
    BANDInput pixel is placed on top of the mosaic based on the criteria in the selected band Input pixel is copied onto the mosaic if the mosaic pixel is NULL or if the chosen input pixel satisfies the criteria in comparison with the corresponding pixel in the mosaic. Special Input pixels are copied onto the mosaic if the special pixel flags are set.

    Inclusions

    • TYPE
    • CRITERIA
    AVERAGEAverage of valid input and the mosaic pixels If the Input and Mosaic pixels are valid then 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
    Close Window
    X

    Band Priority: TYPE


    Description

    The pixels in this band will be used for comparison between input image and the mosaic for a decision to be made in copying image into the mosaic.

    Type string
    Default BANDNUMBER
    Option List:
    Option Brief Description
    BANDNUMBERBand Number Choose this option to enter the band number to be used for comparison. This band number will be compared with the band # in the OriginalBand.

    Exclusions

    • KEYNAME
    • KEYVALUE

    Inclusions

    • NUMBER
    KEYWORDPVL Keyword in "BandBin" group Choose this option to enter Keyword from the "BandBin" group of the PVL

    Exclusions

    • NUMBER

    Inclusions

    • KEYNAME
    • KEYVALUE
    Close Window
    X

    Band Priority: NUMBER


    Description

    The band number should match that in the "OriginalBand" of "BandBin" Group

    Type integer
    Default 1
    Close Window
    X

    Band Priority: KEYNAME


    Description

    The entered key name must match the key name in the "BandBin"

    Type string
    Default OriginalBand
    Close Window
    X

    Band Priority: KEYVALUE


    Description

    This value must match the value associated with the key name entered in the KEYNAME

    Type string
    Default 1
    Close Window
    X

    Band Priority: CRITERIA


    Description

    This parameter is used to select one of two ways to mosaic the pixels in areas of overlap when doing by band comparison.

    Type string
    Default LESSER
    Option List:
    Option Brief Description
    LESSERInput pixel LESSER than the corresponding pixel in the mosaic If the dn value of a pixel in the input cube is lesser than the corresponding pixel in the mosaic in the chosen band, then the input cube pixel will replace the corresponding pixel for all the bands in the mosaic.
    GREATERInput pixel GREATER than the corresponding pixel in the mosaic If the dn value of a pixel in the input cube is greater than the corresponding pixel in the mosaic in the chosen band, then the input cube pixel will replace the corresponding pixel for all the bands in the mosaic.
    Close Window
    X

    Ground Range: GRANGE


    Description

    The ground range can either be calculated automatically or entered by the user. If the USER option is selected, values must be entered for the MINRINGRAD, MAXRINGRAD, MINRINGLON, and MAXRINGLON parameters. AUTO is the default for this parameter.

    Type string
    Default AUTO
    Option List:
    Option Brief Description
    AUTOAutomatically Calculate Range The program will automatically calculate the groundrange for the mosaic by examining all the cubes in the FROMLIST. This is the default option.

    Exclusions

    • MINRINGRAD
    • MAXRINGRAD
    • MINRINGLON
    • MAXRINGLON
    USERUser Entered Range The program will use the user entered ground range values for the mosaic.

    Inclusions

    • MINRINGRAD
    • MAXRINGRAD
    • MINRINGLON
    • MAXRINGLON
    Close Window
    X

    Ground Range: MINRINGRAD


    Description

    The minimum ring radius value to use in the mosaic.

    Type double
    Close Window
    X

    Ground Range: MAXRINGRAD


    Description

    The maximum ring radius value to use in the mosaic.

    Type double
    Close Window
    X

    Ground Range: MINRINGLON


    Description

    The minimum ring longitude value to use in the mosaic.

    Type double
    Close Window
    X

    Ground Range: MAXRINGLON


    Description

    The maximum ring longitude value to use in the mosaic.

    Type double
    Close Window
    X

    Options: TRACK


    Description

    If selected the application will track the mosaic origin. Once origin is tracked, the tracker cannot be turned off.

    Type boolean
    Default FALSE
    Close Window
    X

    Options: MATCHBANDBIN


    Description

    This option causes the application to fail if the input bandbin group does not match the mosaic bandbin group.

    Type boolean
    Default TRUE
    Close Window
    X

    Options: MATCHDEM


    Description

    This option causes the application to fail if the input DEM shapemodel does not match the mosaic's' shapemodel.

    Type boolean
    Default FALSE
    Close Window
    X

    Options: HIGHSATURATION


    Description

    This option causes High Saturation values (both Instrument and Representation) in the input image to be automatically copied to the mosaic irrespective of the priority

    Type boolean
    Default FALSE
    Close Window
    X

    Options: LOWSATURATION


    Description

    This option causes Low Saturation values (both Instrument and Representation) in the input image to be automatically copied to the mosaic irrespective of the priority

    Type boolean
    Default FALSE
    Close Window
    X

    Options: NULL


    Description

    This option causes NULL values in the input image to be automatically copied to the mosaic irrespective of the priority

    Type boolean
    Default FALSE
    Close Window