ISIS Application Documentation
camstats | Standard View | TOC | Home |
Generates and outputs camera statistics for a cube in raw camera geometry
Description
Categories
Groups
History
This program generates camera statistics from a user-supplied Level0 or Level1 cube. The output of camstats can be directed to a PVL file or a comma-delimited text file (flat file). For each output group, the program will calculate the minimum, maximum, average, and standard deviation values. The output groups are listed below:
The output values are calculated using the entire image area. However, the number of data collection points for the statistics can be controlled by using the line increment (LINC) and sample increment (SINC) parameters. The default value for LINC and SINC are 1. If the default value is used, then every line and sample of the image is used in the calculation of the output values. The increment value can be increased to reduce program execution time. If a value other than 1, for example the number 10, is assigned to LINC and SINC, then every tenth line and tenth sample of the image are used in the calculation of the output values. The edges of the image are always sampled even if the increment does not fall on the edge. Keep in mind that sparse increments assigned to LINC and SINC are susceptible to an adverse effect on the accuracy of the statistics.
The statistics are output both to the screen and to the print.prt file in PVL format. Additionally, if the user specifies a file using the TO parameter, the statistics are written to that file in PVL format (default) or as a comma-separated-value text file (FLAT file), depending on the FORMAT parameter.
If the output file exists and the APPEND parameter is set to "no", the contents will be overwritten.
Name | Description |
---|---|
FROM | Input cube filename |
ATTACH | Attach results to the cube's label |
TO | Ouput text filename |
FORMAT | Output file format (PVL or FLAT) |
APPEND | Append results to output file specified by TO. |
Name | Description |
---|---|
LINC | Line Increment |
SINC | Sample Increment |
Input cube with appropriate camera labels (refer to spiceinit). The input must be a Level0 or Level1 cube.
Type | cube |
---|---|
File Mode | input |
Filter | *.cub *.CUB |
If this option is selected, the output camera statistics will be attached to the input cube's label under the group "CameraStatistics."
Applications such as qmos reference the attached label for geometric information of the cube.
Type | boolean |
---|---|
Default | FALSE |
A text file in label format (PVL), which will contain the results of camstats. This output file, for example, can be used with the getkey application to pass the results to other programs when developing scripts.
Alternatively, the output can be written to a text file format, see the "FORMAT" parameter for more information.
The format is ignored unless the "TO" parameter is specified.Type | filename |
---|---|
File Mode | output |
Internal Default | None |
This is the format type for the output file. PVL format is the default. The format is ignored unless the TO parameter is specified.
Type | string | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Default | PVL | |||||||||
Option List: |
|
If this option is not selected, the output from the camstats application is appended to the output file. If this option is set to "NO" or "FALSE," any information in the TO file is overwritten.
Note: This will append the formatted results to the end of the TO file without regard to the formatting of the current contents.
Type | boolean |
---|---|
Default | FALSE |
LINC will control the number of lines where statistical data are collected. If a LINC of 10 is entered, every tenth line will be used in the data collection. This parameter as well as the SINC parameter are primarily used to reduce runtime for very large images by collecting data from a smaller statistical sample rather than the entire image.
Note: Keep in mind that if the LINC increment is set too sparsely, this could adversely influence the accuracy of the statistics.
Type | integer |
---|---|
Default | 1 |
SINC will control the number of samples where statistical data are collected. If a SINC of 10 is entered, every tenth sample will be used in the data collection. This parameter as well as the LINC parameter are primarily used to reduce runtime for very large images by collecting data from a smaller statistical sample rather than the entire image.
Keep in mind that if the SINC increment is set too sparsely, this could adversely influence the accuracy of the statistics.
Type | integer |
---|---|
Default | 1 |
Robert Sucharski | 2007-01-22 | Original version. |
Steven Lambright | 2007-08-14 | Added an application test. |
Kris Becker | 2008-02-27 | Check for special pixel values and write them as NULL values in keywords and the flat text file. |
Steven Lambright | 2008-05-12 | Removed references to CubeInfo . |
Christopher Austin | 2008-06-11 | Added the ATTACH option. |
Steven Koechle | 2008-11-12 | Camstats now outputs history to the cube when it finishes execution. |
Tammy Becker | 2012-01-19 | Modified documentation and added Glossary links. |
Janet Richie, Ella Mae Lee | 2012-11-20 | Modified documentation, fixes #1174. |
Lynn Weller | 2013-02-25 | Removed links to applications imbedded in text and replaced with italicized application name. Added application links to the "Related Objects and Documents" section of the documentation. Fixes mantis ticket #1525. |
Jeffrey Covington | 2015-02-19 | Updated FORMAT and APPEND documentation to be more clear. Made general edits for clarity. |
Andrew Stebenne | 2015-04-03 | Removed the filter on the TO parameter so that any file can be used for output. Updated documentation to clarify the existence and functioning of a few quirks. Addresses redmine ticket #175. |
Tyler Wilson | 2016-08-17 | Added statistics for ObliqueLineResolution/ObliqueSampleResolution, and Oblique Pixel Resolution. References #476, #4100. |