OSIRIS Toolbox

Overview

Github Release

v5.0.0 is the "master" branch on Github

Issue Tracker

Please report issues to the issue tracker

Rectification Matrices

Contact

OSIRIS Support

Details

v5.0.0 works for both pre-upgrade H2 and post-upgrade H2RG data.

v5.0.0 is the "master" branch on Github

DRP Issues
Flux Misassignment -- Not really misassignment
  • The DRP adds noise to raw data such that reduced data cubes have lower SNR than raw spectra. The additional noise is localized and flux appears to be conserved.
    • Primarily affects emission line point sources and high SNR data
    • New detector data (2016-present) significantly less affected
  • The 100 mas plate scale is more susceptible than other scales
  • We recommend not to use the Clean Cosmic Ray module.
  • The reported fringing appears to be due to undersampled spectra and not to optical effects.
What Can I do?
  • Expect 5-7% uncertainty in the 100 mas plate scale for emission line point sources
  • Try re-reducing with Cosmic Ray rejection "skipped"
  • Ensure you have the latest Rectification Matrices
  • Contact OSIRIS Support
What is Keck Doing?

v5.0.0 Release Notes (2021-Feb-22)

    Major updates:
  • New wavelength solution for 2021. OSIRIS had to be opened for servicing in Dec. 2020, so new arc scans were taken in Jan 2021 and new wavelength solutions were created. Tests show that the average wavelength shift at Kn3 35 mas to be about -0.04+-0.07 Angstroms (based on comparisons with OH skylines). At Kn3 50 mas, the shift is on average: 0.38+-0.06 Angstroms.

v5.0beta Release Notes (2020-Sep-22)

    Major updates:
  • New wavelength solution for 2019 & 2020. Unlike data before 2019, there appears to be larger residual offsets in the wavelength solution between different plate scales. The smallest shift is at 50 mas and the grows larger for smaller plate scales. At Kn3 35 mas, the offset is about 0.3 Angstrom based on comparisons with OH sky lines.
  • Handle imager upgrade pixel units (DN) instead of DN/s
  • The FITS files from the imager upgrade were flipped such that the images were not in an astronomical orientation.
  • QL2 will now flip IMAGER images about the x-axis (IDL-> im=reverse(im,2)) for upgraded images only. SPEC and DRP cubes are NOT flipped.
  • Made a slight update to IDL_astro routine xy2ad.pro to handle WCS in OSIMG images.
  • Other minor updates

v4.2.0 Release Notes (2018-May-07)

    Major updates:
  • Derived new wavelength solution for OSIRIS in March 2018, which was required because OSIRIS was opened. All users are recommended to use this version, especially those with data post March 2018.
  • Updated manual - new installation instructions, wavelength solution, bad pixel mask info, updated information post-2016 detector upgrade are ongoing. Download manual.

v4.1.0 Release Notes (2017-December-18)

    Major updates:
  • New wavelength solution for data after May 2017
  • Bad pixel mask
  • Better K-band scale sky behavior
  • Cosmic ray rejection turned off by default

v4.0.0 Release Notes (2017-January-25)

    Major updates:
  • Updates to the code in order to run the pipeline for the new detector (2016 data and newer).
  • Installation has now been simplified (see below for install directions). Bash scripts have been included for those who would like to use bash shell.
  • Test framework is now available to run tests of the pipeline (requires pytest module in python, see README in ''tests'' directory)
  • Optimized algorithms for the construction of data cubes
  • qlook2, odrfgui, and oopgui are now also included in the repository
    Minor Updates:
  • WCS bugs have been fixed.
  • qlook2 fixes
    • units bug is fixed
    • fix initial autoscale to imager display
    • clean up startup scripts
Get the Pipeline
Pipeline on github
To Download:
  • git method (please see the README and Example links under "To Install"):
    1. git clone https://github.com/Keck-DataReductionPipelines/OsirisDRP.git
      1. Errors of form: 
        Cloning into 'OsirisDRP'...
fatal: unable to access 'https://github.com/Keck-DataReductionPipelines/OsirisDRP.git/': Peer reports incompatible or unsupported protocol version.
        are due to outdated security protocols on some operating systems. Github suggests upgrading your OS.
      2. You may use the "Save As..." method.
    2. git fetch
    3. git checkout master
  • Save As... method:
    1. Save .zip link or .tar.gz link
    2. If you wish to install a different version, substitute that version in the Save As URL.
To Install:
    git method
  • Please read and follow:
    1. README
    2. Example
  • Save As... method: (coming soon)
