Skip to content

Commit

Permalink
Updated the documentation with a repo link
Browse files Browse the repository at this point in the history
Signed-off-by: James Till Matta <[email protected]>
  • Loading branch information
jmatta1 committed Feb 8, 2018
1 parent f22ad12 commit 0f5c6dc
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DecompLib/main_page.dox
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
@mainpage DecompLib
@tableofcontents
@section sec_intro Introduction
DecompLib is a small header only template library for decomposing a spectrum into a set of weighted response functions. The decomposition processes is necessary because the response of a detector to mono-energetic incident radiation is not necessarily mono-energetic, let alone at the same energy. Therefore to determine the radiation incident on the detector the detected spectrum must be decomposed using the response matrix (each row encodes the response to a particular mono-energetic input.)
<a href="https://github.com/jmatta1/DecompLib">DecompLib</a> is a small header only template library for decomposing a spectrum into a set of weighted response functions. The decomposition processes is necessary because the response of a detector to mono-energetic incident radiation is not necessarily mono-energetic, let alone at the same energy. Therefore to determine the radiation incident on the detector the detected spectrum must be decomposed using the response matrix (each row encodes the response to a particular mono-energetic input.)

This decomposition can be stated as the following fitting problem:
@f[
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
</div>
<div class="textblock"><h1><a class="anchor" id="sec_intro"></a>
Introduction</h1>
<p>DecompLib is a small header only template library for decomposing a spectrum into a set of weighted response functions. The decomposition processes is necessary because the response of a detector to mono-energetic incident radiation is not necessarily mono-energetic, let alone at the same energy. Therefore to determine the radiation incident on the detector the detected spectrum must be decomposed using the response matrix (each row encodes the response to a particular mono-energetic input.)</p>
<p><a href="https://github.com/jmatta1/DecompLib">DecompLib</a> is a small header only template library for decomposing a spectrum into a set of weighted response functions. The decomposition processes is necessary because the response of a detector to mono-energetic incident radiation is not necessarily mono-energetic, let alone at the same energy. Therefore to determine the radiation incident on the detector the detected spectrum must be decomposed using the response matrix (each row encodes the response to a particular mono-energetic input.)</p>
<p>This decomposition can be stated as the following fitting problem: </p><p class="formulaDsp">
\[ S = \sum\limits_{\alpha}f_{\alpha}\times{}\vec{R}_{\alpha} \]
</p>
Expand Down

0 comments on commit 0f5c6dc

Please sign in to comment.