Supported Software: Running dark_settle

BASIC PROCEDURE FOR INCORPORATING DARK_SETTLE INTO YOUR IRS LH REDUCTION:

1. Gather *bcd.fits files for a single AOR and IRS module (LH is the only module for which the program has been tested). Download with Leopard by checking "bcd files".

2. Gather appropriate *flatfield.fits and *flatfield_cmask.fits files in either (a) the bcd/ director(y/ies) or (b) a parallel ../cal/ director(y/ies). You can download these with Leopard by checking "cal files". If flats are not found in either of these default locations, the program will query you for the location of the flatfield file[s]. If you are using pre-flatfielded data (eg., *rsc.fits), you should set the keyword /RSC.

3. Run dark_settle on the files, producing *_dks_bcd.fits files.

4. [Optional] Perform background subtraction on *_dks_bcd.fits files.

5. [Optional] Clean rogue pixels in the dark-settled, background-subtracted data using IRSCLEAN.

6. Extract using SPICE. Dark-settled, bg-subtracted, cleaned BCDs can be used with cleaned bmask and uncertainty files.

INPUTS:

The sofware has one optional input (a list of data files), as well as several optional keywords to choose from. The IDL calling sequence is:

dark_settle $
[,dataFiles] $
[,DIRECTORY=Directory] $
[,FILTER=filter] $
[,/NOCORRECT] $
[,SPLIT=split] $
[,OUTPUT_DIR=output_dir] $
[,FLATFIELD=flatfield] $
[,/RSC ] [,/CUBE ]$
[,/HELP]

Each of the optional inputs and keywords in the above calling sequence is described here.

OUTPUTS:

Each file will have each row corrected so that its median equals that of the "target column". The file names will have the string "dks" (dark-settle) appended to the front of the file type. If the file is a *_bcd.fits file, the corrected version will be *_dks_bcd.fits.

When the program exits, the equivalent command line input that you could have typed (incorporating any file dialogs) will be printed to the screen.

EXAMPLES:

1. SIMPLE MODE: program will query for any needed inputs.

   IDL> dark_settle

   NOTE: Under the IDL Virtual Machine (VM), this is the only mode that operates. It is invoked from the Unix command line by typing:

   unix% idl -vm=[path to dark_settle]/dark_settle.sav

2. USER INPUT MODE: specify all parameters in advance

   This mode is useful for embedding dark_settle in a program and/or re-running on newly processed BCDs. The following example uses the sample data that comes with the dark_settle distribution:

               IDL> cd,'[path to DarkSettle]'
               IDL> dark_settle,'sampledata/r12076032/ch3/bcd/*[!dks]_bcd.fits'
   
   

   The input file list can include wild cards accepted by IDL's FILE_SEARCH procedure, as well as names of text files. See the command line documentation for more details.

   NOTE: This mode is not available under the IDL Virtual Machine