VITESS Modules to simulate Propagation and Apertures

There are 5 modules that can be used to simulate propagation of the neutrons to a certain area, where it may pass an aperture: space, slit, spacewindow, spacewindow_multiple and grid. They all take into account gravity (if this option is chosen). Space propagates the neutrons over a certain distance and takes into account attenuation (in air). Slit propagates the neutrons over a certain distance to a rectangular window centered around the beam axis. Spacewindow propagates the neutrons over a certain distance to a rectangular or circular window whose center might be out of the center of the beamline. It can consider attenuation inside the window and non-perfect absorption outside the window and can also be used as a beamstóp. Additionally, it has some filter options.
Spacewindow_multiple works like Spacewindow, but can treat up to 100 rectangular or circular windows in any geometry. It is described in spacewindow_multiple.html
Their x-coordinates are reset to 0 (as in most others modules) after finishing the propagation. gridsimulates a regular set of N x M apertures of equal size. A series of such ensembles of apertures which can be used for collimation in SANS instruments.



VITESS Module 'space' to simulate Propagation over a Certain Distance

The module space simply simulates the propagation over a certain distance. An attenuation inside the medium can be considered by giving the macrosopic absorption and total scattering cross-section. The macroscopic cross-section can be calculated from the microscopic cross-section by multipyling with the particle density.

Parameters for module 'space'

Parameter
Unit
Description
Range or Values
Command Option
distance
[cm]
distance from the origin (usually the exit of the previous component) to a plane vertical to the x-axis where the next component begins >= 0 -d
total scattering
[1/cm]
macroscopic total scattering cross-section >= 0 -M
absorption
[1/cm]
macroscopic absorption cross-section for 1.798 Ã
The absorption cross-section for the wavelength under consideration is calculated in the module from this value.
>= 0 -m


VITESS Module 'slit' to simulate Propagation to a Rectangular Slit

The module slit simulates the propagation to a rectangular window in a certain distance, which is centered around the beam axis and has its normal vector along the x-axis. Only those neutrons hitting the window are considered further. This common case can be easily handled using this simple module. In all other cases the module spacewindow has to be used.

Parameters for module 'slit'

Parameter
Unit
Description
Range or Values
Command Option
distance
[cm]
the distance from the origin (usually the exit of the previous component) to the slit along the x-axis >= 0 -d
width
[cm]
width of the rectangular slit >= 0 -W
height
[cm]
height of the rectangular slit >= 0 -H


VITESS Module 'spacewindow' to simulate Propagation to a Rectangular or Circular Aperture

The module spacewindow simulates free propagation of neutrons (from x=0) to a rectangular or circular window. The (rectangular) window can be rotated about the x-axis. There is the possibility to let only neutrons of a certain range in flight direction and a certain color pass.
The window may have a thickness, an inner and/or an outer material. In case of ideal transmission inside and ideal absorption outside, only those hitting the window are considered further on. Otherwise, attenuation is calculated for neutrons passing inside (inner material) or outside (outer material).
There is also the possibility to simulate a beamstop by defining a negative window, where neutrons pass outside and are absorbed inside. But it is a better choice to use the module beamstop for that. To simulate beamstops and windows between sample and detector, the option 'use previous frame' has been included. It prevents the usual shift of the origin to the center of the window, thus leaving the origin in the center of the sample, which is necessary for a proper working of the detector module.
Two kinds of material can be chosen. Outer material denotes the material of the window frame absorbing neutrons outside the window. Inner material denotes the material of the window pane (if any) through which the neutrons have to pass. For each material used, the thickness has to be given. Setting the thickness of the material to zero means ideal absorption for the outer and ideal transmission for the inner material. For both kinds of materials, a file describing the absorption can be given (see below). If the file is given, the treatment of transmission is activated, otherwise the ideal transmission/absorption is assumed. For the window frame, there is also the option to choose from a number of absorbing materials.
The file format describing the transmission is:

    First column : wavelength  [Å] 
    Second column: attenuation [1/cm] 
  
For the outer materials, the following options exist
    Value 0 - data from file (created by user)
    Value 1 - Gadolinium.
    Value 2 - Cadmium.
    Value 3 - Bor10.
    Value 4 - Europium
    Value 5 - Silicon.
    Value 6 - Ideal absorption
  
