IRSCLEAN_MASK Change Log

• Changes Made in Version 1.9
• Changes Made in Version 1.8
• Changes Made in Version 1.7
• Changes Made in Version 1.6
• Changes Made in Version 1.5
• Changes Made in Version 1.4
• Changes Made in Version 1.3

Changes Made in Version 1.9

Release Date: 27 July 2007

• Changes to IRSCLEAN
  • Added new option /PeakUp to analyze and/or clean rogue pixels in the peakup apertures.
  • Bug Fix: Program exits when no file is input.
  • Allow /getfmask to work on data with only NaN's or zeros in interorder regions (coa2d or bksub), using the orders to compute sigma. Fixes bug: "Attempt to subscript W_I with IOK is out of range."
  • Changed "Save mask?" dialogue to read "Done editing mask?".
  • Allow multiple input rogue masks (combine using OR).
  • Automatic uncertainty and bmask finding when IRSCLEAN is run on a previously cleaned (_clean.fits) image. (Result is a _clean_clean.fits file).
  • Improvements in cleaning algorithm.
  • Bug Fix: No longer forces all rogue mask pixels to be cleaned, regardless of quality.
  • No longer update bmask and uncertainty pixels in rogue mask which were not successfully cleaned.
  • Output a new unclean_mask image file representing the pixels that were not successfully cleaned.
• Changes to documentation:
  • Updated "1.8" to "1.9".
  • Added section: "Should I Always Run IRSCLEAN on My Data?".
  • Added Appendix 3 Cleaning the Peakup Sub-Arrays to describe the /PeakUp keyword.
  • Updated existing sections to accomodate the /PeakUp option.
  • Updated section on Saving Your Mask.
  • Added description of new "unclean" mask, and new subsection in Appendix 1, "A second pass at cleaning data using the unclean_mask file."

Changes Made in Version 1.8

Release Date: 5 March 2007

• Changes to IRSCLEAN_MASK
  • Added new option /noStage2 to skip the "Stage 2" cleaning of multiple files using the mask derived in Stage 1.
  • No more NaN's in clean pixels or in extracted uncertainty . Fixed cleaning algorithm to eliminate possibility of cleaned pixels set to NaN. Uncertainties for "cleaned" pixels are now interpolated using the same algorithm as for data (used to be set to NaN).
  • Fixed problem finding uncertainty and bmask files for some bksub.fits data.
  • Improved cleaning algorithm so there are fewer un-cleaned pixels and fewer pixels with unusual values.
  • Eliminated interactive dialogues when file input keywords are set in the command line (inRmask_File,outRmask_File, outClean_File,filesToClean).
• Changes to documentation:
  • Updated "1.7" to "1.8".
  • Updated section on "Cleaning" Uncertainty and Mask Files to describe the new method of cleaning uncertainty files.
  • Added section Quitting After Stage 1 to describe the /noStage2 keyword.
  • Updated existing sections to accomodate the /noStage2 option.

Changes Made in Version 1.7

Release Date: 9 January 2007

• Changes to IRSCLEAN_MASK
  • Added Keyword /ABS_VAL to allow searching for rogues by absolute value (will find positive and negative outliers).
  • Added Keyword /NEGATIVE_ONLY to only search for "negative" rogue pixels.
  • Added keyword maskFunction to allow a user-supplied IDL function (or set of functions) that creates a rogue mask from your input image, independently of the default multiresolution method used when /getFmask is set.
  • Added sample IDL function irsclean_threshall.pro, usable with keyword maskFunction, which defines rogue pixels as all pixels greater than a particular multiple of the noise level.
  • Updated Short Low, Short High, and Long Low order masks to the most recent versions used in the IRS pipeline.
  • Incorporated the Peakup Mask as Short Low "orders" 4 (Red) and 5 (Blue).
  • Bug Fix: Problem reading campaigns.txt on some platforms and versions of IDL.
  • Bug Fix: Cleaning the wrong uncertainty and bmask files for coa2d.fits and bksub.fits data.
• Changes to documentation:
  • Updated "1.6" to "1.7".
  • Added a description of The User-Defined Mask
  • Updated section "Letting IRSCLEAN_MASK find a Mask Automatically" to explain the use of the new keywords /ABS_VAL and /NEGATIVE_ONLY.
  • Added a section on "Specifying Your Own Subroutine for Automatic Mask Finding" to explain the use of the new keyword maskFunction.

Changes Made in Version 1.6

Release Date: 1 September 2006

• Changes to IRSCLEAN_MASK
  • Bug Fix: Keyword outCleanFile not working.
  • Bug Fix: Keyword /Nan not working on some platforms.
  • Streamlined file-picking algorithm and error handling by adding file_picker.pro.
  • IDL Version prior to 6.0: Ensure that files do not get overwritten without user permission.
• Changes to documentation:
  • Update "1.5" to "1.6".
  • Minor touchups for clarity.

Changes Made in Version 1.5

Release Date: 8 August 2006

• Changes to IRSCLEAN_MASK
  • Better rogue-finding in low resolution (SL,LL) with /getFmask. (Improved noise estimation under high background conditions.)
  • Added ORDERS= keyword, which provides the capability to specify which orders to search for rogue pixels.
  • Bug Fix: "Type conversion error: Unable to convert given STRING to Integer" error message.
• Changes to documentation:
  • Update "1.4" to "1.5".
  • Description of new ORDERS keyword.
  • Minor edits to the section Letting IRSCLEAN_MASK Find a Mask Automatically

Changes Made in Version 1.4

Release Date: 24 April 2006

• Changes to IRSCLEAN_MASK
  • Bug Fix: "Incorrect Channel Number" error message even when input rogue mask is the same channel as the data.
  • Bug Fix: Unable to display regions with the order mask set to 1.
  • Bug Fix: Color table needs to be initialized.
  • Replaced outdated order mask files with current b?_wavsamp_omask.fits masks, which are compatible with current extraction apertures.
  • Only use/save rogue pixels that are in the order mask.
  • Added the capability to process background-subtracted (bksub.fits) images from the pipeline, along with the uncertainty and pipeline mask products.
  • Updated sampledata/ to S13 fits files, including the addition of bksub.fits for channel 2 (LL).
• Changes to documentation:
  • Update "1.3" to "1.4".
  • Added entry in table 3 for bksub products.
  • Added a Change Log file with history of changes.
  • Minor changes for clarity.

Changes Made in Version 1.3

Release Date: 8 February 2006

• Changes to IRSCLEAN_MASK
  • IRSCLEAN_MASK is now compatible with SPICE! The program automatically looks for bmask and uncertainty files and creates "cleaned" versions for use in spectral extraction.
  • The sample data have been standardized to conform to pipeline nomenclature. New droop,bcd,bmask,func, etc data are now located under "sampledata" subdirectory
  • Old sample data have been removed.
  • For more clarity in display, interorder pixels are blanked out in mask editing and stage 1 cleaning. These pixels do not get cleaned.
  • Pop-up WARNINGs when input rogue mask either:
    1. Is not an integer array
    2. Is of unknown channel number
    3. Has a different channel number than the data
  • We added the DIRECTORY keyword to allow the user to set the initial working directory.
• Changes to documentation:
  • Added section on using results as inputs to SPICE
  • Revised description of sample data.
  • Revised description of BMASK.
  • Added Appendix item on using the DIRECTORY keyword.
  • Update "1.2" to "1.3".
  • Updated graphics to reflect version 1.3, new sampledata
  • Added a "changes since last version" section.