The FIMS Tool

What is FIMS?
Important Note concerning Releases
Supported Platforms
Downloading and installing FIMS
How to Use FIMS
Problem and Bug Reports

What is FIMS?

The FORS Instrumental Mask Simulator (FIMS) is a SkyCat plugin to specify the FORS instrumental setup (e.g. the 19 slit positions in MOS) during Phase II Proposal Preparation. FIMS creates and manages the instrumental setup by Target Setup Files (TSFs). These TSFs can be loaded by the P2PP tool to become part of an Observation Block (OB) for FORS. For further information, see the FIMS User Manual.

Important Note concerning Releases

The latest public release of FIMS is labeled P81, and corresponds to version 2.52 of the tool. This version can be used for Period 81 Observing Programmes (see below). It has solved several bugs discovered in P80 version of the tool. Therefore, for the users of Period 80 Observing Programmes:
- for visitor mode runs the current version 2.52 is preferred.
- for service mode runs, please contact usd-help@eso.org.
The information on the previous version of the tool is available.

FIMS is released as a tarball which also includes the appropriate SkyCat version (2.7.3) and an additional plugin for making ESO-compliant finding charts.

Supported Platforms

The latest version of the FORS Instrumental Mask Simulator (FIMS) is available for Linux platforms only. If you do not have access to a PC or workstation running this operating system, please contact the USD for assistance.

Downloading and installing FIMS

NOTE: Version "P81" can be used for FORS1 and FORS2 observing runs of Period 81.

Installation kit

Version "P81" (FIMS 2.52):
```
fims-P81-Linux.tar.gz
```

Installing FIMS

Once you have downloaded the FIMS tarball, Unpack it by executing:

gunzip -c fims-<version>.tar.gz | tar xvf -

This will create a directory called fims-<version>.

You may now remove the gzipped tar file:
rm fims-<version>.tar.gz
Execute the command sequence:

cd fims-<version>
./fims_install.sh

Follow the instructions on the screen. The installation script will first ask you where you want to install the FIMS tool. The default directory is the one created when you unpacked the tarball, but you can specify any other directory provided you have write access to it.. The script will complain if this condition is not met.
It will then try to guess where the Perl interpreter is located on your machine, so as to adapt two auxiliary scripts to your local configuration. If it doesn't find the perl executable in your path, the script will offer you to provide this information by hand. However, the script language Perl is not mandatory for FIMS. The two scripts are only to create Postscript files from a MXU setup of FORS2. You can thus choose to skip this step if you do not need this functionality.

The script will then proceed with the installation of the tool. At the end of the installation, the full path to the startup script needed to launch FIMS (fims.sh) is displayed. Depending on your preferences, you may want to create an alias to this script, or add the directory in which it is contained (i.e. <fims-install-directory>/bin) to your PATH variable.

Environment variables for FIMS

FIMS uses a number of environment variables, and provides defaults. They are all defined in the startup script <fims-install-directory>/bin/fims.sh Only FC_DIR can be overwritten by the setenv (or export in bash and ksh) command. All other variables are hardcoded in the <fims-install-directory>/bin/fims.sh startup script. Running this script for the first time will create the directory INS_USER and its subdirectories, LOG_DIR, SET_DIR, and PREP_DIR with the defaults given below, if these do not exist already.

FIMSROOT: points to the FIMS installation directory
INS_ROOT (default is $HOME): this is the root directory for all FIMS output
INS_USER (default is .fims): this is the project (user)-related subdirectory
LOG_DIR (default is $INS_ROOT/$INS_USER/LOG): the directory where FIMS writes the log-file and the control file for automatic positioning
SET_DIR (default is $INS_ROOT/$INS_USER/SET): the directory where FIMS writes the acquisition files. This path variable can be redefined during a fims session [SetUpDir].
PREP_DIR (default is $INS_ROOT/$INS_USER/PREP): the initial directory to select FITS files to be loaded by SkyCat. The initial directory to select local catalogs be loaded by SkyCat.
FC_DIR (default is the directory from which SKYCAT was started): the directory in which the finding chart tool saves the jpeg files. This variable is not mandatory.

How to Use FIMS

User Manual

The use of FIMS is described in the FIMS User Manual. It is indispensable for you to read this document, particularly if you are not familiar with the tool yet.

Quick start

FIMS can be started with fims.sh [instrument number] [skycat options] [DEBUG]

instrument number is one digit and controls the menu bar.

skycat option is a list of SkyCat command line options embedded in a pair of ""-characters
DEBUG is an optional flag to print all environment variables of fims.sh This flag is only suitable in case of installation errors.

Examples are (for user smith):

fims.sh 1 (for FORS1 only)
fims.sh 2 (for FORS2 only)
fims.sh 2 "-float_panel 1 -file /home/smith/.fims/PREP/test.fits -cat /home/smith/.fims/PREP/objects.ptl" DEBUG
Starts FIMS for FORS2 and specify the command line options for SkyCat. (Here SkyCat loads a fits image and a target catalog). Don't forget to use the double quotes. Additionally all environment variables are shown.

When "fims.sh 1" is used, the following output will appear :


Calling FIMS for FORS1...

Remember to copy any MXU technical masks to /home/smith/.fims/SET



  W E L C O M E     T O     F I M S
 -----------------------------------

 +----------------+                +------------------+
 | FIMS      2.52 |----plugin----> | SkyCatTool 2.7.3 |
 +----------------+                +------------------+

 +------------------------------------------+
 | last checkin : 2007/12/04 GD 15:27:25 UT | INPUT : /home/smith/.fims/PREP
 | now is       : 2007/12/18 GD 17:33:26 UT | OUTPUT: /home/smith/.fims/SET
 | FIMS requires: SkyCat 2.7.3              | LOGS  : /home/smith/.fims/LOG
 +------------------------------------------+


skycat -with_grid 1 -scrollbars 1 -rtd 0  ...
Loading the graphics features plugin...
Loading the FIMS plugin...for FORS1

A FITS image taken with FORS2 (tar.gz file; 5.0 Mbytes) is available for practising with FIMS.

Verification of FIMS

Verify the SkyCat version: Press [Help] [About SkyCat]. SkyCat version number must be 2.7.3
Verify the FIMS version: Press [Help] [About FIMS]. FIMS Version number must be 2.52 (version P81).
If not done so far, load a FITS image with World Coordinates, e.g. with [Data-Servers] [Image Servers] [DSS] and a image size of 7 arcmin.
With FIMS started for the FORS2 instrument, press [FORS2] [Enter Mode] [MOS] to create the FORS mask for MultiObjectSpectroscopy.


NEW MODE -->SkyCat V2.7.3 -->  FIMS V2.52 2007/12/04 15:27:25 for FORS2
FORS2 at UT1
Executing load_instrument ...
load FORS2.isf
executing load_gris_filt_disp ...
20 gris-filt combinations read from  FORS2.isf

line_org =>CCD.SLAVE_XSR.RANGE       "-135.2777 135.2777"      <
line_org =>CCD.MASTER_XSR.RANGE      "-135.2777 135.2777"  <
line_org =>CCD.SLAVE_YSR.RANGE       "17.6957  152.9573"      <
line_org =>CCD.MASTER_YSR.RANGE      "-120.0196 14.796" <
line_org =>CCD.SLAVE_XHR.RANGE       "-67.5840 67.5840"      <
line_org =>CCD.MASTER_XHR.RANGE      "-67.5840 67.5840"  <
line_org =>CCD.SLAVE_YHR.RANGE       "9.062 76.646"      <
line_org =>CCD.MASTER_YHR.RANGE      "-60.282 7.302"  <
line_org =>FIELDXRANGE.VALUE           "-109.609 106.279";<
line_org =>FIELDYRANGE.VALUE           "-108.512 107.165";<
modus: mos with mask mos
label: 0
BPM: 0
width: 1.0
length: real
lslit: 0.5
filter:         none 20  2 >> OS filter found ok
INS_DISP: 5.00
FOCSCALE: 1.901679
PIX 0.030
CCDscale_standard 0.250124
CCDscale_highres 0.1250626
FORS2 CCD Frame
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0 none none
 >>DISP  50.0 A/mmCD   1.2 A/pix   6.0  12.0 A/''   3.2   6.3 A/mmfc
 >>BLU    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>RED    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>USD    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>SPE    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>Field Stop total range = 2518.5 A (SR) = 2433.8 A (HR)
 >>CCD total range = 3085.5 A (SR) = 3083.0 A (HR)

WAVE CONFIG MASK
Ok     : Filter does match Grism
grism :         none 20  2
INS_DISP: 5.00
FOCSCALE: 1.901679
PIX 0.030
CCDscale_standard 0.250124
CCDscale_highres 0.1250626
FORS2 CCD Frame
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0 none none
 >>DISP  50.0 A/mmCD   1.2 A/pix   6.0  12.0 A/''   3.2   6.3 A/mmfc
 >>BLU    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>RED    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>USD    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>SPE    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>Field Stop total range = 2518.5 A (SR) = 2433.8 A (HR)
 >>CCD total range = 3085.5 A (SR) = 3083.0 A (HR)

WAVE CONFIG MASK
colli: COLL_SR+6
WCS: world_x = 16.19494   world_y = 2.10911
FORS2 at UT1
NOMI SCALE : 0.250124''/p = 6.947889e-05 o/p  0.125063''/p = 3.473961e-05 o/p  1.901679''/mm ff
Init_Mask_World: canvscale=1  wx=4.6000385522809E+01 wy=-3.4559520317583E+01 trigo=1.2142713399250871
Init_Mask_World: focscale=1.901679 scal=0.00052824417089262002  arc_to_deg=2.7777778E-4
world2: BONSAI OFF
p1x: 4.6000385522809E+01
p2y: -34.500470542939766
ccdm1x: 4.6000385522809E+01
ccdm1y: -34.622919971675863
ccds1x: 4.6000385522809E+01
ccds1y: -34.622919971675863
EDIT_REF_TARG...
EDIT_REF_TARG...
Ok     : Filter does match Grism
grism :         none 20  2                     
INS_DISP: 5.00
FOCSCALE: 1.901679
PIX 0.030
CCDscale_standard 0.250124
CCDscale_highres 0.1250626
FORS CCD Frame
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0 none none
 >>DISP  50.0 A/mmCD   1.5 A/pix   6.0  12.0 A/''   3.2   6.3 A/mmfc
 >>BLU    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>RED    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>USD    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>SPE    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>Field Stop total range = 2518.5 A (SR) = 2433.8 A (HR)
 >>CCD total range = 3085.5 A (SR) = 3083.0 A (HR)

WAVE CONFIG MASK
INS_DISP: 5.00
FOCSCALE: 1.901679
PIX 0.030
CCDscale_standard 0.250124
CCDscale_highres 0.1250626
FORS CCD Frame
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0
 >> 500.0 < 500.0 < 500.0 < 500.0 < 500.0 none none
 >>DISP  50.0 A/mmCD   1.5 A/pix   6.0  12.0 A/''   3.2   6.3 A/mmfc
 >>BLU    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>RED    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>USD    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>SPE    0.0 A =    0.0 pixel =    0.0 '' =  0.000 ' =     0.000 mm(fp)
 >>Field Stop total range = 2518.5 A (SR) = 2433.8 A (HR)
 >>CCD total range = 3085.5 A (SR) = 3083.0 A (HR)

EDIT_REF_TARG...
mask initialized

Problem and Bug Reports

Please report all FIMS problems and bugs to the ESO User Support Department (USD).

WCS keywords in wide field mosaics

At present FIMS does not support WCSs where the CRPIXn keyword value is outside the range 0 < CRPIXn <= NAXISn (ie. outside of the field of view). This is ONLY important for you if you, instead of having obtained new pre-imaging with FORS, are going to use a sub-image extracted from a large field, for instance from a mosaic or from wide field imaging.

This means that despite the fact that the global image may have correctly set WCS, if the mosaic is split and only part of it used for mask preparation with FIMS the error message "Error: out of coordinate range" will appear if that part of the mosaic does not contain the reference pixel of the center (CRPIX1 and CRPIX2 keywords).

Pre-images taken with FORS1/2 with PA=+/-180 degrees

In case of pre-imaging taken with FORS1/FORS2 with position angle PA=+/-180 degrees, the mask created by FIMS may be wrong. Therefore we strongly discourage the use of PA=+/-180 deg for pre-imaging. If you already have images taken with FORS at this position angle and need to use them to prepare the masks with FIMS, please contact usd-help@eso.org.

Right handed WCS (North up, East to the right)

FIMS does not treat properly the images taken with other telescopes/instruments if they have WCS oriented with North up and East to the right. In order to prepare a correct FIMS setup files a possible work-around is to edit the WCS,and therefore modify the image so that it has the "standard" orientation with North up and East to the left. This should be done with care in case of significant distortions in the images. If unsure of the distortions, it is better to take the new pre-images with FORS1/2.