Skip to content
Snippets Groups Projects
Commit c1240f92 authored by Alex Buts's avatar Alex Buts
Browse files

refs #9581 LoadDetectorInfo description 

and small changes to number of other files.
parent ae2118ed
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 271 additions and 8 deletions
Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadDetectorInfo.h
+ 1
− 1
View file @ c1240f92
...@@ -40,7 +40,7 @@ namespace Mantid ...@@ -40,7 +40,7 @@ namespace Mantid
/// Algorithm's name for identification overriding a virtual method /// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "LoadDetectorInfo"; } virtual const std::string name() const { return "LoadDetectorInfo"; }
///Summary of algorithms purpose ///Summary of algorithms purpose
virtual const std::string summary() const {return "Loads delay times, tube pressures and tube wall thicknesses from a given file.";} virtual const std::string summary() const {return "Loads delay times, tube pressures, tube wall thicknesses and, if necessary, the detectors positions from a given special format file";}
/// Algorithm's version for identification overriding a virtual method /// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; } virtual int version() const { return 1; }
......
Code/Mantid/Framework/DataHandling/src/LoadDetectorInfo.cpp
+ 4
− 4
View file @ c1240f92
...@@ -42,7 +42,7 @@ namespace Mantid ...@@ -42,7 +42,7 @@ namespace Mantid
{ {
declareProperty(new WorkspaceProperty<>("Workspace","",Direction::InOut), declareProperty(new WorkspaceProperty<>("Workspace","",Direction::InOut),
"The name of the workspace to that the detector information will be loaded into"); "The name of the workspace to that the detector information will be loaded into.");
std::vector<std::string> exts; std::vector<std::string> exts;
// each of these allowed extensions must be dealt with in exec() below // each of these allowed extensions must be dealt with in exec() below
exts.push_back(".dat"); exts.push_back(".dat");
...@@ -50,11 +50,11 @@ namespace Mantid ...@@ -50,11 +50,11 @@ namespace Mantid
exts.push_back(".sca"); exts.push_back(".sca");
exts.push_back(".nxs"); exts.push_back(".nxs");
declareProperty(new FileProperty("DataFilename","", FileProperty::Load, exts), declareProperty(new FileProperty("DataFilename","", FileProperty::Load, exts),
"A .raw,.dat,.nxs or .sca file that contains information about the detectors in the " "A **raw, dat, nxs** or **sca** file that contains information about the detectors in the "
"workspace. The description of Dat and nxs file format is provided below."); "workspace. The description of **dat** and **nxs** file format is provided below.");
declareProperty("RelocateDets", false, declareProperty("RelocateDets", false,
"If true then the detectors are moved to the positions specified in the raw/dat/nxs file.", "If true, the detectors are moved to the positions specified in the file defined by the field above.",
Direction::Input); Direction::Input);
} }
......
Code/Mantid/docs/source/algorithms/LoadDetectorInfo-v1.rst
+ 257
− 1
View file @ c1240f92
...@@ -6,8 +6,264 @@ ...@@ -6,8 +6,264 @@
.. properties:: .. properties::
.. |AlphaX| replace:: :math:`\alpha_{x}`
.. |AlphaY| replace:: :math:`\alpha_{y}`
.. |AlphaZ| replace:: :math:`\alpha_{z}`
Description Description
----------- ------------
The algorithm loads specific detector properties and, if *RelocateDets* property is true, the detector positions into the instrument,
attached to the target workspace and modifies these properties as described below.
The detection time delay for each detector is subtracted from the time of flight bin boundaries in the spectrum associated with that detector.
It is required that all the monitors have the same time delay and if this is non-zero the delay time is added to all TOF values.
It is important that the units of the input workspace are TOF in microseconds, that :ref:`algm-GroupDetectors`
has not been run and this algorithm is only applied once to a workspace.
Values for the partial pressure of **3He** and **wall thickness** are added into the parameter map for each detector
in a form that can be read by :ref:`algm-DetectorEfficiencyCor`. That is, the values are assumed to be in atmospheres
and meters, respectively, and the properties are stored internally in the workspace parameter map as **3He(atm)** and **wallT(m)**.
The values are likely to be read from the same **RAW** file that the workspace was loaded from or a
**DAT** file that corresponds to the same run or series of experimental runs.
Spectra whose associated detector data are not found in the input **DAT** or **RAW** file will not have their
time of flight bin boundaries adjusted. Similarly nothing will be written to the parameter map for those detectors,
the algorithm will continue to process data as normal but a warning will be written to the log.
Detectors that are listed in the input file but do not exist in the instrument definition file will be ignored and details will be written to the log.
If all the time offsets are the same and the file **appears** to contain enough data for all detectors
all detector spectra will use same bin boundaries, where possible.
This will make the algorithm run much more quickly and use less memory.
When using a **RAW** file the time offset for each detector is read from the "hold off" table in the file's
header while pressure and wall thickness data must be present in the user table array.
The format for **.DAT** files is specified in the document **DETECTOR.DAT format** written by Prof G Toby Perring and briefly described below.
If the RelocateDets option is set to true, (it is false by default)
then the detectors are moved to the corresponding positions specified in the data file provided.
Related or similar algorithms
##############################
See :ref:`algm-UpdateInstrumentFromFile` which can do similar job in modifying the detector parameters and positions and accepting arbitrary ASCII files.
**Detectors.dat** data format
#############################
The the detector data can be stored as ASCII or `NeXus http://download.nexusformat.org/`_ data file.
The description of the ASCII DETECTOR.dat file is provided in the table below. Nexus file format can come in two flavors.
The first one is completely equivalent to the ASCII 19 column data format and introduced to increase the speed of accessing these data in binary format,
where the second one left for the compatibility with Libisis.
It has meaningful data corresponding to the columns 1-6, 17&18 below, but does not support multiple tube pressures and wall thickness.
The :ref:`algm-LoadDetectorInfo` algorithm currently reads and interprets rows 1-6,17&18 of the table,
provided below (or columns of det.dat file) or correspondent data blocks from the NeXus file.
It also does not understand the short (15 columns) MARI detector.dat ASCII file format (see **ISIS detector.dat files** below).
Co-ordinate frames
##################
For the purposes of the detector table we choose a right handed set of axes fixed in the spectrometer:
- x-axis -- horizontal
- y-axis -- vertical
- z-axis -- parallel to :math:`k_{i}`
Centers of each detector element are defined in spherical polar co-ordinates as seen from the sample position:
- **THETA** -- Polar angle measured from the z-axis (what we would normally call the scattering angle PHI). Note that 0< **THETA** <180
- **PHI** -- Azimuthal angle measured from the x-axis in a right handed sense (what TGP, CDF and RD01 call -BETA).
For example, the West Bank of HET has PHI=0, the North Bank has PHI=90, the South Bank has PHI=270.
To specify the orientation of a detector, define axes x', y', z' as follows:
- x'-axis -- increasing THETA
- y'-axis -- increasing PHI
- z'-axis -- parallel to the line joining sample and detector
The natural coordinate frame for the detector, xd, yd, zd, may not coincide with x', y', z'.
For example, the natural frame for a gas tube is with zd along the axis of the tube, and the direction of xd chosen to be perpendicular to the line joining the detector with the sample.
The characteristic dimensions of the detector, W_x, W_y, W_z, are given in the frame xd, yd, zd.
The detector coordinate axes xd, yd, zd are related to x', y', z' by a rotation.
The transformation is be expressed by a three-component vector
:math:`\alpha_{x},\alpha_{y},\alpha_{z}`, where the magnitude of the vector gives the angle of rotation in a right-hand sense,
and the normalized elements give the components along x', y', z' of the unit vector about which the rotation takes place.
The magnitude of the vector is in degrees.
- e.g. non-PSD gas tube on the Debye-Scherrer cone:
:math:`\alpha_{x} = -90^{o};\alpha_{y} = \alpha_{z} = 0^{o}; Wx = Wy = 0.0254, Wz = 0.300`
- e.g. Davidson bead monitor filling the HET beam at the monitor_2 position:
:math:`\alpha_{x} =\alpha_{y}= \alpha_{z} = 0^{o}; Wx = Wy = 0.045, Wz = 0.00025`
Note that for PSD detectors the angles and dimensions refer to the pixel, not the whole tube. For HET, Wz = 0.914/64 = 0.01428.
File format
###########
The file consists of number of ASCII columns, separated by spaces. All distances are in meters, and all angles in degrees.
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| Column Number | Column Name | Column Type | Column Description |
+===============+=============+=============+=======================================================================================================+
| 1 | DET_NO | integer | Detector index number as in SPECTRA.DAT |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 2 | DELTA | real | Electronics delay time ( :math:`\mu s` ). The origin is up to you. HOMER uses the peak in monitor_2 |
| | | | as the origin of time, so the only thing that really matters is the difference in the delay |
| | | | time between the detectors and the monitors. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 3 | L2 | real |Sample - detector distance (m) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 4 | CODE | integer | Code number that describes the detector type. Up to now this column has |
| | | | been redundant so the old files can contain unity for all detectors. |
| | | | Proper detectors should now follow the scheme: |
| | | | |
| | | | 0. Dummy detector entry (see later) |
| | | | 1. Davidson scintillator bead monitor (or just monitor) |
| | | | 2. non-PSD gas tube |
| | | | 3. PSD gas tube |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 5 | THETA | real |Scattering angle (deg) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 6 | PHI | real |Azimuthal angle (deg). Origin and rotation sense defined above |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 7 | W_x | real |True detector dimensions (m) in the frame xd' |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 8 | W_y | real |True detector dimensions (m) in the frame yd' |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 9 | W_z | real |True detector dimensions (m) in the frame zd' |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 10 | F_x | real | False detector dimensions (m) in the frame xd' to avoid gaps between detectors |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 11 | F_y | real |False detector dimensions (m) in the frame yd' to avoid gaps between detectors |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 12 | F_z | real |False detector dimensions (m) in the frame zd' to avoid gaps between detectors |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 13 | |AlphaX| | real | x-coordinate of the vector describing orientation of detector in the co-ordinate frame defined above. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 14 | |AlphaY| | real | y-coordinate of the vector describing orientation of detector in the co-ordinate frame defined above. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 15 | |AlphaZ| | real | z-coordinate of the vector describing orientation of detector in the co-ordinate frame defined above. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| The columns with numbers higher then those described above contain information about the detectors that is dependent on the detector type: |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| **CODE = 0 (Dummy detector entry)** : |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 16 | det_1 | real | Frequently, some of the inputs to the data acquisition electronics do not have any detectors |
| | | | plugged into them. To ensure that any noise on these inputs is safely directed to a 'dust-bin' |
| | | | spectrum, they are given detector numbers which are associated with spectrum 0 in SPECTRA.DAT. |
| | | | Dummy entries in DETECTOR.DAT are required for each of these dummy detectors. |
| | | | These entries should be given detector CODE = 0, which will be used to indicate that the other |
| | | | entries in DETECTOR.DAT can be ignored. For the sake of clarity, set all DELTA, L2...DET_4 to |
| | | | zero for dummy detectors. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 17 | det_2 | real | The same as 16 |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 18 | det_2 | real | The same as 16 |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 19 | det_2 | real | The same as 16 |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| **CODE = 1 (monitor)** : |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 16 | det_1 | real | Dead time ( :math:`\mu s` ). Important for old detectors and high counting rate. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 17 | det_2 | real | Macroscopic absorption cross-section :math:`\Sigma ;(m^{-1}meV^{-0.5})`. |
| | | | For our monitors this is for Li scintillator glass. (I think I know what :math:`\Sigma`; |
| | | | is approximately, but we don't at present use it anywhere, so set to zero) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 18 | det_3 | real | Ignored. Set to zero |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 19 | det_4 | real | Ignored. Set to zero |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| **CODE = 2 (non-PSD gas tube)** : |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 16 | det_1 | real | Dead time ( :math:`\mu s` ). Important for old detectors and high counting rate. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 17 | det_2 | real | Gas tube detector **3He** partial pressure (atms) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 18 | det_3 | real | Gas tube wall thickness (m) ( 0.00080 ) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 19 | det_4 | real | Ignored. Set to zero |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| **CODE = 3 (PSD gas tube)** : |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 16 | det_1 | real | Dead time ( :math:`\mu s` ). Important for old detectors and high counting rate. |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 17 | det_2 | real | Gas tube detector **3He** partial pressure (atms) (10.0 or 6.4) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 18 | det_3 | real | Gas tube wall thickness (m) ( 0.00080 ) |
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
| 19 | det_4 | real | Index of tube to which the pixel belongs. Each PSD gas tube must be given a unique identifier. |
| | | | This enables programs that use DETECTOR.DAT to recognize that pixels have come from the same PSD tube.|
+---------------+-------------+-------------+-------------------------------------------------------------------------------------------------------+
ISIS DETECTOR.DAT raw files
###########################
The ISIS raw files seem to have two possible entries - MARI is non-standard for some reason. The table below describes correspondence between the fields
in ASCII file above and the data containing in DETECTOR.DAT file present on data acquisition machine and the data written to the RAW file on different ISIS instruments.
+----+--------------+-----------------+---------------+
| | Field | Field name in RAW file |
+----+--------------+-----------------+---------------+
| | Name in | All instruments.| MARI fields: |
| N | ASCII file | Fields in use 14| In use 10. |
| | above | ASCII ncol=19 | ASCII ncol=15 |
+====+==============+=================+===============+
| 1 | det_no | spec | spec |
+----+--------------+-----------------+---------------+
| 2 | delta | delt | delt |
+----+--------------+-----------------+---------------+
| 3 | l2 | len2 | len2 |
+----+--------------+-----------------+---------------+
| 4 | code | code | code |
+----+--------------+-----------------+---------------+
| 5 | theta | tthe | tthe |
+----+--------------+-----------------+---------------+
| 6 | phi | ut1 | ut1 |
+----+--------------+-----------------+---------------+
| 7 | W_x | ut2 | ut2 |
+----+--------------+-----------------+---------------+
| 8 | W_y | ut3 | ut3 |
+----+--------------+-----------------+---------------+
| 9 | W_z | ut4 | ut4 |
+----+--------------+-----------------+---------------+
| 10 | F_x | ut5 | --- |
+----+--------------+-----------------+---------------+
| 11 | F_y | ut6 | --- |
+----+--------------+-----------------+---------------+
| 12 | F_z | ut7 | --- |
+----+--------------+-----------------+---------------+
| 13 | |AlphaX| | ut8 | ut5 |
+----+--------------+-----------------+---------------+
| 14 | |AlphaY| | ut9 | ut6 |
+----+--------------+-----------------+---------------+
| 15 | |AlphaZ| | ut10 | ut7 |
+----+--------------+-----------------+---------------+
| 16 | det_1 | ut11 | --- |
+----+--------------+-----------------+---------------+
| 17 | det_2 | ut12 | ut8 |
+----+--------------+-----------------+---------------+
| 18 | det_3 | ut13 | ut9 |
+----+--------------+-----------------+---------------+
| 19 | det_4 | ut14 | ut10 |
+----+--------------+-----------------+---------------+
Usage
------------
**Example - LoadDetectorInfo:**
bla bla bla
......
Code/Mantid/docs/source/algorithms/OneStepMDEW-v1.rst
+ 3
− 2
View file @ c1240f92
...@@ -10,8 +10,8 @@ Description ...@@ -10,8 +10,8 @@ Description
----------- -----------
This algorithm is used in the Paraview event nexus loader to both load This algorithm is used in the Paraview event nexus loader to both load
an event nexus file and convert it into a an event nexus file and convert it into a `MDEventWorkspace <http://www.mantidproject.org/MDEventWorkspace>`_
`MDEventWorkspace <http://www.mantidproject.org/MDEventWorkspace>`_ for use in visualization. for use in visualization.
The :ref:`algm-LoadEventNexus` algorithm is called with default The :ref:`algm-LoadEventNexus` algorithm is called with default
parameters to load into an `EventWorkspace <http://www.mantidproject.org/EventWorkspace>`_. parameters to load into an `EventWorkspace <http://www.mantidproject.org/EventWorkspace>`_.
...@@ -26,4 +26,5 @@ Usage ...@@ -26,4 +26,5 @@ Usage
Used internaly. See examples of :ref:`algm-LoadEventNexus` and :ref:`algm-ConvertToDiffractionMDWorkspace` algorithms Used internaly. See examples of :ref:`algm-LoadEventNexus` and :ref:`algm-ConvertToDiffractionMDWorkspace` algorithms
for the details of the usage of these algorithms for the details of the usage of these algorithms
.. categories:: .. categories::
Code/Mantid/docs/source/algorithms/UpdateInstrumentFromFile-v1.rst
+ 6
− 0
View file @ c1240f92
...@@ -21,6 +21,12 @@ position. Note that this algorithm moves the detectors without ...@@ -21,6 +21,12 @@ position. Note that this algorithm moves the detectors without
subsequent rotation, hence this means that detectors may not for example subsequent rotation, hence this means that detectors may not for example
face the sample perfectly after this algorithm has been applied. face the sample perfectly after this algorithm has been applied.
Related or similar algorithms
##############################
See :ref:`algm-LoadDetectorInfo` which can do similar job modifying the detector parameters and positions and working with special format ASCII files or ISIS raw or special nexus files.
Additional Detector Parameters Using ASCII File Additional Detector Parameters Using ASCII File
############################################### ###############################################
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment