EIS Mapper Software

"EIS mapper" is a way of displaying the location of EIS rasters by over-plotting them on a full disk image (typically an EUV image from AIA or EIT). By doing this for every day of the mission one can fairly quickly identify useful data-sets based on the feature they were pointed at (e.g., active regions, coronal holes, etc.), by simply clicking through the images one-by-one.

Please visit the EIS Mapper webpage (https://eismapper.pyoung.org) to see the output from the software below.

Ken Dere originally presented the EIS data in this way, and referred to it as "EIS mapper". His website is no longer available, however, so the present webpage describes IDL software that produces webpages in a similar style.

Step 0: Getting started

All software is written in IDL and is available in the Hinode/EIS branch of Solarsoft.

First, create a directory in which you want to store the EIS Mapper data, and then point to it with the environment variable $EIS_MAPPER. For example, if you want to use the directory $HOME/my_eis_mapper, then put the following line in your IDL Startup file:


Step 1: Preparing EIS data

The first step in the process is to create save files containing information about the EIS observations. This is done for individual years with, e.g.:

IDL> eis_mapper_obs_str, year=2011

The save files go to $EIS_MAPPER/data, with a separate file for each month. In each save file is a structure that has been created with the routine eis_obs_structure.

Step 2: Calendar files

To create a html page containing a calendar listing all the days for which maps are available, do:

IDL> eis_mapper_year, 2011

which creates the file $EIS_MAPPER/html/2011/index.html. If a day in the calendar has a link, then it means a map page is available.

To process all years of the EIS mission, repeat the above call for all years from 2006 onwards. 

WARNING: this step can take quite a long time. Typically an hour.

Step 3: Create index file

After you have run eis_mapper_year for all years of the mission you can create an index file with a list of all the years for which there are data:

IDL> eis_mapper_year_index

This creates the file $EIS_MAPPER/html/index.html.

The EIS obs structure

The routine eis_obs_structure is a convenient way of quickly querying the EIS databases from the IDL command line and returning the results in an IDL structure. Some information about it is given in Section 4 of EIS Software Note No. 19. The routine eis_mapper_obs_str that is run in Step 1 calls eis_obs_structure, and any of the eis_obs_structure keywords can be passed to eis_mapper_obs_str.


The above procedure will show you the results for the entire EIS database. It is possible to show results for a subset of the database by modifying the EIS data that is saved in Step 1. Two examples are illustrated below.

Only show the results for a single EIS study

Suppose you only want to show the results for the study "Atlas_60" (a spectral atlas study that is run regularly). You can search on a  study acronym with eis_obs_structure, but it's much quicker to search on the raster acronym. To find the latter, start the GUI routine eis_xstudy:

IDL> eis_xstudy

Search for your study and click on it. The raster window at the bottom of the window now shows information about the raster, including the acronym (in this case it is also "Atlas_60"). You can now do:

IDL> eis_mapper_obs_str, year=2011, rast_acr='atlas_60', outdir='~/eis_mapper_atlas_60'

Note that I set an output directory so that the results don't overwrite the standard EIS mapper results.

With the new observation structure save files, you can perform Step 2, adding the outdir optional input:

IDL> eis_mapper_year, 2011, outdir='~/eis_mapper_atlas_60'

NOTE: if you use rast_acr='atlas' (for example) then the routine will pick all rasters that have atlas in their name.

Require specific wavelengths to be observed

You may be interested in a specific emission line or plasma diagnostic and would like to display only those rasters that contain these lines.An example is the Fe XIII 202.04/203.82 density diagnostic.

First create a directory where the mapper files will go. For example, '~/eis_mapper_fe13'.

Now do:

IDL> obs_all=eis_obs_structure('1-jan-2011','1-jan-2012')
IDL> obs=eis_filter_obs_struc(obs_all,wvl=[202.04,203.82])
IDL> save,file='~/eis_mapper_fe13/data/obs_str_2011.save',obs

With the observation structure saved you can now create the html files with

IDL> eis_mapper_year, 2011, outdir='~/eis_mapper_fe13'

Spectral atlas observations

Spectral atlas observations take the complete wavelength range of EIS, and thus offer the full range of spectral diagnostics. The commands below show how to restrict the EIS mapper output to only spectral atlas observations for 2013:

IDL> eis_mapper_obs_str,year=2013,outdir='~/eis_mapper_atlas',/atlas
IDL> eis_mapper_year, 2013,outdir='~/eis_mapper_atlas'

Other options

Other options for eis_filter_obs_struc include xcen, ycen and fovx. For example:

IDL> obs=eis_filter_obs_struc(obs_all,xcen=[-200,200],fovx=100)

will select only rasters that are within +/- 200 arcsec of the central meridian, and have a field-of-view in the X-direction of at least 100 arcsec.

You can also select on the EIS slit. So, /narrow will select only rasters that use either the 1" or 2" slit, while /slot will select only rasters that use the 40" or 266" slits. To choose a specific slit, use the slit_index input: 0 corresponds to the 1" slit, 1 to the 266" slit, 2 to the 2" slit and 3 to the 40" slit.

Page maintained by Dr Peter R Young.