Skip to content

Commit

Permalink
Merge pull request #37615 from mantidproject/fix-typos-in-sxd-docs
Browse files Browse the repository at this point in the history
Fix typos in SXD documentation
  • Loading branch information
SilkeSchomann authored Jun 27, 2024
2 parents 33505ce + 5c5569e commit b039819
Showing 1 changed file with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The updated positions are stored in an .xml file, the path to the file is return
sxd = SXD()
wsname = sxd.load_run(32863)
peaks_ws = sxd.find_sx_peaks(wsname, nstd=8)
peaks_ws = sxd.find_sx_peaks(wsname)
sxd.remove_peaks_on_detector_edge(peaks_ws, 2)
# initial UB
Expand Down Expand Up @@ -144,7 +144,7 @@ The reduction proceeds as follows:
for run in runs:
ws = sxd.get_ws(run)
peaks = sxd.find_sx_peaks(ws, nstd=8)
peaks = sxd.find_sx_peaks(ws)
sxd.remove_peaks_on_detector_edge(peaks, 2)
sxd.set_peaks(run, peaks)
# find UB with consistent indexing across runs
Expand Down Expand Up @@ -173,11 +173,12 @@ The reduction proceeds as follows:
for run in runs:
skew_args = {**skew_args, 'OutputFile': path.join(save_dir, f"{run}_{peak_type.value}_int.pdf")}
sxd.integrate_data(integration_type, peak_type, run=run, **skew_args)
sxd.remove_non_integrated_peaks(sxd.get_peaks(run, peak_type, integration_type))
sxd.calc_absorption_weighted_path_lengths(peak_type, integration_type, run=run, ApplyCorrection=True)
sxd.save_peak_table(run, peak_type, integration_type, save_dir, save_format='SHELX')
# save combined table
sxd.save_all_peaks(peak_type, integration_type, save_dir=save_dir, save_format=fmt)
sxd.save_all_peaks(peak_type, integration_type, save_dir=save_dir, save_format='SHELX')
.. _isis-single-crystal-diffraction-wish-ref:

Expand Down Expand Up @@ -206,7 +207,7 @@ This example shows how to load data with specific file extension and perform an
WishSX.mask_detector_edges(ws, nedge=16, ntubes=2)
wsMD = WishSX.convert_ws_to_MD(ws, frame="Q (lab frame)")
# find peaks and integrate
peaks = WishSX.find_sx_peaks(ws, nstd=8)
peaks = WishSX.find_sx_peaks(ws)
peaks_int = WishSX().integrate_peaks_MD_optimal_radius(wsMD, peaks, peaks+"_int", ws=ws, **intPeaksMDArgs)
Note that the method ``integrate_peaks_MD_optimal_radius`` requires an instance of the class ``WishSX()`` - this is
Expand Down Expand Up @@ -269,7 +270,7 @@ has changed).
WishSX.mask_detector_edges(ws, nedge=16, ntubes=2)
wsMD = WishSX.convert_ws_to_MD(ws, frame="Q (lab frame)")
# find peaks and integrate
peaks = WishSX.find_sx_peaks(ws, nstd=8)
peaks = WishSX.find_sx_peaks(ws)
peaks_int = WishSX().integrate_peaks_MD_optimal_radius(wsMD, peaks, peaks+"_int", ws=ws, **intPeaksMDArgs)
peaks_int = peaks_int.name()
# filter to get strong peaks only
Expand Down

0 comments on commit b039819

Please sign in to comment.