For materials 1 - 4, the maximal wavelength range is 0.3 ... 28 Å. For silicon, the maximal wavelength range is 1 .. 20 Å (Data from Thomas Krist, HZB, Berlin)
Note that the wavelength values must appear in the table in ascending order from shortest to longest wavelength

Parameters for module 'Spacewindow'

Parameter
Unit
Description
Range or Values
Command Option
distance orig. <-> win
[cm]
the distance from the origin (usually the exit of the previous component) to the center of the window. It is the projection of the vector from the origin to center of the window on the x-axis >= 0 -l
window shape shape of the window
circular : circular window defined by its center (relative to beam axis) and radius
rectangular: rectangular window defined by the distances from the 4 edges to the center of the beam axis
circular, rectangular -R
radius
[cm]
radius of the circular window >= 0 -r
center y
center z
[cm]
horizontal (y) and vertical (z) position of the center of the window relative to the center of the beam axis >= 0 -y
-z
min. y
max. y
[cm]
right and left edge of the rectangular window relative to the center of the beam axis >= 0 -w
-W
min. z
max. z
[cm]
lower and upper vertical edge of the rectangular window relative to the center of the beam axis >= 0 -h
-H
rot. angle
[deg]
rotation of the window about the (negative) x-axis
 0 deg: height along the z-axis (upwards)
90 deg: height along the y-axis (to the left)
[-180,180] deg -A
used as beamstop yes: negative window: absorption inside and transmission outside
no : normal window: transmission inside
If a 3D treatment is not needed, it is easier to use the module beamstop instead then.
'no', 'yes' -S
use previous frame yes: origin of the co-ordinate system remains unchanged
no : x-ordinate is shifted to the exit of the window (default)
Prevention of the shift of the origin is necessary for beamstops and windows between sample and detector
'no', 'yes' -F
treat color filter: Treat only events with a given color. A negative number means any color
This option will be removed in VITESS 4. Please, use module filter instead in the future.
-1,0, 1 ... -f
remove other colors defines what to do with trajectories of the wrong color:
'yes': remove all trajectories with the wrong color
'no' : ignore the window and propagate all neutrons to its exit
This option will be removed in VITESS 4. Please, use module filter instead in the future.
-1,0, 1 ... -d
min. phi
max. phi
[deg]
filter: minimal and maximal flight direction phi
phi is the projection of the flight direction to the y-z-plane
0° negative z-axis, 90° negative y-axis, 180° positive z-axis, 270° positive y-axis,
A negative value for minimum or maximum means that the whole range is allowed.
This option will be removed in VITESS 4. Please, use module filter instead in the future.
[0°,360°] -p, -P
outer transmission file File containing the wavelength dependent attenuation (see desription itn the text) inside the frame of the window
This is for the window option only, for the beamstop option, vacuum is assumed around the beamstop material.
-C
thickness of frame
[cm]
Thickness of the material used for the absorbing window frame
The frame must be at least as thick as the pane. Both, frame and pane are centered around the distance to the origin. (cf. figure below)
≥ 0 -t
frame material Material used for the absorbing window frame
This is for the window option only, for the beamstop option, vacuum is assumed around the beamstop material.
-c
inner transmission file File containing the wavelength dependent attenuation (see desription itn the text) inside the window pane or the beamstop -m
thickness of window
[cm]
Thickness of the material used for the window pane or the beamstop
The pane cannot be thicker than the frame. Both, frame and pane are centered around the distance to the origin. (cf. figure below)
≥ 0 -T



VITESS Module 'spacewindow_multiple' to simulate Propagation to a Ensemble of Apertures

The module multiplewindows simulates free propagation of neutrons from (x=0) to the multi-aperture circular collimator (circular slits) or just characterising a space region of interest. The influence of gravity can be included in the calculation or omitted(-G option, values 1 or 0). If gravity is included, neutrons travel from plane x=0 to the collimator plane on parabolic trajectories. This is very useful for simulating a SANS (pinhole collimation) instrument with long distances for the long wavelength range. This collimator represents a window with multiple holes (with an ideally absorbing circular plate) transmitting the neutrons. The radius of the circular plate has to be given by the user. The radius and center position of each hole is described in the parameter file, which must be created by the user. 


