Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

JWST-NIRSpec MSA spectral visualization tool

Project Description

This tool is a prototype for the “Spectrum View” mode, when designing a NIRSpec MSA observation with APT. The intent for the tool is to provide a means of visualizing the spectra which will be observed given a particular MSA shutter configuration, filter, and grating.

In the current standalone implementation, the user must provide an MSA configuration file, which is a .csv file which can be exported from APT, and contains a record of which shutters are open. Once the MSA config file has been parsed, and a filter+grating combination is chosen, the tool displays a simplified model of where the spectra from the open shutters will fall on the NRS1 and NRS2 detectors.

Installation

It is strongly recommended to use MSAViz in conjunction with the Anaconda Python distribution, which greatly simplifies the installation of dependencies.

NOTE: these instructions have not been tested on Windows.

Step 1: Create a new conda environment.

$ conda create --name msaviz pip numpy scipy astropy cython
$ source activate msaviz

You can specify a particular python version when creating the conda environment with python=2 or python=3 or something similar; otherwise, it will default to the python version of your Anaconda distribution.

If you prefer to use msaviz in an existing conda environment (which already has the dependencies installed), feel free to do so. Just skip the conda create line, and then $ source activate <your_environment> instead of $ source activate msaviz. However, make sure that your environment has sufficiently-new versions of the dependent packages.

Step 2: Install Kivy and its dependencies.

Windows:

$ conda install docutils pygments
$ pip install pypiwin32 kivy.deps.sdl2 kivy.deps.glew
$ pip install kivy
$ garden install filebrowser

Mac:

To install the Kivy dependencies, you will need to have the Homebrew package manager installed. If you are trying to install this on a Mac owned by STScI, you will likely run into problems when attempting to install Homebrew. I have included the install_homebrew.sh script here, to handle this task. Once you run the script, and follow the instructions at the end, simply do $ brew_activate in advance any time you activate your conda environment.

$ brew install pkg-config sdl2 sdl2_image sdl2_ttf sdl2_mixer
$ USE_OSX_FRAMEWORKS=0 pip install -I --no-cache-dir --no-binary all kivy
$ garden install filebrowser

Step 3: Install MSAViz.

$ pip install msaviz

If you’re viewing this on testpypi.python.org, try this instead:

$ pip install -i https://testpypi.python.org/pypi msaviz

Quickstart Guide

To begin using MSAViz, start the conda environment (if on an STScI Mac, activate Homebrew before the environment; see above) and run the package:

$ source activate msaviz
$ msaviz

File Select Screen

When the interface has opened, complete the following steps on the file select screen:

  1. Choose a working directory (the included test/ directory is the default).
  2. Select a filter & grating combination using the dropdown.
  3. Choose an MSA config file which has been exported from APT.
  4. Press Parse and wait while the MSA config file is parsed and the wavelengths are calculated.
  5. Once this is complete, press Show the Spectrum Display! to view the visualization.

Spectrum View Screen

On the spectrum view screen, the spectrum from each shutter is displayed on a representation of the two detectors. A colorbar at the bottom of the screen shows the displayed wavelengths.

To zoom & pan the display, simulate a multi-touch with a right-click (which will leave a small red dot on the screen, which is the focus point for zooming), then click and drag to increase or decrease zoom. After zooming in, click and drag to pan in any direction. You can zoom back out with the same method as zooming in.

Click Check Wavelength to open the associated dialog (see below).

Click Export... and choose a filename to export an ascii table showing the open shutters and their wavelength bounds on each detector (including the predicted lost wavelengths due to the detector gap).

Click Save... and choose a filename to export a PNG image of the spectrum display. This function does not work when the display is zoomed.

Click Shutters... to move to the shutter view Screen (see below), or Back to return to the file select Screen.

Check Wavelength Dialog

On the Check Wavelength dialog, you can identify where a particular wavelength or set of wavelengths will likely fall with respect to the two detectors, for all open shutters at once. Enter a wavelength in the text box and press Submit to add that wavelength to the list.

Once at least one wavelength has been entered, a scrollable table will appear below, showing the list of open shutter coordinates, and where each wavelength will likely fall for each shutter. This will also warn if a particular wavelength will fall near the edge of one of the two detectors for a given shutter, since that wavelength may fall off of that detector during the actual observation.

Click Save to File and select a filename and path to save the table of wavelengths to a file. Click Done to go back to the spectrum view screen.

Shutter View Screen

On the shutter view screen, a map of the four MSA quadrants is shown, indicating all closed (black), open (orange), inactive (grey), and stuck-open (red) shutters. You can zoom & pan this display in the same way as the spectrum view screen.

Click on any open shutter to select or deselect it; selected shutters turn cyan, and cause the corresponding spectrum on the spectrum view screen to be highlighted. Note that the individual shutters in an MSA slitlet must be selected individually if you want to highlight all of the associated spectra.

Click Find... to enter a set of shutter coordinates (with the option to select from a dropdown of all shutters which are currently selected shutters), and then automatically zoom and pan to center on the chosen shutter.

Click Save... and choose a filename to export a PNG image of the shutter display. This function does not work when the display is zoomed. Click Back to return to the spectrum view screen.

Programmatic API

The MSAViz package exposes two classes and three functions, which may be used from the python command line, or from other python scripts. They can be imported like so:

