Update direct_inelastic.rst #18510
Merged
Update direct_inelastic.rst #18510
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cleaned up some of the text
AnthonyLim23
added
the
Documentation
martyngigg
reviewed
Jan 23, 2017
| - :ref:`GetEiMonDet <algm-GetEiMonDet>` has had a complete rewrite. The new version 2 utilizes elastic peak position data generated by :ref:`FindEPP <algm-FindEPP>`, the detectors of interest are specified by their indices instead of distances from sample, and the revised algorithm is able to deal with cases where neutrons arrive at the detectors in a later time frame. | ||
| - :ref:`MaskDetectors <algm-MaskDetectors>` has been modified to work on with grouped spectra. If a detector of the mask workspace is masked, the spectrum of the target workspace, with the detector group containing the masked detector become masked. This allows to use *.xml* masks, produced by :ref:`SaveMask <algm-SaveMask>` algorithm on the workspaces containing mapped spectra obtained from ISIS instruments. | ||
| - :ref:`GetEiMonDet <algm-GetEiMonDet>` has had a complete rewrite. Version 2 utilises the elastic peak position data generated by :ref:`FindEPP <algm-FindEPP>`. The detectors of interest are specified by their indices instead of their distance from the sample. The revised algorithm is able to deal with cases where neutrons arrive at the detectors in a later time frame. | ||
| - :ref:`MaskDetectors <algm-MaskDetectors>` has been modified to work on grouped spectra. If a detector of the workspace is masked then the relevant spectra of the target workspace become masked(zero). The use of *.xml* masks, produced by :ref:`SaveMask <algm-SaveMask>` algorithm, on a workspaces containing mapped spectra obtained from an ISIS instruments. |
There was a problem hiding this comment.
The final sentence here doesn't quite make sense to me.
Edited the last sentence on line 18.
|
The notes look good to me now. I built it locally without warnings so I don't think we need wait for the builders |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cleaned up some of the text
Description of work.
Check the documentation
Reviewer
Please comment on the following (full description):
Code Review
Functional Tests
Do changes function as described? Add comments below that describe the tests performed?
How do the changes handle unexpected situations, e.g. bad input?
Has the relevant documentation been added/updated?
Is user-facing documentation written in a user-friendly manner?
Has developer documentation been updated if required?
Does everything look good? Comment with the ship it emoji but don't merge. A member of
@mantidproject/gatekeeperswill take care of it.