Initial revision
This commit is contained in:
144
doc/user/histogram.htm
Normal file
144
doc/user/histogram.htm
Normal file
@ -0,0 +1,144 @@
|
||||
<html>
|
||||
<head>
|
||||
<title> Histogram memory</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Histogram memory</h1>
|
||||
<hr size=4 width="66%">
|
||||
<p>
|
||||
Histogram memories are used in order to control large area sensitive
|
||||
detectors or single detectors with time binning information.
|
||||
Basically each detector maps to a defined memory location. The
|
||||
histogram memory wizard takes care of putting counts detected in the
|
||||
detector into the proper bin in memory. Some instruments resolve energy
|
||||
(neutron flight time) as
|
||||
well, than there is for each detector a row of memory locations mapping to
|
||||
the time bins. As usual in SICS the syntax is the name of the histogram
|
||||
memory followed by qualifiers and parameters. As a placeholder for the
|
||||
histogram memories name in your system, HM will be used in the following
|
||||
text.
|
||||
</p>
|
||||
<p>
|
||||
A word or two has to be lost about the SICS handling of preset values for
|
||||
histogram memories.
|
||||
Two modes of operation have to be distinguished: counting until a timer has passed,
|
||||
for example: count for 20 seconds. This mode is called timer mode. In the other
|
||||
mode, counting is continued until a control monitor has reached a certain
|
||||
preset value. This mode is called Monitor mode. The preset values in Monitor
|
||||
mode are usually very large. Therefore the counter has an exponent data variable.
|
||||
Values given as preset are effectively 10 to the power of this exponent. For
|
||||
instance if the preset is 25 and the exponent is 6, then counting will be
|
||||
continued until the monitor has reached 25 million. Note, that this scheme with
|
||||
the exponent is only in operation in Monitor mode.
|
||||
</p>
|
||||
|
||||
<h2> Configuration</h2>
|
||||
<p>
|
||||
A HM has a plethora of configuration options coming with it which define
|
||||
memory layout, modes of operation, handling of bin overflow and the like.
|
||||
Additionally there are HM model specific parameters which are needed
|
||||
internally in
|
||||
order to communicate with the HM. In
|
||||
most cases the HM will already have been configured at SICS server startup
|
||||
time. However, there are occasion where these configuartion option need to
|
||||
enquired or modified at run time. The command to enquire the current value
|
||||
of a configuration option is: <b>HM configure option</b>, the command to set it is:
|
||||
<b> HM configure option newvalue</b>. A list of common configuration options and their
|
||||
meaning is given below:
|
||||
<DL>
|
||||
<DT> HistMode
|
||||
<DD> HistMode describes the modes of operation of the histogram memory.
|
||||
Possible values are:
|
||||
<UL>
|
||||
<LI>Transparent, Counter data will be written as is to memory. For debugging
|
||||
purposes only.
|
||||
<LI> Normal, neutrons detected at a given detector will be added to the
|
||||
apropriate memory bin.
|
||||
<LI> TOF, time of flight mode, neutrons found in a given detector will be
|
||||
put added to a memory location determined by the detector and the time
|
||||
stamp.
|
||||
<LI> Stroboscopic mode. This mode serves to analyse changes in a sample due
|
||||
to an varying external force, such as a magnetic field, mechanical stress
|
||||
or the like. Neutrons will be stored in memory according to detector
|
||||
position and phase of the external force.
|
||||
</UL>
|
||||
<DT> OverFlowMode
|
||||
<DD> This parameter determines how bin overflow is handled. This happend
|
||||
when more neutrons get detected for a particular memory location then are
|
||||
allowed for the number type of the histogram memory bin. Possible values
|
||||
are:
|
||||
<UL>
|
||||
<LI>Ignore. Overflow will be ignored, the memory location will wrap around
|
||||
and start at 0 again.
|
||||
<LI>Ceil. The memory location will be kept at the highest posssible value
|
||||
for its number type.
|
||||
<LI>Count. As Ceil, but a list of overflowed bins will be maintained.
|
||||
</UL>
|
||||
<DT> Rank
|
||||
<DD> Rank defines the number of histograms in memory.
|
||||
<DT> Length
|
||||
<DD> gives the length of an individual histogram.
|
||||
<DT> BinWidth
|
||||
<DD> determines the size of a single bin in histogram memory in bytes.
|
||||
<DT>dim0, dim1, dim2, ... dimn
|
||||
<DD>define the logical dimensions of the histogram. Must be set if the
|
||||
the sum command (see below) is to be used. This is a clutch necessary to
|
||||
cope with the different notions of dimensions in the SINQ histogram memory
|
||||
and physics.
|
||||
</DL>
|
||||
For time of flight mode the time binnings can be retrieved and modified with
|
||||
the following commands. Note that these commands do not follow the configure
|
||||
syntax given above. Please note, that the usage of the commands for
|
||||
modifying time bins is restricted to instrument managers.
|
||||
<DL>
|
||||
<DT>HM timebin
|
||||
<DD> Prints the currently active time binning array.
|
||||
<DT>HM genbin start step n
|
||||
<DD>Generates a new equally spaced time binning array. Number n time bins
|
||||
will be generated starting from start with a stepwidth of step.
|
||||
<DT>HM setbin inum value
|
||||
<DD>Sometimes unequally spaced time binnings are needed. These can be
|
||||
configured with this command. The time bin iNum is set to the value value.
|
||||
<DT>HM clearbin
|
||||
<DD>Deletes the currently active time binning information.
|
||||
</DL>
|
||||
</p>
|
||||
|
||||
<h2>Histogram Memory Commands</h2>
|
||||
<p>
|
||||
Besides the configuration commands the HM understands the following
|
||||
commands:
|
||||
<DL>
|
||||
<DT>HM preset
|
||||
<DD> with a new value sets the preset time or monitor for counting. Without a
|
||||
value prints the current value.
|
||||
<DT>HM exponent
|
||||
<DD> with a new value sets the exponent to use for the preset time
|
||||
in Monitor mode. Without a
|
||||
value prints the current value.
|
||||
<DT>CountMode
|
||||
<DD> with a new values sets the count mode. Possible values are Timer for a
|
||||
fixed counting time and Monitor for a fixed monitor count which has to be
|
||||
reached before counting finishes. Without a value print the currently active
|
||||
value.
|
||||
<DT>HM init
|
||||
<DD> after giving configuration command sthis needs to be called in order to
|
||||
transfer the configuration from the host computer to the actual HM.
|
||||
<DT>HM count
|
||||
<DD> starts counting using the currently active values for CountMode and
|
||||
preset. This command does not block, i.e. in order to inhibit further
|
||||
commands from the console, you have to give Success afterwards.
|
||||
<DT>HM InitVal val
|
||||
<DD> initialises the whole histogram memory to the value val. Ususally 0 in
|
||||
order to clear the HM.
|
||||
<DT> HM get i iStart iEnd
|
||||
<DD> retrieves the histogram number i. A value of -1 for i denotes retrieval
|
||||
of the whole HM. iStart and iEnd are optional amd
|
||||
allow to retrieve a subset of a histogram between iStart and iEnd.
|
||||
<DT>HM sum d1min d1max d2min d2max .... dnmin dnmax
|
||||
<DD>calculates the sum of an area on the detector. For each dimension a
|
||||
minimum and maximum boundary for summing must be given.
|
||||
</DL>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user