Commit 6d5c7c07 authored by clantz's avatar clantz
Browse files

Made many changes to doxygen comments for html formatting

parent 13c389db
......@@ -32,8 +32,8 @@ DataReader::DataReader() : DataReader( 0, 0, "", 0 ){
/** @brief Constructor for DataReader.
*
* @param1 Number of channels being read
* @param2 Number of samples per channel
* @param nCh Number of channels being read
* @param nSamp Number of samples per channel
*/
DataReader::DataReader( const unsigned int nCh, const unsigned int nSamp )
: DataReader( nCh, nSamp, "", 0 ){
......@@ -45,9 +45,9 @@ DataReader::DataReader( const unsigned int nCh, const unsigned int nSamp )
/** @brief Constructor for DataReader.
*
* @param1 Number of channels being read
* @param2 Number of samples per channel
* @param3 Input filename.
* @param nCh Number of channels being read
* @param nSamp Number of samples per channel
* @param fNameIn Input filename.
*/
DataReader::DataReader( const uint nCh, const uint nSamp,
const std::string& fNameIn )
......@@ -58,10 +58,10 @@ DataReader::DataReader( const uint nCh, const uint nSamp,
/** @brief Constructor for DataReader.
*
* @param1 Number of channels being read
* @param2 Number of samples per channel
* @param4 Output file name (custom)
* @param3 Run number being used.
* @param nCh Number of channels being read
* @param nSamp Number of samples per channel
* @param4 fNameIn Output file name (custom)
* @param3 runNum Run number being used.
*/
DataReader::DataReader( const uint nCh, const uint nSamp,
......@@ -83,7 +83,7 @@ DataReader::~DataReader(){
/** @brief Adds an analysis to vector of analysis
*
* @param1 Pointer to an Analysis.
* @param ana Pointer to an Analysis.
*
* @return none
*/
......@@ -94,7 +94,7 @@ void DataReader::AddAnalysis( Analysis* ana ){
/** @brief Enables the read from list of files option for DataReader
*
* @param1 name of the list of files to be processed (with the full path if it's not in the execution folder)
* @param listname name of the list of files to be processed (with the full path if it's not in the execution folder)
*
* @return none
*/
......@@ -228,11 +228,11 @@ Detector* DataReader::GetDetector( std::string _detName ){
/** @brief Run method for DataReader
* @return none
*
* Call Initialize, ProcessEvents, and Finalize
* Made so the driver class only has to call one method.
*
* @return none
*/
void DataReader::Run(){
......
......@@ -27,6 +27,9 @@ Detector::~Detector( ){
}
/** @brief Get the properties of a detector element
* @param row Row of element to be accessed
* @param column Column of element to be accessed
* @return Pointer to the Channel of the requested element
*
* Returns a pointer to the Channel stored in m_Elements with the
* requested row and column.
......
......@@ -21,6 +21,10 @@ RPD::RPD( ){
}
/** @brief Constructor that takes the whole vector of channels readout and selects and stores only the RPD ones
* @param _readOut Vector of Channels with all detector configs
*
* Creates a new RPD type Detector and picks the relevant Channels from the input vector.
*
*/
RPD::RPD( std::vector < Channel* > _readOut){
......@@ -47,6 +51,9 @@ RPD::~RPD( ){
}
/** @brief Get the properties of a detector element
* @param row Row of element to be accessed
* @param column Column of element to be accessed
* @return Pointer to the Channel of the requested element
*
* If m_SortedElements is populated, return the element in
* m_SortedElements[row][column].
......
......@@ -38,7 +38,6 @@ WFAnalysis::~WFAnalysis( ){
* perhaps not put into the constructor.
* I.e. a TTree, some tools. Etc.
*
* @return none
*/
void WFAnalysis::Initialize( ){
......@@ -57,13 +56,12 @@ void WFAnalysis::SetupHistograms( ){
/** @brief Analyze Events method for WFAnalysis
* @param vWF 1D vector of all waveforms for N ch
*
* Here is the event-based analysis code.
* A const 1D vector of N TH1* is received.
* N is the number of channels
*
* @param1 1D vector of all waveforms for N ch
* @return none
*/
void WFAnalysis::AnalyzeEvent( const std::vector< TH1* >& vWFH ){
......@@ -79,13 +77,13 @@ void WFAnalysis::AnalyzeEvent( const std::vector< TH1* >& vWFH ){
/** @brief Analyze Events method for WFAnalysis
* @param vWF const 2D vector for all waveforms in event
*
* Here is the event-based analysis code.
* A const 2D vector of NxM is received.
* N is the number of channels
* M is the number of samples per channel
*
* @param1 cosnt 2D vector for all waveforms in event
* @return none
*/
void WFAnalysis::AnalyzeEvent( const std::vector< std::vector< float > >& vWF ){
......@@ -103,11 +101,12 @@ void WFAnalysis::AnalyzeEvent( const std::vector< std::vector< float > >& vWF ){
/**
* @brief Analyze Event method for WF analysis
* @param vCh A vector of pointers to Channel objects
*
* Receives a const vector of Channels. Loops over all Channels within
* the vector for analysis.
* Example of how to retrieve raw data and associated histograms are provided
*
* @param1 A vector of pointers to Channel objects
*/
void WFAnalysis::AnalyzeEvent( const std::vector< Channel* > vCh ){
int ch = 0;
......@@ -130,12 +129,13 @@ void WFAnalysis::AnalyzeEvent( const std::vector< Channel* > vCh ){
/**
* @brief Analyze Event method for WF analysis
* @param vCh A vector of pointers to Channel objects
* @param pad Pointer to a pad to be drawn to
*
* Receives a const vector of Channels. Loops over all Channels within
* the vector for analysis. Also receives a pointer to a TVirtualPad for graphical output
* Example of how to retrieve raw data and associated histograms are provided
*
* @param1 A vector of pointers to Channel objects
* @param2 Pointer to a pad to be drawn to
*/
void WFAnalysis::AnalyzeEvent( std::vector<Channel*> vCh, TVirtualPad* pad ){
int ch = 0;
......@@ -176,15 +176,16 @@ void WFAnalysis::AnalyzeEvent( std::vector<Channel*> vCh, TVirtualPad* pad ){
/** @brief GetDifferential method for WFAnalysis
* @param hIN Histogram to be differentiated
* @param hOUT Output histogram
* @param N Number of points used for summation window
*
* The derivative is calculated as the difference of the summation N points before and after the ith point
* i.e new_sample[i] = sum(samp[i+k])-sum(samp[i-k]), k =1, 2, 3 ... sample_range.
* @f[
* \delta_i(N)= \sum_{k=1}^{N} (s_i + k) - \sum_{k=1}^{N} (s_i - k)
* @f]
*
*
* @param1 Histogram to be differentiated
* @param2 Output histogram
* @param3 Number of points used for summation window
* @return truncated (M-2*window) TH1 histogram
*/
void WFAnalysis::GetDifferential( TH1D *hIN, TH1D *hOUT, int N){
......@@ -208,12 +209,15 @@ void WFAnalysis::GetDifferential( TH1D *hIN, TH1D *hOUT, int N){
}
/** @brief GetRMS method for WFAnalysis
* @param h Input histogram
* @param diff_window Averaging window used in GetDifferential
* @param debug Saves a PDF of the RMS histogram if true
* @return Width of gaussian fit excluding tails created by peaks
*
* Given an input histogram, outputs an RMS value
* based on a gaussian fit concentrating on the center
* based on a gaussian fit concentrating on the center.
* The result can be saved to a PDF if debug is set to true.
*
* @param1 Input histogram
* @return RMS value of central peak
*/
double WFAnalysis::GetRMS( TH1D *h , int diff_window, bool debug){
......@@ -250,15 +254,15 @@ double WFAnalysis::GetRMS( TH1D *h , int diff_window, bool debug){
}
/** @brief OverlayHistos method for WFAnalysis
* @param h1 Base histogram (left y-axis)
* @param h2 Overlayed histogram (right y-axis)
* @param pad Address of a pad (TPad or TCanvas) to be drawn on
* @param debug Saves the result of the overlay if true
*
* Plots two input histograms on the same, specified pad with
* separate axis. Saves the plots as PDFs with the name of the
* base histogram if given the option.
* base histogram if debug is set to true
*
* @param1 Base histogram (left y-axis)
* @param2 Overlayed histogram (right y-axis)
* @param3 Address of a pad (TPad or TCanvas) to be drawn on
* @param4 Save option. If true, save a .pdf
*/
void WFAnalysis::OverlayHistos( TH1D *h1, TH1D *h2 , TVirtualPad* pad, bool debug){
......@@ -291,10 +295,10 @@ void WFAnalysis::OverlayHistos( TH1D *h1, TH1D *h2 , TVirtualPad* pad, bool debu
}
/** @brief Finalize method for WFAnalysis
* @return none
*
* Write histograms, TTree if it exists.
*
* @return none
*/
void WFAnalysis::Finalize( ){
......
......@@ -213,6 +213,7 @@ void XMLSettingsReader::getChildValue(std::string _baseNode, int _baseNumber,
/*! @brief This routine loads data from a file
* @param _fileName
* @return true if parsing was successful, false otherwise.
* This Routine loads the XML-Tree from a given file.
*/
bool XMLSettingsReader::parseFile(std::string _fileName){
......
......@@ -18,7 +18,14 @@ ZDC::ZDC( ){
}
/** @brief Constructor for ZDC with vector of Channels and module number
* @param _readOut Vector of Channels with all detector configs
* @param _zdcNumber Number of the ZDC module
*
* Creates a new ZDC type Detector with an assigned number and picks the
* relevant Channel from the input vector.
*
*/
ZDC::ZDC( std::vector < Channel* > _readOut, int _zdcNumber){
m_Number = _zdcNumber;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment