diff --git a/DecompLib/main_page.dox b/DecompLib/main_page.dox index 58e8168..2ae2a5c 100644 --- a/DecompLib/main_page.dox +++ b/DecompLib/main_page.dox @@ -54,6 +54,8 @@ For more information about the usage and member functions of DataVector, RespMat To learn more about \ref performDecomposition check out the \ref Calculation module. +@section sec_doc Documentation +Documentation is available in a few forms. For the full documenation of DecompLib's objects and functions please see the \ref IO and \ref Calculation modules. For more about usage of the algorithm itself and the potential alternative uses and pitfalls associated with it, see the second half of the technical report in the doc directory. @section sec_example Example DecompLib contains a directory called Example. This directory contains a program demonstrating the usage of DecompLib as well as four utility functions to assist with the input and output to the example. diff --git a/README.md b/README.md index 8982bf9..4910a2b 100644 --- a/README.md +++ b/README.md @@ -171,5 +171,3 @@ long long retVal = performDecomposition(inputSpectrum, responseMatrix, //member function `getElement(binNumber)` ``` -To learn more about the particular pitfalls that are possible with the algorithm please see the second half technical report in the DecompLib doc directory. - diff --git a/docs/index.html b/docs/index.html index 209888e..a59c4d0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -115,6 +115,7 @@
Usage of the library is simple. One need only instantiate one of each of the three classes, fill them with data, then call the performDecomposition function to decompose the spectrum. Since code is worth more than prose for this a semi-pseudocode example is below.
For more information about the usage and member functions of DataVector, RespMatrix, and DecompVector check out the Input/Output Classes module.
To learn more about performDecomposition check out the Decomposition Functions module.
+Documentation is available in a few forms. For the full documenation of DecompLib's objects and functions please see the Input/Output Classes and Decomposition Functions modules. For more about usage of the algorithm itself and the potential alternative uses and pitfalls associated with it, see the second half of the technical report in the doc directory.
DecompLib contains a directory called Example. This directory contains a program demonstrating the usage of DecompLib as well as four utility functions to assist with the input and output to the example.
diff --git a/docs/navtreedata.js b/docs/navtreedata.js index f07685e..6e73313 100644 --- a/docs/navtreedata.js +++ b/docs/navtreedata.js @@ -7,6 +7,7 @@ var NAVTREE = [ "Install", "index.html#ssec_install", null ] ] ], [ "Usage", "index.html#sec_use", null ], + [ "Documentation", "index.html#sec_doc", null ], [ "Example", "index.html#sec_example", [ [ "DecomposeSpectrum", "index.html#ssec_decompose", null ], [ "RootTh1ToCsv", "index.html#ssec_root1d", null ], diff --git a/docs/navtreeindex0.js b/docs/navtreeindex0.js index b4dd8ed..dbff2eb 100644 --- a/docs/navtreeindex0.js +++ b/docs/navtreeindex0.js @@ -1,92 +1,93 @@ var NAVTREEINDEX0 = { -"_data_vector_8h.html":[7,0,0,0], -"_data_vector_8h_source.html":[7,0,0,0], -"_decomp_vector_8h.html":[7,0,0,2], -"_decomp_vector_8h_source.html":[7,0,0,2], -"_decomposition_8h.html":[7,0,0,1], -"_decomposition_8h_source.html":[7,0,0,1], -"_helper_8h.html":[7,0,0,3], -"_helper_8h_source.html":[7,0,0,3], -"_resp_matrix_8h.html":[7,0,0,4], -"_resp_matrix_8h_source.html":[7,0,0,4], -"annotated.html":[6,0], -"class_data_vector.html":[5,1,0], -"class_data_vector.html#a0845d3ed7a4c871c1fe077f07511f82c":[5,1,0,4], -"class_data_vector.html#a2fcb29f2799521a5fd154c905f395477":[5,1,0,5], -"class_data_vector.html#a33b29d735bfb18caaff69f0ea86ccb5c":[5,1,0,0], -"class_data_vector.html#a503260d1c8e8f6f69ef29f6c920d2f17":[5,1,0,1], -"class_data_vector.html#a6a34787d14d4c765063437ce96fa100d":[5,1,0,9], -"class_data_vector.html#a6e2964cc4ff5514f6237525105d421d4":[5,1,0,2], -"class_data_vector.html#a7316e4c8a7e442614d67c61e7e0f6c66":[5,1,0,7], -"class_data_vector.html#a9ab925631f37d914a09174d195b862ce":[5,1,0,8], -"class_data_vector.html#a9ae9fa31d7d1470791210869a5272061":[5,1,0,3], -"class_data_vector.html#aa35652d95bc5237a12b416073184cf53":[5,1,0,6], -"class_decomp_vector.html":[5,1,1], -"class_decomp_vector.html#a037c78baf69ad787fd980277a4e7f8f7":[5,1,1,7], -"class_decomp_vector.html#a19cc2b2226f1f17b2e451ddddcef4e3b":[5,1,1,3], -"class_decomp_vector.html#a3c074e1468d1a82e15be8f915fe997fb":[5,1,1,12], -"class_decomp_vector.html#a4b37489624d21b7faf959e4a66f853d3":[5,1,1,13], -"class_decomp_vector.html#a600c8a61101049134a79b2f699386f81":[5,1,1,4], -"class_decomp_vector.html#a8a7e5fadf7429e06467b6f63a0b64776":[5,1,1,0], -"class_decomp_vector.html#aa21e0c2851308399463f5e8f91365807":[5,1,1,14], -"class_decomp_vector.html#aa376eeb4c67ea32608189e65c8420bfe":[5,1,1,1], -"class_decomp_vector.html#aaac56954ca426d119fb49a0bece2a279":[5,1,1,6], -"class_decomp_vector.html#ab4f6ce9cf5fd74a97e4effc54a4336e2":[5,1,1,5], -"class_decomp_vector.html#ac0fb335dee78c1e36f3b710a863ae2f7":[5,1,1,10], -"class_decomp_vector.html#ac2102597cc8436ccf8fc5d46e6d9344b":[5,1,1,11], -"class_decomp_vector.html#ac235f12fff61d7a49535174a2b0a361e":[5,1,1,8], -"class_decomp_vector.html#aeb7b3b13184692ad2db75c11ffccd1df":[5,1,1,2], -"class_decomp_vector.html#af630f8e7024380afb480065a30c80250":[5,1,1,9], -"class_resp_matrix.html":[5,1,2], -"class_resp_matrix.html#a1ac40bc56ef7532ad7959c239de8a65e":[5,1,2,17], -"class_resp_matrix.html#a2e71d57803da82da1bb4987957339346":[5,1,2,1], -"class_resp_matrix.html#a366309b2bcf6e3b5d46d4fba3422827b":[5,1,2,3], -"class_resp_matrix.html#a4e64a54ec7f11c4003fed268938e5a18":[5,1,2,10], -"class_resp_matrix.html#a5027c13a92377e4c7e07501ffaf1d6c5":[5,1,2,2], -"class_resp_matrix.html#a89cfffe66a1910d75fc81e192b17e504":[5,1,2,18], -"class_resp_matrix.html#a90e1bd2ecfe3a86a992aa3d061bec106":[5,1,2,5], -"class_resp_matrix.html#a99284515560aeb2962174c8a8da34728":[5,1,2,0], -"class_resp_matrix.html#a9a3f84142d6c9a9070d8d331776f6cc1":[5,1,2,9], -"class_resp_matrix.html#aa0e9fb8584974e469de539e816b83fa0":[5,1,2,11], -"class_resp_matrix.html#ab99399ebe459e46bc85497fea80bb682":[5,1,2,4], -"class_resp_matrix.html#ac67508293efa2ac46e5e18635c6ccabd":[5,1,2,6], -"class_resp_matrix.html#ad1a2f8260c93e59f82a2205d2b739852":[5,1,2,8], -"class_resp_matrix.html#ad57044b1edfec7615636ae639d30e632":[5,1,2,16], -"class_resp_matrix.html#ae68ab1c8e09cd89a7ec54f6e400ae3d5":[5,1,2,13], -"class_resp_matrix.html#aef02393b54a75d94690068d55a0909cf":[5,1,2,15], -"class_resp_matrix.html#af70bcc465ea4ea9303cfa22b38ed1419":[5,1,2,14], -"class_resp_matrix.html#af955bb8d74a488c8cfb403442091c294":[5,1,2,7], -"class_resp_matrix.html#afa8b3ea779b3d6bcf87064962cdb3aa8":[5,1,2,12], -"classes.html":[6,1], -"dir_f43a96c71b34c03fa2e20309f896b591.html":[7,0,0], -"files.html":[7,0], -"functions.html":[6,2,0], -"functions_func.html":[6,2,1], -"functions_vars.html":[6,2,2], -"globals.html":[7,1,0], -"globals_func.html":[7,1,1], -"group___calculation.html":[5,0], -"group___calculation.html#ga255b08dd193b8e7c84f69e1d8437f446":[7,0,0,1,0], -"group___calculation.html#ga255b08dd193b8e7c84f69e1d8437f446":[5,0,0], -"group___calculation.html#ga425febb7e12ac0f2792d12f3f97d23b7":[7,0,0,3,1], -"group___calculation.html#ga425febb7e12ac0f2792d12f3f97d23b7":[5,0,2], -"group___calculation.html#ga4f3a181671aa26c2f6ecd903e8d08885":[5,0,1], -"group___calculation.html#ga4f3a181671aa26c2f6ecd903e8d08885":[7,0,0,3,0], -"group___i_o.html":[5,1], +"_data_vector_8h.html":[8,0,0,0], +"_data_vector_8h_source.html":[8,0,0,0], +"_decomp_vector_8h.html":[8,0,0,2], +"_decomp_vector_8h_source.html":[8,0,0,2], +"_decomposition_8h.html":[8,0,0,1], +"_decomposition_8h_source.html":[8,0,0,1], +"_helper_8h.html":[8,0,0,3], +"_helper_8h_source.html":[8,0,0,3], +"_resp_matrix_8h.html":[8,0,0,4], +"_resp_matrix_8h_source.html":[8,0,0,4], +"annotated.html":[7,0], +"class_data_vector.html":[6,1,0], +"class_data_vector.html#a0845d3ed7a4c871c1fe077f07511f82c":[6,1,0,4], +"class_data_vector.html#a2fcb29f2799521a5fd154c905f395477":[6,1,0,5], +"class_data_vector.html#a33b29d735bfb18caaff69f0ea86ccb5c":[6,1,0,0], +"class_data_vector.html#a503260d1c8e8f6f69ef29f6c920d2f17":[6,1,0,1], +"class_data_vector.html#a6a34787d14d4c765063437ce96fa100d":[6,1,0,9], +"class_data_vector.html#a6e2964cc4ff5514f6237525105d421d4":[6,1,0,2], +"class_data_vector.html#a7316e4c8a7e442614d67c61e7e0f6c66":[6,1,0,7], +"class_data_vector.html#a9ab925631f37d914a09174d195b862ce":[6,1,0,8], +"class_data_vector.html#a9ae9fa31d7d1470791210869a5272061":[6,1,0,3], +"class_data_vector.html#aa35652d95bc5237a12b416073184cf53":[6,1,0,6], +"class_decomp_vector.html":[6,1,1], +"class_decomp_vector.html#a037c78baf69ad787fd980277a4e7f8f7":[6,1,1,7], +"class_decomp_vector.html#a19cc2b2226f1f17b2e451ddddcef4e3b":[6,1,1,3], +"class_decomp_vector.html#a3c074e1468d1a82e15be8f915fe997fb":[6,1,1,12], +"class_decomp_vector.html#a4b37489624d21b7faf959e4a66f853d3":[6,1,1,13], +"class_decomp_vector.html#a600c8a61101049134a79b2f699386f81":[6,1,1,4], +"class_decomp_vector.html#a8a7e5fadf7429e06467b6f63a0b64776":[6,1,1,0], +"class_decomp_vector.html#aa21e0c2851308399463f5e8f91365807":[6,1,1,14], +"class_decomp_vector.html#aa376eeb4c67ea32608189e65c8420bfe":[6,1,1,1], +"class_decomp_vector.html#aaac56954ca426d119fb49a0bece2a279":[6,1,1,6], +"class_decomp_vector.html#ab4f6ce9cf5fd74a97e4effc54a4336e2":[6,1,1,5], +"class_decomp_vector.html#ac0fb335dee78c1e36f3b710a863ae2f7":[6,1,1,10], +"class_decomp_vector.html#ac2102597cc8436ccf8fc5d46e6d9344b":[6,1,1,11], +"class_decomp_vector.html#ac235f12fff61d7a49535174a2b0a361e":[6,1,1,8], +"class_decomp_vector.html#aeb7b3b13184692ad2db75c11ffccd1df":[6,1,1,2], +"class_decomp_vector.html#af630f8e7024380afb480065a30c80250":[6,1,1,9], +"class_resp_matrix.html":[6,1,2], +"class_resp_matrix.html#a1ac40bc56ef7532ad7959c239de8a65e":[6,1,2,17], +"class_resp_matrix.html#a2e71d57803da82da1bb4987957339346":[6,1,2,1], +"class_resp_matrix.html#a366309b2bcf6e3b5d46d4fba3422827b":[6,1,2,3], +"class_resp_matrix.html#a4e64a54ec7f11c4003fed268938e5a18":[6,1,2,10], +"class_resp_matrix.html#a5027c13a92377e4c7e07501ffaf1d6c5":[6,1,2,2], +"class_resp_matrix.html#a89cfffe66a1910d75fc81e192b17e504":[6,1,2,18], +"class_resp_matrix.html#a90e1bd2ecfe3a86a992aa3d061bec106":[6,1,2,5], +"class_resp_matrix.html#a99284515560aeb2962174c8a8da34728":[6,1,2,0], +"class_resp_matrix.html#a9a3f84142d6c9a9070d8d331776f6cc1":[6,1,2,9], +"class_resp_matrix.html#aa0e9fb8584974e469de539e816b83fa0":[6,1,2,11], +"class_resp_matrix.html#ab99399ebe459e46bc85497fea80bb682":[6,1,2,4], +"class_resp_matrix.html#ac67508293efa2ac46e5e18635c6ccabd":[6,1,2,6], +"class_resp_matrix.html#ad1a2f8260c93e59f82a2205d2b739852":[6,1,2,8], +"class_resp_matrix.html#ad57044b1edfec7615636ae639d30e632":[6,1,2,16], +"class_resp_matrix.html#ae68ab1c8e09cd89a7ec54f6e400ae3d5":[6,1,2,13], +"class_resp_matrix.html#aef02393b54a75d94690068d55a0909cf":[6,1,2,15], +"class_resp_matrix.html#af70bcc465ea4ea9303cfa22b38ed1419":[6,1,2,14], +"class_resp_matrix.html#af955bb8d74a488c8cfb403442091c294":[6,1,2,7], +"class_resp_matrix.html#afa8b3ea779b3d6bcf87064962cdb3aa8":[6,1,2,12], +"classes.html":[7,1], +"dir_f43a96c71b34c03fa2e20309f896b591.html":[8,0,0], +"files.html":[8,0], +"functions.html":[7,2,0], +"functions_func.html":[7,2,1], +"functions_vars.html":[7,2,2], +"globals.html":[8,1,0], +"globals_func.html":[8,1,1], +"group___calculation.html":[6,0], +"group___calculation.html#ga255b08dd193b8e7c84f69e1d8437f446":[8,0,0,1,0], +"group___calculation.html#ga255b08dd193b8e7c84f69e1d8437f446":[6,0,0], +"group___calculation.html#ga425febb7e12ac0f2792d12f3f97d23b7":[8,0,0,3,1], +"group___calculation.html#ga425febb7e12ac0f2792d12f3f97d23b7":[6,0,2], +"group___calculation.html#ga4f3a181671aa26c2f6ecd903e8d08885":[6,0,1], +"group___calculation.html#ga4f3a181671aa26c2f6ecd903e8d08885":[8,0,0,3,0], +"group___i_o.html":[6,1], "index.html":[], -"index.html#sec_example":[3], -"index.html#sec_extended":[4], +"index.html#sec_doc":[3], +"index.html#sec_example":[4], +"index.html#sec_extended":[5], "index.html#sec_install":[1], "index.html#sec_intro":[0], "index.html#sec_use":[2], "index.html#ssec_build":[1,0], -"index.html#ssec_csv1d":[3,3], -"index.html#ssec_csv2d":[3,4], -"index.html#ssec_decompose":[3,0], +"index.html#ssec_csv1d":[4,3], +"index.html#ssec_csv2d":[4,4], +"index.html#ssec_decompose":[4,0], "index.html#ssec_install":[1,1], -"index.html#ssec_root1d":[3,1], -"index.html#ssec_root2d":[3,2], -"modules.html":[5], +"index.html#ssec_root1d":[4,1], +"index.html#ssec_root2d":[4,2], +"modules.html":[6], "pages.html":[] };