The `Monitor_nD` component

This component is a general Monitor that can output 0/1/2D signals (Intensity vs. [something] and vs. [something] ...)

Identification

Author: Emmanuel Farhi
Origin: ILL (France)
Date: 14th Febrary 2000.
Version: 0.13.2
Modification history:
- EF, 29th Feb 2000 : added more options, monitor shape, theta, phi
- EF, 10th Mar 2000 : use struct

Description

This component is a general Monitor that can output 0/1/2D signals 
It can produce many 1D signals (one for any variable specified in 
option list), or a single 2D output (two variables related).
Also, an additional 'list' of neutrons can be produced.
By default, monitor is square (in x/y plane). disk is also possible
The 'cylinder' option will change that for banana shaped detector
The 'sphere' option simulates spherical detector.


Possible options are
Variables to record:
    kx ky kz k wavevector (Angs-1)
    vx vy vz v            (m/s)
    x y z radius          (m)      Distance
    t time                (s)      Time of Flight
    energy omega          (meV)
    lambda wavelength     (Angs)
    p intensity flux      (n/s) or (n/cm^2/s)
    ncounts               (1)
    sx sy sz              (1)      Spin
    vdiv                  (deg)    vertical divergence
    hdiv divergence       (deg)    horizontal divergence
    angle                 (deg)    divergence from  direction
    theta longitude       (deg)    longitude (x/z)
    phi   lattitude       (deg)    lattitude (y/z)

Other options are:
    auto {limits}             automatically set detector limits
    all  {limits or bins}     to set all limits or bins values
    bins=[bins=20]            Number of bins in the detector along dimension
    borders                   to also count off-limits neutrons
                              (X < min or X > max)
    cylinder                  to get a cylindrical monitor (e.g. banana)
                              (radius along x, height along y).
    disk                      disk flat xy monitor
                              radius is max abs value of xmin xmax ymin ymax
    file=string               Detector image file name
                              default is component name, plus variable ext.
    square                    square flat xy monitor
    limits=[min max]          Lower/Upper limits for axes
                              (see below for the variable unit)
    list=[counts=1000] or all for a long file of neutron characteristics
                              with [counts] events
    multiple                  for 1D monitors into multiple independant files
    no or not                 revert next option
    outgoing                  monitor outgoing beam in non flat (sph/cyl) det
                              (default is incoming beam)
    per cm2                   intensity will be per cm^2
    slit or absorb            absorb neutrons that are out detector
    sphrere                   to get a spherical monitor (e.g. a 4PI)
                              radius is max abs value of xmin xmax ymin ymax
    unactivate                to unactivate detector (0D detector)
    verbose                   to display additional informations

EXAMPLES:
 Monitor_nD(
  xmin = -0.1, xmax = 0.1,
  ymin = -0.1, ymax = 0.1,
  options = "intensity per cm2 angle,limits=[-5 5] bins=10,with
             borders, file = mon1");
                          will monitor neutron angle from [z] axis, between -5
                       and 5 degrees, in 10 bins, into "mon1.A" output 1D file
  options = "sphere theta phi outgoing"   for a sphere PSD detector (out beam)
  options = "angle radius auto limits"   is a 2D monitor with automatic limits
  options = "list kx ky kz energy" records each neutron contribution in 1 file
  options = "multiple kx ky kz energy and list all neutrons" 
         makes 4 output 1D files and produces a complete list for all neutrons

Input parameters

Parameters in boldface are required; the others are optional.

Name	Unit	Description
xmin	m	Lower x bound of opening
xmax	m	Upper x bound of opening
ymin	m	Lower y bound of opening
ymax	m	Upper y bound of opening
options	str	String that specify the configuration of the monitor The general syntax is "[x] options..." (see Descr.)

Output parameters

Name	Unit	Description	Default
Nsum
psum
p2sum
Mon2D_N
Mon2D_p
Mon2D_p2
area
Coord_Type
Flag_With_Borders
Flag_Verbose
Flag_per_cm2
Coord_Label
Coord_Var
Monitor_Label
Flag_List
Flag_Multiple
Coord_Number
Coord_Bin
Coord_Min
Coord_Max
Buffer_Block
Mon_File
Mon2D_Buffer
Flag_Absorb
Neutron_Counter
Buffer_Counter
Buffer_Size
Flag_Shape
Sphere_Radius
Cylinder_Height
Flag_Auto_Limits

The Monitor_nD component

Identification

Description

Input parameters

Output parameters

Links

The `Monitor_nD` component