some more docu

This commit is contained in:
nemu
2010-06-04 19:51:20 +00:00
parent e4fa408420
commit 5386342cf4
17 changed files with 249 additions and 695 deletions

View File

@ -41,7 +41,7 @@ using namespace std;
* <p>Constructor.
*
* \param runList run list collection
* \param fitType if true, a chisq fit will be performed, otherwise a log max-likelihood fit will be carried out.
* \param useChi2 if true, a chisq fit will be performed, otherwise a log max-likelihood fit will be carried out.
*/
PFitterFcn::PFitterFcn(PRunListCollection *runList, Bool_t useChi2)
{

View File

@ -144,7 +144,7 @@ Bool_t PFunctionHandler::CheckMapAndParamRange(UInt_t mapSize, UInt_t paramSize)
* \param map map vector
* \param param fit parameter vector
*/
Double_t PFunctionHandler::Eval(Int_t funNo, vector<Int_t> map, vector<Double_t> param)
Double_t PFunctionHandler::Eval(Int_t funNo, vector<Int_t> map, vector<double> param)
{
if (GetFuncIndex(funNo) == -1) {
cerr << endl << "**ERROR**: Couldn't find FUN" << funNo << " for evaluation";

View File

@ -1154,7 +1154,6 @@ void PMusrCanvas::InitFourier()
/**
* <p>Initialize the class, and sets up the necessary objects.
*
* \param number The plot number of the msr-file PLOT block
* \param title Title to be displayed
* \param wtopx top x coordinate (in pixels) to place the canvas.
* \param wtopy top y coordinate (in pixels) to place the canvas.
@ -2352,7 +2351,7 @@ void PMusrCanvas::CleanupFourierDifference()
* \param y y-value of the data
* \param theo theory histogram
*/
double PMusrCanvas::CalculateDiff(const double x, const double y, TH1F *theo)
double PMusrCanvas::CalculateDiff(const Double_t x, const Double_t y, TH1F *theo)
{
Int_t bin = theo->FindBin(x);
@ -2372,7 +2371,7 @@ double PMusrCanvas::CalculateDiff(const double x, const double y, TH1F *theo)
* \param y y-value of the data
* \param theo theory error graphs
*/
double PMusrCanvas::CalculateDiff(const double x, const double y, TGraphErrors *theo)
double PMusrCanvas::CalculateDiff(const Double_t x, const Double_t y, TGraphErrors *theo)
{
Int_t bin = 0;
Double_t xVal, yVal;
@ -2396,7 +2395,7 @@ double PMusrCanvas::CalculateDiff(const double x, const double y, TGraphErrors *
* \param x x-value of the data
* \param graph TGraphErrors which should be searched
*/
Int_t PMusrCanvas::FindBin(const double x, TGraphErrors *graph)
Int_t PMusrCanvas::FindBin(const Double_t x, TGraphErrors *graph)
{
Int_t i, bin = 0;
Double_t *xTheo = graph->GetX();

View File

@ -628,7 +628,7 @@ void PMusrT0::Done(Int_t status)
*
* \param event event type
* \param x keyboard event: character key; mouse event: x-position
* \param mouse event: y-position
* \param y mouse event: y-position
* \param selected not used
*/
void PMusrT0::HandleCmdKey(Int_t event, Int_t x, Int_t y, TObject *selected)

View File

@ -412,6 +412,7 @@ void PStartupHandler::OnFatalError(const Char_t *str)
* <p>Not used.
*
* \param str not used
* \param len not used
*/
void PStartupHandler::OnCdataBlock(const Char_t *str, Int_t len)
{

View File

@ -56,10 +56,15 @@ PUserFcn::~PUserFcn()
//------------------------------------------------------
/**
* <p>
* <p> user function example: polynome of 3rd order
*
* <b>return:</b>
* \f[ = \sum_{k=0}^3 c_k t^k \f]
*
* <b>meaning of paramValues:</b> \f$c_0\f$, \f$c_1\f$, \f$c_2\f$, \f$c_3\f$
*
* <b>return:</b> function value
*
* \param t time in \f$(\mu\mathrm{s})\f$, or x-axis value for non-muSR fit
* \param param parameter vector
*/
Double_t PUserFcn::operator()(Double_t t, const std::vector<Double_t> &param) const