From bae86c45e251183ec7ac9b714eb2fee4a2bdd7bf Mon Sep 17 00:00:00 2001 From: Nick Draper <nick.draper@stfc.ac.uk> Date: Thu, 9 Feb 2017 10:17:59 +0000 Subject: [PATCH] Fix bad indentation in lists re #18762 also a few spellings --- .../source/interfaces/HFIRPowderReduction.rst | 165 +++++++++--------- .../interfaces/HFIR_4Circle_Reduction.rst | 84 ++++----- 2 files changed, 124 insertions(+), 125 deletions(-) diff --git a/docs/source/interfaces/HFIRPowderReduction.rst b/docs/source/interfaces/HFIRPowderReduction.rst index f048708ce86..a46d7f66158 100644 --- a/docs/source/interfaces/HFIRPowderReduction.rst +++ b/docs/source/interfaces/HFIRPowderReduction.rst @@ -14,41 +14,41 @@ in SPICE format. Use cases for tabs ------------------ - 1. **Raw Detectors**: Visualize the reading of detectors directly coming out of the raw data +1. **Raw Detectors**: Visualize the reading of detectors directly coming out of the raw data - - Plot N lines for N Pts.; - - Highlight (make it thicker) the Pt that is interested; - - New from Mantid: *ReadRawSpiceSignal(Pts)*; + - Plot N lines for N Pts.; + - Highlight (make it thicker) the Pt that is interested; + - New from Mantid: *ReadRawSpiceSignal(Pts)*; - 2. **Individual Detector**: Visual the readings of one detector across an experiment +2. **Individual Detector**: Visual the readings of one detector across an experiment - - Plot the counts of any individual detector; - - Able to change the X-axis from 2theta to arbitrary sample environment log; - - New from Mantid: *ReadRawSpiceSignal(DetectorID, XLabel)*; + - Plot the counts of any individual detector; + - Able to change the X-axis from 2theta to arbitrary sample environment log; + - New from Mantid: *ReadRawSpiceSignal(DetectorID, XLabel)*; - 3. **Normalized**: Reduce one scan each time +3. **Normalized**: Reduce one scan each time - - Plot the reduced data - - Automatically locate detector efficiency file - - New from Mantid: *ConvertCWPDMDToSpectra(ExcludedDetectors=[])* - - New from Mantid: *ConvertSpiceDataToRealSpace(DetectorEfficiencyTable)* + - Plot the reduced data + - Automatically locate detector efficiency file + - New from Mantid: *ConvertCWPDMDToSpectra(ExcludedDetectors=[])* + - New from Mantid: *ConvertSpiceDataToRealSpace(DetectorEfficiencyTable)* - 4. **Multiple Scans**: Reduce a set of scans +4. **Multiple Scans**: Reduce a set of scans - - Reduce a set of scans and plot in 2D/water-fall mode; - - Able to merge all the scans; - - New from Mantid: *ConvertCWPDMDToSpectra(ExcludedDetectors=[])* + - Reduce a set of scans and plot in 2D/water-fall mode; + - Able to merge all the scans; + - New from Mantid: *ConvertCWPDMDToSpectra(ExcludedDetectors=[])* - 5. **Vanadium**: strip vanadium peaks +5. **Vanadium**: strip vanadium peaks - - Strip vanadium peak with unit 'Degrees' because of the binning (range and step size) must be respected; - - Peaks' position should be calculated and indicated auotmatically; - - *Mantid::StripPeaks()* will be called instread of *StripVadadiumPeaks()* because - the later one only works in d-spacing; + - Strip vanadium peak with unit 'Degrees' because of the binning (range and step size) must be respected; + - Peaks' position should be calculated and indicated auotmatically; + - *Mantid::StripPeaks()* will be called instread of *StripVadadiumPeaks()* because + the later one only works in d-spacing; - 6. **Advanced Setup** +6. **Advanced Setup** - - URL for raw data files; + - URL for raw data files; Workflow for *Normalization* @@ -56,31 +56,31 @@ Workflow for *Normalization* Here is a typical use case for reduce data via tab *Noramlization* - 1. User specifies *Exp No* and *Scan No* and push button *Load*; +1. User specifies *Exp No* and *Scan No* and push button *Load*; - - HFIR-PDR-GUI loads SPICE data according to experiment number and scan number; - - HFIR-PDR-GUI checks whether vanadium correction file, i.e., detector efficiency file exists on server; - - HFIR-PDR-GUI checks whether excluded detectors file exists on server; - - HFIR-PDR-GUI checks log **m1** for wavelength and set to *Wavelength* ; + - HFIR-PDR-GUI loads SPICE data according to experiment number and scan number; + - HFIR-PDR-GUI checks whether vanadium correction file, i.e., detector efficiency file exists on server; + - HFIR-PDR-GUI checks whether excluded detectors file exists on server; + - HFIR-PDR-GUI checks log **m1** for wavelength and set to *Wavelength* ; - 2. User may specify detector efficient file; +2. User may specify detector efficient file; - 3. User specifies *Bin Size*; - - 4. User pushes button *2Theta*, *dSpacng*, or *Q*; +3. User specifies *Bin Size*; + +4. User pushes button *2Theta*, *dSpacng*, or *Q*; - - HFIR-PDF-GUI reduce data in unit of *2theta* by taking accounting of + - HFIR-PDF-GUI reduce data in unit of *2theta* by taking accounting of - - Detector efficiency; - - Excluded detectors; + - Detector efficiency; + - Excluded detectors; - 5. HFIR-PDR-GUI plots the reduced data; +5. HFIR-PDR-GUI plots the reduced data; - 6. User may rebin by different binning parameters or unit; +6. User may rebin by different binning parameters or unit; - 7. User may push button *Next Scan* or *Prev Scan* to load and reduce other scans with current setup; +7. User may push button *Next Scan* or *Prev Scan* to load and reduce other scans with current setup; - 8. User may save the result by pushing button *Save*; +8. User may save the result by pushing button *Save*; Workflow for *Raw Detectors* @@ -88,18 +88,18 @@ Workflow for *Raw Detectors* Here is a typical use case for reduce data via tab *Noramlization* - 1. User specifies *Exp No* and *Scan No* and push button *Load*; +1. User specifies *Exp No* and *Scan No* and push button *Load*; - - HFIR-PDR-GUI loads SPICE data according to experiment number and scan number; - - HFIR-PDR-GUI checks whether vanadium correction file, i.e., detector efficiency file exists on server; - - HFIR-PDR-GUI checks whether excluded detectors file exists on server; - - HFIR-PDR-GUI checks log **m1** for wavelength and set to *Wavelength* ; + - HFIR-PDR-GUI loads SPICE data according to experiment number and scan number; + - HFIR-PDR-GUI checks whether vanadium correction file, i.e., detector efficiency file exists on server; + - HFIR-PDR-GUI checks whether excluded detectors file exists on server; + - HFIR-PDR-GUI checks log **m1** for wavelength and set to *Wavelength* ; - 2. User specifies a *Pt.* number and push button *Plot Raw Detector*; +2. User specifies a *Pt.* number and push button *Plot Raw Detector*; - - HFIR-PDF-GUI plots the raw detector counts normalized by monitor count; + - HFIR-PDF-GUI plots the raw detector counts normalized by monitor count; - 3. User may push button *Previous Pt.* or *Next Pt.* for the other experiment points; +3. User may push button *Previous Pt.* or *Next Pt.* for the other experiment points; @@ -109,15 +109,14 @@ Workflow for *Multiple Scans* It might be confusing to use the functionalities in tab *Multiple Scans*. Here is the suggested workflow to reduce multiple scans and possibly merge them. - 1. Set up *Exp No* and range of scan numbers; - 2. Push button *Load All* to load and reduce all runs specified in previous step to single-spectrum diffraction pattern; - 3. Plot all reduced scans in default; - 4. Optinally plot all data in 2D fill plot; - 5. User can delete some scans from the reduced scans via GUI or input text edit (not implemented yet); - 6. Push button *Merge* to merge the scans; - 7. Push button *Save All* to save all individual scans to files; - 8. Push button *Save Merged* to save the merged scans to one file; - +1. Set up *Exp No* and range of scan numbers; +2. Push button *Load All* to load and reduce all runs specified in previous step to single-spectrum diffraction pattern; +3. Plot all reduced scans in default; +4. Optinally plot all data in 2D fill plot; +5. User can delete some scans from the reduced scans via GUI or input text edit (not implemented yet); +6. Push button *Merge* to merge the scans; +7. Push button *Save All* to save all individual scans to files; +8. Push button *Save Merged* to save the merged scans to one file; HB2A Data Reduction ------------------- @@ -129,50 +128,50 @@ There information can be retrieved from HB2A's data repository accessible from i Experiment setup and sample log =============================== - 1. **Wavelength**: There are three settings for neutron wavelength, referenced by sample log *m1*. +1. **Wavelength**: There are three settings for neutron wavelength, referenced by sample log *m1*. - - Ge 113: :math:`\lambda = 2.41 \AA`, m1 = 9.45 (The **error** can be 0.05, such that in Exp 231 scan0001, m1=9.5) - - Ge 115: :math:`\lambda = 1.54 \AA`, m1 = 0 - - Ge 117 :math:`\lambda = 1.12 \AA`, No used + - Ge 113: :math:`\lambda = 2.41 \AA`, m1 = 9.45 (The **error** can be 0.05, such that in Exp 231 scan0001, m1=9.5) + - Ge 115: :math:`\lambda = 1.54 \AA`, m1 = 0 + - Ge 117 :math:`\lambda = 1.12 \AA`, No used - 2. **Collimator translation**: There are two status for collimator, which is specified by sample log *colltrans* +2. **Collimator translation**: There are two status for collimator, which is specified by sample log *colltrans* - - *IN*: colltrans = 0 - - *OUT*: colltrans = +/-80 + - *IN*: colltrans = 0 + - *OUT*: colltrans = +/-80 Raw data correction files ========================= - 1. **Detector efficiency**: +1. **Detector efficiency**: - - File name: *HB2A_exp0IJK__GE_abc_XY_vcorr.txt* where + - File name: *HB2A_exp0IJK__GE_abc_XY_vcorr.txt* where - - IJK is the experiment number - - abc is the GE set up. It can be 113, 115 or 117 - - XY is either IN or OUT. - - Exmaple: *HB2A_exp0400__Ge_113_IN_vcorr.txt* + - IJK is the experiment number + - abc is the GE set up. It can be 113, 115 or 117 + - XY is either IN or OUT. + - Example: *HB2A_exp0400__Ge_113_IN_vcorr.txt* - - Web address: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0IJK__Ge_abc_IN_vcorr.txt* + - Web address: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0IJK__Ge_abc_IN_vcorr.txt* - - IJK is the experiment number - - abc is the GE set up. It can be 113, 115 or 117 - - XY is either IN or OUT. - - Exmaple: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0400__Ge_113_IN_vcorr.txt* + - IJK is the experiment number + - abc is the GE set up. It can be 113, 115 or 117 + - XY is either IN or OUT. + - Example: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0400__Ge_113_IN_vcorr.txt* - 2. **Excluded detectors**: Some detectors might be exluded from the experiment for some reason. It is recorded in some excluded detectors' file. +2. **Excluded detectors**: Some detectors might be exluded from the experiment for some reason. It is recorded in some excluded detectors' file. - - File name: *HB2A_exp0IJK__exclude_detectors.txt* + - File name: *HB2A_exp0IJK__exclude_detectors.txt* - - IJK is the epxeriment number - - Exmaple: *HB2A_exp0400__exclude_detectors.txt* + - IJK is the epxeriment number + - Example: *HB2A_exp0400__exclude_detectors.txt* - - Web address: *http://neutron.ornl.gov/user_data/hb2a/expIJK/Datafiles/HB2A_exp0IJK__exclude_detectors.txt* + - Web address: *http://neutron.ornl.gov/user_data/hb2a/expIJK/Datafiles/HB2A_exp0IJK__exclude_detectors.txt* - - IJK is the experiment number - - Example: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0400__exclude_detectors.txt* + - IJK is the experiment number + - Example: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0400__exclude_detectors.txt* - 3. Detector gaps: The 2-theta gap (in unit degrees) can be changed among cycles. +3. Detector gaps: The 2-theta gap (in unit degrees) can be changed among cycles. - Location example: *http://neutron.ornl.gov/user_data/hb2a/exp400/Datafiles/HB2A_exp0400__gaps.txt* diff --git a/docs/source/interfaces/HFIR_4Circle_Reduction.rst b/docs/source/interfaces/HFIR_4Circle_Reduction.rst index f12e2af8e59..d152332983e 100644 --- a/docs/source/interfaces/HFIR_4Circle_Reduction.rst +++ b/docs/source/interfaces/HFIR_4Circle_Reduction.rst @@ -16,42 +16,42 @@ Introduction of Tabs 1. **Setup and Data Access**: Configure the instrument name, data server URL and directories. - - Configure the instrument name; - - Set up and test HB3A data server's URL; - - Configure the directory to save raw data; - - Configure the directory to save working result; - - Download data from server; + - Configure the instrument name; + - Set up and test HB3A data server's URL; + - Configure the directory to save raw data; + - Configure the directory to save working result; + - Download data from server; 2. **View Raw Data**: View 2D image of counts on detector of one measurement. - - Plot the counts of the 256 by 256 2D detector; + - Plot the counts of the 256 by 256 2D detector; 3. **Calculate UB**: Calculate UB matrix. - - Find peak in one measurement; - - Option to load Miller index directly from SPICE file; - - Calculate UB matrix; - - Re-index the peaks; - - Refine UB matrix with more than two peaks. + - Find peak in one measurement; + - Option to load Miller index directly from SPICE file; + - Calculate UB matrix; + - Re-index the peaks; + - Refine UB matrix with more than two peaks. 4. **Merge Scan**: Merge all the measurements in a scan. - - Merge all measuring points in a scan to an MDEventWorkspace in HKL-frame or Q-sample-frame; - - Allow various ways to set up UB matrix + - Merge all measuring points in a scan to an MDEventWorkspace in HKL-frame or Q-sample-frame; + - Allow various ways to set up UB matrix 5. **Peak Integration**: Integrate peaks - - Still in developmenet + - Still in developmenet 6. **Survey**: Get experiments runs' information by scanning through all SPICE files in an experiment - - For selected scans in an experiment, list the run (i.e., Pt.) with maximum detector counts in a specific scan; - - For each listed run, the information show includes detector counts and HKL + - For selected scans in an experiment, list the run (i.e., Pt.) with maximum detector counts in a specific scan; + - For each listed run, the information show includes detector counts and HKL @@ -92,28 +92,28 @@ Workflow to calculate and refine UB matrix Here is a typical use case to calculate UB matrix after initial setup. - 1. User specifies *Experiment* and pushes button *Set* - 2. Users may do a new survey or load a survey result file in tab *Survey*; - 3. User enters tab *View Raw Data* and inputs scan number and list all the measuring points (Pt.) - 4. User views all the measurements +1. User specifies *Experiment* and pushes button *Set* +2. Users may do a new survey or load a survey result file in tab *Survey*; +3. User enters tab *View Raw Data* and inputs scan number and list all the measuring points (Pt.) +4. User views all the measurements - * User finds out the measurement with the strongest reflection and push button use - * Alternatively, user can use the survey result to find out the Pt. with the maximum counts of the scan + * User finds out the measurement with the strongest reflection and push button use + * Alternatively, user can use the survey result to find out the Pt. with the maximum counts of the scan - 5. GUI shifts to tab *Calculate UB* automatically - 6. User pushes button *Find Peak* with checking *Load HKL from file* - 7. GUI finds the peak center and load HKL - 8. User pushes button *Add peak* to add the peak to table - 9. User repeats step 2 to 9 to add other peaks - 10. User select the peaks that are linearly independent and pushes *Calcualte UB* - 11. GUI calculates UB matrix and show the result - 12. User may push *Index peak* to use the calculated UB matrix to index peaks in the table to check UB matrix; - 13. User may refine the UB matrix and thus lattice parameters +5. GUI shifts to tab *Calculate UB* automatically +6. User pushes button *Find Peak* with checking *Load HKL from file* +7. GUI finds the peak center and load HKL +8. User pushes button *Add peak* to add the peak to table +9. User repeats step 2 to 9 to add other peaks +10. User select the peaks that are linearly independent and pushes *Calcualte UB* +11. GUI calculates UB matrix and show the result +12. User may push *Index peak* to use the calculated UB matrix to index peaks in the table to check UB matrix; +13. User may refine the UB matrix and thus lattice parameters - a. user adds more peaks to the UB peak table; - b. user selects at least 3 non-degenerate peaks; - c. user clicks button *Refine*; - d. application refines UB matrix and outputs the refined UB matrix, refined lattice parameters and their error. + a. user adds more peaks to the UB peak table; + b. user selects at least 3 non-degenerate peaks; + c. user clicks button *Refine*; + d. application refines UB matrix and outputs the refined UB matrix, refined lattice parameters and their error. Workflow to merge measurements in scan @@ -151,17 +151,17 @@ and scaled up by same factor (e.g, 1500). 1. Set up region of interest - - define region of interest on the detector - - check whether the ROI does not exclude any peak + - define region of interest on the detector + - check whether the ROI does not exclude any peak 2. Specify background Pts. - - specify the Pts. in the scan that are used to estimate background + - specify the Pts. in the scan that are used to estimate background 3. Integrate peaks - - select peaks to integrate - - integrate peaks + - select peaks to integrate + - integrate peaks 4. Review the integration result 5. Export to Fullprof peak integration (.int) file. @@ -277,8 +277,8 @@ where * :math:`B_i` is the estimated background * the set of measurements *<pt>* is defined by the motor positions in the range of :math:`x_0 \pm \frac{N}{2}FWHM`. - - usually the default value of *N* is set to 2. - - :math:`FWHM = 2\sqrt{2\ln2}s \approx 2.3548s` + - usually the default value of *N* is set to 2. + - :math:`FWHM = 2\sqrt{2\ln2}s \approx 2.3548s` The error can be calculated as -- GitLab