From: Benjamin Linnik Date: Wed, 25 Feb 2015 17:05:13 +0000 (+0100) Subject: Run analyzer: first push of new ROOT run analyzer, still not tested completely X-Git-Url: https://jspc29.x-matter.uni-frankfurt.de/git/?a=commitdiff_plain;h=e4a02b02441d75fe6e83879b11423f0d26686961;p=radhard.git Run analyzer: first push of new ROOT run analyzer, still not tested completely --- diff --git a/MABS_run_analyzer/.ChargeSpektrumFull_temp.c.swp b/MABS_run_analyzer/.ChargeSpektrumFull_temp.c.swp new file mode 100644 index 0000000..44bf102 Binary files /dev/null and b/MABS_run_analyzer/.ChargeSpektrumFull_temp.c.swp differ diff --git a/MABS_run_analyzer/.kdev_include_paths b/MABS_run_analyzer/.kdev_include_paths new file mode 100644 index 0000000..ceae48c --- /dev/null +++ b/MABS_run_analyzer/.kdev_include_paths @@ -0,0 +1,3 @@ +/home/blinnik/fairroot/ExternalPackages_2_14/include/root/ +/home/nantero/exp/fairroot/fairsoft/ExtPac/include/root/ + diff --git a/MABS_run_analyzer/CSVRow.C b/MABS_run_analyzer/CSVRow.C new file mode 100644 index 0000000..9bf3cc1 --- /dev/null +++ b/MABS_run_analyzer/CSVRow.C @@ -0,0 +1,34 @@ +#include "CSVRow.h" + +#include +#include +#include +#include + + +std::string const& CSVRow::operator[](std::size_t index) const { + return m_data[index]; +} + +std::size_t CSVRow::size() const { + return m_data.size(); +} + +void CSVRow::readNextRow(std::istream& str) { + std::string line; + std::getline(str,line); + + std::stringstream lineStream(line); + std::string cell; + + m_data.clear(); + while(std::getline(lineStream,cell,'\t')) { + m_data.push_back(cell); + } +} + +std::istream& operator>>(std::istream& str,CSVRow& data) { + data.readNextRow(str); + return str; +} + diff --git a/MABS_run_analyzer/CSVRow.h b/MABS_run_analyzer/CSVRow.h new file mode 100644 index 0000000..c11e33c --- /dev/null +++ b/MABS_run_analyzer/CSVRow.h @@ -0,0 +1,22 @@ +#ifndef CSVROW_H +#define CSVROW_H + + +#include +#include + +class CSVRow { +public: + std::string const& operator[](std::size_t index) const; + std::size_t size() const; + void readNextRow(std::istream& str); + + friend std::istream& operator>>(std::istream& str,CSVRow& data); + +private: + std::vector m_data; +}; + +//std::istream& operator>>(std::istream& str,CSVRow& data); + +#endif diff --git a/MABS_run_analyzer/ChargeSpektrum.c b/MABS_run_analyzer/ChargeSpektrum.c new file mode 100644 index 0000000..6c7eaa5 --- /dev/null +++ b/MABS_run_analyzer/ChargeSpektrum.c @@ -0,0 +1,76 @@ +#include "Run.h" +#include "MAPS.h" + +// bad c- style fix me +#include "Run.c" +#include "MAPS.c" +#include "CSVRow.h" +#include "CSVRow.C" + +Int_t* ReadRunList(Int_t*); + +void ChargeSpektrum() +{ + cout << endl << endl; + + /// number of runs to be analyzed, number of lines read by @c ReadRunList() + Int_t numberRuns=0; + ReadRunList(&numberRuns); + /// array with run numbers + Int_t* runList=new Int_t[numberRuns]; + Run* runs[numberRuns]; + + cout << "Found " << numberRuns << " run(s) in 'runlist.txt'." << endl; + for(Int_t runi=0;runidividedmatrix = 1; + runs[runi]->upperpart = 1; + } + } + if (runi+1 < numberRuns) + { + if (runList[runi] == runList[runi+1] ) + { + cout << "Using devided matrix lower" << endl; + runs[runi]->dividedmatrix = 1; + runs[runi]->upperpart = 0; + } + } + runs[runi]->analyzeRun(true); // creates or opens .root file, can analyze the RAW data +// runs[runi]->analyzeFrame(100000); +// runs[runi]->analyzeFrame(86000); +// runs[runi]->analyzeFrame(0); +// runs[runi]->processed->plotFrame(39); + } +} + + +Int_t* ReadRunList(Int_t* numberRuns) +{ + Int_t* runList=new Int_t[1000]; + + std::ifstream file("runlist.txt"); + CSVRow row; + Int_t runLauf=0; + while (file >> row) + { + try + { + runList[runLauf]=atoi(row[0].c_str()); + runLauf++; + } + catch(...) + { + cout << "File ended"; + } + } + *numberRuns=runLauf; + return runList; +} \ No newline at end of file diff --git a/MABS_run_analyzer/MAPS.c b/MABS_run_analyzer/MAPS.c new file mode 100644 index 0000000..8287669 --- /dev/null +++ b/MABS_run_analyzer/MAPS.c @@ -0,0 +1,2141 @@ +#include"MAPS.h" +#include "Run.h" + +using namespace std; + +MAPS::MAPS() { + +}; + +MAPS::MAPS(Run* runp) { + run = runp; + initMapsRun(); + + UInt_t FileEvNb; // Event number per file + UInt_t TotEvNb; // Total events in RUN - should be less if RUN was stopped before endl + + // check if sepcified system is correct, if not, switch and reinitialize + if ( switchsystem() ) + { + if (run->labbook.system.EqualTo("USB")) + { + run->labbook.system = Form("PXI"); + } + else + { + run->labbook.system = Form("USB"); + } + run->setSystemInfo(); + initMapsRun( ); + } sleep(1); // TODO test if removable + + + + if ( checkConf(fPixelsData) ) // TODO FileEvNbInConfig + { + //----------------------------------------------- + //Check and open Data Files + int MaxFiles = FileTotalEvNbInConfig/FileEvNbInConfig; + if( checkDataFiles(MaxFiles) ) + { + initSave(); + } + //----------------------------------------------- + } sleep(1); // TODO test if removable + +} +//#################################################################### + +MAPS::~MAPS(void) { + + if(fSave && fOk) + { + fOutputFile->cd(); + + fHitTree->Write("",TObject::kOverwrite); + fNoiseTree->Write("",TObject::kOverwrite); + fDynNoiseTree->Write("",TObject::kOverwrite); + + hint1->Write("",TObject::kOverwrite); + hint2->Write("",TObject::kOverwrite); + + + fOutputFile->Save(); + fOutputFile->Close(); + + cout<Close(); + cout<<"...finished!"<ProcessLine("new TBrowser;"); + +// delete[] fOutputFile; +// delete[] fHitNtup; +// delete[] fNoiseNtup; +// delete[] fMeanNoiseNtup; + +// delete[] hint1; +// delete[] hint2; + } + + for(Int_t i=0; istorepathLinux; + fOutDir = run->storepathLinux; // ouput directory is input directory + + fRunNumber = run->labbook.runnumber; + fRows = run->sensorinfocurrent.rows; + fColumns = run->sensorinfocurrent.columns; + fPixels = fRows*fColumns; + fMatrix = run->labbook.matrix; + fSystem = run->labbook.system; + fConfigFile = fInDir+Form("/RUN_%i_i.rz",fRunNumber); + fRootFile = fInDir+Form("/RUN_%i_i.root",fRunNumber); + + cout<<"================================================================="< "<SetOptFit(1011); + gStyle->SetPalette(1); + gStyle->SetCanvasColor(0); + gStyle->SetFrameFillColor(10); + gStyle->SetOptStat(0); +//----------------------------------------------- +} + +//#################################################################### +bool MAPS::switchsystem( ) +{ + UInt_t NrAdcBoards; + ifstream inn(fConfigFile, ios::binary); + + if( inn.good() ) + { + inn.seekg(0, ios::end); + int End = inn.tellg(); + inn.seekg(0, ios::beg); + + char* RAWDATA = new char[End]; + inn.read ( RAWDATA, End); + inn.close(); + + NrAdcBoards = littleEndian32( RAWDATA, 4*9); // Number of Adc boards installed in the system + + + TString System[5] = {"","","USB","","PXI"}; + if( fSystem == "" ) + { + if( NrAdcBoards == 1) { + fSystem = "USB"; + } + if( NrAdcBoards == 2) { + fSystem = "USB"; + } + if( NrAdcBoards == 4) { + fSystem = "PXI"; + } + } + else if( (NrAdcBoards == 2 && fSystem != "USB") || (NrAdcBoards == 4 && fSystem != "PXI") ) + { + cout<<"---------"< Check config file ..."< Number of Pixels defined is bigger than found: "< "<50) + { + cout<<"Expected Nr of Files is too big: " << MaxFiles << " ! Nr of Files reduced to 50!"< Wrong Number of Pixels: ( "<< count-count_tmp-29 <<" ) in Framenr: "< ",fRunNumber,FileNr)<= 1) { + printf("%6.2f TB ", (Float_t)(End/(TMath::Power(2,40))) ); + } + else if (End/(TMath::Power(2,30)) >= 1) { + printf("%6.2f GB ", (Float_t)(End/(TMath::Power(2,30))) ); + } + else if (End/(TMath::Power(2,20)) >= 1) { + printf("%6.2f MB ", (Float_t)(End/(TMath::Power(2,20))) ); + } + else if (End/(TMath::Power(2,10)) >= 1) { + printf("%6.2f kB ", (Float_t)(End/(TMath::Power(2,10))) ); + } + else { + printf("%6.2f B ", (Float_t)(End)); + } + + cout<Branch("frame" , &fFrameInfo.frame , "frame/i" , 32000); + fHitTree->Branch("hits" , &fFrameInfo.hits , "hits/i" , 32000); + fHitTree->Branch("pixel" , &fFrameInfo.pixel[0] , "pixel[hits]/i" , 32000); + for(int i=0; i<25; i++) { + fHitTree->Branch( Form("p%i",i+1) , &fFrameInfo.p[i][0] , Form("p%i [hits]/F",i+1) , 32000); + } + // Noise TTree + fNoiseTree = new TTree("noise", "noise"); + fDynNoiseTree = fNoiseTree; +//----------------------------------------------- + hint1 = new TH2F("Hitmulit", "Hit multiplicity", fColumns, 0, fColumns, fRows, 0, fRows); + hint2 = new TH2F("Pixmulit", "Pix multiplicity", fColumns, 0, fColumns, fRows, 0, fRows); + + fdiscriminatedhitmatrix = new TH2F("HittedPixel Discri", "HittedPixel Discri", fColumns, 0, fColumns, fRows, 0, fRows); + fADCHitmatrix = new TH2F("HittedPixel ADC", "HittedPixel", fColumns, 0, fColumns, fRows, 0, fRows); + + hint1->GetXaxis()->SetRangeUser(0, fColumns); + hint1->GetYaxis()->SetRangeUser(0, fRows); + hint1->GetXaxis()->SetTitle("column"); + hint1->GetYaxis()->SetTitle("row"); + hint1->GetZaxis()->SetTitle("Signal [ADC]"); + + hint2->GetXaxis()->SetRangeUser(0, fColumns); + hint2->GetYaxis()->SetRangeUser(0, fRows); + hint2->GetXaxis()->SetTitle("column"); + hint2->GetYaxis()->SetTitle("row"); + hint2->GetZaxis()->SetTitle("Signal [ADC]"); +//----------------------------------------------- + cout<<"-----------------------"< fEventsSum ) { + Frames = fEventsSum; + printf("Changed 'Number Frames' to: %u\n", Frames ); + } + if( Frames+Start > fEventsSum ) { + Start = fEventsSum-Frames; + printf("Changed 'First Event' to: %u\n", Start ); + } +// Get fPixels and allocate array + Float_t *ARR = new Float_t[Frames*fPixels]; + Float_t PEDESTAL; + Float_t NOISE; + Int_t PIXEL; + + for(Int_t i=Start; iBranch("pixel" , &PIXEL , "pixel/i" , 32000); + fNoiseTree->Branch("noise" , &NOISE , "noise/F" , 32000); + fNoiseTree->Branch("pedestal" , &PEDESTAL , "pedestal/F" , 32000); + } + + for(Int_t i=0; iFill(); + } + } + + cout<<"-----------------------"<[fPixels](); + + /// number of frames cut away in second noise estimate (propably hit frames) + Int_t* nframescutawaysecondnoiseestimate = new Int_t[fPixels](); + Int_t npixelscutawaysecondnoiseestimate=0; + /// number of frames cut away in third noise estimate (hopefully hit frames) + Int_t* nframescutawaythirdnoiseestimate = new Int_t[fPixels](); + Int_t npixelscutawaythirdnoiseestimate=0; + + Float_t curpixelpedestal; + Float_t curpixelnoise; + + fDynNoiseTree->Branch("frame" , &fFrameNumber , "frame/i" , 32000); + fDynNoiseTree->Branch("noise" , &fNoiseMean , "noise/F" , 32000); + fDynNoiseTree->Branch("pedestal" , &fPedestalsMean , "pedestal/F" , 32000); + + // check if all RAW data files are OK + if(fOk) + { + // Check amount of Frames, if too low -> increase + if(frames<100) + { + cout<<"Too few Frames! Change Frames from "<=GetNumberFrames()) + startframe=GetNumberFrames()-frames; + + // first estimate + // sum up over all frames every CDS value, pixelwise + for(Int_t framei=startframe; framei 5 * sigma + // sum up over all frames every CDS value, pixelwise + for(Int_t framei=startframe; framei " << 5.*fNoise[pixeli] << endl; + nframescutawaysecondnoiseestimate[pixeli]++; + } + } + } + // calculate average pedestal of each pixel + for(Int_t pixeli=0; pixeli 5 * sigma of noise value from second estimate + // sum up over all frames every CDS value, pixelwise + + // reset noise and pedestal array + for(Int_t pixeli=0; pixeli " << 3.*pixelnoise2[pixeli] << endl; + nframescutawaythirdnoiseestimate[pixeli]++; + } + } + } +// cout << noiselastframes[0].front() << endl; +// cout << noiselastframes[0].size() << endl; + // calculate average pedestal of each pixel + for(Int_t pixeli=0; pixeliFill(); + + fFrameNumber = 0; + fNoiseMean = (float)TMath::Mean((const int)fPixels, fNoise); + fPedestalsMean = (float)TMath::Mean((const int)fPixels, fPedestals); + + fDynNoiseTree->Fill(); + } + + fNoiseOk = true; + return true; + } + else + { + return false; + } +}; + +template +arraytype MAPS::SumOverArray(const arraytype* (a), Int_t n) { + arraytype sum = 0; + for (int i=0; i +arraytype MAPS::debugStream(const arraytype* (a), Int_t n, Int_t columns, Int_t precision) { + cout << endl << endl; + cout << "\033[1;29m----------------------------------\033[0m" << endl; + for (int i=0; iBranch("frame" , &fFrameNumber , "frame/i" , 32000); + fDynNoiseTree->Branch("noise" , &fNoiseMean , "noise/F" , 32000); + fDynNoiseTree->Branch("pedestal" , &fPedestalsMean , "pedestal/F" , 32000); + } + + if(fOk) + { +//Check amount of Frames + if(Frames<50) + { + cout<<"Too few Frames! Change Frames from "<= 1) { + printf("%6.2f TB ", (Float_t)(End/(TMath::Power(2,40))) ); + } + else if (End/(TMath::Power(2,30)) >= 1) { + printf("%6.2f GB ", (Float_t)(End/(TMath::Power(2,30))) ); + } + else if (End/(TMath::Power(2,20)) >= 1) { + printf("%6.2f MB ", (Float_t)(End/(TMath::Power(2,20))) ); + } + else if (End/(TMath::Power(2,10)) >= 1) { + printf("%6.2f kB ", (Float_t)(End/(TMath::Power(2,10))) ); + } + else { + printf("%6.2f B ", (Float_t)(End)); + } + cout<<"for dynamic noise calculation! "< fEventsSum ) { + Frames = fEventsSum; + printf("Changed 'Number Frames' to: %u\n", Frames ); + } +// Get fPixels and allocate array + Float_t PEDESTAL; + Float_t NOISE; +// Int_t PIXEL=0; + + if(!fNoiseOk) { + getNoise(0,Frames); + } + { + int i=0; + + + while(!STOP) + { + getFrame(i); + hitana(); + + STOP = true; + + for(Int_t j=0; jFill(); + + fFrameNumber = 0; + fNoiseMean = TMath::Mean((const int)fPixels, fNoise); + fPedestalsMean = TMath::Mean((const int)fPixels, fPedestals); + + fDynNoiseTree->Fill(); + } + return true; + } + else + { + return false; + } +}; + +//#################################################################### + + +bool MAPS::regetDynNoise(Int_t Frames) { + + for(Int_t pixeli=0; pixeliFill(); + } + } + } + + if ( fFrameNumber%10000==0) + { + debugStream<>(fPedestals, fPixels, fColumns, 2); + } + return true; +} + +//################################################################### +bool MAPS::loadNoise( TString InDir, Int_t RunNumber, Int_t Matrix) { + + TString FILENAME = InDir+Form("%i/%i_%i.root",RunNumber,RunNumber,Matrix); + TFile *f = new TFile(FILENAME,"READ"); + + if(f->IsZombie()) + { + cerr<<"ERROR: loadNoise() failed!"<Get("noise"); + + UInt_t PIXEL; + Float_t NOISE, PEDESTAL; + + noiseTree->SetBranchAddress("pixel" , &PIXEL ); + noiseTree->SetBranchAddress("noise" , &NOISE ); + noiseTree->SetBranchAddress("pedestal" , &PEDESTAL ); + + Int_t entries = noiseTree->GetEntries(); + + for(Int_t i=0; iGetEntry(i); + + fNoise[i] = NOISE; + fPedestals[i] = PEDESTAL; + } + cout<<"-----------------------"< (5.*fNoise[i]) ) + { + HITNR++; + HITS.Set(HITNR); + HITS.AddAt(i,(HITNR-1)); +// cout << "Frame: " << fFrameNumber << " Candidate at pixel: " << i << " with ADC: " << (1.*fCdsmatrix[i]-fPedestals[i]) << endl; + + if(fSave) { + hint2->Fill(i%fColumns+0.1, (int)(i/fColumns)+0.1); // counts up in 2dimensional pixel matrix + } + } + } + + //Rewrite HITS to fHitlist array (why?) + Hitlist= new Int_t[HITNR]; + + for(Int_t i=0; i Remove hits where the seed pixel is within 2 pixels beside the edge + // Hitlist[hit]%fColumn = x-coordinate of the seed pixel, Hitlist[hit]/fColumns = y-coordinate of the seed pixel + if (Hitlist[hit]%fColumns < 2 || Hitlist[hit]%fColumns > fColumns-3 || Hitlist[hit]/fColumns < 2 || Hitlist[hit]/fColumns > fRows-3) + continue; + + //Provide 5x5 clusters with CDS - content: + for(Int_t row=0; row<5; row++) + { + for(Int_t column=0; column<5; column++) + { + // wenn erste Reihe des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in erster oder zweiten Reihe des Matrix liegt + if ( (row==0) && (A<2) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn zweite Reihe des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in erster Reihe des Matrix liegt + else if ( (row==1) && (A<1) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn vierte Reihe des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in letzter Reihe des Matrix liegt + else if ( (row==3) && (A>= (fRows-1)) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn vierte Reihe des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in vorletzter Reihe des Matrix liegt + else if ( (row==4) && (A>= (fRows-2)) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + else + { + // wenn erste Spalte des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in erster oder zweiten Spalte des Matrix liegt + if ( (column==0) && (B<2) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn zweite Spalte des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in erster Spalte der Matrix liegt + else if ( (column==1) && (B==0) ) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn dritte Spalte des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in letzter Spalte der Matrix liegt + else if ( (column==3) && (B==fColumns-1)) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + // wenn letzte Spalte des Clusters gefüllt werden soll + // und das Seed Pixel am Rand - in vorletzter Spalte der Matrix liegt + else if ( (column==4) && (B>fColumns-3)) { + cout << "WARNING: Clusters are filled with dummy values, please check MAPS.c hitana() cluster fill procedure." << endl; + CLUSTER[(row*5)+column]=DUMMY; + } + else { + CLUSTER[(row*5)+column] = 1.*fCdsmatrix [Hitlist[hit]+(row-2)*fColumns+(column-2)] - fPedestals [Hitlist[hit]+(row-2)*fColumns+(column-2)]; + } + } + } + } +// for(Int_t row=0; row<5; row++) +// { +// for(Int_t column=0; column<5; column++) +// { +// std::cout.width(10); +// std::cout << std::fixed; +// std::cout << std::left << std::setprecision(2) << CLUSTER[row*5+column]; +// } +// cout << endl; +// } +// cout << endl; + + //Check seeds (whether highest entry in cluster): + for(Int_t i=6; i<19; i++) // why not over full cluster? (I=0 i<25 TODO + { + if ( (i!=12) && (CLUSTER[i] > CLUSTER[12]) ) { + CHANCE=0; +// cout << "kill cluster: " << Hitlist[hit] << " with ADC: " << CLUSTER[12] << endl; + break; + } + // maybe this is unnecessary, if upper if clause is a >= comparison + else if ( (i!=12) && (CLUSTER[i] == CLUSTER[12]) && i>12 ) { + cout << "WARNING: next pixel value identical to precessor" << endl; + CHANCE=0; //NOTE: potential error source + break; + } + else { + CHANCE=100; + if(i%5==3) { + i+=2; + }; + } + } + + //Begin: loop evaluate true seeds: + if(CHANCE==100) + { + //Fill hit TTree: + fFrameInfo.pixel[fHits] = Hitlist[hit]; + for(int clupos=0; clupos<25; clupos++) + { + fFrameInfo.p [clupos][fHits] = CLUSTER[clupos]; + } + + fHits++; + + if(fSave) { + hint1->Fill( Hitlist[hit]%fColumns, (int)(Hitlist[hit]/fColumns) ); + } + + for(Int_t row=0; row<5; row++) + { + for(Int_t column=0; column<5; column++) + { + if ( (row==0) && (A<2) ) { } + else if ( (row==1) && (A<1) ) { } + else if ( (row==3) && (A>= (fRows-1)) ) { } + else if ( (row==4) && (A>= (fRows-2)) ) { } + else + { + if ( (column==0) && (B<2) ) { } + else if ( (column==1) && (B==0) ) { } + else if ( (column==3) && (B==fColumns-1)) { } + else if ( (column==4) && (B>fColumns-3)) { } + else { + fHittedPixel[Hitlist[hit]+(row-2)*fColumns+(column-2)] = 1; + } + } + } + } + fHittedPixel[Hitlist[hit]] = 2; + } + } + //End: loop evaluate true seeds: + //End: loop over all potential seed pixels: + + if(fSave) + { + for(Int_t i=0; i0) + { + if (fHittedPixel[i]>1) + { +// cout << "Frame: " << fFrameNumber << " Hit at pixel: " << i << " with ADC: " << fFrameInfo.p [(2*5)+2][fHits-1]+fPedestals[Hitlist[0]] << endl; +// for(Int_t row=0; row<5; row++) +// { +// for(Int_t column=0; column<5; column++) +// { +// std::cout.width(10); +// std::cout << std::fixed; +// std::cout << std::left << std::setprecision(2) << fFrameInfo.p [(row*5)+column][fHits-1]+fPedestals[Hitlist[0]+(row-2)*fColumns+(column-2)]; +// } +// cout << endl; +// } +// cout << endl; +// cout << "Noise : "<< endl; +// for(Int_t row=0; row<5; row++) +// { +// for(Int_t column=0; column<5; column++) +// { +// std::cout.width(10); +// std::cout << std::fixed; +// std::cout << std::left << std::setprecision(2) << fNoise[Hitlist[0]+(row-2)*fColumns+(column-2)]; +// } +// cout << endl; +// } +// cout << endl; +// cout << "Pedestial : "<< endl; +// for(Int_t row=0; row<5; row++) +// { +// for(Int_t column=0; column<5; column++) +// { +// std::cout.width(10); +// std::cout << std::fixed; +// std::cout << std::left << std::setprecision(2) << fPedestals[Hitlist[0]+(row-2)*fColumns+(column-2)]; +// } +// cout << endl; +// } +// cout << endl; +// +// cout << "Noise of my pixel #0 : "<< endl; +// std::cout.width(10); +// std::cout << std::fixed; +// std::cout << std::left << std::setprecision(5) << fNoise[0]; +// cout << endl; + } + fdiscriminatedhitmatrix->SetBinContent(i%fColumns, (int)(i/fColumns), fHittedPixel[i]); + fADCHitmatrix->SetBinContent(i%fColumns, (int)(i/fColumns), fCdsmatrix[i]); + } + } + + fFrameInfo.hits = fHits; + if(fHits<100) + { + fHitTree->Fill(); + } + else + { + cout<<"\rFrame: "< " << CommonModeInRow << endl; +// } + + if(TMath::Abs(CommonModeInRow)>20) // TODO better warning criteria + { + warning = true; + } + if(warning) { cout<<"\rFrame: "< Common Mode suspiciously high! "<(fPedestals, fPixels, fColumns, 2); + } + + for(int column=0; column(fPedestals, fPixels, fColumns, 2); + } +} + +//#################################################################### + +void MAPS::plotFrame(Int_t FrameNumber) { + + if(!getFrame(FrameNumber)) { + cout<<"Frame could not be loaded!"<Divide(2,3); + gStyle->SetOptFit(1011); + gStyle->SetPalette(1); + gStyle->SetCanvasColor(0); + gStyle->SetFrameFillColor(10); + gStyle->SetOptStat(0); + + TH2F *h1 = new TH2F("CDS matrix", "CDS matrix", fColumns, 0, fColumns, fRows, 0, fRows); + TH2F *h2 = new TH2F("Frame 0 matrix", "Frame 0 matrix", fColumns, 0, fColumns, fRows, 0, fRows); + TH2F *h3 = new TH2F("Frame 1 matrix", "Frame 1 matrix", fColumns, 0, fColumns, fRows, 0, fRows); + TH1F *h4 = new TH1F("Frame 0 histo", "Frame 0 histo", 2*16384, -16384, 16384); + TH1F *h5 = new TH1F("Frame 1 histo", "Frame 1 histo", 2*16384, -16384, 16384); + + Int_t column; + Int_t row; + Float_t F0,F1,CDS; + + for(Int_t i=0; iFill(column,row,CDS); + h2->Fill(column,row,F0); + h3->Fill(column,row,F1); + h4->Fill(F0); + h5->Fill(F1); + } + + cm1->cd(1); + h1->Draw("colz"); + h1->GetXaxis()->SetTitle("column"); + h1->GetYaxis()->SetTitle("row"); + h1->GetZaxis()->SetTitle("Signal [ADC]"); + + cm1->cd(2); + h1->Draw("surf2z"); + h1->GetXaxis()->SetTitle("column"); + h1->GetYaxis()->SetTitle("row"); + h1->GetZaxis()->SetTitle("Signal [ADC]"); + + cm1->cd(3); + h2->Draw("surf2z"); + h2->GetXaxis()->SetTitle("column"); + h2->GetYaxis()->SetTitle("row"); + h2->GetZaxis()->SetTitle("Signal [ADC]"); + + cm1->cd(4); + h3->Draw("surf2z"); + h3->GetXaxis()->SetTitle("column"); + h3->GetYaxis()->SetTitle("row"); + h3->GetZaxis()->SetTitle("Signal [ADC]"); + + cm1->cd(5); + h4->Draw(); + h4->GetXaxis()->SetTitle("Signal [ADC]"); + h4->GetYaxis()->SetTitle("Counts"); + + cm1->cd(6); + h5->Draw(); + h5->GetXaxis()->SetTitle("Signal [ADC]"); + h5->GetYaxis()->SetTitle("Counts"); + + cm1->DrawClone(); + cm1->Close(); + cm1->Update(); + cout<<"\rPIXELMATRIX plotted! "<Divide(2,2); + gStyle->SetOptFit(1011); + gStyle->SetPalette(1); + gStyle->SetCanvasColor(0); + gStyle->SetFrameFillColor(10); + gStyle->SetOptStat(1); + + TH1F *h1 = new TH1F("noisee", "noise", 2000, 0, 200); + TH1F *h2 = new TH1F("pedestal", "pedestal", 1000, -50, 50); + TH2F *h3 = new TH2F("noise matrix", "noise matrix", fColumns, 0, fColumns, fRows, 0, fRows); + TH2F *h4 = new TH2F("pedestal matrix", "pedestal matrix", fColumns, 0, fColumns, fRows, 0, fRows); + + Int_t column; + Int_t row; + Float_t NOISE,PEDESTAL; + + for(Int_t i=0; iFill(NOISE); + h2->Fill(PEDESTAL); + h3->Fill(column,row,NOISE); + h4->Fill(column,row,PEDESTAL); + } + + cm2->cd(1); + h3->Draw("colz"); + h3->GetXaxis()->SetTitle("column"); + h3->GetYaxis()->SetTitle("row"); + h3->GetZaxis()->SetTitle("Noise [ADC]"); + + cm2->cd(2); + h4->Draw("colz"); + h4->GetXaxis()->SetTitle("column"); + h4->GetYaxis()->SetTitle("row"); + h4->GetZaxis()->SetTitle("Pedstals [ADC]"); + + cm2->cd(3); + h1->Draw(); + h1->GetXaxis()->SetTitle("Noise [ADC]"); + h1->GetYaxis()->SetTitle("Counts"); + + cm2->cd(4); + h2->Draw(); + h2->GetXaxis()->SetTitle("Pedestal [ADC]"); + h2->GetYaxis()->SetTitle("Counts"); + + cm2->DrawClone(); + cm2->Close(); + cm2->Update(); + cout<<"NOISE plotted! "< fEventsSum ) { + Frames = fEventsSum; + printf("Changed 'Number Frames' to: %u\n", Frames ); + } + if( Frames+Start > fEventsSum ) { + Start = fEventsSum-Frames; + printf("Changed 'First Event' to: %u\n", Start ); + } + } +} + +//#################################################################### + +void MAPS::plotSignal(Int_t Start, Int_t Frames) { + + if(fOk) + { +//Check availabilty of Frames + if( Frames > fEventsSum ) { + Frames = fEventsSum; + printf("Changed 'Number Frames' to: %u\n", Frames ); + } + if( Frames+Start > fEventsSum ) { + Start = fEventsSum-Frames; + printf("Changed 'First Event' to: %u\n", Start ); + } + + TH2F *h1 = new TH2F("Frames 0 " , "Frame 0" , fPixels, 0, fPixels, 2*16384, -16384, 16384); + TH2F *h2 = new TH2F("Frames 1" , "Frame 1" , fPixels, 0, fPixels, 2*16384, -16384, 16384); + TH2F *h3 = new TH2F("CDS" , "CDS" , fPixels, 0, fPixels, 2*16384, -16384, 16384); + + TH1F *h4 = new TH1F("Frames 0 histo" , "Frames 0 histo" , 2*16384, -16384, 16384); + TH1F *h5 = new TH1F("Frames 1 histo" , "Frames 1 histo" , 2*16384, -16384, 16384); + TH1F *h6 = new TH1F("CDS histo" , "CDS histo" , 2*16384, -16384, 16384); + + for(int i=Start; iFill(j,fF0matrix [j]); + h2->Fill(j,fF1matrix [j]); + h3->Fill(j,fCdsmatrix [j]); + + h4->Fill(fF0matrix [j]); + h5->Fill(fF1matrix [j]); + h6->Fill(fCdsmatrix [j]); + } + } + } + + + TCanvas* cm11; + cm11 = new TCanvas("cm11","Signal",50,100,1200,800); + cm11->Divide(3,2); + gStyle->SetOptFit(1011); + gStyle->SetPalette(1); + gStyle->SetCanvasColor(0); + gStyle->SetFrameFillColor(10); + gStyle->SetOptStat(0); + + cm11->cd(1); + h1->Draw("colz"); + h1->GetXaxis()->SetTitle("Pixel#"); + h1->GetYaxis()->SetTitle("Signal"); + + cm11->cd(2); + h2->Draw("colz"); + h2->GetXaxis()->SetTitle("Pixel#"); + h2->GetYaxis()->SetTitle("Signal"); + + cm11->cd(3); + h3->Draw("colz"); + h3->GetXaxis()->SetTitle("Pixel#"); + h3->GetYaxis()->SetTitle("Signal"); + + cm11->cd(4); + h4->Draw(); + h4->GetXaxis()->SetTitle("Signal [ADC]"); + h4->GetYaxis()->SetTitle("Counts"); + + cm11->cd(5); + h5->Draw(); + h5->GetXaxis()->SetTitle("Signal [ADC]"); + h5->GetYaxis()->SetTitle("Counts"); + + cm11->cd(6); + h6->Draw(); + h6->GetXaxis()->SetTitle("Signal [ADC]"); + h6->GetYaxis()->SetTitle("Counts"); + + cm11->DrawClone(); + cm11->Close(); + cm11->Update(); + cout<<"\rSIGNALS plotted! "<Divide(3,2); + gStyle->SetOptFit(1011); + gStyle->SetPalette(1); + gStyle->SetCanvasColor(0); + gStyle->SetFrameFillColor(10); + gStyle->SetOptStat(0); + + if( Frames > fEventsSum ) { + Frames = fEventsSum; + printf("Changed 'Number Frames' to: %u\n", Frames ); + } + if( Frames+Start > fEventsSum ) { + Start = fEventsSum-Frames; + printf("Changed 'First Event' to: %u\n", Start ); + } + + TH2F *h1 = new TH2F("Frame 0 vs T" , "Frame 0 vs T" , Frames, Start, Start+Frames, 2*16384, -16384, 16384); + TH2F *h2 = new TH2F("Frame 1 vs T" , "Frame 1 vs T" , Frames, Start, Start+Frames, 2*16384, -16384, 16384); + TH2F *h3 = new TH2F("CDS vs T" , "CDS vs T" , Frames, Start, Start+Frames, 2*16384, -16384, 16384); + + TH1F *h4 = new TH1F("Frames 0 phisto" , "Frames 0 phisto" , 2*16384, -16384, 16384); + TH1F *h5 = new TH1F("Frames 1 phisto" , "Frames 1 phisto" , 2*16384, -16384, 16384); + TH1F *h6 = new TH1F("CDS phisto" , "CDS phisto" , 2*16384, -16384, 16384); + + for(int i=Start; iFill( i,fF0matrix[Pixel]) ; + h2->Fill( i,fF1matrix[Pixel]) ; + h3->Fill( i,fCdsmatrix[Pixel] ); + + h4->Fill( fF0matrix[Pixel] ); + h5->Fill( fF1matrix[Pixel] ); + h6->Fill( fCdsmatrix[Pixel] ); + } + } + + cm4->cd(1); + h1->Draw("colz"); + h1->GetXaxis()->SetTitle("Frame#"); + h1->GetYaxis()->SetTitle("Signal"); + + cm4->cd(2); + h2->Draw("colz"); + h2->GetXaxis()->SetTitle("Frame#"); + h2->GetYaxis()->SetTitle("Signal"); + + cm4->cd(3); + h3->Draw("colz"); + h3->GetXaxis()->SetTitle("Frame#"); + h3->GetYaxis()->SetTitle("Signal"); + + cm4->cd(4); + h4->Draw(); + h4->GetXaxis()->SetTitle("Signal [ADC]"); + h4->GetYaxis()->SetTitle("Counts"); + + cm4->cd(5); + h5->Draw(); + h5->GetXaxis()->SetTitle("Signal [ADC]"); + h5->GetYaxis()->SetTitle("Counts"); + + cm4->cd(6); + h6->Draw(); + h6->GetXaxis()->SetTitle("Signal [ADC]"); + h6->GetYaxis()->SetTitle("Counts"); + +// cm4->DrawClone(); +// cm4->Update(); +// cm4->Close(); + cout<<"\rPIXELSIGNALS plotted! "<=28 && (count%1053)<28+64*16 && countframes==11) +// if( (count%1053)>=28 && (count%1053)<28+64*16) +// { +// y = ((count%1053)-28)%64; +// x = ((count%1053)-28)/64; +// +// z1 = a1; +// z2 = a2; +// z3 = a1-a2; +// +// histo1[0]->Fill(z1); +// histo1[1]->Fill(z2); +// histo1[2]->Fill(z3); +// +// histo2[0]->Fill(x,y,z1); +// histo2[1]->Fill(x,y,z2); +// histo2[2]->Fill(x,y,z3); +// +// // cout<< (count%1053)-28 <<"\t"<=1050 && count<1053+50)) +// // if( count%1053==13 ) +// { +// cout<> (7-i)) & 1); +// } +// if(1) {cout<<" ";} +// } +// // cout<<" "; +// // cout<Divide(3,2); +// gStyle->SetOptFit(1011); +// gStyle->SetPalette(1); +// gStyle->SetCanvasColor(0); +// gStyle->SetFrameFillColor(10); +// gStyle->SetOptStat(1); +// +// cm->cd(1); +// histo1[0]->Draw(); +// histo1[0]->GetXaxis()->SetTitle("Signal [ADC]"); +// histo1[0]->GetYaxis()->SetTitle("Entries"); +// cm->Update(); +// cm->cd(2); +// histo1[1]->Draw(); +// histo1[1]->GetXaxis()->SetTitle("Signal [ADC]"); +// histo1[1]->GetYaxis()->SetTitle("Entries"); +// cm->Update(); +// cm->cd(3); +// histo1[2]->Draw(); +// histo1[2]->GetXaxis()->SetTitle("Signal [ADC]"); +// histo1[2]->GetYaxis()->SetTitle("Entries"); +// cm->Update(); +// +// cm->cd(4); +// histo2[0]->Draw("colz"); +// histo2[0]->GetXaxis()->SetTitle("column"); +// histo2[0]->GetYaxis()->SetTitle("row"); +// histo2[0]->GetZaxis()->SetTitle("Signal [ADC]"); +// cm->Update(); +// cm->cd(5); +// histo2[1]->Draw("colz"); +// histo2[1]->GetXaxis()->SetTitle("column"); +// histo2[1]->GetYaxis()->SetTitle("row"); +// histo2[1]->GetZaxis()->SetTitle("Signal [ADC]"); +// cm->Update(); +// cm->cd(6); +// histo2[2]->Draw("colz"); +// histo2[2]->GetXaxis()->SetTitle("column"); +// histo2[2]->GetYaxis()->SetTitle("row"); +// histo2[2]->GetZaxis()->SetTitle("Signal [ADC]"); +// cm->Update(); +} + +//#################################################################### +//#################################################################### + +UInt_t MAPS::littleEndian32(char* RawData, Int_t Pos) { + +// for(int j=3;j>=0;j--) +// { +// char a = RawData[j+Pos]; +// +// int n=CHAR_BIT*sizeof(a); +// +// cout<<" | "; +// for (int i=0;istringToNumber((string)fMatrix); + + if( matrixNumber>5 ) // TODO + { + cerr<<"ERROR: "< +#include +#include +#include +#include +#include "Riostream.h" +#include +#include "TString.h" +#include "TMath.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include "TCanvas.h" +#include "TObject.h" +#include "TStyle.h" +#include "TEnv.h" +#include "TGraph.h" +#include "TGaxis.h" +#include "TStyle.h" +#include "TFrame.h" +#include "TVector.h" +#include "TVectorD.h" +#include "Foption.h" +#include "TRandom.h" +#include "TSpline.h" +#include "TPaveStats.h" +#include "TVirtualFitter.h" +#include "TVirtualPad.h" +#include "TVirtualGraphPainter.h" +#include "TBrowser.h" +#include "TSystem.h" +#include "TPluginManager.h" +#include "TPad.h" +#include +#include +#include +#include +#include +#include +#include +#include "help.h" + +#include "Run.h" +class Run; + +/** + * @file + * @brief Use brief, otherwise the index won't have a brief explanation. + * + * Detailed explanation. + * + * + */ +class MAPS { + +private: + /// Input Directory, set and passed initMapsRun() to in the constructor + TString fInDir; + /// If the pixel data is in wrong order use this. You have to implement the class which does the ordering + TString fOrderCode; + /// processed runnumber, set and passed initMapsRun() to in the constructor of @c MAPS() + Int_t fRunNumber; + /// Number of Pixels found in Raw Data, is set im @c checkConf() + Int_t fPixelsData; + /// Number of Pixels written to #fCdsmatrix and used for analysis + Int_t fPixels; + /// number of rows in the sensor, set and passed initMapsRun() to in the constructor, if Mimosa34 and system==USB then it is equal to 8, for PXI system it is equal to 16 + Int_t fRows; + /// number of columns in the sensor, set and passed initMapsRun() to in the constructorm, if Mimosa34 then it is equal to 64 + Int_t fColumns; + /// Variable to be able to subdivide the Matrix according to fOrderCode + TString fMatrix; + Int_t fEventsSum; + Int_t fFile; + + Int_t fFrameNumber; /**< enum value 1 */ + /// true if all data files OK + bool fOk; + /// if set to true, a root file for the analyzed run will be created, set and passed initMapsRun() to in the constructor + bool fSave = true; + /// if set to true, the frame retrieved with @c getframe() is OK + bool fFrameOk; + /// if set to true, the file from where the noise is extracted is OK + bool fNoiseOk; + bool fNoiseExt; + /// not used any more, used by Steffan before. delete? + int fNoiseDyn; + Float_t HIT_tmp[29]; + + /// total number of events, stated in the config file #fRootFile + UInt_t FileTotalEvNbInConfig = 0; + /// number of events per file, stated in the config file #fRootFile + UInt_t FileEvNbInConfig = 0; + + /// Average noise over all pixels in #fPixels in current frame to be binned into #fDynNoiseTree + Float_t fNoiseMean; + /// Average pedestal to be binned into fDynNoiseTree + Float_t fPedestalsMean; + /// array over number of frames in each file with run data + Int_t* fEvents; + /// Array with f0 values of pixels in current frame + Int_t* fF0matrix; + /// Array with f1 values of pixels in current frame, used to generate #fCdsmatrix = #fF0matrix - #fF1matrix + Int_t* fF1matrix; + /// Array with CDS values of pixels in current frame + Float_t* fCdsmatrix; + /// Array with noise information of. given pixel, estimated in @c InitialDynNoise() + Float_t* fNoise;/**< Some documentation for first. */ + /// Array with pedestial information of given pixel + Float_t* fPedestals; + + std::queue* noiselastframes; + + + Int_t fHits; + /// Array mit der Größe Pixel * Frames, enthält CDS Werte + Float_t* fDynFrameArr; + /// Irgendein Array mit Grüße fPixels + Int_t* fDynCounter; + + /// Array wich indicates if a pixel in the current frame is a seed pixel (value=2), a cluster pixel (value=1) or not hit at all (value=0) + Int_t* fHittedPixel; + + /// Array of file handlers for each RAW files, filled in @c checkDataFiles() + ifstream* fInn; + /// ROOT output file with hit, noise, cluster and pedestial information + TFile* fOutputFile; + /// Pointer to the ROOT TTree of the run containing the noise, only used if external noise used + TTree* fNoiseTree; + /// Pointer to the ROOT TTree of the current frame in the current run + TTree* fDynNoiseTree; + /// system of the run, "PXI" or "USB", set and passed initMapsRun() to in the constructor + TString fSystem; + /// default number of frames to use for noise calculation + const static int numberofframesfornoise = 100; + + + /// full path in LINUX style to the .root file, all hit information is stored there + TString fRootFile; + /// full path in LINUX style to the .rz file, all run configuration is stored there + TString fConfigFile; + + /// address table to acess RAW bit data saved in 16 Bit format + unsigned short int value1[0x100][0x100]; + /// address table to acess RAW bit data saved in 16 Bit format + unsigned short int value2[0x100][0x100]; + + TH2F* hint1,*hint2; + /// saves hit information for given frame, 2 for pixels which are seed pixels and 1 for cluster pixel. Not hit pixel have a 0. + TH2F* fdiscriminatedhitmatrix; + /// saves hit ADC values for given frame. If not in cluster, value 0. + TH2F* fADCHitmatrix; + bool plotHint; + + + /** + * @brief Reads bits at certain position in RAW data and returns unsigned int value + * + * @code + * return (Int_t)(UChar_t)RawData[3+Pos]*TMath::Power(2,24) + + * ( Int_t)(UChar_t)RawData[2+Pos]**TMath::Power(2,16) + + * (Int_t)(UChar_t)RawData[1+Pos]*TMath::Power(2,8) + + * (Int_t)(UChar_t)RawData[0+Pos]; + * @endcode + * @return a number from 0 to 16843009 + */ + UInt_t littleEndian32(char* RawData, Int_t Pos); + + /** + * @brief Reads bits at certain position in RAW data and returns unsigned int value + * + * @code + * return (Int_t)(UChar_t)RawData[1+Pos]*TMat*h::Power(2,8) + + * (Int_t)(UChar_t)RawData[0+Pos]; + * @endcode + * @return a number from 0 to 257 + */ + Short_t littleEndian16(char* RawData, Int_t Pos); + + /** + * @brief checks if the passed files are OK, checks if configuration file is consistent with RAW data + * + * If there is corrupted data in the RAW files a warning is printed.
+ * If the RAW files indicate, that the runs are done with another system then stated in the config files, the system in the config file is ignored and + * a warning is printed, for this @c switchsystem() is called. + */ + void initMapsRun( TString, TString, Int_t, Int_t, Int_t, TString, TString, Int_t, bool); + + + /** + * @brief checks if the passed files are OK, checks if configuration file is consistent with RAW data + * + * If there is corrupted data in the RAW files a warning is printed.
+ * If the RAW files indicate, that the runs are done with another system then stated in the config files, the system in the config file is ignored and + * a warning is printed, for this @c switchsystem() is called. + */ + void initMapsRun(); + + /** + * @brief initializes ROOT file structure, if fSave is set to true + * + * Called in the constructor of @c MAPS() + */ + void initSave(); + + /** + * @brief Compares provided information with that found in the RAW data + * @return true on success, false on failure + * + * It also sets #FileTotalEvNbInConfig, #FileEvNbInConfig and @a fPixelsData accordingly + */ + bool checkConf(Int_t&); + + /** + * @brief If specified system (USB or PXI) is wrong, return true + * @return true on wrong specification, false on correct + * + * Called in the constructor of @c MAPS() + */ + bool switchsystem(); + + /** + * @brief Calls @c checkDataFiles() for each file in run and saves file handler + * + * Fills @c fInn with file handlers for every RAW data in the @c fInn array + * Also estimates the total number of frames. + * + * @return true if all RAW data files exist + * + * Called in the constructor of @c MAPS() + */ + bool checkDataFiles( Int_t ); + + /** + * @brief tests for existance of a RAW data file and estimates number of recorded frames. + * + * Outputs into console the number of found frames, can be adjusted to estimate number of total pixels per frame + * + * @return true if tested RAW data file exists + * + * Called in @c checkDataFiles(), which is calles in the constructor of @c MAPS() + */ + bool checkDataFile( UInt_t, UInt_t& ); + + /** + * @brief Reorder pixels for Mimosa 29a chip + * + * Pixels are counted different here - account for this + */ + void reorderMi29a(); + + /** + * @brief Sums over a given array + * + * Give this function an array, it weill return a sum + */ + template + arraytype SumOverArray(const arraytype* (a), Int_t n); + + template + arraytype debugStream(const arraytype* (a), Int_t n=512, Int_t columns=8, Int_t precision=2); + +// /** +// * @brief Sums over a given array +// * +// * Give this function an array, it weill return a sum +// */ +// template +// arraytype SumOverArray(const arraytype* (a), Int_t n); + + +public: + /** + * @brief Empty constructor, not valid + * + * returns a warning, that asks the user to use the @c MAPS(Run*) constructor, otherwise + * one will have to initialize all the information by hand + */ + MAPS (void); + MAPS ( TString InDir, TString OutDir, Int_t RunNumber, Int_t Rows, Int_t Columns, TString System="USB", TString OrderCode="", Int_t Matrix=0, bool Save=1); + MAPS ( Run* ); + ~MAPS (void); + + /** + * @brief Reads in RAW data, offsets to specific frame, sets fF0matrix, fF1matrix and fCdsmatrix + * + * @param FrameNumber TheFrame + * + */ + bool getFrame (Int_t FrameNumber); + /** + * @brief Old routine, shoould be deletable without side effects */ + bool getNoise (Int_t Start, Int_t Frames); + + /** + * @brief Calculates a first estimate of the noise and pedestial of each pixel in #frames + * + * Calculate noise and pedestial, trying to avoid pixels with hit charge + * + * Steps: + * 1. Calculate noise and pedestial + * 2. Recalculate noise and pedestial without pixels with higher CDS then 5 sigma + * 3. Recalculate noise and pedestial again using second estimate, without pixels with higher CDS then 3 sigma. This noise and pedestial is called #fPedestals and #fNoise. + * This new noise and pedestial will be used for hit analysis (@c hitana()) + * + * @return true if no errors occured + */ + bool InitialDynNoise(Int_t startframe = 0, Int_t Frames = numberofframesfornoise); + /** + * @brief Old routine, shoould be deletable without side effects */ + bool getDynNoise (Int_t Frames = numberofframesfornoise); + /** + * @brief Old routine, shoould be deletable without side effects */ + bool getDynNoise2(Int_t Frames = numberofframesfornoise); + + /** + * @brief Eliminates line structures in the chip + * + * @Todo An average over the noise of a line is calculated and subtracted from each #fCdsmatrix value of every pixel in this line.
+ * Noise structure between different lines is eliminated this way. + * + * @see fCdsmatrix + */ + void filterCommonMode(); + + /** + * @brief recalculates the noise and the pedestial for each pixel in @c frames using only the latest frame + * + * If in the current frame the pixel was not hit, then use its noise and pedestial value weighted by 1/@c frames for new estimate
+ * The code looks like this: + * + * @code + * for(Int_t pixeli=0; pixeli (5.*fNoise[i]) ) + * + * if true, saves pixel as seed pixel candidate, creates 5x5 cluster + * around it. If cluster has biggest value in the middle, then count it as a valid + * cluster and indicate a hit in the discriminator matrix #fHittedPixel, TH2F variable #fdiscriminatedhitmatrix + * and TH2F ADC matrix #fADCHitmatrix + * + */ + void hitana (); + + /** + * @brief Old routine, shoould be deletable without side effects */ + void hitana2 (); + + void plotNoise (void); + void plotFrame (Int_t FrameNumber); + void plotHitDis (Int_t Start, Int_t Frames); + void plotSignal (Int_t Start, Int_t Frames); + void plotPixSignal (Int_t Start, Int_t Frames, Int_t Pixel); + + void writeData (); + + Int_t GetNumberRun() { return fRunNumber; } + Int_t GetNumberFrames() { return fEventsSum; } + Int_t GetNumberPixels() { return fPixels; } + Int_t GetNumberRows() { return fRows; } + Int_t GetNumberColumn() { return fColumns; } + Float_t* GetCDSFrame() { return fCdsmatrix; } + Int_t* GetF0Frame() { return fF0matrix; } + Int_t* GetF1Frame() { return fF1matrix; } + Float_t* GetNoise() { return fNoise; } + + /// Output Directory, set and passed initMapsRun() to in the constructor + TString fOutDir;///< Some documentation for first. + Run* run; +}; +#endif \ No newline at end of file diff --git a/MABS_run_analyzer/Run.h b/MABS_run_analyzer/Run.h new file mode 100644 index 0000000..237a4f4 --- /dev/null +++ b/MABS_run_analyzer/Run.h @@ -0,0 +1,320 @@ +#ifndef __RUN__H +#define __RUN__H + +#include +#include +#include "sys/stat.h" + +#include +#include +#include +#include +#include +#include +#include +#include "TLegend.h" + +#include "TH1F.h" +#include "TF1.h" + +#include "help.h" + + +#define SERVERPATH "mysql://jspc29.x-matter.uni-frankfurt.de" +#define SERVERUSER "radhard" +#define SERVERPWD "mimosa88" + +#include "MAPS.h" +class MAPS; + + +/** + * @brief Has all the raw and processed information about a specific run + * + * This class makes SQL requests to the server, gets database results to a given runnumber, + * stores information about a specific run, writes the analyzed data and results back + * to the databases and stores the analyzed data as histograms. + * + */ +class Run { + +private: + /// Object to connect to the database located at jspc29 + TSQLServer *db; + /// pointer to a row of the results gathered by #db + TSQLRow *rowsql; + /// a pointer to the results of gathered by #db + TSQLResult *res; + /// number of rows the SQL database found to a given request + int nrows=0; + + /** + * @brief Takes a number, returns a string, used to build SQL queries + */ + template + string numberToString ( T ); + + /** @brief formats and checks SQL statements */ + template + char const* prepareSQLStatement( T ); + + /** + * @brief tries to get veto peak position from other, but close runs + */ + void getVetoPeakPositionFromFe55Run(); + /** + * @brief takes a float and a precision and returns the number as a string with given precision + */ + string to_str_w_prec(const Float_t, const int); + + /** + * @brief takes a float value and a precision and appends it to an SQL statement used to update the database + */ + void constructUpdateString(string*, const string, const Float_t, int); + + /** + * @brief A structure to hold information about a given sensor, like number of #columns and #rows + */ + struct sensorinfostruct + { + /// number of rows read out in the system the run was taken with (USB or PXI) + Int_t rows=0; + /// number of columns read out in the system the run was taken with (USB or PXI) + Int_t columns=0; + // sensorinfo():rows(0),columns(0){}; + // sensorinfo( int d, int m ) : rows( d ), columns( m ) {} + }; + + /** + * @brief writes values back to the SQL database + */ + void updateDatabase(); + + /** + * @brief removes all numbers from given string + */ + string removeNumbers(std::string x); + + /** + * @brief removes all punctuation from given string + */ + string removePunctuation(std::string x); + + /// if the submatrix is devided in two parts (#devided==true), then here are the rows where the border starts and ends, + /// notice, that pixel at the direct border are ignored. + const Float_t devided_lower_matr_min = 0.0; + /// see #devided_lower_matr_min + const Float_t devided_lower_matr_max = 6.0; + /// see #devided_lower_matr_min + const Float_t devided_upper_matr_min = 10.0; + /// see #devided_lower_matr_min + const Float_t devided_upper_matr_max = 16.0; + + /** + * @brief Generates a human readable string with information about the run + * + * The labbook data is used to make a string with useful information about the run + */ + Bool_t generateReadableRunCode(); + + /// is set to true if an entry was found in the SQL database + Bool_t runexistsinDB = 0; + + /// is set to true if an entry was found in the SQL database + Bool_t runexistsAsRootFile = 0; + + /// is set to true if the RAW Data is consistent + Bool_t runRAWok = 0; + + /** + * @brief fills noise #histogram */ + Bool_t binNoise(); + /** + * @brief fills Seedm, Sum and Veto #histogram */ + Bool_t binSeedSumVeto(); + /// noise quantiles: mean value, sigma in postive direction and sigma in negative direction + Double_t noisequantiles[3]; + + Bool_t plot1DHistogram(TH1F* histogram, TString titlestr = "", TString legendstr = ""); + + /** + * @brief Checks if a file exists + */ + Bool_t checkFileExists(TString); + +public: + /** @brief empty constructor */ + Run (void); + /** @brief default constructor */ + Run ( Int_t ); + /** @brief writes values back to the database, destroys the #MAPS object */ + ~Run (void); + + /** + * @brief analysis the RAW data + * + * Seed, sum and Veto spectrum are generated + * Clusters are found + * All analysis can be started after initialization of #MAPS + */ + Bool_t analyzeRun(Bool_t force = 0); + + /** + * @brief analysis the RAW data of a given frame + * + * F0, F1 matrix are generated + */ + Bool_t analyzeFrame(Int_t frame); + + + Bool_t runAllreadyAnalyzed(); + + Bool_t plotNoise(); + + /** + * @brief provides information from the SQL database + */ + struct labbooksctruct + { + /// runnumber for which the data is provided + Int_t runnumber = 0; + /// system, "USB" or "PXI" + TString system = ""; + /// temperature the run supposed to run with in °C + Float_t temp = -272; + /// actual temperature the chip had when meausurement started in °C + Float_t tempSens = -272; + /// number of chip/sensor used + TString chip = ""; + /// generation of the sensor + TString chipGen = ""; + /// the radioactive source the chip was radiated with during measurement + TString source = ""; + /// submatrix for which the measurement was done + TString matrix = ""; + /// ionizing radiation dose of the measured chip in MRad + Float_t radDoseIon = -1; + /// non-ionizing radiation dose of the chip in \f$ 10^{10} \frac{\text{neq}}{\text{cm}^2} \f$ + Float_t radDoseNonIon = -1; + /// position of th veto peak found in the database in ADU for this specific run + Float_t posVetoDB = -1; + /// the resistivity of the epitexial layer of the chip + Int_t resistivity = -1; + /// Thickness of epitexial layer in micro meters + Int_t epi_thickness = -1; + /// clock rate at wich the chip was measured in MHz + Int_t clock = 100; + /// path to the RAW files as seen from system which took the run + TString storepath = ""; + }; + /// stores information from the SQL database of a given run + labbooksctruct labbook; + + /// path to the RAW files on LINUX systems + TString storepathLinux = ""; + + TFile* rootfile; + + /** @brief sets #sensorinfocurrent after run data got from db, USB or PXI */ + void setSystemInfo(); + + + /** @brief A structure to hold the histogram data for the run + * + * seed, sum and veto histograms are stored here + * + */ + struct histogramstruct + { + /// Seed spectrum, only the seed pixel is considered when this histogram is build + TH1F* Seed; + /// Sum spectrum, the charge of whole cluster is summed up in binned into this TH1F histogram + TH1F* Sum; + /// Veto spectrum, used to find better calibration peak, only entries where Sum over not seed pixels is below #vetothreshold are binned into this histogram + TH1F* Veto; + /// Noise histogram + TH1F* Noise; + + TF1* SeedSr90PeakFit; + }; + histogramstruct histogram; + + /// maximal bin in + Int_t maxbinusb; + Int_t maxbinPXI; + + + /** @brief information about the submatrices of the sensor + */ + struct pixelinfo + { + Int_t ndiods; + Float_t diodesize; + /// TODO: add more + }; + pixelinfo pixelinfoMi34[32]; + + /// analyze only half of matrix + Bool_t dividedmatrix = false; + /// if #dividedmatrix ist set to true, which part to analyze? + Bool_t upperpart = false; + + /// fitted position of the most probable value of the seed spectrum + Float_t posSeed=0; + /// fitted position of the most probable value in the over cluster summed spectrum + Float_t posSum=0; + /// fitted position of the calibration peak of Fe55-beta-photons in the seed spectrum, from a run best suited to the current + Float_t posVeto=0; + + + /** @brief related Fe55 run + * + * if the analyzed run is not a Fe55 calibration run, find a related Fe55 run + * and fill this structure + * + * The run can be used to calibrate the run by using the position of the + * Fe55 calibration peak. ADU can be converted to e- + */ + struct OtherRun + { +// /// runnumber from where the position of the veto peak was taken + Int_t posVetorunnumber = 0; + /// fitted position of the calibration peak of Fe55-beta-photons in the seed spectrum, from a run best suited to the current + Float_t posVeto=0; + /// temperature + Float_t temperature; + }; + /** @brief related Fe55 run + * + * if the analyzed run is not a Fe55 calibration run, find a related Fe55 run + * and fill this structure + * + * The run can be used to calibrate the run by using the position of the + * Fe55 calibration peak. ADU can be converted to e- + */ + OtherRun Fe55run; + /// noise average in ADU + Float_t NoiseAvg=0; + /// positive noise error in ADU + Float_t NoiseAvgPlus=0; + /// negative noise error in ADU + Float_t NoiseAvgMinus=0; + /// to convert from ADU to values in electron one has to divide by this value, it is given in [1/e] + Float_t gain=0; + /// Charge collection efficciency of the cluster in percent + Float_t CCE_in_Perc_25=0; + /// Charge collection efficciency of the seed pixel in percent + Float_t CCE_in_Perc_1=0; + /// specific string wich encodes the database information of the run + TString runcode=""; + + /** @brief Converting string to numbers */ + Float_t stringToNumber ( string ); + + /// processed run class + MAPS *processed; + + /// sensor information to use in analysis, is the system read out by USB or PXI? Number of rows differ + sensorinfostruct sensorinfocurrent; +}; +#endif \ No newline at end of file diff --git a/MABS_run_analyzer/Run_analyzer.c b/MABS_run_analyzer/Run_analyzer.c new file mode 100644 index 0000000..e69de29 diff --git a/MABS_run_analyzer/Run_analyzer.h b/MABS_run_analyzer/Run_analyzer.h new file mode 100644 index 0000000..f630a1b --- /dev/null +++ b/MABS_run_analyzer/Run_analyzer.h @@ -0,0 +1,26 @@ +#ifndef __RUN_ANALYZER__H +#define __RUN_ANALYZER__H + +#include "Run.h" +#include "MAPS.h" + +Int_t numberRuns=0; + + +/** + * @file + * @brief Analyze and plot MABS runs + * + * Detailed explanation. + * + * + */ +// class Run_analyzer { + +// private: +// +// public: +// +// }; + +#endif \ No newline at end of file diff --git a/MABS_run_analyzer/doxygenconfig.cfg b/MABS_run_analyzer/doxygenconfig.cfg new file mode 100644 index 0000000..d2c864e --- /dev/null +++ b/MABS_run_analyzer/doxygenconfig.cfg @@ -0,0 +1,1808 @@ +# Doxyfile 1.8.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "Mimosa run analyzer" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter and setter methods for a property. Setting this option to YES (the default) will make doxygen replace the get and set methods by a property in the documentation. This will only work if the methods are indeed getting or setting a simple type. If this is not the case, or you want to show the methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = amsmath + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/MABS_run_analyzer/help.h b/MABS_run_analyzer/help.h new file mode 100644 index 0000000..6ce53da --- /dev/null +++ b/MABS_run_analyzer/help.h @@ -0,0 +1,112 @@ +#ifndef HELP_H +#define HELP_H + +#include +#include +#include +#include +#include +#include +#include +#include "TStopwatch.h" + +#define MAXHITS 1000000 + +//#################################################################### + +Int_t print_progress(Float_t ProgressInPercent) { + + Int_t nCharacter = printf("\r ["); + Int_t iBlock; + + for( iBlock=0; iBlock