Skip to content

Commit 3bda494

Browse files
committed
Improve Welcome screen "Controls" tab a bit.
1 parent 5c32f8b commit 3bda494

File tree

5 files changed

+40
-27
lines changed

5 files changed

+40
-27
lines changed
-3.65 MB
Binary file not shown.
316 KB
Loading

InterSpec_resources/static_text/use_instructions.xml

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
</div>
9797
</div>
9898
<div class="UseInstructionSection">
99-
<div class="UseInstructionHeader">Identify Peak(s)</div>
99+
<div class="UseInstructionHeader">Fit Peak(s)</div>
100100
<div style="border:1px solid black">
101101
<div style="padding-top: 10px" align="center"><h3><b>Method 1</b></h3></div>
102102
<div style="padding-top: 10px" align="center">
@@ -190,22 +190,22 @@ the XHTML message for that entry.
190190
"desc_message_id": "3desktop-mouse-interactions-energyslider-desc"
191191
},
192192
"4desktop-mouse-interactions-identifypeaks": {
193-
"title": "Identify Peak(s)",
194-
"img": "InterSpec_resources/images/IDPeaks.gif",
193+
"title": "Peak Fit",
194+
"img": "InterSpec_resources/images/PeakFit.gif",
195195
"desc_message_id": "4desktop-mouse-interactions-identifypeaks-desc"
196196
},
197197
"4desktop-mouse-interactions-multipeaks": {
198-
"title": "Fit Peak(s)",
198+
"title": "ROI Fit",
199199
"img": "InterSpec_resources/images/multi_peak_fit.gif",
200200
"desc_message_id": "4desktop-mouse-interactions-multipeaks-desc"
201201
},
202202
"7desktop-mouse-interactions-deletepeaks": {
203-
"title": "Fit Multi-Peak(s)",
203+
"title": "Delete Peak",
204204
"img": "InterSpec_resources/images/DeletePeaks.gif",
205205
"desc_message_id": "7desktop-mouse-interactions-deletepeaks-desc"
206206
},
207207
"6desktop-mouse-interactions-visualcalibration": {
208-
"title": "Visual Calibration",
208+
"title": "Energy Calibration",
209209
"img": "InterSpec_resources/images/VisRecalib.gif",
210210
"desc_message_id": "6desktop-mouse-interactions-visualcalibration-desc"
211211
},
@@ -243,44 +243,56 @@ the XHTML message for that entry.
243243

244244

245245
<message id='3desktop-mouse-interactions-energyslider-desc'>
246-
<center> From <b>View</b> &rarr; <b>Chart Options</b> select &quot;<b>Show Energy Slider</b>&quot;.
247-
</center>
248-
<div>Easy to use way to adjust spectrum energy range. <b>InterSpec</b> will remember if you want the energy slider chart showing.</div>
246+
<center> From <b>View</b> &rarr; &quot;<b>Chart Options</b>&quot; select &quot;<b>Show Energy Slider</b>&quot;.</center>
247+
<div>This is an easy to use way to adjust spectrum energy range.</div>
248+
<div><b>InterSpec</b> will remember if you want the energy slider chart showing.</div>
249249
</message>
250250

251251
<message id='4desktop-mouse-interactions-identifypeaks-desc'>
252252
<center>
253-
<p style="font-size: 14px"> To Identify peaks, you may use any of the following options: </p>
253+
<p style="font-size: 14px">There are a number of ways to fit peaks, including: </p>
254+
</center>
254255
<ol>
255-
<li>Double-Left-Click</li>
256-
<li><b><kbd>CTRL</kbd></b> + Left-Click Drag &rarr; Left-Click </li>
257-
<li>Left-Click "<b>Add</b>" &rarr; <u>Optional</u>: Double-Left-Click "<b>Mean</b>," "<b>FWHM</b>," or "<b>Area</b>" to adjust parameters</li>
258-
<li>Left-Click "<b>Search for Peaks</b>"</li>
256+
<li>Double-Left-Click. You can double click near the same peak again to add another one.</li>
257+
<li><b><kbd>CTRL</kbd></b> + Left-Click Drag &rarr; Left-Click (see &quot;ROI fit&quot;) </li>
258+
<li>From the &quot;<b>Peak Manager</b>&quot; tab click &quot;<b>Add</b>&quot; &rarr;. You can then adjust the parameters in the table to the values you would like.</li>
259+
<li>From the &quot;<b>Peak Manager</b>&quot; tab click &quot;<b>Search for Peaks</b>&quot; to git all the peaks in the spcetrum.</li>
260+
<li>Right-click on an existing peak and select &quot;<b>Add Peak</b>&quot; to add a peak to the same ROI.</li>
259261
</ol>
260-
</center>
262+
263+
<p>Hint: before fitting a peak it is useful to be showing the reference lines of the
264+
nuclide responsible for it, so this way when the peak is fit for, it will get associated
265+
with that nuclide. This infomation is used to fit for energy calibration, detector response, activity, and shielding quantities.
266+
</p>
261267
</message>
262268

263269

264270
<message id='4desktop-mouse-interactions-multipeaks-desc'>
271+
<div>To fit a definite number of peaks in a Region of Interest (ROI):</div>
265272
<center>
266-
To define how many peaks should be in a Region of Interest (ROI): <b><kbd>CTRL</kbd></b> + Left-Click Drag &rarr; and then select how many peaks.
267-
273+
<b><kbd>CTRL</kbd></b> + Left-Click Drag &rarr; and then select how many peaks.
268274
</center>
269275
</message>
270276

271277
<message id='7desktop-mouse-interactions-deletepeaks-desc'>
272-
<center>
273278
<ol>
274279
<li>Right-Click &rarr; "<b>Delete Peak</b>"</li>
275280
<li>Right-Click &rarr; "<b>Peak Editor</b>" &rarr; "<b>Delete</b>"</li>
276281
<li><b><kbd>SHIFT</kbd></b> + Left-Click Drag</li>
277282
<li>Left-Click "<b>Clear all Peaks</b>" &rarr; Left-Click "<b>Yes</b>"</li>
283+
<li>Drag one side of the ROI past the other side.</li>
278284
</ol>
279-
</center>
280285
</message>
281286

282287
<message id='6desktop-mouse-interactions-visualcalibration-desc'>
283-
<center> <kbd>CTRL</kbd> + <kbd>ALT</kbd> + Left-Click Drag &rarr; <u>Optional</u>: Adjust Quantities &rarr; "<b>Accept</b>"</center>
288+
<div>To graphically adjust energy calibration:</div>
289+
<center> <kbd>CTRL</kbd> + <kbd>ALT</kbd> + Left-Click Drag &rarr; <u>Optional</u>: Adjust Quantities &rarr; &quot;<b>Accept</b>&quot;</center>
290+
<div>Note: if do this action again, like first on a high energy peak, then on a low energy peak (or vice versa), the dialog that pops up will
291+
give you the option to preserve both actions by adjusting both the offset and gain so this way both peaks will remain at the energies you drug them to.
292+
</div>
293+
<p>The &quot;Energy Calibration&quot; tab also allows you to either manually adjust
294+
energy calibration coefficients, or fit for them using the nuclides associated with peaks.
295+
</p>
284296
</message>
285297

286298
<message id='5desktop-mouse-interactions-peakeditor-desc'>
@@ -290,16 +302,17 @@ To define how many peaks should be in a Region of Interest (ROI): <b><kbd>CTRL</
290302

291303

292304
<message id='8desktop-mouse-interactions-adjustROI-desc'>
293-
<center><div>Place mouse on edge of Region of Interest (ROI) and drag.</div>
294-
<div>Mouse must be within the y-range of the peak, and within 10 pixels of the edge of the ROI.</div>
295-
</center>
305+
<center><div>Place mouse near the edge of Region of Interest (ROI) and drag.</div></center>
306+
<div>Mouse must be within the y-range of the peak, and within 10 pixels of the edge of the ROI.</div>
296307
</message>
297308

298309

299310
<message id='8desktop-mouse-interactions-scale-y-desc'>
300-
<center>Scale the y-range of background and/or secondary spectra.
301-
<b>InterSpec</b> will remember if you want these sliders showing when there is a background or secondary spectrum.
311+
<center>Scale the amplitude of background and/or secondary spectra relative to the foreground
312+
by selecting <b>View</b> &rarr; &quot;<b>Chart Options</b>&quot; &rarr; &quot;<b>Show Y-Axis Scalers</b>&quot;.
302313
</center>
314+
<p>To restore the background or secondary spectrum to being live-time normalized, click the &quot;Normalize&quot; button on the &quot;Spectrum Files&quot; tab.</p>
315+
<p><b>InterSpec</b> will remember if you want these sliders showing when there is a background or secondary spectrum.</p>
303316
</message>
304317

305318

docs/releases/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
* Various smaller bug fixes and improvements
1414

1515
* Interactions with the spectra:
16-
* ![GitHub Logo](/images/logo.png)
17-
1816
* ![Zoom in and out](v1.0.4/ZoomInOut.gif)
1917

2018
* ![SHift the energy range shown](v1.0.4/ERShift.gif)
@@ -25,6 +23,8 @@
2523

2624
* ![Adjust the energy range of a Region of Interest (ROI)](v1.0.4/roi_range_adjust.gif)
2725

26+
* ![Fit for peaks](v1.0.4/PeakFit.gif)
27+
2828
* ![Fit for multiple peaks](v1.0.4/multi_peak_fit.gif)
2929

3030
* ![Drag on axis to adjust ranges](v1.0.4/axis_drag.gif)

docs/releases/v1.0.4/PeakFit.gif

316 KB
Loading

0 commit comments

Comments
 (0)