JWST user documentation is under development; current versions are preliminary and subject to revision.

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id277319515
Content Column
id277319517
Content Block
overflowauto
nameSummary
id277319516

The JWST NIRSpec MPT Manual Planner is designed to help the user manually create new plans and modify existing plans.

Content Block
overflowauto
nameContent
id277805920

Introduction

The MPT Planner is designed to automatically create optimal plans, but it is also possible for the user to create plans manually. Checking the Manual Planning box at the top of the Planner tab puts the planner into the manual planning view.  Figure 1 shows MPT in the Manual Planning view.

Figure container
Figure caption

Figure 1. MPT Manual Planner

 


The Manual Planning template  has four sections that we discuss in detail below.

 


Anchor
section1
section1
MPT Section 1. Planning angles

Multiexcerpt include
MultiExcerptNameAPA
PageWithExcerptNIRSpec MPT: Planner


Anchor
section2
section2
MPT Section 2. Primary candidate list  

The list of Primary Candidates is a catalog or candidate set that should be defined in the NIRSpec MPT: Catalogs pane. In Manual Planning mode, select the appropriate list from the pull down menu.


Anchor
section3
section3
MPT Section 3. Exposure setup  

In section 3 the observer defines the exposure specification. In the table in this section, each new exposure specification results in one or more new exposures.  The number of new exposures is determined by the dither pattern specified. Click the ADD button to add a new exposure.

The Exposure Time Calculator (ETC) should be used to determine the best exposure parameters to optimize the signal-to-noise of your observation. An exposure is configured by setting the Grating/Filter combination, Readout Pattern,  Number of Groups, and Number of Integrations.  

Info

Users should ultimately use the Exposure Time Calculator for all sensitivity calculations.

The exposure parameters that the observer needs to define are listed in Table 1.

Table 1: Description of Science Parameters for a given exposure

Multiexcerpt include
MultiExcerptNameExposure Setup
PageWithExcerptNIRSpec MPT: Planner

Exposures may be reorganized and removed if necessary, using the Duplicate, Insert Above, and Delete buttons.


Anchor
section4
section4
MPT Section 4. Pointing/Config setup  

Pointings and configurations

NIRSpec MSA configurations are described by a configuration file.  Those configurations are created by APT when the MPT is used.  It is possible to save a configuration off-line by exporting it from APT. An edited configuration file may also be imported into APT. The only format supported for importing or exporting an MSA configuration file is comma-separated values (.csv).

Warning

Note that it is possible to create then upload your own MSA configuration in the .csv file. Keep in mind that if a configuration file is created or edited outside of the MPT, geometric distortions will not be accounted for.  Doing this is only advised for science sources that are spatially extended where spectra will not be adversely impacted by distortion.

Click 'Add', 'Duplicate', 'Insert Above', and/or 'Delete' to create the configurations you want. By double clicking on a row, a window will pop open. This is the manual editor.

Manually editing a configuration

When the manual editor is open, the shutter view is presented with the sources from the Primary List over-plotted, as shown in Figure 3.

 

Figure container
Figure title

Figure 3. Manual editor

 

The configuration of shutters is shown for the four MSA quadrants, using the color convention introduced in NIRSpec MPT: Plans. Here it is possible to zoom in and out to the shutter level. Zooming is accomplished by clicking the right mouse button and dragging up and down.  This is usually enabled on a trackpad by depressing two fingers at once and dragging in an upward or downward motion.  Hovering the mouse over a single micro-shutter, provides its identifier and state (open, closed, stuck_closed, etc). 

Individual available shutters may be opened/closed with a "Left Click" on the mouse. Use "Ctr+Left Click" to open/close rows. Also available are  the "Open all" or "Close all" buttons. The idea is to open shutters that correspond to sources of interest, as shown in Figure 4.

Figure container
Figure title

Figure 4. Manually editing the configuration file

Figure caption

Detail of the editing process using the manual editor. In this example, six shutters have been opened manually (shown in yellow) creating slitlets around two sources. Note that the rows corresponding to those shutters will change from white to orange to signify that they are now taken and cannot be used for other sources.

Once a configuration is complete, it is possible to save it using the "Export to CSV" button. This produces an ASCII file of comma-separated values that can be shared and read in APT. The exported CSV file has values of 0, 1, s, or x for each commanded open, commanded closed, failed open, or failed closed shutter, respectively. Additionally, an image of the configuration can be saved in SVG format.

Three tabs are located at the bottom of the window: 'Collapsed', Pointing', and 'Parameters'.

The 'Collapsed' view (Figure 5) shows  each target's position in its own shutter, all plotted together in a single virtual shutter.

Figure container
Figure title

Figure 5. Collapsed Tab

Figure caption

Detail of the Manual Planner view. The Collapsed tab shows the distribution of sources in a single virtual shutter.

Under the 'Pointing' tab (Figure 6) it is possible to give a name to the configuration, and specify appropriate pointing equatorial coordinates. If the pointing is not already populated, it is mandatory to add appropriate RA and Dec values. 
Figure container
Figure title

Figure 6. Pointing Tab

Figure caption

Detail of the Manual Planner view. The Pointing tab allows the user to input the equatorial coordinates (RA, Dec) and select a name for the configuration.

Under the 'Parameters' tab, it is currently required that a Candidate set be selected, even for plans generated with the Manual Planner. This implies that a catalog is required as well. In a future version of MPT, it will no longer be required for manual planning.  To further ensure that the standard calibration pipeline will not fail,  there must be targets in planned slits. Figure 7 shows a detail of the Parameters tab design.
Figure container
Figure title

Figure 7. Parameters Tab

Figure caption

Detail of the Manual Planner view. In the Parameters tab users input the list of sources from the Catalogs list.

Confirm this new configuration by clicking on the OK button.

 


Generating a plan

Under Plan Name, assign a name to this manual plan and click on Finish Plan. This will process and generate the plan and direct the user to the Plans tab, where it is possible to assess the quality of the plan.

 


 

Comment

 

Saving a Configuration File

  • Go to the Plans tab, select a single plan, and then select an individual exposure (such as "c0e0").

  • Select Show to display the MSA shutter view for that exposure.

  • From the pop-up window, select Export to CSV.

Note that this is done one exposure at a time.  The exported csv file has values of 10, or x for each open, failed open (add link to hardware page), or closed shutter, respectively.

Importing a saved or edited configuration file

  • Under Pointings and Configs select Add.
  • Double-click the new line just added to bring up a pop-up window for the manual planner.
  • Provide a name for the new configuration.
  • Manually open or close shutters.  Note that MSA rows are colored to indicate which have been used for sources.  Red indicates Failed-Open shutters.
  • Specify the pointing in the Pointing tab of the pop-up window.
  • Choose the primary candidate list, grating/filter, and whether the configuration is a master backroung in the Parameters tab.
  • Save this new configuration by selecting OK.
  • Select Finish Plan to make a plan using this configuration.
  • Select Create Observation to make an observation that uses the new plan. Link to plans tab instead


Starting a new MSA configuration from the Manual Planner

 

  • In the Planner pane, start the Manual Planner.

  • In the Pointings and Configs area select Add.  This adds a new entry to the table.

  • Double-click the new line just created; the Manual Planner pop-up window will appear.
  • Select Import CSV and then the file. Give the new configuration a name.
  • Shutters may be opened or closed one by one in the MSA shutter view.  Note that MSA rows are colored to indicate which have been used for sources.  Red indicates Failed-Open shutters.
  • Specify the pointing in the Pointing tab of the pop-up window.
  • Choose the primary candidate list, grating/filter, and whether the configuration is a master backroung in the Parameters tab.
  • Save this new configuration by selecting OK.
  • Select Finish Plan to make a plan using this configuration.
  • Select Create Observation to make an observation that uses the new plan. Link to plans tab instead



Content Block
overflowauto
nameRelated links
id280628021

Related links

JWST User Documentation Home

Content Block
overflowauto
nameReferences
id281944791

References

Karakla, D. et al. 2014, Proc. SPIE 9149
The NIRSpec MSA Planning Tool for multi-object spectroscopy with JWST

JWST technical documents

Content Column
id277319512
Content Block
overflowauto
nameIcon
id278719485

Multiexcerpt include
MultiExcerptNameAPT icon and name
PageWithExcerptMR:APT icon and name

Content Block
overflowauto
nameUpdates
id1066359141
HTML Wrap
padding0
margin0
idupdatesbox
HTML Wrap
tagspan
classupdatesbox-heading

Last updated

Updated July 26, 2017

  • Modified warning in MPT Section 4: Pointing/config setup


Published June 12, 2017


Comment
The format for 'Last updated' is shown below. Enter updates above this internal"Comment" box. Only enter major updates (not typos or formatting changes).


Updated April 5, 2017

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. 
  • Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. 

Published March 2, 2017


Restrict Content
groupsconfluence-authors

Tables are only visible to JDox content providers

"Updated" refers to the updated or publish dates for the public pages.

Page properties
idcomments
UpdatedJuly 26, 2017
Open commentsYes
TeamAPT NIRSpec
AuthorBeck, Ubeda, Wisklowski
Page properties
idlayout
UpdatedJuly 26, 2017
Fix pageNo
Type-
Teameditors