ISIS Application Documentation
Prints Image Serial Number
 
          Description
        
    This program will print the serial number for an image.
   
 
          Categories
        
 
              History
          
| Stuart Sides | 2006-06-01 | 
      Original version
     | 
 
| Elizabeth Miler | 2006-12-13 | 
      Fixed up, finished documentation and checked in
     | 
 
| Steven Lambright | 2007-07-27 | 
      Changed category from Utility to Control Networks
     | 
 
| Steven Lambright | 2007-08-07 | 
      Added application test: default
     | 
 
| Christopher Austin | 2008-01-08 | 
      Augmented observation number and added TO file with APPEND option
     | 
 
| Steven Koechle | 2008-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 Lambright | 2008-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 Boyd | 2011-03-07 | 
      Added FORMAT option to choose between PVL and FLAT format. Effects output
      file only, default is still PVL.
     | 
 
| Kaitlyn Lee | 2018-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
         | 
 
| APPEND | Appends results on output file | 
 
 
Display File Name
| 
                    Name
                     | 
                    Description
                     | 
 
| DEFAULT | Allows 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
                     | 
 
| FORMAT | Output format | 
 
 
 | 
 
Files:
                        FROM
                         Description
                       
          The cube file containing the label the serial number is to be created for.
        
| 
                             Type
                            | cube | 
| 
                               File Mode
                              | input | 
| 
                               Filter
                              | 
          *.cub
         | 
 
 
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
         | 
 
 
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 | 
 
 
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 | 
 
 
Options:
                        FILE
                         Description
                       
            If this boolean is not checked then the filename will not be part of
            the output.
        
| 
                             Type
                            | boolean | 
| 
                               Default
                              | False | 
 
 
Options:
                        SN
                         Description
                       
            If this boolean is not checked then the Serial Number will not be
            part of the output.
        
| 
                             Type
                            | boolean | 
| 
                               Default
                              | True | 
 
 
Options:
                        OBSERVATION
                         Description
                       
            If this boolean is not checked then the Observation Number will not
            be part of the output.
        
| 
                             Type
                            | boolean | 
| 
                               Default
                              | False |