Commit 4d1e1625 authored by Zhou, Wenduo's avatar Zhou, Wenduo
Browse files

Fixed docs.

parent 879a3666
......@@ -36,7 +36,7 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override { return {"AlignComponents", "GetDetOffsetsMultiPeaks"}; }
const std::vector<std::string> seeAlso() const override { return {"AlignComponents"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "Diffraction\\Calibration;"
......
......@@ -34,9 +34,7 @@ public:
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return {"GetDetOffsetsMultiPeaks", "CalibrateRectangularDetectors", "AlignComponents"};
}
const std::vector<std::string> seeAlso() const override { return {"AlignComponents"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Diffraction\\Calibration"; }
......
......@@ -26,7 +26,7 @@ public:
const std::string name() const override;
int version() const override;
const std::vector<std::string> seeAlso() const override { return {"CalibrateRectangularDetectors"}; }
const std::vector<std::string> seeAlso() const override { return {}; }
const std::string category() const override;
const std::string summary() const override;
......
......@@ -52,7 +52,7 @@ class AlignComponents(PythonAlgorithm):
return "Diffraction"
def seeAlso(self):
return ["GetDetOffsetsMultiPeaks", "CalibrateRectangularDetectors"]
return []
def name(self):
"""
......
......@@ -100,8 +100,7 @@ Output:
Estimated resolution of detector of spectrum 100 = 0.00323608260137
Estimated resolution of detector of spectrum 999 = 0.00354849176520
.. seealso :: Algorithms :ref:`algm-EstimateDivergence`, :ref:`algm-CalibrateRectangularDetectors` and
:ref:`algm-GetDetOffsetsMultiPeaks`
.. seealso :: Algorithms :ref:`algm-EstimateDivergence`.
.. categories::
......
......@@ -13,7 +13,7 @@ Description
This algorithm calibrates the detector pixels and creates a
:ref:`diffraction calibration workspace
<DiffractionCalibrationWorkspace>`. Unlike
:ref:`algm-CalibrateRectangularDetectors` the peak fitting and
`CalibrateRectangularDetectors` the peak fitting and
calibration is done in TOF not d spacing. The peak d values are
converted to TOF based on either the old calibration or the instrument
geometry. The ``InputWorkspace`` contains the data from a standard
......
......@@ -65,13 +65,13 @@ Using known peak positions
These techniques require knowing the precise location, in d-space, of
diffraction peaks and benefit from knowing
more. :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>`
more. `GetDetOffsetsMultiPeaks` (deprecated)
and :ref:`PDCalibration <algm-PDCalibration>` are the main choices for
this. Both algorithms fit individual peak positions and use those fits
to generate the calibration information.
The workflow for :ref:`GetDetOffsetsMultiPeaks
<algm-GetDetOffsetsMultiPeaks>` is identical to that of
The workflow for `GetDetOffsetsMultiPeaks` (deprecated)
is identical to that of
:ref:`GetDetectorOffsets <algm-GetDetectorOffsets>` without the
cross-correlation step (5). The main difference in the operation of
the algorithm is that it essentially calculates an offset from each
......@@ -98,13 +98,12 @@ using this are
Workflow algorithms
###################
:ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>`
`CalibrateRectangularDetectors` (deprecated)
will do most of the workflow for you, including applying the
calibration to the data. While its name suggests it is only for a
particular subset of detector types, it is not. It has many options
for selecting between :ref:`GetDetectorOffsets
<algm-GetDetectorOffsets>` and :ref:`GetDetOffsetsMultiPeaks
<algm-GetDetOffsetsMultiPeaks>`.
<algm-GetDetectorOffsets>` and `GetDetOffsetsMultiPeaks` (deprecated).
.. _calibration_tofpd_group_calibration-ref:
......@@ -630,9 +629,11 @@ alternative is to generate a grouping file to load with
Adjusting the Instrument Definition
-----------------------------------
`This section is out of date!`
This approach attempts to correct the instrument component positions based on the calibration data. It can be more involved than applying the correction during focussing.
1. Perform a calibration using :ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>` or :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>`. Only these algorithms can export the :ref:`Diffraction Calibration Workspace <DiffractionCalibrationWorkspace>` required.
1. Perform a calibration using `CalibrateRectangularDetectors` (deprecated) or `GetDetOffsetsMultiPeaks` (deprecated). Only these algorithms can export the :ref:`Diffraction Calibration Workspace <DiffractionCalibrationWorkspace>` required.
2. Run :ref:`AlignComponents <algm-AlignComponents>` this will move aspects of the instrument to optimize the offsets. It can move any named aspect of the instrument including the sample and source positions. You will likely need to run this several times, perhaps focussing on a single bank at a time, and then the source and sample positions in order to get a good alignment.
3. Then either:
......
......@@ -51,7 +51,7 @@ New
- :ref:`AlignComponents <algm-AlignComponents>`
This algorithm will take the calibration from the output of
:ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>`, :ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>`, *et al* and
`GetDetOffsetsMultiPeaks`, `CalibrateRectangularDetectors`, *et al* and
minimizes the difference between the *DIFC* of the instrument and
calibration by moving and rotating instrument components.
- :ref:`CorrectTOF <algm-CorrectTOF>` applies to the time-of-flight correction which considers the specified elastic peak position.
......
......@@ -107,8 +107,7 @@ Powder Diffraction
- `Pearl Powder Diffraction Script <http://docs.mantidproject.org/v3.8.0/api/python/techniques/PearlPowderDiffractionISIS-v1.html>`_:
A workflow diagram for ``pearl_run_focus`` function has been created.
- :ref:`CalibrateRectangularDetectors
<algm-CalibrateRectangularDetectors>` has been modified to output
- `CalibrateRectangularDetectors` has been modified to output
``.h5`` formatted calibration files as well as the other versions it
already supported.
......
......@@ -128,7 +128,7 @@ Performance
- :ref:`CorrectFlightPaths <algm-ConvertToConstantL2>`: 10% speedup
- :ref:`ExtractSpectra <algm-ExtractSpectra>`: no change when X-range changes, otherwise 50x to 100x speedup for Workspace2D and up to 3x speedup for EventWorkspace
- :ref:`GetAllEi <algm-GetAllEi>`: 5-10% speedup
- :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>`: 5-10% speedup
- `GetDetOffsetsMultiPeaks`: 5-10% speedup
- :ref:`GetEi <algm-GetEi>`: 20% speedup
- :ref:`MaxEnt <algm-MaxEnt>`: 5% speedup
- :ref:`ModeratorTzero <algm-ModeratorTzero>`: 30% speedup
......
......@@ -57,15 +57,8 @@ Bugfixes
Deprecation
###########
- Existing :ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>` is deprecated.
- Existing :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>` is deprecated.
Deprecation
###########
- Existing :ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>` is deprecated.
- Existing :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>` is deprecated.
- Existing `CalibrateRectangularDetectors` is deprecated.
- Existing `GetDetOffsetsMultiPeaks` is deprecated.
Engineering Diffraction
......
......@@ -11,8 +11,8 @@ Diffraction Changes
Powder Diffraction
------------------
- :ref:`GetDetOffsetsMultiPeaks`, which is deprecate since v6.2.0, is removed.
- :ref:`CalibrateRectangularDetectors`, which is deprecate since v6.2.0, is removed. And system test CalibrateRectangularDetectors_Test is removed.
- `GetDetOffsetsMultiPeaks`, which is deprecate since v6.2.0, is removed.
- `CalibrateRectangularDetectors`, which is deprecate since v6.2.0, is removed. And system test CalibrateRectangularDetectors_Test is removed.
Engineering Diffraction
-----------------------
......
Markdown is supported
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