Inheritance diagram for icarus_tool::SBNDataNoiseBoard:

Public Member Functions
	SBNDataNoiseBoard (const fhicl::ParameterSet &pset)

	~SBNDataNoiseBoard ()

void	configure (const fhicl::ParameterSet &pset) override

void	nextEvent () override

void	generateNoise (CLHEP::HepRandomEngine &, CLHEP::HepRandomEngine &, icarusutil::TimeVec &, detinfo::DetectorPropertiesData const &, double, const geo::PlaneID &, unsigned int) override

Private Types
using	WaveformTools = icarus_signal_processing::WaveformTools< icarusutil::SigProcPrecision >

using	BoardToNoiseVecMap = std::unordered_map< unsigned int, icarusutil::TimeVec >

using	BoardToHistMap = std::unordered_map< unsigned int, TH1D * >

Private Member Functions
void	GenerateCorrelatedNoise (CLHEP::HepRandomEngine &, icarusutil::TimeVec &, double, unsigned int)

void	GenerateUncorrelatedNoise (CLHEP::HepRandomEngine &, icarusutil::TimeVec &, double, unsigned int)

void	GenNoise (std::function< void(double[])> &, const icarusutil::TimeVec &, icarusutil::TimeVec &, float)

void	ComputeRMSs ()

void	makeHistograms ()

void	SampleCorrelatedRMSs ()

void	ExtractUncorrelatedRMS (float &, int, int) const

void	makeBoardHistos (unsigned int)

Private Member Functions inherited from icarus_tool::IGenNoise
virtual	~IGenNoise () noexcept=default

Private Attributes
size_t	fPlane

int	fMedianNumBins

float	fNoiseRand

long	fCorrelatedSeed

long	fUncorrelatedSeed

std::vector< float >	fIncoherentNoiseFrac

bool	fStoreHistograms

std::string	fInputNoiseHistFileName

std::string	fHistogramName

std::string	fCorrelatedHistogramName

std::string	fUncorrelatedHistogramName

std::string	fCorrelatedRMSHistoName

std::string	fUncorrelatedRMSHistoName

std::string	fTotalRMSHistoName

WaveformTools	fWaveformTool

BoardToNoiseVecMap	fCoherentBoardToNoiseVecMap

BoardToNoiseVecMap	fIncoherentBoardToNoiseVecMap

std::vector< icarusutil::TimeVec >	fCoherentNoiseVec

std::vector< icarusutil::TimeVec >	fIncoherentNoiseVec

icarusutil::FrequencyVec	fNoiseFrequencyVec

bool	fNeedFirstSeed =true

TProfile *	fInputNoiseHist

TH1D *	fMediaNoiseHist

TProfile *	fPeakNoiseHist

TFile *	fHistogramFile

std::vector< float >	totalRMS

std::vector< float >	rmsUnc

std::vector< float >	rmsCorr

Eigen::FFT< double >	fEigenFFT

Detailed Description

Definition at line 41 of file SBNDataNoiseBoard_tool.cc.

Member Typedef Documentation

using icarus_tool::SBNDataNoiseBoard::BoardToHistMap = std::unordered_map<unsigned int, TH1D*>

private

Definition at line 100 of file SBNDataNoiseBoard_tool.cc.

using icarus_tool::SBNDataNoiseBoard::BoardToNoiseVecMap = std::unordered_map<unsigned int, icarusutil::TimeVec>

private

Definition at line 92 of file SBNDataNoiseBoard_tool.cc.

using icarus_tool::SBNDataNoiseBoard::WaveformTools = icarus_signal_processing::WaveformTools<icarusutil::SigProcPrecision>

private

Definition at line 86 of file SBNDataNoiseBoard_tool.cc.

Constructor & Destructor Documentation

icarus_tool::SBNDataNoiseBoard::SBNDataNoiseBoard ( const fhicl::ParameterSet & pset )

explicit

Definition at line 126 of file SBNDataNoiseBoard_tool.cc.

 {
     // Recover the configuration of the tool from the input fhicl file and set up
     configure(pset);
     ComputeRMSs();
     
     // Output some histograms to catalogue what's been done
     makeHistograms();
     std::cout << " after making histos " << std::endl;
 }

icarus_tool::SBNDataNoiseBoard::~SBNDataNoiseBoard ( )

Definition at line 137 of file SBNDataNoiseBoard_tool.cc.

 {
     // Close the input file
     fHistogramFile->Close();
 }

Member Function Documentation

void icarus_tool::SBNDataNoiseBoard::ComputeRMSs ( )

private

Definition at line 360 of file SBNDataNoiseBoard_tool.cc.

 {
 
 }

void icarus_tool::SBNDataNoiseBoard::configure ( const fhicl::ParameterSet & pset )

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 143 of file SBNDataNoiseBoard_tool.cc.

 {
 std::cout << " configuring tool " << std::endl;
     // Recover the histogram used for noise generation
     fPlane                          = pset.get< size_t             >("Plane");
     fMedianNumBins                  = pset.get< int                >("MedianNumBins");
     fNoiseRand                      = pset.get< float              >("NoiseRand");
     fCorrelatedSeed                 = pset.get< long               >("CorrelatedSeed",1000);
     fUncorrelatedSeed               = pset.get< long               >("UncorrelatedSeed",5000);
     std::vector<float> noiseFracVec = pset.get< std::vector<float> >("IncoherentNoiseFraction", std::vector<float>());
     fStoreHistograms                = pset.get< bool               >("StoreHistograms");
     fInputNoiseHistFileName         = pset.get< std::string        >("NoiseHistFileName");
     fCorrelatedHistogramName        = pset.get< std::string        >("CorrelatedHistogramName");
     fUncorrelatedHistogramName      = pset.get< std::string        >("UncorrelatedHistogramName");
     fCorrelatedRMSHistoName         = pset.get< std::string        >("CorrelatedRMSHistoName");
     fUncorrelatedRMSHistoName       = pset.get< std::string        >("UncorrelatedRMSHistoName");
     fTotalRMSHistoName              = pset.get< std::string        >("TotalRMSHistoName");
  
     for(auto& noiseFrac : noiseFracVec) {
         fIncoherentNoiseFrac.push_back(float(noiseFrac));
     }
 
     std::string fullFileName;
 
     cet::search_path searchPath("FW_SEARCH_PATH");
 
     searchPath.find_file(fInputNoiseHistFileName, fullFileName);
 
     fHistogramFile = TFile::Open(fullFileName.c_str(), "READ");
     
     if (!fHistogramFile->IsOpen())
         throw cet::exception("NoiseFromHist::configure") << "Unable to open input file: " << fInputNoiseHistFileName << std::endl;
 
     std::cout << " end configuring tool " << std::endl;
     return;
 }

void icarus_tool::SBNDataNoiseBoard::ExtractUncorrelatedRMS	(	float &	cf,
		int	channel,
		int	index
	)		const

private

Definition at line 369 of file SBNDataNoiseBoard_tool.cc.

370 {

371 }

void icarus_tool::SBNDataNoiseBoard::GenerateCorrelatedNoise	(	CLHEP::HepRandomEngine &	engine,
		icarusutil::TimeVec &	noise,
		double	noise_factor,
		unsigned int	board
	)

private

Definition at line 310 of file SBNDataNoiseBoard_tool.cc.

 {    
    
     // Set the engine seed to the board being considered
     engine.setSeed(fCorrelatedSeed+board,0);
     
     CLHEP::RandFlat noiseGen(engine,0,1);
     
     std::function<void (double[])> randGenFunc = [&noiseGen](double randArray[]){noiseGen.fireArray(2,randArray);};
 
     GenNoise(randGenFunc, fCoherentBoardToNoiseVecMap[board], noise, noise_factor);
     
     return;
 }

