Skip to content

Commit 0c16643

Browse files
committed
Slightly improve documentation for "Rel. B.R." in nuclide search.
1 parent 876746b commit 0c16643

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

InterSpec_resources/static_text/nuclide_search_help.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ Rows of the results table can be clicked on (in the image to the left the second
3535
<td style="border: 1px solid black;">The energy of the gamma/x-ray that matched to within the search window.</td></tr>
3636
<tr><th style="border: 1px solid black;"><b>Diff.</b></th>
3737
<td style="border: 1px solid black;">The sum of all energy difference between searched energies, and the matched gamma/x-ray. Especially for HPGe spectra, sorting by this column will allow listing sources closest to energy to what was searched for. However, there is no lower limit on the matching branching ratio, so nuclides with many many gammas may still be listed before the desired nuclide.</td></tr>
38-
<tr><th style="border: 1px solid black;"><b>B.R.</b></th>
39-
<td style="border: 1px solid black;">The branching ratio the gamma or x-ray matched to the search window has. Sorting the result table by this column will often work well when searching on the energies of particularly dominant peaks in the spectrum; the sum of all searched on energies is used to perform the sorting.</td></tr>
38+
<tr><th style="border: 1px solid black;"><b><nobr>Rel. B.R.</nobr></b></th>
39+
<td style="border: 1px solid black;">The branching ratio of the matched gamma or x-ray, relative to that nuclides largest gamma branching ratio.<br />
40+
For example, if you search on 185.71 keV, the U235 result will show a Rel. B.R. of 0.94; this is because the 19.59 keV gamma is the most abundant gamma with a BR of 0.61, so the 0.572 BR of 185.71 keV will be divided by 0.61 to give the displayed result of 0.94.<br />
41+
Sorting the result table by this column will often work well when searching on the energies of particularly dominant peaks in the spectrum; when multiple energies are searched on, the sum of all searched energies is used to perform the sorting.
42+
</td></tr>
4043
<tr><th style="border: 1px solid black;"><b>Profile</b></th>
4144
<td style="border: 1px solid black;">This number tries to represent how well the profile of the observed spectrum matches expected peaks of a particular result. The higher value this number is, the better candidate a particular result is. Many (non-rigurously derived) factors go into calculating this number, but it tries to take into account if a peak due to a candidate source is seen, what other peaks should be seen in the spectrum, or do the amplitudes of the observed peaks that can be attributed to the candidate soruce, have a reasonable amplitude. This value will work best when the user has fit the unknown peaks in a spectrum, or at least difficult peak areas of the spectrum (<em>InterSpec</em>s automated peak search is also performed, and combined with the user peaks, but often time user can do a better job fitting hard to fit peaks). This is the default column results are sorted by.</td></tr>
4245

src/IsotopeSearchByEnergyModel.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1474,7 +1474,7 @@ boost::any IsotopeSearchByEnergyModel::headerData( int section,
14741474
case IsotopeSearchByEnergyModel::Column::Distance:
14751475
return WString("Difference between selected nuclide's energy level and searched energy level");
14761476
case IsotopeSearchByEnergyModel::Column::Energy:
1477-
return WString("Nuclide energy");
1477+
return WString("True gamma/x-ray energy");
14781478
case IsotopeSearchByEnergyModel::Column::BranchRatio:
14791479
return WString("Branching ratio, relative to the nuclides largest yield gamma"
14801480
" (i.e., 1.0 indicates the most abundant gamma, not one gamma per decay)");

0 commit comments

Comments
 (0)