Home

User Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Contributor Documentation

Getting Started
Learn More
Explore in Detail
Get Inspired

Quick Links

Software Manual
AstroDiscuss
GitHub
API Reference

Documentation Versions

ISIS 2

Documentation
Tutorials
Technical Documents
USGS

ISIS Application Documentation

getsn

Printer Friendly View | TOC | Home

Prints Image Serial Number

Overview Parameters

Description

This program will print the serial number for an image.

Categories

History

Stuart Sides2006-06-01 Original version
Elizabeth Miler2006-12-13 Fixed up, finished documentation and checked in
Steven Lambright2007-07-27 Changed category from Utility to Control Networks
Steven Lambright2007-08-07 Added application test: default
Christopher Austin2008-01-08 Augmented observation number and added TO file with APPEND option
Steven Koechle2008-04-04 Added booleans for which keywords to get. If TO parameter is not entered output will go to console. Added results group to SessionLog and GuiLog (if applicable)
Steven Lambright2008-10-31 The print.prt file will now properly contain the results when getsn is run from the command line; before the results group was always empty. The "TerminalOutput" user preference no longer affects the output of this program. The default values of "FILE" and "OBSERVATION" have been changed to FALSE.
Mackenzie Boyd2011-03-07 Added FORMAT option to choose between PVL and FLAT format. Effects output file only, default is still PVL.
Kaitlyn Lee2018-01-17 Removed unreachable else clause that assumed more than two options are allowed to be entered in for the parameter FORMAT. Added test to default case to increase code coverage.

Parameter Groups

Files

Name Description
FROM Cube file to get the serial number for
TO The text to append result Pvl
APPENDAppends results on output file

Display File Name

Name Description
DEFAULTAllows serial number to default to the file name

Options

Name Description
FILE Get the Filename
SN Get the Serial Number
OBSERVATION Get the Observation Number

Output format

Name Description
FORMATOutput format
X

Files: FROM

Description

The cube file containing the label the serial number is to be created for.

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

Files: TO

Description

The text file in which the Result Pvl created is either appended or written to.

Type filename
File Mode output
Internal Default No Output file will be created
Filter *.txt *.prt *.pvl
Close Window
X

Files: APPEND

Description

Appends the created Results Pvl to the TO parameter output file. If this is set to false, then it write the results to the output file instead.

Type boolean
Default TRUE
Close Window
X

Display File Name: DEFAULT

Description

Within the Result Pvl, if the serial number is not know, then Unknown is displayed in the keyword SerialNumber. If this parameter is set to TRUE, then is displays the input cube's filename is displayed in the keyword SerialNumber instead.

Type boolean
Default FALSE
Close Window
X

Options: FILE

Description

If this boolean is not checked then the filename will not be part of the output.

Type boolean
Default False
Close Window
X

Options: SN

Description

If this boolean is not checked then the Serial Number will not be part of the output.

Type boolean
Default True
Close Window
X

Options: OBSERVATION

Description

If this boolean is not checked then the Observation Number will not be part of the output.

Type boolean
Default False
Close Window
X

Output format: FORMAT

Description

Output format options, either PVL or FLAT may be used to display the selected outputs.

Type string
Default PVL
Option List:
Option Brief Description
PVLPvl format Output will be in Pvl format.
FLATFlatfile format Output file in comma separated value, flatfile, format.
Close Window