void icarus_tool::SBNDataNoiseBoard::generateNoise	(	CLHEP::HepRandomEngine &	engine_unc,
		CLHEP::HepRandomEngine &	engine_corr,
		icarusutil::TimeVec &	noise,
		detinfo::DetectorPropertiesData const &	,
		double	noise_factor,
		const geo::PlaneID &	planeID,
		unsigned int	board
	)

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 243 of file SBNDataNoiseBoard_tool.cc.

 {
     makeBoardHistos(board);
 
     //std::cout << " generating noise channel " << channel << std::endl;
     //GET THE GEOMETRY.
     art::ServiceHandle<geo::Geometry> geom;
 
     // We need to know the plane to look up parameters
 //    size_t cryostat=planeID.Cryostat;
 //    size_t tpc=planeID.TPC;
 
     //std::cout <<  " index " << index << " generating noise totalRMS " << totalRMS[index] << std::endl;
     // Define a couple of vectors to hold intermediate work
     icarusutil::TimeVec noise_unc(noise.size(),0.);
     icarusutil::TimeVec noise_corr(noise.size(),0.);
     
     // Make sure the work vector is size right with the output
     if (fNoiseFrequencyVec.size() != noise.size()) fNoiseFrequencyVec.resize(noise.size(),std::complex<float>(0.,0.));
 
     // If applying incoherent noise call the generator
     GenerateUncorrelatedNoise(engine_unc,noise_unc,noise_factor, board); 
 
     GenerateCorrelatedNoise(engine_corr, noise_corr, noise_factor, board);
 
     // std::cout <<  " summing noise " << std::endl;
     // Take the noise as the simple sum of the two contributions
     std::transform(noise_unc.begin(),noise_unc.end(),noise_corr.begin(),noise.begin(),std::plus<float>());
     
 //    float mediaNoise=0;
 //    for(unsigned int jn=0;jn<noise.size();jn++) mediaNoise+=noise.at(jn);
 
 //    mediaNoise/=(noise.size());
 
     //std::cout << " media noise size " << noise.size() << std::endl;
     //fMediaNoiseHist->Fill(mediaNoise);
     //std::cout << " media noise " << mediaNoise << std::endl;
     return;
 }

void icarus_tool::SBNDataNoiseBoard::GenerateUncorrelatedNoise	(	CLHEP::HepRandomEngine &	engine,
		icarusutil::TimeVec &	noise,
		double	noise_factor,
		unsigned int	board
	)

private

Definition at line 289 of file SBNDataNoiseBoard_tool.cc.

 {
     // Here we aim to produce a waveform consisting of incoherent noise
     // Note that this is expected to be the dominate noise contribution
     // Check for seed initialization
     if (fNeedFirstSeed)
     {
         engine.setSeed(fUncorrelatedSeed,0);
         fNeedFirstSeed = false;
     }
     
     // Get the generator
     CLHEP::RandFlat noiseGen(engine,0,1);
     
     std::function<void (double[])> randGenFunc = [&noiseGen](double randArray[]){noiseGen.fireArray(2,randArray);};
 
     GenNoise(randGenFunc, fIncoherentBoardToNoiseVecMap[board], noise, noise_factor);
 
     return;
 }

void icarus_tool::SBNDataNoiseBoard::GenNoise	(	std::function< void(double[])> &	gen,
		const icarusutil::TimeVec &	freqDist,
		icarusutil::TimeVec &	noise,
		float	scaleFactor
	)

private

Definition at line 325 of file SBNDataNoiseBoard_tool.cc.

 {
     double rnd_corr[2] = {0.,0.};
     // std::cout << " noise size " << noise.size() << std::endl;
     // Build out the frequency vector
     for(size_t i=0; i< noise.size()/2; ++i)
     {
         //std::cout << " i " << i << " freqdist " << freqDist[i] << std::endl;
         // exponential noise spectrum
         gen(rnd_corr);
         // if(i!=10) continue;
         float pval  = freqDist[i] * ((1-fNoiseRand) + 2 * fNoiseRand*rnd_corr[0]) * scaleFactor;
         float phase = rnd_corr[1] * 2. * M_PI;
         //   float pval  = freqDist[i]*scaleFactor ;
         //  float phase = 0;
         std::complex<float> tc(pval*cos(phase),pval*sin(phase));
         
         fNoiseFrequencyVec[i] = tc;
         //std::cout << " i " << i << " noise freqvec " << fNoiseFrequencyVec[i] << std::endl; 
     }
     
     // inverse FFT MCSignal
     fEigenFFT.inv(noise, fNoiseFrequencyVec);
     //    for(unsigned int jn=0;jn<noise.size();jn++) std::cout << " jn " << jn << " noise sum " << noise.at(jn) << std::endl; 
     //exit(22);
     //std::cout << " end gen noise " << std::endl;
     return;
 }

void icarus_tool::SBNDataNoiseBoard::makeBoardHistos ( unsigned int board )

private

Definition at line 180 of file SBNDataNoiseBoard_tool.cc.

 {
     if (fCoherentBoardToNoiseVecMap.find(board) == fCoherentBoardToNoiseVecMap.end())
     {
     
         TH1D* corrHistPtr = (TH1D*)fHistogramFile->Get((fCorrelatedHistogramName+std::to_string(board)).c_str());    
         if (!corrHistPtr)
             throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fCorrelatedHistogramName+std::to_string(board) << std::endl;
 
         icarusutil::TimeVec& noiseVec = fCoherentBoardToNoiseVecMap[board];
 
         noiseVec.resize(corrHistPtr->GetNbinsX(),0.);
         for(size_t histIdx = 0; histIdx < size_t(corrHistPtr->GetNbinsX()); histIdx++) noiseVec[histIdx] = corrHistPtr->GetBinContent(histIdx+1);
     }
 
     if(fIncoherentBoardToNoiseVecMap.find(board) == fIncoherentBoardToNoiseVecMap.end())
     {
         TH1D* uncorrHistPtr = (TH1D*)fHistogramFile->Get((fUncorrelatedHistogramName+std::to_string(board)).c_str());    
         if (!uncorrHistPtr)
             throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fUncorrelatedHistogramName << std::endl;
 
         icarusutil::TimeVec& noiseVec = fIncoherentBoardToNoiseVecMap[board];
 
         noiseVec.resize(uncorrHistPtr->GetNbinsX(),0.);
         for(size_t histIdx = 0; histIdx < size_t(uncorrHistPtr->GetNbinsX()); histIdx++) noiseVec[histIdx] = uncorrHistPtr->GetBinContent(histIdx+1);
     }
 
     // Should we store hists?
     if (fStoreHistograms)
     {
         auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataForJob();
         auto const detProp   = art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataForJob(clockData);
 
         // Define histograms
         art::ServiceHandle<art::TFileService> tfs;
     
         art::TFileDirectory* histDirectory = tfs.get();
         
         // Make a directory for these histograms
         art::TFileDirectory dir = histDirectory->mkdir(Form("CorNoisePlane%1zu",fPlane));
         
         float sampleRate  = sampling_rate(clockData);
         float readOutSize = detProp.ReadOutWindowSize();
         float maxFreq     = 1.e6 / (2. * sampleRate);
         float minFreq     = 1.e6 / (2. * sampleRate * readOutSize);
         int   numSamples  = readOutSize / 2;
         
         fInputNoiseHist   = dir.make<TProfile>("InNoise",   ";freq(kHz)", numSamples, minFreq, maxFreq);
         fMediaNoiseHist   = dir.make<TH1D>("MedNoise",  ";ADC", 100, -10., -10.);;
         fPeakNoiseHist    = dir.make<TProfile>("PeakNoise", ";freq(kHz)", numSamples, minFreq, maxFreq);;
     }
     //SampleCorrelatedRMSs();
 }

void icarus_tool::SBNDataNoiseBoard::makeHistograms ( )

private

Definition at line 354 of file SBNDataNoiseBoard_tool.cc.

 {
     
     return;
 }

void icarus_tool::SBNDataNoiseBoard::nextEvent ( )

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 234 of file SBNDataNoiseBoard_tool.cc.

 {
     // We update the correlated seed because we want to see different noise event-by-event
     fCorrelatedSeed   = (333 * fCorrelatedSeed) % 900000000;
     SampleCorrelatedRMSs();
 
     return;
 }

void icarus_tool::SBNDataNoiseBoard::SampleCorrelatedRMSs ( )

private

Definition at line 365 of file SBNDataNoiseBoard_tool.cc.

 {
 
 }

Member Data Documentation

BoardToNoiseVecMap icarus_tool::SBNDataNoiseBoard::fCoherentBoardToNoiseVecMap

private

Definition at line 94 of file SBNDataNoiseBoard_tool.cc.

std::vector<icarusutil::TimeVec> icarus_tool::SBNDataNoiseBoard::fCoherentNoiseVec

private

Definition at line 97 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fCorrelatedHistogramName

private

Definition at line 80 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fCorrelatedRMSHistoName

private

Definition at line 82 of file SBNDataNoiseBoard_tool.cc.

long icarus_tool::SBNDataNoiseBoard::fCorrelatedSeed

private

Definition at line 74 of file SBNDataNoiseBoard_tool.cc.

Eigen::FFT<double> icarus_tool::SBNDataNoiseBoard::fEigenFFT

private

Definition at line 120 of file SBNDataNoiseBoard_tool.cc.

TFile* icarus_tool::SBNDataNoiseBoard::fHistogramFile

private

Definition at line 113 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fHistogramName

private

Definition at line 79 of file SBNDataNoiseBoard_tool.cc.

BoardToNoiseVecMap icarus_tool::SBNDataNoiseBoard::fIncoherentBoardToNoiseVecMap

private

Definition at line 95 of file SBNDataNoiseBoard_tool.cc.

std::vector<float> icarus_tool::SBNDataNoiseBoard::fIncoherentNoiseFrac

private

Definition at line 76 of file SBNDataNoiseBoard_tool.cc.

std::vector<icarusutil::TimeVec> icarus_tool::SBNDataNoiseBoard::fIncoherentNoiseVec

private

Definition at line 98 of file SBNDataNoiseBoard_tool.cc.

TProfile* icarus_tool::SBNDataNoiseBoard::fInputNoiseHist

private

Definition at line 109 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fInputNoiseHistFileName

private

Definition at line 78 of file SBNDataNoiseBoard_tool.cc.

int icarus_tool::SBNDataNoiseBoard::fMedianNumBins

private

Definition at line 72 of file SBNDataNoiseBoard_tool.cc.

TH1D* icarus_tool::SBNDataNoiseBoard::fMediaNoiseHist

private

Definition at line 110 of file SBNDataNoiseBoard_tool.cc.

bool icarus_tool::SBNDataNoiseBoard::fNeedFirstSeed =true

private

Definition at line 106 of file SBNDataNoiseBoard_tool.cc.

icarusutil::FrequencyVec icarus_tool::SBNDataNoiseBoard::fNoiseFrequencyVec

private

Definition at line 103 of file SBNDataNoiseBoard_tool.cc.

float icarus_tool::SBNDataNoiseBoard::fNoiseRand

private

Definition at line 73 of file SBNDataNoiseBoard_tool.cc.

TProfile* icarus_tool::SBNDataNoiseBoard::fPeakNoiseHist

private

Definition at line 111 of file SBNDataNoiseBoard_tool.cc.

size_t icarus_tool::SBNDataNoiseBoard::fPlane

private

Definition at line 71 of file SBNDataNoiseBoard_tool.cc.

bool icarus_tool::SBNDataNoiseBoard::fStoreHistograms

private

Definition at line 77 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fTotalRMSHistoName

private

Definition at line 84 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fUncorrelatedHistogramName

private

Definition at line 81 of file SBNDataNoiseBoard_tool.cc.

std::string icarus_tool::SBNDataNoiseBoard::fUncorrelatedRMSHistoName

private

Definition at line 83 of file SBNDataNoiseBoard_tool.cc.

long icarus_tool::SBNDataNoiseBoard::fUncorrelatedSeed

private

Definition at line 75 of file SBNDataNoiseBoard_tool.cc.

WaveformTools icarus_tool::SBNDataNoiseBoard::fWaveformTool

private

Definition at line 88 of file SBNDataNoiseBoard_tool.cc.

std::vector<float> icarus_tool::SBNDataNoiseBoard::rmsCorr

private

Definition at line 117 of file SBNDataNoiseBoard_tool.cc.

std::vector<float> icarus_tool::SBNDataNoiseBoard::rmsUnc

private

Definition at line 116 of file SBNDataNoiseBoard_tool.cc.

std::vector<float> icarus_tool::SBNDataNoiseBoard::totalRMS

private

Definition at line 115 of file SBNDataNoiseBoard_tool.cc.

The documentation for this class was generated from the following file:

SBNDataNoiseBoard_tool.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation