TRestComponentDataSet. Adding some documentation parts

rest-for-physics · Dec 1, 2023 · c354aeb · c354aeb
1 parent 399f712
commit c354aeb
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 2 deletions.
diff --git a/doc/doxygen/images/component_hitmap.png b/doc/doxygen/images/component_hitmap.png
diff --git a/doc/doxygen/images/component_spectra.png b/doc/doxygen/images/component_spectra.png
diff --git a/source/framework/sensitivity/src/TRestComponentDataSet.cxx b/source/framework/sensitivity/src/TRestComponentDataSet.cxx
@@ -21,8 +21,52 @@
  *************************************************************************/
 
 /////////////////////////////////////////////////////////////////////////
-/// This class allows to ...
-///
+/// This class ...
+///
+/// \code
+///    <TRestComponentDataSet name="agSignal_vacuum">
+///    <!-- We add here all the axion-photon coupling components -->
+///        <dataset filename="${DUST}/Dataset_BabyIAXO_XMM_mm_Vacuum.root" weight="1" />
+///
+///        <variable name="final_posX" range="(-10,10)mm" bins="10" />
+///        <variable name="final_posY" range="(-10,10)mm" bins="10" />
+///        <variable name="final_energy" range="(0,10)keV" bins="20" />
+///
+///        <parameter name="weights" value="{NGamma}"/>
+///        <parameter name="parameter" value="final_mass" />
+///        <parameter name="parameterizationNodes" value="" />
+///    </TRestComponentDataSet>
+/// \endcode
+///
+/// \code
+///     restRoot
+///     [0] TRestComponentDataSet comp("components.rml", "agSignal_vacuum");
+///     [1] comp.LoadDataSets()
+///     [2] TFile *f = TFile::Open("vacuumComponent.root", "RECREATE");
+///     [3] comp.Write("agSignal_vacuum");
+/// \endcode
+///
+/// \code
+///     restRoot vacuumComponents.root
+///     [0] TCanvas *c = agVacuum->DrawComponent( { "final_posX", "final_posY"}, {"final_energy"}, 2);
+///	    [1] c->Print("component_hitmaps.png");
+/// \endcode
+///
+/// \htmlonly <style>div.image img[src="component_hitmap.png"]{width:750px;}</style> \endhtmlonly
+/// ![A 2-dimensional histogram scan versus the `final_energy` observable, generated by the DrawComponent
+/// method](component_hitmap.png)
+///
+/// \code
+///     restRoot vacuumComponents.root
+///     [0] TCanvas *c = agVacuum->DrawComponent( { "final_energy"}, {"final_posX", "final_posY"}, 2);
+///	    [1] c->Print("component_hitmaps.png");
+/// \endcode
+///
+/// In both cases each plot will regroup 2 bins.
+///
+/// \htmlonly <style>div.image img[src="component_spectra.png"]{width:750px;}</style> \endhtmlonly
+/// ![A 1-dimensional histogram scan versus the `final_posX` and `final_posY` observables, generated by the
+/// DrawComponent method](component_spectra.png)
 ///
 ///----------------------------------------------------------------------
 ///