Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Secure .gov websites use HTTPS
A lock ( ) or https:// means you’ve safely connected to the .gov website. Share sensitive information only on official, secure websites.

ISIS Documentation

overlapstats

Calculates the statistics of overlapping cube regions

This application takes a list of cubes and an image overlap list file from the output of findimageoverlaps and calculates statistics on all overlapping polygons of the provided images, writing the results to an output file. The statistics generated by this application may provide useful information for choosing parameters for the autoseed application. Images must be ingested into ISIS and have spiceinit, footprintinit, and findimageoverlaps run to produce the input for this application.

Statistics for the area, polygon thickness, and image stack size of the polygons are calculated. These statistics include minimum, maximum, average, standard deviation, and variance. Area refers to the area of the polygon in square meters. Image stack is the number of images that overlap for a given overlap region.

If there are any cubes within the list that do not overlap with any other cube in the list, those cube's filenames are included at the end of the output in the NoOverlap PVL keyword.

Categories

History

Christopher Austin2008-09-30 Original version
Christopher Austin2008-10-28 Fixed the formatting for a tab tabletype, improved documentation, and added an example.
Christopher Austin2008-11-10 The output file TO must now be specified.
Steven Lambright2008-11-17 Added support for image overlap files, which is what "OVERLAPLIST" needs to be. This is a required parameter obtained from running "findimageoverlaps."
Christopher Austin2008-10-28 Added error throwing when there are no overlaps among the cubes provided and other small bug fixes.
Christopher Austin2009-01-26 Added the ERRORS flat file.
Christopher Austin2009-02-17 Added the DETAILS FULL output option. BRIEF is now what the application use to result in.
Christopher Austin2009-03-05 Altered the DETAILS FULL and BRIEF options based off of user input. Now, the statistical data will always be placed in the print.prt file, and the TO file will only be used for the detailed output of the overlaps.
Christopher Austin2009-06-05 Added the SINGLELINE parameter and changed the keywords SerialNumber* to ImageStack*
Christopher Austin2009-06-08 Removed the *Sum keywords from the BRIEF output, and added PolygonCount.
Jai Rideout2011-09-26 Updated and rewrote much of the existing documentation with Raad Saleh and Laszlo Kestay to match the current behavior of the application, as well as clarify the purpose of the application.
Jai Rideout2011-12-26 Added check to ensure the provided cube list is the same one used in findimageoverlaps (i.e. the serial numbers in the overlap list match the serial numbers in the provided cube list). Fixes #515.
Jai Rideout2012-01-18 The errors file now contains a newline at the end. The error count is now calculated regardless of whether or not the ERRORS parameter was specified.
Debbie A. Cook2012-12-10 Changed to use TProjection instead of Projection. References #775
Jeannie Backer2016-04-22 Modified code to get TargetRadii using the cube label and mapping group rather than just the TargetName. Added TargetName keyword to Mapping group. References #3892

Parameters

Input Files

The filename of a list of input cubes. This list should be the same as the list used by findimageoverlaps.
Type filename
File Mode input
Filter *.lis

The filename of the image overlap list. You can obtain this file by running the findimageoverlaps application on the list of input cubes.
Type filename
File Mode input
Filter *

Output

Determines how much detail is given in the output.
Type string
Default BRIEF
Option List:
Option Brief Description
BRIEFBrief table The ouput will be displayed on the screen and placed in the print.prt file. The output will contain a table of statistics as described in the application description, including Area and Thickness statistics. If there are any cubes in the FROMLIST which do not overlap any other cubes in the FROMLIST, they will be listed at the bottom of the output. The number of polygons is also recorded.

Exclusions

  • TO
  • TABLETYPE
  • SINGLELINE
FULLFull data In addition to the output of BRIEF, each overlap's Area, Thickness, and all cubes that make up the overlap are written to the file specified in the TO option. The format of the output can be specified with the TABLETYPE option.

Inclusions

  • TO
  • TABLETYPE

The filename of the output file to contain the detailed stats of each overlap.
Type filename
File Mode output

The output table written to the file specified by the TO option will be formatted in accordance with the following option.
Type string
Default CSV
Option List:
Option Brief Description
TABTab Table Places the resulting statistics into a table where each value is separated by a tab. This format is easier to read by eye than CSV output.

Exclusions

  • SINGLELINE
CSVComma Separated Value Table Places the resulting statistics into a table where each value is separated by a comma.

Inclusions

  • SINGLELINE

Places all cube serial numbers and filenames on the same line in the output file. When False, Serial Numbers and Filenames are placed in columns for better human readability. This option is only available when the output is in CSV format.
Type boolean
Default TRUE

This file will contain the errors that occurred while calculating the overlap statistics. Each line will contain the error message followed by the serial number(s) of the cube(s) involved.
Type filename
File Mode output
Internal Default No Error Output

Example 1

Overlapping Statistics

This example illustrates how to generate overlap statistics for the following list of three overlapping cubes. overlapstats will calculate the thickness, area, and image count for each of the overlapping polygons that the cubes provided in cubes.lis create, and output these results to stats.txt. Each value in the resulting table will be separated by a tab.

Command Line

The command to use for this example.
overlapstats FROMLIST=cubes.lis OVERLAPLIST=overlaps.lis DETAIL=FULL TO=stats.txt TABLETYPE=TAB

Input Images

cube1.cub

First image

cube1.cub

This is the first input image for overlapstats to use

cube2.cub

Second image

cube2.cub

This is the second input image

cube3.cub

Third image

cube3.cub

This is the third input image

Overlapping Images

Overlap Visualization

Overlapping Images

This is not an input to the application, but it shows a visual representation of the overlapping regions of the three cubes. In this image, there are two overlapping regions.

Data Files

Links open in a new window.
The list of cubes to use This is the input list of cubes used to create the overlap list which the statistics will be run on.
The file containing image overlap information This is the file that contains information about the image overlaps. It can be obtained from the findimageoverlaps application.
The resulting stats file The FULL output of overlapstats will be displayed and written to the filename provided in the TO option. You will notice that there are two different overlaps, which correspond with the two overlaps present in the overlap visualization image (see below).