PDS_VERSION_ID          = PDS3
LABEL_REVISION_NOTE     = "2008-06-11, Initial"
RECORD_TYPE             = STREAM
OBJECT                  = TEXT
PUBLICATION_DATE        = 2008-07-01
NOTE                    = "
        hsibdoc.txt describes the Hsib.jar software."
END_OBJECT              = TEXT
END

NOTICE: This software requires the use of:
        Java 1.5 or greater 
        http://www.java.com/en/

NOTICE: This software has been tested on Linux and Mac OS X, but should work 
     on any unix based system. The software is also known to work on Windows,
     but can not browse the file system.  It must be started in the directory
     containing the cubes a user wishes to view when used on Windows.

Summary:
     Hsib, or Hyper-Spectral Image Browser, is a software tool used for the
     examination and analysis of VIMS data. It is written without VIMS
     specificity to allow its use in a broad range of projects involving 
     hyper-spectral data. 

     The Java platform was used for this project because it is open source,
     contains most of the tools needed including the Swing widget set, is 
     easily portable across computer platforms, and has an excellent IDE
     available. Existing software such as the Pirl Parameter Value Logic are 
     incorporated into this project. 

Distribution format:
     The Hsib program is compressed into a single archive JAR file. The
     Hsib.jar file contains all of the Java source files and plugins.
     Disclaimer: The VIMS Operations Team is not responsible for maintaining
     or correcting changes users have made to the program.

     The JAR format is fully described at 
     http://java.sun.com/docs/books/tutorial/deployment/jar/ 

Use and functionality:
     To run Hsib, make sure your java installation is at 1.5 or greater. Save
     the program to your desired directory. There are two general options to 
     start the program. You can open a terminal window and type: 
     "java -jar /path/to/Hsib.jar" where "/path/to" is replaced with YOUR 
     path or open a window into your directory and double-click the icon.
     
     Either of thes options will bring up the Image Browser window. The 
     current directory is shown in the title of the window. Clicking in the 

     "Directories" (yellow) area allows the user to go up and down the 
     directory tree. Note: ".." is used to go up the tree. Clicking on
     individual images ('cubes') in the "Images" (green) area causes more 
     information about the image to be shown in the "Selected Image Info" 
     (orange) area. 
     
     Double-clicking on an individual image causes an Image Viewer to pop up 
     loaded with that image.
     
     Uncalibrated data does not contain backplanes, so the backplane tracking 
     controls are not shown. If the data has been calibrated with a setup 
     that attaches geometric backplanes to the output images, the Back Plane 
     Tracking Controls will be visible to the user.
     
     The "Control Panel" area on the right-hand side of the Image Viewer is 
     where the user can adjust parameters.
     
     The "Zoom Slider" at the top of the control panel controls the size of  
     the image display. The possible zoom values range from 1 to 8 and are 
     currently set to be integet values. If a 64x64 cube is zoomed beyond a 
     zoom of 6, it will not fit in the default display area. Fortunately, 
     the image viewer window can be stretched to a larger size resulting 
     in a larger image display area.
     
     The gray scale limits text fields display the lower and upper bounds of 
     the range of values, Z1=black, Z2=white, used for scaling the displayed
     band.  
     
     If "Autoscale" is toggled off, values can be typed into these fields to 
     change the stretch of the display, when "Autoscale" is on, these values 
     are automatically recalculated whenever the band is changed.
     
     The "Toggle Buttons" allow the user to control some particular 
     parameters. The "Autoscale" toggle button turns automatic scaling of 
     the image display on or off. The defauts are "Bicubic" = on, 
     "Microns" = off, "Overplot" = off, "Autoscale" = on.

     The "Bicubic" button toggles between nearest-neighbor and 
     bi-cubic interpolation for the image display. The "Microns" toggle 
     button toggles the x-axis of the plot area between band-number and 
     wavelength in microns. The "Overplot" allows the overplotting of 
     various skewers through the data each time the sample (x) or line 
     (y) is changed. 
     
     The "Backplane Info" area allows the user to display backplane 
     information for the pixel under the cursor in the image display area. 
     By default the "Track Backplanes" toggle button is off so that must 
     be toggled on to use this feature. The two combo boxes below the 
     toggle button allow the user to select which backplane to display 
     in the first text field and which to display in the second text 
     field. Generally, for calibrated cubes with geometric backplanes 
     (from the pipeline) the backplanes are LATITUDE, LONGITUDE, 
     SAMPLE_RESOLUTION, LINE_RESOLUTION, PHASE_ANGLE, INCIDENCE_ANGLE, 
     EMISSION_ANGLE, and NORTH_AZIMUTH. If an image is displayed that 
     has no backplanes, the "Sorry, no backplanes" label will be 
     displayed instead of the backplane controls.