Äîêóìåíò âçÿò èç êýøà ïîèñêîâîé ìàøèíû. Àäðåñ îðèãèíàëüíîãî äîêóìåíòà : http://xmm.vilspa.esa.es/scisim/release/latest/help/postscript/esim.ps Äàòà èçìåíåíèÿ: Wed Jan 30 17:21:24 2008 Äàòà èíäåêñèðîâàíèÿ: Sun Apr 13 06:06:49 2008 Êîäèðîâêà: Ïîèñêîâûå ñëîâà: trees

EPIC/RFC Camera Simulator (ESIM/RFCSIM) 4.0
Jorgo Bakker and Lalit Jalota
January 30, 2008
This is a paper version of the ESIM(RFCSIM) help. If possible, refer to the HTML version, which con­
tains images and hypertext links.
ESIM(RFCSIM) is a simulator for the EPIC instrument and the camera of the RGS instrument. It
forms part of the XMM­Newton Science Simulator SciSim.
This document contains information specific to ESIM and RFCSIM only; for generic information about
SciSim, see the SciSim User Guide.
Note that ESIM and RFCSIM simulate the EPIC cameras and RGS focal plane camera (RFC), though
they are executed by esim and rfcsim respectively. The User has to keep in mind that they are just two
instances of the same executable.
1

XMM­Newton Science Simulator Page: 2
Contents
1 Documentation 5
2 Overview of ESIM 6
2.1 Features simulated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 Usage 7
3.1 SciSim GUI usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Command line usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4 Configuring the simulation 9
4.1 EPIC/RFC GUI usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1.1 Observation tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1.2 Simulation tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.2.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5 Lay­out of the cameras 20
5.1 EPIC MOS camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.2 EPIC PN camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.3 RGA focal camera (RFC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.4 Pixel lay­out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6 Data files explained 24
6.1 Clocking of CCDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.1.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.1.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.1.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

XMM­Newton Science Simulator Page: 3
6.2 Pixel surfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.2.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.2.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.2.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.3 Doping profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.3.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.3.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.3.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.4 Cloud charge modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.4.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.4.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.4.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
6.5 Pattern library (EPIC­MOS only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.5.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.5.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.5.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.6 Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.6.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.6.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
6.6.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.7 RFC On­Board Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.7.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.7.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.7.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.8 Filters in the filter wheel (EPIC only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.8.1 Keywords tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.8.2 Keywords description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.8.3 Keywords example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

XMM­Newton Science Simulator Page: 4
7 Output using esim reporter 48
8 Acknowledgments 48

XMM­Newton Science Simulator Page: 5
1 Documentation
Gordon R. Hopkinson, Analytic modeling of charge di#usion in charge­coupled­device imagers, Optical
Engineering, August 1987, Vol.(26), No. 8,766­772
David H. Lumb, X­ray measurements of charge di#usion e#ects in EEV Ltd. charge­coupled devices,
Optical Engineering, August 1987, Vol.(26), No. 8,773­778
James Janesick et al, SPIE, X­Ray Instrumentation in Astronomy, 1985, Vol.(597),364­380
H. Soltau et al, Performance of the pn­CCD X­ray detector system designed for the XMM satellite mis­
sion, Nuclear Instruments and Methods in Physics Research A, 1996, Vol.(377),340­
345
R. Hartmann et al, Low energy response of silicon pn­junction detector, Nuclear Instruments and
Methods in Physics Research A, 1996, Vol.(377),191­196
N.Meidinger et al, PN­CCD detector for the European Photon Imaging Camera on XMM
Christian Erd,Rudi Much, David Lumb, Description of the Basic Modes of the Experiments on Board
the XMM Observatory, XMM­PS­GM­01 Issue 3, April 1997
X­Ray Astronomy Group,Leicester Unversity; CEN, Saclay, EPIC MOS EOBB Final Report, May 1994
J.H. Coppoolse, Internal Report, 1991

XMM­Newton Science Simulator Page: 6
2 Overview of ESIM
ESIM is a ray analyser that simulates the X­ray response of the cameras of the XMM­Newton.
ESIM reads rays, traces them through the camera, and filter wheel in the case of EPIC. The resulting
interaction within a CCD of the camera is then converted into frame responses of the camera. It is
implemented as a single executable that acts as an analyzer of rays.
The camera model consists of an optional filter wheel and a group of CCDs that make up the camera
itself.
A CCD is thought of as a collection of both sensitive and insensitive layers of materials. The insensi­
tive layers are dead layers such as surface channels or back­layers, while sensitive layers are the wafer
(substrate) and the layers grown on top of the wafer (epi­layer). X­rays absorbed in these layers create
electron­hole pairs of which the cloud of electrons is traced through these layers to the collection zone
due to electric fields and/or di#usion. During this propagation losses may occur, measured by the Charge
Collection Ine#ciency (CCI).
Surface channels (regions of high doping) split the collection zone into columns. Fixed gate voltages
applied during the integration of the image split those columns into region called pixels. These pixels
make an image.
When the image is read­out clocking schemes of voltages cause the pixel contents to move towards a
storage section or directly towards the read­out register, where they are read out through the read­out
nodes.
During clocking again losses may occur (Charge Transfer Ine#ciency -- CTI). When all pixels are read­out
the contents of the image can be analysed for event­patterns. The resulting information is grouped into
a frame output.
The camera model is hierarchically configurable; each advancement of settings require to go one level
deeper in the configuration.
The software makes use of a uniform interface to pass ray information between various programs. This
means that the output of MSIM , RSIM or GSIM can be used as input for ESIM. The output of ESIM
in turn can be read by the ODF converters as well as some of the SciSim Tools.
A tool ­esim reporter­ is provided as is. It converts ESIM output into tabular ASCII format.
2.1 Features simulated
ESIM models the following features:
. Camera (mis­)alignment;
. CCD (mis­)alignment;
. Filter transmission, including pinholes (applicable to EPIC);
. Stacked surface (dead layers) of materials that either make up the gates (front illumination)
or the back­layers (back illumination) of the CCDs of a camera;

XMM­Newton Science Simulator Page: 7
. Charge Collection E#ciency (CCE) in sensitive layers (e.g. field free regions,high doping
implants or surface losses);
. Photon shot noise;
. Absorption depth;
. Depletion depth due to doping profiles, temperature and voltages applied;
. Frame timing due to clocking schemes;
. Sequential read­out of CCDs;
. Image dark noise and amplifier characteristics of multiple read­out nodes of a CCD;
. Charge Transfer E#ciency;
. Frame read­out e#ects like smearing of pixels;
. Event reconstruction.
3 Usage
The basic functionality of ESIM is to convert X­rays into CCD output. The X­rays are passed to
ESIM as a ray stream, that is typically generated by GSIM (the ray generator of SciSim) and filtered
by MSIM(the Mirror Module simulator) and RSIM (the Reflection Grating Spectrometer simulator).
ESIM can be used in two ways: either from the SciSim graphical user interface (GUI) or from the
command line. The output file can be processed by ODF convertersor by some SciSim Tools.
ESIM is configured by the esim config or rfcsim config sections of the SciSim configuration files.
Which files are scanned for this section is described in the SciSim top level documentation. With the ­c
option an explicit file to be used can be specified.
The GUI can be considered as an editor of this configuration. All parameters that are accessible from
the GUI can also be changed on the command line with the --keyword value option, e.g.
esim ­mode full.
Some parameters will be selected most frequently: camera, mode, filter and the simulation options.
The keyword --camera selects the camera that is currently in use, whereas --mode describes the scientific
mode of the camera (e.g. full image, windowing, fast, etc.). Keyword --filter selects the type of filter
(open,thin,thick, etc..). Finally keyword --option contains various ways to modify the state of simulation
(pattern matching, dark noise, etc..).
Other parameters are best manipulated by editing the
scisim.cfg (see section configuration file).
3.1 SciSim GUI usage
To use ESIM from within the SciSim GUI, start SciSim (see SciSimdocumentation).
First set up a source configuration. Then select RayGen, Mirror, RGA and RFC and/or EPIC
(latter two are instances of ESIM); click on the Run button.
The output of ESIM is written to a file. This file can be analyzed with some of the SciSim Tools or the
ODF converters from the command line.
The simulation can be configured by clicking the camera icon with the right mouse button. This pops up
a configuration screen. The configuration options are described in section Configuring the simulation.

XMM­Newton Science Simulator Page: 8
3.2 Command line usage
To use ESIM from the command line, first generate an ESIM input file with the other simulators (see
the documentation of GSIM,MSIM and/or RSIM.)
Suppose that the input for ESIM is esim.in. ESIM is now run with:
esim < esim.in > esim.out
The generated file can be analyzed with the SciSim Tools, or used as input for the ODF converters.
ESIM can also be used in a pipe together with other simulators, e.g.
cat csim.out | gsim | msim | rsim | esim > esim.out
or
cat csim.out | gsim | msim | rsim | rfcsim > rfcsim.out
Configuring ESIM is done by editing the scisim.cfg, by adding command line options or by specify­
ing a customised configuration file with the ­c option (see the SciSim documentation). The available
configuration options are described in section configuration file.

XMM­Newton Science Simulator Page: 9
4 Configuring the simulation
This chapter describes how to configure the simulation of the RFC and EPIC cameras.
First the usage of the RFC and EPIC GUIs are described, followed by a listing of all keywords needed
to configure the instruments.
One can find the configuration in under the esim config and rfcsim config sections of the scisim.cfg.
4.1 EPIC/RFC GUI usage
The ESIM­GUI is an easy­to­use interface that allows the User to set some top­level simulation param­
eters. For advanced modifications one should access the ESIM/RFCSIM configuration of the scisim.cfg.
Information on how to start the simulator can be found in the top level documentation of SciSim.
The configuration is grouped under so­called ``Tabs''.
4.1.1 Observation tab
Camera One can select a camera out of the cameras defined in the ESIM/RFCSIM configuration.
If the User adds a new camera configuration within the ESIM/RFCSIM configuration section
of the scisim.cfg, it is accessible by the GUI.
Note: the ODF converters need some specifics camera names.
Filter The user may select a filter in the filter wheel in front of the camera (only EPIC).
Additional filters can be set­up by editing the filters within the ESIM/RFCSIM configuration
of the scisim.cfg.
Mode The mode parameter allows the user to specify in what mode the camera is operating. The mode
is dependent on the instrument; therefore this field is automatically updated, when the User
decides to change the Camera parameter.
Additional modes can be set­up by editing the modes of a camera within the ESIM/RFCSIM configuration
of the scisim.cfg.
Rotation see the SciSim User Guide for information about the Rotation settings.
Translation see the SciSim User Guide for information about the Translation settings.
4.1.2 Simulation tab
One can select certain simulation options under the Simulation tab. These options control the accuracy
of the simulation as well as the type of output (e.g. grading events).
The user can switch an option on or o# by pressing the radio­button to the left of the option.
Noise options Amplifier Noise Incorporate amplifier noise in calculations.
Dark noise Incorporate the image dark current in calculations.

XMM­Newton Science Simulator Page: 10
O#set Background Use first images to calculate the back­ground that must be subtracted
from the following images.
Features Analyse All Frames Analyse all frames irrespective their contents. When this option is
switched o#, the simulator skips image­frames that were never illuminated by rays, but
still might have some contents due to noise e#ects.
Event Reconstruction Apply reconstruction of an event according to camera dependent
algorithm.
This option only e#ects the RFC­ and MOS­type cameras.
Smearing Calculate the e#ects of rays hitting the image while it is being read­out. Due
to smearing, the photon might appear to be collected at a location di#erent from the
absorption location within the CCD.
4.2 Configuration file
This section describes the configuration settings.The configuration of the camera simulators allows the
user to modify the simulator's behavior to a great extent. One can reposition the camera, add new modes,
or even new cameras.
The default configuration of ESIM and RFCSIM can be found in the sections esim config and rfc­
sim config of the scisim.cfg.
4.2.1 Keywords tree
esim configuration section
camera
cameras
camera1
temperature
ccds
[ccd1]
id
nodes
[node1], ..., [nodeN]
parameter
accept treshold, background frames, dark current, doping, elevation, lower treshold,
pixelSurface, subtract level, temperature, upper treshold
:
[ccdN]
files
coordinates clock, doping, gradePatterns, materials, onBoardSrc sigmaScales, surface
global
cam type, columns, dead space, illumination, n ccds, n nodes, omega, pixel size, rows
modes
mode1
[modeCcd1], ..., [modeCcdN]
:
modeN
:
cameraN

XMM­Newton Science Simulator Page: 11
debug
filter
filters
filter1, ..., filterN
mode
option
amplifier noise, analyse all frames, dark noise, pattern match, smear e#ect, subtract background
timeProcess
4.2.2 Keywords description
accept treshold
description: NA
parent: parameter
range: ­1
amplifier noise
description: Apply amplifier noise
parent: option
range: 0 (o#) or 1 (on)
analyse all frames
description: Perform analysis on image frames that do not contain X­ray info
parent: option
range: 0 (o#) or 1 (on)
background frames
description: Number of first set of frames that are not used for analysis, but used for background
frame calculation instead.
parent: parameter
range: 0,1,2...
unit: frames
cam type
description: Camera type
parent: global
range: mos,rfc or pn
camera, definition of a ...
description: One can use,modify or create a camera configuration. The keywords in this object specify
the basics of the camera.
Note that almost all keywords are objects themselves.
MOS: If the selected camera name does not start with EMOS1 or EMOS2, the ODF
converters treat the simulator output as if coming from EMOS1.
RFC: If the selected camera name does not start with RGS1 or RGS2, the ODF
converters treat the simulator output as if coming from RGS1.
parent: cameras
childs: ccds, global, files, modes
camera, selection of a ...
description: Selection by name of one of the cameras in cameras.
range: one of the cameras in cameras
cameras
description: Contains a map of cameras. The user may add cameras, giving it a unique name. One
of the cameras is selected by camera

XMM­Newton Science Simulator Page: 12
childs: definitions of cameras
[ccd], definition of a ...
description: Contains basic items of a ccd. Note that it is not preceded by a name
parent: ccds
childs: id, nodes, parameter
range: 1,2,..,maximum ccds in camera
ccds
description: Contains a list of ccd configurations. The user may add/modify configurations, as long
as the ccds are specified in ascending order. The ccds that are not specified here, will
be assigned the configuration of a specified ccd, that has an id closest but smaller than
the unspecified ccd. If such a ccd is not specified, it will take the first ccd in the list.
parent: cameras
childs: ccds
clock
description: Name of file containing detailed clocking data of the ccds, such as row shift time. (See
Clocks)
parent: files
columns
description: Number of columns in the image section
parent: global
range: 600 (MOS), 64 (PN) or 1024 (RFC)
unit: pixel
coordinates
description: Name of the CCF LINCOORD FITS file. It contains all relevant information about the
CCD and Camera alignment.
parent: files
dark current
description: Noise imposed by dark current
parent: parameter
range: floating number >0
unit: electrons s­1
dark noise
description: Apply dark­current noise
parent: option
range: 0 (o#) or 1 (on)
dead space
description: OBSOLETE
parent: global
range: floating number #0
debug
description: A dump of the complete initialised camera into a file called esim debug. none skips the
dump, all will dump all information. When a file name is specified, only those items
will be dumped that are specified in this file
range: none,all or name of existing debug file
doping
description: Specifies the entry in the doping data file, that is used for doping data (see files).
parent: parameter
doping

XMM­Newton Science Simulator Page: 13
description: Name of file containing the doping profiles and cce­losses of the sensitive region of a pixel
(see Dopings)
parent: files
elevation
description: OBSOLETE
parent: global
range: Floating number.
files
description: Specifies the names of the data files needed by this specific camera. The contents of
those data files are described in Data files explained(Sec. 6).
parent: definition of a camera
childs: clock, doping, gradePatterns, materials, onBoardSrc sigmaScales, surface
filter
description: Selection by name of one of the filters in front of the camera. The filters are part of the
filter wheel.
filters
description: EPIC cameras may have a filter wheel in front of them. Such a filter wheel contains
several filters. These filters are specified here. The user can add new or modified
filters,giving it a unique name.
Selection of one of the filters is done by filter
childs: relation of filter names and corresponding file (see Setting up a filter).
global
description: Definition of global parameters of the camera. Note that these parameters apply to all
ccds
parent: definition of a camera
childs: cam type, columns, dead space, illumination, n ccds, n nodes, pixel size, rows, omega
gradePatterns
description: Name of file containing the library of MOS grading patterns (See MOS pattern library)
parent: files
range: fileName or none (latter for RFC and PN)
id
description: CCD identifier
parent: definition of a ccd
range: PN: 1,..,12
RFC: 1,..,9
MOS: 1,..,7
illumination
description: Specifies which side of the CCD is illuminated
parent: global
range: MOS:front; RFC/PN:back
lower treshold
description: Describes the lower threshold in terms of sigma of the total noise. Pixels with charge
less than the lower threshold are discarded.
parent: parameter
range: float number > 0
materials
description: Name of files containing material properties (See Materials)
parent: files
childs: list of material file names
range: at least a silicon file

XMM­Newton Science Simulator Page: 14
mode, definition of a camera ...
description: Allows the User to setup an operation mode of the camera. Such a definition contains a
list ccd modes. If a camera is read out sequentially, the order of the ccd modes in the
list is important.
parent: modes
childs: defined ccd modes
[mode], definition of a ccd ...
description: The mode of a ccd describes its operational status. Note that the items are not preceded
by keywords
parent: definition of a camera mode
childs: [id] [mo] [so] [wx] [wy] [dx] [dy] [bx] [by], where:
id ­ a ccd identifier; in the range 1,..,12 (PN)
1,..,7 (MOS)
1,..,9 (RFC).
mo ­ global operational mode; either prime or fast.
so ­ specific operational mode, value depending on cam type and mo: MOS/RFC/PN
fast ­;
MOS/RFC prime full or window;
PN prime full or large or small.
wx ­ lower left row of the window; in the range 0,..,rows­1 pixels.
wy ­ lower left columns of the window; in the range 0,..,columns­1 pixels.
dx ­ row width of the window; range as wx
dy ­ column width of the window; range as wy
bx ­ row binning within the window; in the range 1,..,rows pixels.
by ­ column binning within the window; in the range 1,..,columns pixels.
rn ­ selects the read­out nodes used to read out the image;
MOS/RFC: 0 (node 0), 1 (node 1) or 2 (both nodes)
in case of PN: 64
example: begin 1 prime window 150 150 300 300 1 1 0 default end
mode, selection of a camera ...
description: Selects the mode, the selected camera is running in.
range: Selection by name of one of the modes defined for the selected camera
modes
description: Contains a map of modes. The user may add a mode, giving it a unique name. One of
the modes is selected by mode
parent: definition of a camera
childs: definitions of camera modes
n ccds
description: Number of ccds that make up the camera
parent: global
range: MOS: 7; RFC 9; PN 12
n nodes
description: Total number of nodes that handle the image read­out of a ccd defined for this camera­
camera
parent: global
range: MOS: 2; RFC 2; PN 64
node
description: The read­out node of the ccd describes the alteration of image contents when the image
is read out.
parent: in this order:
id ­ node identifier; value is one of 0­63 (PN), 0­1(MOS), 0­1(RFC),
gain ­ conversion from electrons­>ADU; value is a positive float,
noise ­ amplifier noise (in electrons), value is a positive float,
cte(X) ­ Serial Charge Transfer E#ciency, value 0#float#1,
cte(X) ­ Parallel Charge Transfer E#ciency, value 0#float#1

XMM­Newton Science Simulator Page: 15
childs: nodes
nodes
description: Contains a list of read­out node configurations. The user may add/modify configurations,
as long as the nodes are specified in ascending order.
The nodes that are not specified here, will be assigned the configuration of a specified
node, that has an id closest but smaller than the unspecified node. If such a node is not
specified, it will take the first node in the list
parent: defined nodes
childs: ccd
omega
description: Multiplication factor to extend the frame time of PN ccds as described in the Modes
Document. Does not have any e#ect on MOS and RFC cameras
parent: global
childs: PN: 0#integer#15; MOS/RFC: ­1
option
description: The User may unselect certain aspects of the simulation. For example, if the User is not
interested in smearing e#ects due to read out of the image, it can be switched o#
childs: amplifier noise, analyse all frames, dark noise, pattern match, smear e#ect, subtract background
parameter
description: Describes some parameters specific for current CCD
parent: definition of a ccd
childs: accept treshold, background frames, dark current, doping, elevation, lower treshold, pixelSurface,
subtract level, temperature, upper treshold
pattern match
description: Apply compression of data by reconstruction of events (Not applicable in case of PN)
parent: option
range: 0 (o#) or 1 (on)
pixelSurface
description: Specifies the entry in the surface data file, that is used for dead pixel surfaces (see files).
parent: parameter
range: valid entry in surface data file
pixel size
description: Edge­length of a square pixel in the image­section of the ccds of this cameracamera
parent: global
range: float#0
unit: micron
rows
description: Number of rows in the image section of a CCD
parent: global
range: MOS: 600; RFC 384; PN 200
onBoardSrc
description: Name of file containing RGScamera related On­Board Calibration sources.
Note that none is a valid file name, used by the MOS and PN cameras.
parent: files
smear e#ect
description: Implementation of smearing during read­out of image
parent: option
range: 0 (o#) or 1 (on)

XMM­Newton Science Simulator Page: 16
subtract background
description: Apply back­ground calculation and subtraction. In case of RFC, this option is set to
zero, because RFC does not have a background subtraction algorithm. In all other cases,
the first frame(s) of data will be used for background calculation, which in turn will be
subtracted of following frames
parent: option
range: 0 (o#) or 1 (on)
subtract level
description: Indicates the type of background subtraction
parent: parameter
range: Possible values are:
< 0 ­ background subtraction is based on calculations of background frames.
> 0 ­ fixed number of electrons used for subtraction
unit: (whole) electrons
surface
description: Name of file containing the surface layers in front of the sensitive region of a pixel: so
called back layers or front gates (See Surfaces)
parent: files
temperature
description: Temperature of this ccd
parent: parameter
range: floating number > 0
unit: K
temperature
description: Temperature of the Camera Cold finger
parent: camera
range: floating number > 0
unit: K
timeProcess
description: Time log information of top­level processes.
range: 0 (o#) or 1 (on)
upper treshold
description: NA
parent: parameter
range: ­1
4.2.3 Keywords example
Below one can find an example of how the configuration section of an ESIM could look like. Note that
the default configuration of MOS and PN can be found in the esim config section and the default
configuration of RFC in the rfcsim config section of scisim.cfg.
begin
esim_config begin
# camera definition and selection
camera MosCamera1
cameras begin
MosCamera1 begin

XMM­Newton Science Simulator Page: 17
temperature 183 # of the camera cold­finger
# ccd definition
ccds begin
begin
id 1
nodes begin
begin 0 0.931 3.7 0.99999 0.99998 end
begin 1 0.931 3.7 1 0.99998 end
end
parameter begin
accept_treshold ­1
background_frames 1
dark_current 1
doping default
elevation 0
lower_treshold 5
pixelSurface PixelGateSurfaces
subtract_level ­1
temperature 200
upper_treshold ­1
end
end
# note that (because other CCDs are not defined) the
# definition of CCD 1 is used for all CCDs
end
# data files
files begin
clock mos_clocks.dat
doping mos_doping.dat
gradePatterns mos_pattern.dat
materials begin silicon.dat oxide.dat nitride.dat end
sigmaScales sigmaScales.dat
surface mos_surface.dat
end
# camera globals
global begin
cam_type mos
columns 600
dead_space 0
illumination front
n_ccds 7
n_nodes 2
omega 0
pixel_size 40
rows 600
end
# mode definition
modes begin
AllCcdsInFull begin
begin 1 prime full 0 0 600 600 1 1 0 default end

XMM­Newton Science Simulator Page: 18
begin 2 prime full 0 0 600 600 1 1 0 default end
begin 3 prime full 0 0 600 600 1 1 0 default end
begin 4 prime full 0 0 600 600 1 1 0 default end
begin 5 prime full 0 0 600 600 1 1 0 default end
begin 6 prime full 0 0 600 600 1 1 0 default end
begin 7 prime full 0 0 600 600 1 1 0 default end
end
CenteredCcdFast begin
begin 1 fast ­ 0 0 600 600 1 100 0 default end
begin 2 prime full 0 0 600 600 1 1 0 default end
begin 3 prime full 0 0 600 600 1 1 0 default end
begin 4 prime full 0 0 600 600 1 1 0 default end
begin 5 prime full 0 0 600 600 1 1 0 default end
begin 6 prime full 0 0 600 600 1 1 0 default end
begin 7 prime full 0 0 600 600 1 1 0 default end
end
end
end
end
debug none
# filter definition and selection
filter thin
filters begin
none none
open filterOpen.dat
thin filterThin.dat
medium filterMedium.dat
thick filterThick.dat
closed filterClosed.dat
end
# mode selection
mode AllCcdsInFull
# simulation options (accessible by GUI)
option begin
amplifier_noise 1
analyse_all_frames 0
dark_noise 1
pattern_match 1
smear_effect 1
subtract_background 1
end
timeProcess 1
#­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
# raytrace section (All simulators contain such a section; for more
# information oabout this section, see the SciSim User Guide)
estimatedRays 0
historyFile none
raytraceMode 0
rotation.angle 0

XMM­Newton Science Simulator Page: 19
rotation.x 0
rotation.y 0
rotation.z 0
scale 1
seed 0
transform 1
translation.x 7500
translation.y 0
translation.z 0
#­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
end
end

XMM­Newton Science Simulator Page: 20
5 Lay­out of the cameras
When an X­ray hits the camera, its position is transformed to camera coordinates using the transforma­
tions given by the transformation section in scisim.cfg (see also section Raytrace configuration in SciSim
documentation).
In turn, the X­ray position is then transformed to the coordinates system of the CCD that is hit.
When this X­ray produces collectable charge, the resulting output of the CCD tells us where an how
much is collected. Where is in terms of pixel coordinates w.r.t. the node that has read­out the charge.
In order to understand the positions of pixels in the output, this chapter gives an overview of the lay­out
and coordinate systems of all cameras and their sub­systems. A schematic lay­out of a pixel is also
presented.
5.1 EPIC MOS camera
The EPIC MOS camera consists of 7 front illuminated CCDs. The CCDs are parallel to the yz­plane of
the camera. Note that the image coordinates of the CCDs di#er from each other.(Figure 1).
Note, that the CCD numbering in the figure is the CCD numbering used in the configuration file for both
mode configuration and ccd configuration.
A CCD of the EPIC MOS camera may use both nodes in order to read­out the image. The first node
is thought of as representing the left part of the image, whereas the last node is operating on the right
side. (see Figure 2).
Note, that physically the nodes are at the bottom of the storage section.
The nodes numbering in the configuration file of a CCD follow the convention used in the figure. By
default the MOS CCDs are operating on node 0 only.
5.2 EPIC PN camera
The EPIC PN camera consists of 12 back illuminated CCDs. The CCDs are parallel to the yz­plane of
the camera (Figure 3).
Note, that the CCD numbering in the figure is the CCD numbering used in the configuration file for both
mode configuration and ccd configuration.
A CCD of the EPIC PN camera uses 64 nodes in parallel in order to read­out the image. The first node
is thought of representing the left part of the image, whereas the last node is operating on the right side.
(see Figure 4).
Note, that physically the nodes are at the bottom of the storage section.
The nodes numbering in the configuration file of a CCD follow the convention used in the figure.
5.3 RGA focal camera (RFC)
The RGS focal camera consists of 9 back illuminated CCDs. The CCDs are parallel to the yz­plane of
the camera (Figure 5).

XMM­Newton Science Simulator Page: 21
Y CC1/2
y
x y
x
y
x y
x x
y
y
x
x
y
Y CC1/2
X CC1/2
y
x
x
y
x
y
x
y
y
x
y
x
x
y
01
SC
Y
X SC
SC
Z
X CC1/2
PA=45 o
SC
Y
-Z SC
0011
N
E
01
01
4
5
EMOS1
EMOS2
5
1 6
3
7
2
6
1
3
4 2
7
Figure 1: Transformation of MOS camera coordinates to CCD image coordinates.

XMM­Newton Science Simulator Page: 22
x
y
x
y
storage
image area
node 0 node 1
x
y
Figure 2: Transformation of MOS CCD image coordinates to CCD node coordinates.
Note, that the CCD numbering in the figure is the CCD numbering used in the configuration file for both
mode configuration and ccd configuration.
By default, a CCD of the RGS focal camera uses both nodes in order to read­out the image. The first
node is thought of representing the left part of the image, whereas the last node is operating on the right
side. (see Figure 6).
Note, that physically the nodes are at the bottom of the storage section.
The nodes numbering in the configuration file of a CCD follow the convention used in the figure.
5.4 Pixel lay­out
A pixel consists of an active region of doped silicon and front or back surface layers as selected by the
pixelSurface keyword in the ESIM/RFCSIM configuration(see also Figure 7).
The surface layers may consist of several areas and materials (see Surfaces). These layers act as filters:
an X­ray may be absorbed (and lost) in a surface.
The active region consists of an epi­layer and perhaps a substrate. If an X­ray is absorbed in this region
the deposited charge may be (partially) collected.

XMM­Newton Science Simulator Page: 23
y
x
y
x
y
x
y
x
y
x
y
x
x
y
y
x
y
x
x
y
EPN
x
y
01
SC
Y
X SC
SC
Z
Y CC1
X CC1
X CC2
Y CC2
PA=45 o
SC
Y
-Z SC
N
E
00
00
11
11
0
0
1
1
Q1
Q2
8
10 1
12
11
7
9 6
5
4
2
3
y
x
Q0
Q3
Figure 3: Transformation of PN camera coordinates to CCD image coordinates.

XMM­Newton Science Simulator Page: 24
y node 0
storage
image area
x
y
y
node 63
Figure 4: Transformation of PN CCD image coordinates to CCD node coordinates.
6 Data files explained
This chapter describes the data files used by the simulator. These data files can be found in data/esim/.
Those files are selected by the keyword files in the ESIM configuration.
The function of the data file, as well as their contents will be explained.
Note that the contents of the data files are encapsulated by a begin end construction, as if such a data
file is an object too.
Note also, that ­in some cases­, an object may contain a list of objects. These objects usually have no
keywords themselves. In order to show the User, what is meant by this object, the name is given in [...].

XMM­Newton Science Simulator Page: 25
Z
SC
X
SC
0
1
0 1
SC
Y
RGS1
/
RGS2
x
y
CC1
Y
1
5
9
2
3
4
6
7
8
X
CC1
decreasing
dispersion
7.333
o
y
x
y
x
y
x
y
x
y
x
y
x
y
x
y
x
increasing
dispersion
Figure 5: Transformation of RFC camera coordinates to CCD image coordinates.

XMM­Newton Science Simulator Page: 26
x
y
x
y
storage
image area
node 0 node 1
x
y
Figure 6: Transformation of RFC CCD image coordinates to CCD node coordinates.
y
x
epi­layer
substrate
back layer(s)
CCE at back
CCE at front
active region
front layer(s)
Figure 7: Global pixel lay­out. The dead layers (front and back) act as filters. A CCI on both sides of
the active region of a pixel might be imposed.

XMM­Newton Science Simulator Page: 27
6.1 Clocking of CCDs
The clock data file contains information of ccd frame clocking for several configurations, each bearing a
unique name. When specifying a camera modemode, the User can select a defined clock for each ccd.
6.1.1 Keywords tree
clocks
default
clearPixel masterSeqWait overScanParallel overScanRegister preReadWait readPixel shiftColumn
shiftRow underScanParallel underScanRegister
user­defined clock1
:
user­defined clockN
6.1.2 Keywords description
clearPixel
description: Time to clear the contents of the read­out node
parent: clock
range: # 0
unit: s
clock, definition of a ...
description: Defines the clocking of the ccd
parent: clocks
childs: clearPixel, masterSeqWait, overScanParallel, overScanRegister, preReadWait, readPixel,
shiftColumn, shiftRow, underScanRegister, underScanParallel
clocks
description: Contains a map of clocks. The user may add clocks, giving it a unique name.
childs: defined clocks
masterSeqWait
description: Pause time before read­out of a quadrant actually starts (see modes document; NA to
RFC/MOS).
parent: clock
range: # 0
unit: s
overScanParallel
description: Number of dummy rows read,after the actual image
parent: clock
range: # 0
unit: pixels
overScanRegister
description: Dummy pixels after the actual row is read (NA to PN).
parent: clock
range: # 0
unit: pixels
preReadWait
description: Pause time before read­out ccd actually starts (see modes document; NA to RFC/MOS).

XMM­Newton Science Simulator Page: 28
parent: clock
range: # 0
unit: s
readPixel
description: Time to read the contents of the read­out node and to convert to ADU
parent: clock
range: > 0
unit: s
shiftColumn
description: Time to do one column shift. Clocking is such that all columns are shifted at once. This
type of shifting occurs in the read­out register (NA to PN).
parent: clock
range: > 0
unit: s
shiftRow
description: Time to do one row shift. Clocking is such that all rows are shifted at once. This may
be towards the storage section or to the read­out register directly.
parent: clock
range: > 0
unit: s
underScanParallel
description: Number of dummy rows read,before the actual image
parent: clock
range: # 0
unit: pixels
underScanRegister
description: Dummy pixels before the actual row is read (NA to PN).
parent: clock
range: # 0
unit: pixels
6.1.3 Keywords example
For other examples, see data/esim/ directory.
begin
clocks begin
default begin
clearPixel 12.00e­6
masterSeqWait ­1
overScanParallel 2
overScanRegister 5
preReadWait ­1
readPixel 6.00e­6
shiftColumn 1.00e­6
shiftRow 10.00e­6
underScanParallel 0
underScanRegister 5
end
end
end

XMM­Newton Science Simulator Page: 29
6.2 Pixel surfaces
The surfaces data file contains information of pixel surfaces that act as a ray filter in front of the sensitive
area of a pixel. Depending on the absorption coe#cient of a ray, the ray will be lost in the surface layers
of a pixel or it will traverse them.
Though the surface is described in terms of one pixel, it holds for all pixels within the image. A pixel
surface is divided into section of pixels. For example ­ if they describe the gate­surfaces ­ each section
describes one gate. Such a section may consist of multiple materials of various thickness. These materials
can be referred to by their name (see Materials).
6.2.1 Keywords tree
surfaces
user­defined surface1
[sub­pixel­area1]
dV
stacked layers
[layer1]
material, z0, z1
:
[layerN]
x0
x1
y0
y1
:
[sub­pixel­areaN]
:
user­defined surfaceN
6.2.2 Keywords description
dV
description: Maximum voltage di#erence within the epi­layer of the sensitive area, as if this were
the only section.
parent: [sub­pixel­area]
range: >0
unit: Volt
[layer], definition of a ...
description: A surface layer of particular thickness and material properties.
parent: stacked layers
childs: material, z0, z1
material
description: Name of the material, this layer is made of.
parent: definition of a surface [layer]
range: Name must be defined in one of the material files selected.
stacked layers

XMM­Newton Science Simulator Page: 30
description: List of layers that are stacked within this section.
Note that each layer is not preceded by a keyword.
Note also, that the layers must be sorted such, that first layer must be closest to the
sensitive area at relative depth = 0
parent: surface
childs: a list of [layer]s
[sub­pixel­area]
description: Part of pixel surface (normalized)
parent: surface
childs: stacked layers, dV, x0, x1, y0, y1
surface, definition of a ...
description: User­defined surface of a pixel. This keyword contains a list of (normalized) surface
sub­areas of a pixel. A pixel surface might be split into sub­areas, each with its own
properties. surface data.
Note that each section of this list is not preceded by a keyword.
parent: surfaces
childs: list of sub­pixel areas
surfaces
description: Contains a map of surfaces. The user may add surfaces, giving it a unique name. A
surface is selected within a parameter description of a ccd (see ccd parameters).
Note that a surface is defined for one pixel, but it applies for the whole image section of
a ccd.
childs: definition of surfaces
x0
description: x position of lower­left corner of the sub­pixel area w.r.t. to lower­left corner of pixel.
parent: [sub­pixel­area]
range: #0
unit: arbitrary
x1
description: x position of upper­right corner of the sub­pixel area w.r.t. to lower­left corner of pixel.
parent: [sub­pixel­area]
range: #0
unit: arbitrary
y0
description: y position of lower­left corner of the sub­pixel area w.r.t. to lower­left corner of pixel.
parent: [sub­pixel­area]
range: #0
unit: arbitrary
y1
description: y position of upper­right corner of the sub­pixel area w.r.t. to lower­left corner of pixel.
parent: [sub­pixel­area]
range: #0
unit: arbitrary
z0
description: Starting depth of a surface w.r.t. the sensitive area of the ccd. (must be positive)
parent: definition of a surface [layer]
range: = z1 of preceding layer
unit: microns

XMM­Newton Science Simulator Page: 31
z1
description: Ending depth of a surface w.r.t. the sensitive area of the ccd. (must be positive)
parent: definition of a surface [layer]
range: > z0 of this layer
unit: microns
6.2.3 Keywords example
For other examples, see data/esim/ directory.
begin
surfaces begin
PixelGateSurfaces begin
begin
dV 9
stacked_layers begin
begin z0 0.000 z1 0.085 material oxide end
begin z0 0.085 z1 0.170 material nitride end
begin z0 0.170 z1 0.670 material silicon end
begin z0 0.670 z1 2.070 material oxide end
end
x0 0
x1 0.5
y0 0
y1 1
end
begin
dV 9
stacked_layers begin
begin z0 0.000 z1 0.100 material oxide end
end
x0 0.5
x1 1
y0 0
y1 1
end
end
end
end

XMM­Newton Science Simulator Page: 32
6.3 Doping profiles
The doping data file contains information of the sensitive part of a pixel. This part of the pixel absorbs
the photon energy in the form of a cloud of electron­hole pairs.
Due to applied electric fields the electrons (and holes) are split and the transferred to opposite direc­
tions (physical front/back­side of the CCD). The electrons are collected in the collection zone (with the
maximum potential field). During their travel, the cloud di#uses radially and charge losses may occur,
depending on the properties of the layers it traverses.
The properties of these layers (field­layer, field­free layer and substrates) are described in this file.
Note that the information is one dimensional; in other words, it applies over the whole image section.
6.3.1 Keywords tree
dopings
default
back
collectionAtFront, riseLength, sigmaScale, thickness, zeroDepth
epi
collectionAtFront, sigmaScaleField, sigmaScaleFieldFree, transmissionCoe#, doping
front
collectionAtFront, riseLength, sigmaScale, thickness, zeroDepth
material
substrate
collectionAtFront, depleted, doping, sigmaScale, thickness
user­defined doping1
:
user­defined dopingN
6.3.2 Keywords description
back
description: Front­illuminated as well as back­illuminated devices su#er from charge collection inef­
ficiency near the surface. This might be a result of heavy doping implants and surface
recombination e#ects.
These e#ects are modeled by using an exponential function of depth as the fraction of
charge collected per electron. As this is a function of depth, the function is integrated
over the cloud radius, in order to get the total collected electrons within the cloud.
Note that if this object is empty, the layer is thought to be non­existent.
Note also, that this layer is a part of the sensitive region; in other words, it is NOT a
dead layer.
parent: definition of a doping profile
childs: collectionAtFront, riseLength, sigmaScale, thickness, zeroDepth
collectionAtFront
description: Defines which side of current doping layer is nearest the collection­zone of pixel charge.
parent: back, epi, front, substrate
range: true or false
depleted
description: Whether the substrate is depleted or not.

XMM­Newton Science Simulator Page: 33
parent: substrate
range: true or false
doping, definition of a complete ... profile
description: The sensitive area is assumed to consist of one material. This is a name reference to an
item in Materials, which is selected by the simulator configuration. Note that this must
be a material of type silicon.
parent: dopings
childs: back, epi, front, material, substrate
doping, definition of an epi­layer ... profile
description: Dynamic table of depth (column 1) versus doping concentration (column 2).
The table needs at least two rows: zero­depth and end depth of the epi­layer.
Zero­depth is assumed nearest to the gates.
Depths should be in ascending order.
parent: epi­layer
childs: table of two columns
range: depth (column 1): increasing and starting at 0
doping concentration (column 2): >0
unit: depth (column 1): microns,
doping concentration (column 2): log(cm­3))
doping, definition of a substrate ...
description: Uniform doping concentration of the substrate.
parent: substrate
range: >0
unit: log(cm­3))
dopings
description: Contains a map of doping profiles. The user may add profiles, giving it a unique name.
A doping profile is selected within a parameter description of a ccd (see ccd parameters).
childs: definition of dopings
epi, definition of an ... layer
description: Properties of the epi­layer (grown on the wafer).
An electric field is generated by applied voltages, that divides the epi­layer into a field­
region and a field­free region. Together with a doping profile, the transition depth of
one region to another can be achieved. This depth is written in the log­file.
parent: doping profile
childs: collectionAtFront, sigmaScaleField, sigmaScaleFieldFree, transmissionCoe#, doping
front
description: See description of back.
material
description: Name of the material, this layer is made of.
parent: definition of a surface [layer]
range: Name must be defined in one of the material files selected.
riseLength
description: Rise length of the exponential function
parent: back,front
range: > 0
unit: microns
sigmaScale, sigmaScaleField, sigmaScaleFieldFree
description: Name reference to an item in Scaling of clouds(selected by files.

XMM­Newton Science Simulator Page: 34
parent: sigmaScale: back, front, substrate
sigmaScaleField, sigmaScaleFieldFree: epi
range: valid entry in Scaling of clouds
substrate
description: The substrate is the slice of material (wafer) on which the epi­layer is grown.
In case of PN the simulator uses this part of the sensitive area as a large depletion
layer. For the RFC this object is empty, because the wafer is etched away. MOS has a
substantially thick substrate, in which virtually all energy is lost due to recombination.
parent: doping profile
childs: collectionAtFront, depleted, doping, sigmaScale, thickness
thickness (of CCE layer)
description: Maximum thickness of the Charge Collection E#ciency layer ( In theory the exponential
never reaches a collection fraction of unity. To speed the code up, the user is allowed to
use a cut­o# depth/thickness. Within that thickness, the formula is used, outside that
region the collection fraction is assumed to be unity
parent: back, front
range: > 0
unit: microns
thickness (of substrate)
description: Thickness of the substrate layer.
parent: substrate
range: # 0
unit: microns
transmissionCoe#
description: The transmission coe#cient as used in Hopkinson's formula (see OPTICAL ENGINEER­
ING, Aug 1987,Vol.26 No.8,page 767).
Zero transmission means that electrons may wander through the interface (e.g. between
epi­layer and substrate).
parent: epi
range: 0 # x # 1
unit: normalized
zeroDepth
description: Thickness of a really dead­zone near the surface.
parent: back, front
unit: microns
6.3.3 Keywords example
For other examples, see data/esim/ directory.
begin
dopings begin
exampleName begin
back begin
collectionAtFront true
riseLength 0.090
sigmaScale none
thickness 0.400
zeroDepth 0.020

XMM­Newton Science Simulator Page: 35
end
epi begin
collectionAtFront false
sigmaScaleField none
sigmaScaleFieldFree epi_ff
transmissionCoeff 0
doping begin
0.00 12.0
7.00 11.0
9.50 10.5
12.00 10.0
end
end
front begin end
material silicon
substrate begin
collectionAtFront true
depleted true
doping 12.
sigmaScale none
thickness 270.
end
end
end
end

XMM­Newton Science Simulator Page: 36
6.4 Cloud charge modifications
Usually the final charge cloud within the collection zone is assumed to have Gaussian distribution; a
single parameter (sigma of the radius) can then describe the shape of the cloud. This provides a relative
easy way to map the 3D­cloud onto a 2D­grid of pixels. Another advantage of this approach is that the
cloud may traverse multiple layers, each with its specific di#usion characteristics. In order to get the final
cloud size, one can take the root of the squared sum of sigmas.
Hopkinson et al. showed that the Gaussian distribution is not valid for field­free regions at least: The
radial distribution shows a Gaussian core with extended wings. As a result, the electrons may spread
over more pixels. Unfortunately his formula converges too slow to be useful for computation. Moreover,
it applies to the field­free region alone, which makes it cumbersome if not too complex at all to calculate
the final cloud size.
This data file gives the user the possibility to modify the distribution, by using two weighted sigmas.
This way the extended wings in the field­free region can be simulated, and ­if applicable­ other regions
of the sensitive layer can be modified too.
6.4.1 Keywords tree
sigmaScales
user­defined sigmaScale1
:
user­defined sigmaScaleN
6.4.2 Keywords description
sigmaScale
description: Dynamic table of 5 columns wide.
The table needs at least two rows: zero­depth and end depth of the layer(normalized);
zero­depth is nearest to the collection zone (see Dopings). The values of the columns
are described below
parent: sigmaScales
childs: The table consists of 5 columns:
depth ­ normalized depth for a particular region in the doping profile.
f sig1 ­ multiply the Gaussian sigma with this to get the shape of the core.
f sig2 ­ multiply the Gaussian sigma with this to get the shape of the extended wings.
f dis1 ­ Weigh factor applied to the grid of pixels obtained from the core.
f dis2 ­ Weigh factor applied to the grid of pixels obtained from the extended wings.
sigmaScales
description: Contains a map of sigma scale entries. The user may add entries, giving it a unique
name. A sigma scale entry is selected within the doping data file (see Dopings).
Note that when a sigma­scale is defined, it MUST have contents
childs: user­defined entries of user­defined sigmaScales
6.4.3 Keywords example
For other examples, see data/esim/ directory.

XMM­Newton Science Simulator Page: 37
begin
sigmaScales begin
ThisIsAnExample begin
0.0 0.1 2.0 0.5 0.5
0.5 0.5 1.5 0.4 0.6
1.0 0.9 1.0 0.6 0.4
end
ThisIsAnotherExample begin
0.0 0.1 3.0 0.8 0.2
1.0 1.0 1.0 0.2 0.8
end
end
end

XMM­Newton Science Simulator Page: 38
6.5 Pattern library (EPIC­MOS only)
The EPIC­MOS camera has a library of patterns used for pattern matching. Though this library is
initially fixed, it might change during operational phase. Therefore the simulation should be able to
handle a modified library too.
This library is stored in the pattern data file (data/esim/mos pattern.dat)
6.5.1 Keywords tree
patterns
fast
[user­defined fast pattern1]
grade, mask
:
[user­defined fast patternN]
prime
[user­defined prime pattern1]
:
[user­defined prime patternN]
6.5.2 Keywords description
grade
description: Grade identifies the pattern to belong to a group of similar (but not identical) patterns.
Therefore the grade does not have to have a unique number.
parent: a fast pattern, a prime pattern
fast
description: fast mode of MOS, a pattern mask of size 5x1 is used on each compressed row
mask
description: The size of a mask depends on the mode: 5x1 (fast) or 5x5 (prime). In both case we
may speak of a center pixel, its direct neighbours and outer pixels.
The outer pixels of the mask may only take the values 0 or 2,
the center pixel must have the value 1 and
its neighbours are either 0 or 1.
parent: a fast pattern, a prime pattern
childs: A matrix (5x1 or 5x5, depending on mode) of whole numbers
range: 0 ­ pixel charge must be below threshold
1 ­ pixel charge must be above threshold
2 ­ don't care about the charge
patterns
description: Contains the pattern library of two distinct scientific modes: fast and prime
childs: fast, prime
prime
description: prime mode of MOS, a pattern mask of size 5x5 is moved across the image, such that
each pixel is in the center of the mask once.
parent: patterns
childs: list of user­defined prime patterns

XMM­Newton Science Simulator Page: 39
[user­defined prime pattern]
description: Definition of a new pattern.
parent: prime
childs: grade, mask
6.5.3 Keywords example
For other examples, see data/esim/ directory.
begin
patterns begin
fast begin
begin grade 1
mask begin 2 0 1 0 2 end end
begin grade 2
mask begin 0 1 1 0 2 end end
end
prime begin
begin grade 1
mask begin 2 2 2 2 2
2 0 0 0 2
2 0 1 0 2
2 0 0 0 2
2 2 2 2 2 end end
begin grade 2
mask begin 2 2 2 2 2
2 0 1 0 2
2 0 1 0 2
2 0 0 0 2
2 2 2 2 2 end end
end
end

XMM­Newton Science Simulator Page: 40
6.6 Materials
6.6.1 Keywords tree
A CCD is a complex device, consisting of various materials. The devices used in the XMM­Newton
cameras all have a wafer of silicon. The MOS camera uses front­illuminated CCDs; X­rays have to
traverse the gates before they reach the sensitive area of the CCD. Though the RFC and PN devices are
back­illuminated, X­rays still must pass the thin dead layer on the back side of the CCD, or even (some
RFC CCDs) a deliberately fetched layer to block unwanted photons.
All these materials have specific properties, that are described in the material file(s) selected by the files
keyword in the ESIM configuration.
materials
user­defined material1
attenuationLength
density
edges
[edge]
edgeEnergy, emitEnergy, yield
energyEh
fanoFactor
permittivity
:
user­defined materialN
6.6.2 Keywords description
attenuationLength
description: Table of two columns containing attenuation lengths as a function of photon energy
parent: material
range: column1 ­ denotes the energy. Column must be sorted in increasing order.
column2 ­ corresponding reciprocal of absorption coe#cient.
unit: column1 ­ eV
column2 ­ ­
density
description: Density of material
parent: material
range: > 0
unit: g cm­3
[edge]
description: If an X­ray has more energy than the edge­energy (K,L,M), it may emit an fluorescence
photon (alpha,beta,..) when it is absorbed.
parent: edges
childs: edgeEnergy, emitEnergy, yield
edgeEnergy
description: Minimum energy required to allow fluorescence occur.
parent: [edge]
range: > 0
unit: eV

XMM­Newton Science Simulator Page: 41
edges
description: List of fluorescence characteristics. Note that this object might be empty if it is not a
property of silicon.
parent: material
childs: list of edges
emitEnergy
description: Energy of emitted fluorescence photon.
parent: [edge]
range: 0 # emitEnergy # edgeEnergy
unit: eV
energyEh
description: Energy required to create electron­hole pair
parent: material
range: > 0
unit: eV
fanoFactor
description: Fano factor; used for calculating photon­shot noise.
parent: material
material
description: Contains some properties of material, that influence the behavior of an X­ray within
that material
parent: materials
childs: attenuationLength, density, edges, energyEh, fanoFactor, permittivity
materials
description: Contains a map of materials. The user may add materials, giving it a unique name.
A material selected within the surface layers (see Surfaces) and doping profiles (see
Dopings).
childs: a map of user­defined materials
permittivity
description: Permittivity of material
parent: material
range: > 0
unit: F cm­1
yield
description: Probability, that an X­ray with su#cient energy emits a photon at this edge.
parent: [edge]
range: 0 < yield # 1
6.6.3 Keywords example
For other examples, see data/esim/ directory.
begin
materials begin
MyMaterial begin
attenuationLength begin
30 0.01
30000 1000.00
end

XMM­Newton Science Simulator Page: 42
density 3
edges begin end # no edges
energyEh 3.9
fanoFactor 0.12
permittivity 1.e­12
end
end
end

XMM­Newton Science Simulator Page: 43
6.7 RFC On­Board Sources
The RGS camera has On­Board sources which are illuminating the camera partially.
6.7.1 Keywords tree
CalibrationSources
user­defined Source1
x y radius eccentricity flux distr.radial.a0, distr.radial.a1 distr.radial.a2 distr.radial.bins distr.energy
:
user­defined SourceN
6.7.2 Keywords description
CalibrationSources
description: Container of all defined sources, mapped on their name
childs: Source
distr.energy
description: Table of three columns (Energy [eV],Energy Band [eV], Intensity [­]).
Note that normalization is done by the Simulator.
parent: Source
unit: > 0
distr.radial.bins
description: Binning applied on the polynominal distribution
parent: Source
range: A number > 0
unit: ­
distr.radial.a0..a1
description: Radial distribution properties: I(r) = a0 + a1 * r + a2 * r * r
Note that normalization is done by the Simulator.
parent: Source
unit: ­, mm­1, mm­2
eccentricity
description: eccentricity of elliptical illumination area
parent: Source
range: (0,1]
unit: ­
flux
description: Flux of the source
parent: Source
range: # 0
unit: photons mm­2 s­1
radius
description: Radius along major axis (X­axis) of elliptical illumination area
parent: Source
range: # 0
unit: mm
Source

XMM­Newton Science Simulator Page: 44
description: Description
parent: CalibrationSources
childs: x, y, radius, eccentricity, flux, distr.radial.a0..a1, distr.radial.bins, distr.energy
x, y
description: center of illumination area in CamCoord 1 (CC1) coordinates
parent: Source
unit: mm
6.7.3 Keywords example
For other examples, see data/esim/ directory.
begin
CalibrationSources begin
CalibrationSource1 begin
x ­99.05
y ­5.185
radius 15.0
eccentricity 0.88
flux 1.e­3
distr.radial.a0 108.636
distr.radial.a1 ­14.4739
distr.radial.a2 0.4821
distr.radial.bins 1000
distr.energy begin
1500. 1 0.95
3000. 1000 0.5
end
end
end
end

XMM­Newton Science Simulator Page: 45
6.8 Filters in the filter wheel (EPIC only)
In front of the EPICcameras a filter wheel is positioned. This filter wheel contains several filters, that
are designed to reduce UV and optical photon fluxes.
6.8.1 Keywords tree
filter
filter diameter
pinholes
boxes
[box1], ..., [boxN]
circles
[circle1], ..., [circleN]
transmission
translation.x
translation.y
translation.z
rotation.x
rotation.y
rotation.z
6.8.2 Keywords description
[box]
description: Rectangular pinhole, whereas (yy,zz) denote the position of the lower­left corner in the
filter plane, and (dy,dz) the size of the box.
Note that (dy,dz) must be positive.
parent: boxes
childs: [yy] [zz] [dy] [dz]
unit: mm
boxes
description: Contains a list of rectangular shaped pinholes (no keywords).
Note that the list might be empty.
parent: pinholes
childs: list of boxes
[circle]
description: Circular pinhole, whereas (yy,zz) denote the position of the lower­left corner in the filter
plane, and R the radius.
Note that R must be positive.
parent: circles
childs: [yy] [zz] [R]
unit: mm
circles
description: Contains a list of circular shaped pinholes (no keywords).
Note that the list might be empty.
parent: pinholes
childs: list of circles

XMM­Newton Science Simulator Page: 46
filter
description: Contains a description of a filter positioned in front of the camera.
The filter is assumed to be circular and to have uniform properties. Cracks (pin holes)
are allowed to be specified.
childs: filter diameter, pinholes, transmission, translation.x, translation.y, translation.z, rotation.x,
rotation.y, rotation.z
filter diameter
description: Diameter of filter within the filter wheel
parent: filter
range: > 0
unit: mm
pinholes
description: Defines thin ­or even open­ areas in the filter.
It is assumed that any ray can pass the filter in such a section. Though the user can
specify limited shapes, it is noted, that these shapes can be used to build complex
pinholes. In other words, pinholes might overlap, such that they cover a complex shaped
area.
parent: filter
childs: boxes, circles
transmission
description: Contains a table of transmission of the filter as function of the ray­energy
parent: filter
childs: column1 ­ denotes the energy. Column must be sorted in increasing order.
column2 ­ corresponding transmission coe#cients.
Note that the table must consist of at least two rows: energy for zero transmission and
energy for full transmission. coe#cient.
range: (energy # 0, 0 # transmission # 1)
unit: column1 ­ eV
column2 ­ ­
translation.x, translation.y, translation.z
description: Position of filter in the coordinate system of the camera. Translate over x, then over y
and finally translate over z.
Note that these keywords work di#erent from the translation keywords used for all ray­
tracers.
Note also that translation.x must be negative in order to position the filter in front of
the camera.
parent: filter
unit: mm
rotation.x, rotation.y, rotation.z
description: Position of filter in the coordinate system of the camera. Translate over x, then over y
and finally translate over z.
Note that these keywords work di#erent from the rotation keywords used for all ray­
tracers.
parent: filter
range: -180 # rotation < 180
unit: degrees
6.8.3 Keywords example
For other examples, see data/esim/ directory.
begin
filter begin
filter_diameter 72

XMM­Newton Science Simulator Page: 47
pinholes begin
boxes begin
begin 15.00 2.00 0.03 0.05 end
end
circles begin
begin 0.00 0.00 0.01 end
begin 5.00 ­10.00 0.01 end
end
end
rotation.x 0
rotation.y 0
rotation.z 0
transmission begin
0.00 0.000
30000.00 1.000
end
translation.x ­50
translation.y 0
translation.z 0
end
end

XMM­Newton Science Simulator Page: 48
7 Output using esim reporter
The ODF converters are the tools to convert ESIM output into FITS format. This format will be used for
the XMM­Newton Science Analysis Subsystem, which is currently under development (see XMM­Newton
overview).
To view the output of ESIM in ASCII format, one can use ssimascii, which is one of the SciSim Tools.
Along with ESIM, a tool is provided to convert ESIM output into tabular ASCII format: esim reporter.
This tool is provided as is.
The keywords that can be feed into esim reporter are:
ccds Allows the user to output information of a selection of CCDs. Possible values: 1 2 3 4 5 6 7 8
9 10 11 12.
grades Filters events on selected grades. Note that ­1 should be specified when event reconstruction
has not taken place. Possible values: ­1 1 2 3 4 5 6 etc....
fields Specifies the fields that are to be produced in the output file for each event. Possible values:
x y column and row coordinates w.r.t. read­out node (pixels)
energy1 energy2 energy3 energy4 pixel contents (ADU).
grade event reconstruction id. In case of RGS focal camera output this value is equal to
the number of pixels that make up energy1. For MOS the value is equal to the grade
id in MOS pattern library.
peripheral pixels: sum of outer border pixels above threshold in MOS pattern library.
ccd frame node id of the ccd/frame/node that this event belongs to.
time end time of corresponding frame (seconds).
cameraX cameraY camerZ event coordinates converted to camera CC1­coordinates (mm).
refX refY refZ event coordinates converted to telescope coordinates (mm).
Note that all values of the keywords should be enclosed between begin and end.
Example:
esim_reporter ­­ccds "begin 1 end" \
­­grades "begin 1 2 end" \
­­fields "begin energy1 camerZ cameraY end" \
< esim.out
8 Acknowledgments
We wish to thank the following people for their help:
SRON Timo Bootsma, Jan Willem den Herder
Leicester University Tony Abbey, Mike Denby, Andrew Holland
MPI Garching Martin Popp Lothar Struder
ESTEC/ESA Christian Erd, Fred Jansen, David Lumb, Alan Owens, Giuseppe Vacanti, Igor Zayer