Includes these Downloads:
Data Reduction Pipeline (v4.0.0) (01/25/2017)
Convert raw 2-D data into reduced 3-D data cubes. Runs in IDL v6.1 and above.
Data Reduction GUI (ODRFGUI)
Click, click, your data's reduced.
Quicklook2 (ql2)
IDL-based FITS viewer
OSIRIS Observing Planning GUI (OOPGUI)
Generate and save dataset description files (ddf) used at night
Issue tracker on github
Please report your issues
Additional Downloads not currently in Github:
Current OSIRIS Manual (v2.3) (03/01/2010)
3.3 MB of OSIRIS info.
Quicklook2 User's Manual (v2.2) (04/01/2008)
OSIRIS Rectification Matrices
available for download
DRP Cookbook
by Jim Lyke for wiki user information. -->
UCLA Links (Historical, no longer active)
UCLA Data Reduction Pipeline Page
UCLA OSIRIS Updates Page
Links/Download Descriptions
Data Reduction Pipeline (v4.0.0 - 01/25/2017)
Comprehensive pipeline designed to fully reduce all of the calibration data and to reduce scientific data to the level where an astronomer can begin custom analysis. The OSIRIS pipeline is designed to:
  • Fix artifacts on the raw 2D array
  • Wavelength calibrate
  • Assemble all the spectra into a 3D cube (λ wavelength, x and y spatially).
  • Allows for mosaicking of multiple 3D cubes
  • Downloaded and installed by install script
Astronomers are responsible for generating their own custom analysis tools. We encourage sharing of tools.
Data Reduction GUI (v2.3 - 03/01/2010)
ODRFGUI
  • Generates XML data reduction files (DRFs) required to run the pipeline
  • Select pipeline modules
  • Select data
  • Drop into the DRP Queue
  • Downloaded and installed by install script
  • Manual install: download and unpack the package and consult the README file
Current OSIRIS Manual (v2.3 - 03/01/2010)
Complete descriptions of...
  • Capabilities
  • Observational procedures
  • Data reduction system
  • Detector performance
  • Filter curves
  • Much more
  • Downloaded by install script
OSIRIS Observing Planning GUI (v1.5 - 04/01/2008)
OOPGUI
  • Identical to what you use when observing
  • Generate and save planning scripts (.ddf)
  • Java
  • Downloaded and installed by install script
  • Manual install: Download and unpack the package; read the README
Quicklook2 Package (v2.2 - 04/01/2008)
QL2
  • Update to NIRSPEC/NIRC2 Quicklook
  • Handles 2- and 3-D fits files
  • IDL (requires license)
  • Downloaded and installed by install script
  • Manual install:
    1. Download the tar file and unpack the file somewhere in your IDL path
    2. Edit the environment variable 'QL_FILEDIR' in the file 'run_ql2' to match the directory path where you just unpacked Quicklook2.tar file
    3. Add install directory to your path
    4. Type 'run_ql2' at your prompt
Quicklook2 User's Manual (v2.2 - 04/01/2008)
QL2 Manual
  • Complete description of functionality and procedures
  • Detailed install directions
  • Works in UNIX, LINUX, Mac OS, and Windows
  • Downloaded by install script
Previous DRP Versions
v4.0.0-beta
To Download:
  • git method (please see the README and Example links under "To Install"):
    1. git clone https://github.com/Keck-DataReductionPipelines/OsirisDRP.git
    2. git fetch
    3. git checkout v4.0.0-beta
  • Save As... method:
    1. Save .zip link or .tar.gz link
To Install:
    git method
  • Please read and follow:
    1. README
    2. Example
  • Save As... method: (coming soon)

v4.0.0-beta Release Notes (2016-May-30)

  • Updates to the code in order to run the pipeline for the new detector.
  • For data taken in 2016 onward, it is no longer necessary to run the following modules:
    • Remove Cross Talk
    • Glitch Identification.
    • It is fine to keep them in the DRF XML, these modules will automatically not run on the new data.
  • Installation has now been simplified (see README for instructions). Bash scripts have been included for those who would like to use bash shell.
  • Test framework is now available to run tests of the pipeline (requires pytest module in python, see README in ''tests'' directory)
  • WCS bugs have been fixed.
  • This beta release has not been tested extensively on pre-detector upgrade data
Pre-Upgrade Version (v3.2)
Pre-Upgrade Version (v3.2)
Last modified: 06/21/2025 21:05
Send questions or comments to:OSIRIS Support

The information on this page is the property of the W. M. Keck Observatory. The contents of this page or any part thereof shall not be copied or otherwise reproduced or transferred to other documents or used or disclosed to others for any purpose other than observing support at the W. M. Keck Observatory and the subsequent analysis and publication of scientific data obtained from observations conducted at the W. M. Keck Observatory. All rights reserved. © W. M. Keck Observatory.