Cube Generator Help File Test by Todd June 19 2018

Introduction.
	This IDL widget reads raw UVIS data files, optionally applies flatfielding and/or rtg corrections, and interfaces with Josh Colwell's Geometer engine to produce image cubes containing the UVIS data and geometric parameters in the form of separate backplanes. 


Initialization.
	The widget requires a minimum of IDL 5.5. ICY subroutines are called by the Geometer engine, requiring those are installed and initialized. If you can run Geometer, you can run this.

	This widget calls code written by others. Specifically, Josh Colwell's Geometer_engine.pro, Ian Stewart's, feuv_reader.pro and associated routines, and Andrew Steffl's Flatfielding routines. 

Operation.
	Upon running cube_generator.pro, you are welcomed by a widget with a text window on the right, and series of buttons on the left. Throughout the use of the generator, the text window will contain messages relating to what options and actions that are taken, as well as a running log of operations during the actual generation of the image cube. 

	To create a cube, the following steps are required, at a minimum.
  'Input Single File'
  'Output Options' -> 'Output File'
  Set Target
  'Geometer Presets' -> 'Load Kernels'
  'Create'

	A more complete discussion of the options and operations:
  'Input Single File': Select the raw UVIS data (from DAPS) to process.

  'Input Batch File':  Select a text file listing of data for observations that have been split into multiple files. The output cube will concatenate all into a single cube. All input files must be of the same spatial and spectral dimensions.

  'Output Options': Opens a sub-menu of output options

    'Output Format': Allows the cube to be output in a variety of formats.

	'Raw Binary': Outputs the cube as a floating point array. fltarr(spatial, readouts, spectral)

	'IDL_SAV': Writes an IDL save file with the data as a structure. Read into IDL with restore,'file',/verbose to see the format and names of the data and backplane structures.

	'ENVI': Writes the data as a binary array with the addition of a text header file that allows it to be read by ENVI, complete with bandnames and ancillary information..

    'Output File': Select the location and name of the output image cube.

    'Return': Close the 'Output Options' menu and return to the top level.

  'Use AJS Flatfield': If checked, the data will be flatfielded using Andrew Steffl's flatfield routines.

  'Aberration': Should you wish a different aberration to be used in the computation of the geometric parameters, change that here.

  'Use RTG Correction': Selecting this will uniformly subtract the RTG noise level from the data. You can manually set the value of the noise in the box to the right. YOU MUST PRESS ENTER AFTER ENTERING A NUMBER FOR IDL TO RECOGNIZE THE CHANGE.

  'Target Name': The user must specify the observations target manually for the calculation of the geometric parameters. Pull down and select the target. Should you wish to calculate the geometric parameters with reference to a fixed RA/Dec, select RA/Dec from the pull down menu and set the desired values in the text boxes on the right, REMEMBERING TO HIT ENTER IN EACH BOX.

  'Geometer Presets': Opens a sub-menu to allow manipulation of the SPICE kernels.

    'Geometer Path': FUTURE RELEASE. For now, geometer engine must be installed in the same directory as the cube generator code. Future releases will allow you to point to your geometer installation.

    'List Loaded Kernels': FUTURE RELEASE. List all currently loaded kernels

    'Load a Kernel': Select and load into memory a single SPICE kernel.

    'Load Kernel Batch': Select a text file that lists all the kernels you wish to load, along with their respective paths. Confirmation of each loaded kernel will appear in the text window on the right. For example, see the file 'T-0.txt' in the cube_generator distribution. Loading this file would provide all the kernels needed for the space around the Titan-0 flyby in July, 2004.

    'Return': Close this menu and return to the top level.

    'Create': Executes the code to form the image cube. The message window on the right will update and provide information about the procedure. The image cube generation code tests that it has all the information it needs prior to executing. Should there be an error, information about it will be shown in the message window.

    'Help': Shows this file. 

    'Exit': Exits. 


Image Cube Notes.

	The format and definition of the UVIS Image Cube format are explained in UVISImageCube.doc, which is included in the distributed zip file. 


Troubleshooting.

	The code has been tested using a number of different observations that span the variety of observation types encountered thus far by UVIS. If, however, you should come across bugs or problems with a specific observation, let me know and I'll see what needs to be fixed. 

	The most common error will likely be due to interfacing with ICY and the SPICE kernels. These error messages will appear, not in the widget message window, but in the IDL Output Log. 


Future Plans.

	Several options in the widget are currently disabled. Some features will be added in the coming days (specifically the batch operation mode), while others may take some time. Also, if you have any requests for different output options, processing options, etc., let me know and I will do my best to include them in future releases. 

Version History.

	1.0 - August, 2005: Basic single file functions operational
	1.1 - September 16, 2005: Batch file functionality enabled
	1.5 - January 10, 2007: Updates
					Integrated Ian Stewart's flatfield binning procedure.
	2.0 - March 13, 2007: 	New Cube Generator format integrated
					Greg Holtsclaw's time dependent calibration/flatfield routine
					Full variety of flatfielding and calibration routines
					Geometer_engine 3.11
					C-Kernel override options
					Handfull of other smaller changes


Contact.

	Kristopher Larsen
	LASP
	University of COlorado
	larsen@lasp.colorado.edu
	303-735-6513