The format of parameter file: Y, Z give the center position of the hole, R the radius of the hole.
Example (two holes):
-10 0.0 2.0
0.0 10.0 3.0
The number of holes for each collimator must be < 100. The number of lines is equal to the number of holes in the multiple collimator. The neutrons at x=0 has been calculated by the previous module (naturally they may differ in y and z-coordinates, divergence, wavelength and time) and those hitting the holes (or outside of circular plate) are considered further on in case of ideal transmission or transmited via the "inner material of collimator". Other neutrons are absorbing in case of ideal absorption or transmitting via the "outer material of collimator".
Their x-coordinates are reset to 0 as is usually  done by most of the modules after finishing their specific calculations.

Also the module calculates the center of the beam at the collimator plate and the time of flight. The user must give the outer radius of the circular plate and the distance from the former module to the plate along the x-axis. (The plate must be perpendicular to the x-direction). An example of visualization with such a parameter file is given below:
(For visualization use the module monitor or visual (see visual module help file))

with
-4.0 0.0 1.3
3.5 0.0 1.3
0.0 3.5 1.3
0.0 -3.5 1.3
0.0 0.0 1.3
-2.5 2.5 1.3
2.5 -2.5 1.3
2.5 2.5 1.3
-2.5 -2.5 1.3
 
---------------------------------------------
There are two kinds of material can be chosen. Outer material is meaning the "absorbtion" material for the collimator. Inner material is meaning the "transmission" material for the collimator. The thickness for the each material must be given too. If the thickness of material is given zero, so for outer material is meaning the ideal absorbtion. For the inner material is meaning the ideal transmission.

For the inner material data can be red from the file, which has the structure, given below. If the file is given, the exp. transmission is activating automaticly, otherwise the ideal transmission is acivated.


List of outer materials, which are included in the module
Value 0 - Read data from file, which created by user
Value 1 - Gd: Gadolinium.
Value 2 - Cd: Cadmium.
Value 3 - B: Bor10.
Value 4 - Eu
Value 5 - Si: Silicon.
Value 6 - Ideal absorbtion
For values 1-4 wavelength range must be 0.3 ... 28 A in the source module or virtual source
Foe value 5 wavelength range must be 1 .. 20 A in the source module or virtual source
This data was given by Thomas Krist, HMI, Berlin.

The format of file, which is describing the transmission is:
Wavelength, A Value MU, cm^(-1)
...............................................................

The wavelength values in the table must be increasing!!!
Then, the transmission is calculated by formula: Transmission = exp(-MU*Distance);
where Distance is length of flight of neutron in given material in cm, which calculated automaticly. During passing the neutrons via material, the Transmission is multiply on the neutron probability.

Please note.
The wavelength range must be from smallest to longest wavelength in the table. If you used material from list and/or material from file, please choose the minimal and maximum wavelength values in the source module (or virtual source), which do not extend the wavelength range for the absorption (outer) and transmission (inner) materials.

Parameters for module 'Spacewindow_multiple'

Parameter
Unit
Description
Range or Values
Command Option
collimator file File containing data defining the windows. Each line must contain 3 or 4 numbers:
y, z, radius for circular windows or y, z, width, height
The number of holes for each collimator must be less than 100.
-I
distance orig. <-> win
[cm]
the distance from the origin (usually the exit of the previous component) to the center of the window. It is the projection of the vector from the origin to center of the window on the x-axis >= 0 -D
Outer radius
[cm]
Outer radius of the circular plate (multiaperture collimators) >= 0 -r
window shape shape of the individual windows
circular : circular window defined by its center (relative to beam axis) and radius
rectangular: rectangular window defined by the center position (y,z), width and height
automatic : 3 numbers give circular, 4 nambers give rectangular shape
circular, rectangular, automatic -S
outer tranmsission file File containing the wavelength dependent attenuation (see desription itn the text) inside the frame of the window -C
thickness of frame
[cm]
Thickness of the material used for the absorbing window frame >= 0 -t
frame material Material used for the absorbing window frame -c
inner transmission file File containing the wavelength dependent attenuation (see desription itn the text) inside the window pane -m
thickness of window
[cm]
Thickness of the material used for the window pane >= 0 -T


VITESS Module 'grid' to simulate Propagation to a Multi-Aperture Collimator