>>> from msaviz import MSA, MSAConfig #classes
>>> from msaviz import check_wavelengths, parse_msa_config, wavelength_table # functions

The MSA class is the low-level construct used to calculate pixel-to-wavelength mappings for a given filter+disperser combination. This class will generally not be used, and is included for completeness; see the module documentation for details on its invocation and use.

The MSAConfig class includes methods to parse an MSA config file, and calculate wavelengths and useful statistics based on the open shutters for that configuration. Instantiate with paired filter and disperser name strings, as well as the path to an MSA config file (a .csv file exported from APT). The filter & disperser can be changed with MSAConfig.update_instrument(), and the config file can be changed with MSAConfig.update_config().

  • The MSAConfig.wavelength() method accepts one or more Quadrant, Row, and Column coordinates, and returns a numpy array of wavelength values at each pixel on each detector. Note that these are 0-based indexing, so you must subtract 1 from the usual coordinates and NRS number.
  • The MSAConfig.wavelength_table property returns an astropy.table.QTable instance containing the wavelength ranges for each shutter on each detector.
  • The MSAConfig.write_wavelength_table() method writes the above table to an ascii file.
  • The MSAConfig.verify_wavelength() method accepts one or more target wavelengths, and returns a table of flags for each shutter indicating the location of the target wavelengths with respect to the detectors.
>>> msa = MSAConfig('f070lp', 'g140h', 'test/single_shutter.csv')
>>> wavelengths = msa.wavelength(0, 174, 15) # Quadrant 1, Column 175, Row 16
>>> wavelengths.shape
(2, 1, 2048)
>>> msa.write_wavelength_table('single_shutter_table.txt')
>>> table = msa.verify_wavelength([1.22, 1.84, -19, 1000], verbose=True)
Trimming target wavelengths outside the filter transmission range...
Target wavelength 1.22 micron:
 -> falls on NRS2 for 100.0% of shutters
>>> print(table)
Quadrant Column Row 1.220 micron
-------- ------ --- ------------
       1     35  30            2

If the full functionality of the MSAConfig class isn’t required, the calculate_wavelengths function accepts a config_file, filtname, and dispname, and returns the wavelength table as described above, and optionally writes the table to a given file.

>>> wavelength_table = calculate_wavelengths('msa_config1.csv', 'f170lp', 'g235m', outfile='msa_config1_f170lp_g235m_wave.txt')

Similarly, the check_wavelengths function accepts a list of target wavelengths, as well as a config_file, filtname, and dispname, and uses MSAConfig.verify_wavelength to return (and optionally write to a given file) a table of wavelength flags for each open shutter.

>>> flag_table = check_wavelengths([1.22, 1.84, -19, 1000], 'msa_config1.csv', 'f170lp', 'g235m', outfile='msa_config1_f170lp_g235m_flags.txt')

Finally, parse_msa_config is a utility function which parses an MSA config file and returns a dictionary of shutter coordinates and status. By default, only open and stuck-open shutters are included, and the status is a boolean value (True if the shutter is stuck-open, False if it is simply open); however, by setting open_only=False, the function returns a dictionary of every shutter in the MSA, and the status is a single-character code (‘x’ is inactive, ‘s’ is stuck-open, ‘1’ is open, and ‘0’ is closed).

>>> for (q,i,j), stuck in parse_msa_config('msaviz/test/single_shutter.csv').items():
...     print('Q {}, I {}, J {} - {}'.format(q+1, i+1, j+1, stuck))
...
Q 3, I 240, J 61 - True
Q 1, I 177, J 121 - True
Q 1, I 35, J 30 - False
Q 3, I 328, J 132 - True
Q 2, I 244, J 46 - True
Q 1, I 176, J 121 - True
Q 2, I 53, J 43 - True
Q 3, I 242, J 69 - True
Q 3, I 44, J 155 - True
Q 2, I 196, J 50 - True
Q 2, I 27, J 94 - True
Q 3, I 331, J 104 - True
Q 3, I 144, J 42 - True
Q 1, I 105, J 169 - True
Q 1, I 104, J 169 - True
Q 1, I 175, J 121 - True
Q 1, I 38, J 25 - True
Q 2, I 235, J 40 - True
Q 2, I 321, J 117 - True
Q 2, I 26, J 94 - True
Q 3, I 307, J 139 - True
Q 3, I 330, J 35 - True
Q 4, I 351, J 156 - True
Release History

Release History

This version
History Node

1.0.3a2

History Node

1.0.3a1

History Node

1.0.2a4

History Node

1.0.2a3

History Node

1.0.2a2

History Node

1.0.2a1

History Node

1.0.1a14

History Node

1.0.1a13

History Node

1.0.1a12

History Node

1.0.1a11

History Node

1.0.1a10

History Node

1.0.1a9

History Node

1.0.1a8

History Node

1.0.1a7

History Node

1.0.1a6

History Node

1.0.1a5

History Node

1.0.1a4

History Node

1.0.1a3

History Node

1.0.1a2

History Node

1.0.1a1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
msaviz-1.0.3a2-py2.py3-none-any.whl (10.5 MB) Copy SHA256 Checksum SHA256 py2.py3 Wheel May 25, 2017
msaviz-1.0.3a2.tar.gz (10.3 MB) Copy SHA256 Checksum SHA256 Source May 25, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting