Skip to content

Commit c995661

Browse files
committed
Add release and tutorials/example-problem listings.
1 parent b61c260 commit c995661

File tree

2 files changed

+65
-5
lines changed

2 files changed

+65
-5
lines changed

docs/releases/index.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,59 @@
11
## v1.0.4 (July 21, 2019)
2-
2+
This release primarily improves the interactivity with the spectrum.
3+
Download Windows, Linux, and macOS binaries from: https://github.com/sandialabs/InterSpec/releases/tag/v1.0.4
34

45
* Bug fixes:
56
* InterSpec would not start for Windows users with some non-English characters (ex, an umlaut) in their user names. Paths with these letters also affected the file query tool, or if the open file menu item was used to open spectrum file.
67
* The "Add Peak" option when a Region of Interest (ROI) is right clicked had issue resulting in peaks not actually being added
78
* Windows and Linux version of app could sometimes get duplicate menu items
89

910
* New Features:
10-
* Based on the awesome work by Christian Morte (@kenmorte) of using [D3.js](https://d3js.org/) to plot spectrum files, the plotting and interacting with spectra has been completely re-written, and made substantially better. See below videos for an overview of how to interact with the spectrum.
11+
* Based on the awesome work by [Christian Morte](https://github.com/kenmorte) of using [D3.js](https://d3js.org/) to plot spectrum files, the plotting and interacting with spectra has been completely re-written, and made substantially better. See below videos for an overview of how to interact with the spectrum.
12+
* This new charting mechanism will make it easier to implement richer, more interactive features in the future.
1113
* On touch-devices, some touch interactions are working, but there is no timeline for when the rest will be implemented, so for now phone and tablet versions of the app will use the old charting mechanism
14+
* There are significant additional performance improvements and user experience improvements possible, but there is no timeline for this work
15+
* Added some example problems and solutions available at https://sandialabs.github.io/InterSpec/tutorials/
1216
* Added a few new file formats (TKA, MultiAct), and some new N42 format variants
13-
* Various smaller bug fixes and improvements
17+
* A number of smaller bug fixes and improvements
18+
19+
### Interactions with the spectra:
20+
All these videos are also available within `InterSpec` by going to the **Help** → **Welcome...** menu item, and then selecting the **Controls** tab.
1421

15-
* Interactions with the spectra:
1622
* ![Zoom in and out](v1.0.4/ZoomInOut.gif)
23+
* Left-click and drag to the right to zoom in, and left-click and drag to the left to zoom out (same as before).
24+
* Or use the energy slider chart (see below)
1725

18-
* ![SHift the energy range shown](v1.0.4/ERShift.gif)
26+
* ![Shift the energy range shown](v1.0.4/ERShift.gif)
27+
* Use the right mouse button to grab and drag the spectrum left and right.
28+
* You can also use the vertical scroll-wheel (if your mouse or trackpad supports this) to move the chart left and right.
29+
* You can also "grab" the x-axis using the left mouse button to drag it left and right.
30+
* Or use the energy slider chart (see below)
1931

2032
* ![Use energy slider chart to control displayed energy range](v1.0.4/energy_slider.gif)
33+
* Select the **View** → **Chart Options** → **Show Energy Slider** menu item to enable the slider chart. Whether this chart is shown or not is remembered by `InterSpec` in future sessions.
2134

2235
* ![Scale background and/or secondary spectrum](v1.0.4/yscale.gif)
36+
* Select the **View** → **Chart Options** → **Show Y-Axis Scalers** menu option to enable the scalers on the right side of the chart. Scalers are only shown for the background and secondary spectra, and only when they are plotted (eg, if you are only displaying a foreground spectrum, no sliders will be shown). The **Spectrum Files** tab has a button to re-Live-Time normalize the spectra (which `InterSpec` does by default) if you wish. Whether these scalers are shown or not is remembered by `InterSpec` in future sessions.
2337

2438
* ![Adjust the energy range of a Region of Interest (ROI)](v1.0.4/roi_range_adjust.gif)
39+
* Move your mouse to within 10 pixels of the edge of a ROI, and the cursor will change indicating you can left-click and drag the ROI edge to where you would like. Your mouse must also be approximately within the Y-axis range of the peak as well (this is so when you have HPGe spectra with many peaks, you wont accidentally grab a ROI edge when zooming in and out).
40+
* Dragging one side of a ROI past the other side of a ROI will delete the ROI.
2541

2642
* ![Fit for peaks](v1.0.4/PeakFit.gif)
43+
* Same as before. The easiest way to fit a peak is to just double click in the vicinity of the peak region. If you want to add another peak nearby, just double click again. You can also right-click on a peak and select to add a peak in the same region of interest (ROI).
2744

2845
* ![Fit for multiple peaks](v1.0.4/multi_peak_fit.gif)
46+
* <kbd>CTRL</kbd> + Left-Click-and-Drag. When you release the mouse a menu will pop up and allow you to select how many peaks you would like in the ROI.
2947

3048
* ![Drag on axis to adjust ranges](v1.0.4/axis_drag.gif)
49+
* You can change the axis ranges by clicking and dragging the ticks.
50+
* The y-axis also responds to the mouse wheel, which lets you adjust the padding both on the top, and the bottom of the y-axis
3151

3252
* ![Visual Energy Calibration](v1.0.4/VisRecalib.gif)
53+
* <kbd>CTRL</kbd> + <kbd>ALT</kbd> + Left-Click-Drag
54+
* If you do this twice in a row, like first on a low energy peak, then a high energy peak (or vice versa), the dialog that pops up will have an option that will make it so both of your calibrations points will be preserved by adjusting both the gain and offset.
55+
56+
* See the **Controls** tab of the **Welcome** screen in `InterSpec` for more.
3357

3458

3559

docs/tutorials/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Tutorials
2+
3+
## An overview of using InterSpec for Analysis
4+
See [brief_ana_overview_InterSpec_Oct2018.pdf](brief_analysis_intro/brief_ana_overview_InterSpec_Oct2018.pdf).
5+
Data files:
6+
* [Example1.pcf](brief_analysis_intro/spectra/Example1.pcf)
7+
* [Example1_background.pcf](brief_analysis_intro/spectra/Example1_background.pcf)
8+
* [Example2d_worked.n42](brief_analysis_intro/spectra/Example2d_worked.n42)
9+
* [Example3_worked.n42](brief_analysis_intro/spectra/Example3_worked.n42)
10+
11+
## Making a Detector Response Function
12+
Tutorial on making a detector response function in InterSpec: [detector_characterization_brief_20190619.pdf](make_drf/detector_characterization_brief_20190619.pdf).
13+
Further information (also available within InterSpec in its help system) is in [make_drf_help_20190619.pdf](make_drf/make_drf_help_20190619.pdf)
14+
* Example data for HPGe (see [source_info.txt](make_drf/cal_data_HPGe/source_info.txt) for source and detector information):
15+
* [drf_cal_HPGe_Am241.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Am241.pcf), [drf_cal_HPGe_Cd109.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Cd109.pcf), [drf_cal_HPGe_Co60.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Co60.pcf), [drf_cal_HPGe_Na22.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Na22.pcf), [drf_cal_HPGe_Ba133.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Ba133.pcf), [drf_cal_HPGe_Co57.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Co57.pcf), [drf_cal_HPGe_Cs137.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_Cs137.pcf), [drf_cal_HPGe_U232.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_U232.pcf), [drf_cal_HPGe_background.pcf](make_drf/cal_data_HPGe/drf_cal_HPGe_background.pcf)
16+
* [source_info.txt](make_drf/cal_data_HPGe/source_info.txt)
17+
* Example data for NaI:
18+
* [drf_cal_NaI_am241.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_am241.pcf), [drf_cal_NaI_cd109.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_cd109.pcf), [drf_cal_NaI_co60.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_co60.pcf), [drf_cal_NaI_na22.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_na22.pcf), [drf_cal_NaI_ba133.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_ba133.pcf), [drf_cal_NaI_co57.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_co57.pcf), [drf_cal_NaI_cs137.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_cs137.pcf), [drf_cal_NaI_u232.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_u232.pcf), [drf_cal_NaI_y88.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_y88.pcf), [drf_cal_NaI_22Na_18F.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_22Na_18F.pcf), [drf_cal_NaI_background.pcf](make_drf/cal_data_NaI_3x3/drf_cal_NaI_background.pcf)
19+
* [source_info.txt](make_drf/cal_data_NaI_3x3/source_info.txt)
20+
21+
22+
23+
## Example Problems
24+
* Determine nuclide, and distance a source is inside a cargo container in a high scatter environment
25+
* Problem Setup: [cargo_container_question.pdf](example_problems/one_over_r2/problem_1/cargo_container/cargo_container_question.pdf)
26+
* Problem Solution: [cargo_container_solution.pdf](example_problems/one_over_r2/problem_1/cargo_container/cargo_container_solution.pdf)
27+
* Spectrum file with data: [cargo_container_3x3NaI.n42](example_problems/one_over_r2/problem_1/cargo_container/cargo_container_3x3NaI.n42)
28+
* Determine nuclide, activity, and depth of a buried source from a single HPGe measurement
29+
* Problem Setup: [buried_source_question.pdf](example_problems/determine_activity_shielding/problem_1/buried_source_question.pdf)
30+
* Problem Solution: [buried_source_solution.pdf](example_problems/determine_activity_shielding/problem_1/buried_source_solution.pdf)
31+
* Spectrum file with data: [buried_source_40%_HPGe.n42](example_problems/determine_activity_shielding/problem_1/buried_source_40%_HPGe.n42)
32+
* Determine Uranium enrichment and mass
33+
* Problem Setup: [uranium_problem_one_question.pdf](example_problems/uranium_enrichment/problem_1/uranium_problem_one_question.pdf)
34+
* Problem Solution: [uranium_problem_one_solution.pdf](example_problems/uranium_enrichment/problem_1/uranium_problem_one_solution.pdf)
35+
* Spectrum file with data: [uranium_40%_HPGe_15cm.n42](example_problems/uranium_enrichment/problem_1/uranium_40%_HPGe_15cm.n42)
36+

0 commit comments

Comments
 (0)