The module grid simulates the propagation of neutrons from the origin (x=0, previous module, e.g. the previous grid item) to a multi-aperture collimator of rectangular or circular holes and outer shape. This grid collimator represents a disk with multiple rectangular or circular apertures transmitting neutrons. The size of the circular or rectangular disk and the distance from the former module to the current disk (along the x-axis) have to be given by the user. (The disk must be perpendicular to the x-direction.)
The size and center position of each aperture is defined in a parameter file, which has to be created by the user (see example below). The collimator disk can be shifted horizontally and/or vertically. The vertical shifting is useful to consider gravitational effects.
Deviations of some parameters from ideal values can be simulated (see table below).

The vertical shift can be calculated automatically by the module, if the parameters belonging to 'Gravity Option' are set. At the same time, the ideal sizes of the aperatures are calculated from the length of the grid system and the distance between the beginning of the grid system and the current grid. In this case, the file describing the first grid item is sufficient for the whole grid system; otherwise a file has to be written for each grid item.

Non-ideal absorption in the plate can also be treated. The transmission is calculated then as:

   Transmission = exp(-μ*pathlen) 

where 'pathlen' is the length of the path of the neutron in the given material, (which is calculated automatically from the thickness of the material). The x-coordinates are reset to 0 (as usual) at the end of the treatment in this module.

Parameter file defining the holes

The user has to create a file describing the windows of the grid system. The number of lines is equal to the number of holes in the multiple collimator grid. The format of each line is like this:
1st column: (y-coordinate): horizontal position of the center of the aperture
2nd column: (z-coordinate): vertical position of the center of the aperture
3rd column: width = height of the hole

Example:
4 quadratic holes of 1 x 1 cm2 in a distance of 1.2 cm (horizontally and vertically) would look like that:

#   y     z   width
#----------------------
  -0.6  -0.6   1.0  
   0.6  -0.6   1.0
  -0.6   0.6   1.0 
   0.6   0.6   1.0

Parameters for module 'grid'

Parameter
Unit
Description
Range or Values
Command Option
holes description file that characterizes the positions and sizes of the apertures of the grid (see table above) - -I
shape of the grid shape of the holes and the collimator disk containing the holes 'circular'
'square'
-N
crosstalk analysis 'yes': analysis of cross-talk between channels within the grid system activated
'no' : no analysis of cross-talk
'no'
'yes'
-K
distance to grid
[cm]
distance from the previous module, e.g. the previous item of the grid system, to the current item (along the beam direction, i.e. x-axis) >=0 -D
horizontal/vertical shift
[cm]
horizontal/vertical shift of the collimation disk any -d
-e
thickness of the disk
[cm]
thickness of the material used for the collimation disk >=0 -t
size of the grid disk
[cm]
for circular outer shape : radius of the disk
for rectangular outer shape: width of the dísk
>0 -a
vert. size of the disk
[cm]
for rectangular outer shape: height of the disk >0 -b
material description file for 'material from file':
File that characterizes the transmission of the material of the collimation disk
- -C
material material of the grid disk:
'from file' needs a 'material description file' as input
in all other cases the necessary data are in the program
'from file'
'gadolinum'
'cadmium'
'bor-10'
'Eu'
'silicon'
'ideal absorber'
-c
Deviation: distance to grid
[cm]
random deviation Δd from the defined distance d between the previous module (e.g. the previous grid item) and the current grid item
a linear distribution within [d-Δd, d+Δd] is assumed
>=0 -X
Deviation: horizontal/vertical position
[cm]
random deviation ΔX of the horizontal/vertical position X of the collimator disk
a linear distribution within [X-ΔX, X+ΔX] is assumed
≥0 -y
-q
Deviation: size of the window
[cm]
random deviation Δs of the size s of the individual apertures in the collimation disk
a linear distribution within [s-Δs, s+Δs] is assumed
≥0 -h
-H
Deviation: center of window
[cm]
random deviation Δx of the center position x of the individual apertures in the collimation disk
a linear distribution within [x-Δx, x+Δx] is assumed
>=0 -h
-H
Pos. in grid system
[cm]
distance from the first item in the grid system to the current item
used to calculate the ideal position of this grid item and the sizes of its apertures
>0 -M
Half length of grid system
[cm]
half the distance from the beginning of the grid system to the focal point, usually the detector
used to calculate the ideal position of this grid item and the sizes of its apertures
>0 -m
standard wavelength
[Ã…]
wavelength for which the grid system is calculated >0 -n

Back to VITESS overview
vitess@fz-juelich.de

Last modified: Tue May 8 17:08:06 MET DST 2001