Inheritance diagram for icarus_tool::SBNNoise:

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

	~SBNNoise ()

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

void	nextEvent () override

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

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

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

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

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

void	ComputeRMSs ()

void	makeHistograms ()

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

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

icarusutil::TimeVec	fCoherentNoiseVec

icarusutil::TimeVec	fIncoherentNoiseVec

std::vector< double >	fCorrAmpDistVec

double	fIncoherentNoiseRMS

double	fCoherentNoiseRMS

icarusutil::FrequencyVec	fNoiseFrequencyVec

bool	fNeedFirstSeed =true

TProfile *	fInputNoiseHist

TProfile *	fMedianNoiseHist

TProfile *	fPeakNoiseHist

TProfile *	fCorAmpDistHist

TH1D *	corrRMSHistPtr

TH1D *	uncorrRMSHistPtr

TH1D *	totalRMSHistPtr

float	totalRMS

Eigen::FFT< double >	fEigenFFT

Detailed Description

Definition at line 40 of file SBNNoise_tool.cc.

Member Typedef Documentation

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

private

Definition at line 82 of file SBNNoise_tool.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 121 of file SBNNoise_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();
 }

icarus_tool::SBNNoise::~SBNNoise ( )

Definition at line 131 of file SBNNoise_tool.cc.

132 {

133 }

Member Function Documentation

void icarus_tool::SBNNoise::ComputeRMSs ( )

private

Definition at line 342 of file SBNNoise_tool.cc.

 {
     // Let's get the rms we expect from the incoherent noise contribution to the waveform
     // A couple of ways to do this, let's basically invert the frequency spectrum to
     // produce a waveform and then get the rms from that
     std::function<void (double[])> randGenFunc = [](double randArray[]){randArray[0]=0.5; randArray[1]=0.5;};
     
     icarusutil::TimeVec waveNoise(fIncoherentNoiseVec.size());
     float              scaleFactor = 1.;
     
     GenNoise(randGenFunc, fIncoherentNoiseVec, waveNoise, scaleFactor);
     
     // Now get the details...
     double nSig(3.);
     double mean,rmsTrunc;
     int    nTrunc;
     int    range;
     
     // Use the waveform tool to recover the full rms
     fWaveformTool.getTruncatedMeanRMS(waveNoise, nSig, mean, fIncoherentNoiseRMS, rmsTrunc, nTrunc, range);
     
     // Do the same for the coherent term
     GenNoise(randGenFunc, fCoherentNoiseVec, waveNoise, scaleFactor);
     
     fWaveformTool.getTruncatedMeanRMS(waveNoise, nSig, mean, fCoherentNoiseRMS, rmsTrunc, nTrunc, range);
 
     if (fStoreHistograms)
     {
         for(size_t idx = 0; idx < fCorrAmpDistVec.size(); idx++)
             fCorAmpDistHist->Fill(idx, fCorrAmpDistVec[idx], 1.);
     }
 
  totalRMS=totalRMSHistPtr->GetMean();
 double rmsUnc=uncorrRMSHistPtr->GetMean();
 //double rmsCorr=corrRMSHistPtr->GetMean();
 fIncoherentNoiseFrac=rmsUnc/totalRMS;
     return;
 }

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

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 135 of file SBNNoise_tool.cc.

 {
     // 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);
     fIncoherentNoiseFrac       = pset.get< float       >("IncoherentNoiseFraction",0.5);
     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");
     // Initialize the work vector
     auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataForJob();
     auto const detProp = art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataForJob(clockData);
     fNoiseFrequencyVec.resize(detProp.NumberTimeSamples(),std::complex<float>(0.,0.));
 
     // Set up to input the histogram with the overall noise spectrum
     std::string fullFileName;
     std::string corrAmpFileName;
 
     cet::search_path searchPath("FW_SEARCH_PATH");
     searchPath.find_file(fInputNoiseHistFileName, fullFileName);
     
     TFile inputFile(fullFileName.c_str(), "READ");
     
     if (!inputFile.IsOpen())
         throw cet::exception("NoiseFromHist::configure") << "Unable to open input file: " << fInputNoiseHistFileName << std::endl;
     
     TH1D* corrHistPtr = (TH1D*)inputFile.Get(fCorrelatedHistogramName.c_str());    
     if (!corrHistPtr)
         throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fCorrelatedHistogramName << std::endl;
 
   TH1D* uncorrHistPtr = (TH1D*)inputFile.Get(fUncorrelatedHistogramName.c_str());    
     if (!uncorrHistPtr)
         throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fUncorrelatedHistogramName << std::endl;
 
     corrRMSHistPtr = (TH1D*)inputFile.Get(fCorrelatedRMSHistoName.c_str());  
     if (!corrRMSHistPtr)
         throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fCorrelatedRMSHistoName << std::endl;
 
   uncorrRMSHistPtr = (TH1D*)inputFile.Get(fUncorrelatedRMSHistoName.c_str());  
     if (!uncorrRMSHistPtr)
         throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fUncorrelatedRMSHistoName << std::endl;
 
  totalRMSHistPtr = (TH1D*)inputFile.Get(fTotalRMSHistoName.c_str());  
     if (!totalRMSHistPtr)
         throw cet::exception("NoiseFromHist::configure") << "Unable to recover desired histogram: " << fTotalRMSHistoName << std::endl;
 
     // Close the input file
     inputFile.Close();
 std::cout << " corr nbins " << corrHistPtr->GetNbinsX() << std::endl;
 std::cout << " uncorr nbins " << uncorrHistPtr->GetNbinsX() << std::endl;
     fCoherentNoiseVec.resize(corrHistPtr->GetNbinsX(), 0.);
     
     // Recover the bin contents into local vectors
     for(size_t histIdx = 0; histIdx < size_t(corrHistPtr->GetNbinsX()); histIdx++)
         fCoherentNoiseVec[histIdx] = corrHistPtr->GetBinContent(histIdx+1);
 fIncoherentNoiseVec.resize(uncorrHistPtr->GetNbinsX(), 0.);
     
     // Recover the bin contents into local vectors
     for(size_t histIdx = 0; histIdx < size_t(uncorrHistPtr->GetNbinsX()); histIdx++)
         fIncoherentNoiseVec[histIdx] = uncorrHistPtr->GetBinContent(histIdx+1);
     // Should we store hists?
 
 std::cout << " after filling vectors " << std::endl;
     if (fStoreHistograms)
     {
         // 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);
         fMedianNoiseHist  = dir.make<TProfile>("MedNoise",  ";freq(kHz)", numSamples, minFreq, maxFreq);;
         fPeakNoiseHist    = dir.make<TProfile>("PeakNoise", ";freq(kHz)", numSamples, minFreq, maxFreq);;
         
         fCorAmpDistHist   = dir.make<TProfile>("CorAmp",    ";Motherboard", fCorrAmpDistVec.size(),0.,fCorrAmpDistVec.size());
     }
    
     return;
 }

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

private

Definition at line 293 of file SBNNoise_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);};
         
         float fraction    = std::sqrt(1. - fIncoherentNoiseFrac * fIncoherentNoiseFrac);
         float scaleFactor = fraction * noise_factor / fCoherentNoiseRMS;
         
         GenNoise(randGenFunc, fCoherentNoiseVec, noise, scaleFactor);
     
     return;
 }

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

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 239 of file SBNNoise_tool.cc.

 {
 noise_factor=totalRMS;
 //std::cout <<  " generating noise " << 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.));
     //std::cout <<  " generating uncorrelated noise " << std::endl;
     // If applying incoherent noise call the generator
     if (fIncoherentNoiseFrac > 0.) GenerateUncorrelatedNoise(engine_unc,noise_unc,noise_factor);
     
 //    int board=channel/64;
 //std::cout <<  " generating correlated noise " << std::endl;
     // If applying coherent noise call the generator
     if (fIncoherentNoiseFrac < 1.) 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>());
     
     return;
 }

void icarus_tool::SBNNoise::GenerateUncorrelatedNoise	(	CLHEP::HepRandomEngine &	engine,
		icarusutil::TimeVec &	noise,
		double	noise_factor
	)

private

Definition at line 270 of file SBNNoise_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);};
 
     float  scaleFactor = fIncoherentNoiseFrac * noise_factor / fIncoherentNoiseRMS;
     
     GenNoise(randGenFunc, fIncoherentNoiseVec, noise, scaleFactor);
 
     return;
 }

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

private

Definition at line 312 of file SBNNoise_tool.cc.

 {
     double rnd_corr[2] = {0.,0.};
     
     // Build out the frequency vector
     for(size_t i=0; i< noise.size()/2; ++i)
     {
         // exponential noise spectrum
         gen(rnd_corr);
         
         float pval  = freqDist[i] * ((1-fNoiseRand) + 2 * fNoiseRand*rnd_corr[0]) * scaleFactor;
         float phase = rnd_corr[1] * 2. * M_PI;
         
         std::complex<float> tc(pval*cos(phase),pval*sin(phase));
         
         fNoiseFrequencyVec[i] = tc;
     }
     
     // inverse FFT MCSignal
     fEigenFFT.inv(noise, fNoiseFrequencyVec);
     
     return;
 }

void icarus_tool::SBNNoise::makeHistograms ( )

private

Definition at line 336 of file SBNNoise_tool.cc.

 {
     
     return;
 }

void icarus_tool::SBNNoise::nextEvent ( )

overridevirtual

Implements icarus_tool::IGenNoise.

Definition at line 231 of file SBNNoise_tool.cc.

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

Member Data Documentation

TH1D* icarus_tool::SBNNoise::corrRMSHistPtr

private

Definition at line 107 of file SBNNoise_tool.cc.

double icarus_tool::SBNNoise::fCoherentNoiseRMS

private

Definition at line 94 of file SBNNoise_tool.cc.

icarusutil::TimeVec icarus_tool::SBNNoise::fCoherentNoiseVec

private

Definition at line 88 of file SBNNoise_tool.cc.

TProfile* icarus_tool::SBNNoise::fCorAmpDistHist

private

Definition at line 106 of file SBNNoise_tool.cc.

std::vector<double> icarus_tool::SBNNoise::fCorrAmpDistVec

private

Definition at line 91 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fCorrelatedHistogramName

private

Definition at line 76 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fCorrelatedRMSHistoName

private

Definition at line 78 of file SBNNoise_tool.cc.

long icarus_tool::SBNNoise::fCorrelatedSeed

private

Definition at line 70 of file SBNNoise_tool.cc.

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

private

Definition at line 115 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fHistogramName

private

Definition at line 75 of file SBNNoise_tool.cc.

float icarus_tool::SBNNoise::fIncoherentNoiseFrac

private

Definition at line 72 of file SBNNoise_tool.cc.

double icarus_tool::SBNNoise::fIncoherentNoiseRMS

private

Definition at line 93 of file SBNNoise_tool.cc.

icarusutil::TimeVec icarus_tool::SBNNoise::fIncoherentNoiseVec

private

Definition at line 89 of file SBNNoise_tool.cc.

TProfile* icarus_tool::SBNNoise::fInputNoiseHist

private

Definition at line 103 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fInputNoiseHistFileName

private

Definition at line 74 of file SBNNoise_tool.cc.

TProfile* icarus_tool::SBNNoise::fMedianNoiseHist

private

Definition at line 104 of file SBNNoise_tool.cc.

int icarus_tool::SBNNoise::fMedianNumBins

private

Definition at line 68 of file SBNNoise_tool.cc.

bool icarus_tool::SBNNoise::fNeedFirstSeed =true

private

Definition at line 100 of file SBNNoise_tool.cc.

icarusutil::FrequencyVec icarus_tool::SBNNoise::fNoiseFrequencyVec

private

Definition at line 97 of file SBNNoise_tool.cc.

float icarus_tool::SBNNoise::fNoiseRand

private

Definition at line 69 of file SBNNoise_tool.cc.

TProfile* icarus_tool::SBNNoise::fPeakNoiseHist

private

Definition at line 105 of file SBNNoise_tool.cc.

size_t icarus_tool::SBNNoise::fPlane

private

Definition at line 67 of file SBNNoise_tool.cc.

bool icarus_tool::SBNNoise::fStoreHistograms

private

Definition at line 73 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fTotalRMSHistoName

private

Definition at line 80 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fUncorrelatedHistogramName

private

Definition at line 77 of file SBNNoise_tool.cc.

std::string icarus_tool::SBNNoise::fUncorrelatedRMSHistoName

private

Definition at line 79 of file SBNNoise_tool.cc.

long icarus_tool::SBNNoise::fUncorrelatedSeed

private

Definition at line 71 of file SBNNoise_tool.cc.

WaveformTools icarus_tool::SBNNoise::fWaveformTool

private

Definition at line 84 of file SBNNoise_tool.cc.

float icarus_tool::SBNNoise::totalRMS

private

Definition at line 111 of file SBNNoise_tool.cc.

TH1D* icarus_tool::SBNNoise::totalRMSHistPtr

private

Definition at line 109 of file SBNNoise_tool.cc.

TH1D* icarus_tool::SBNNoise::uncorrRMSHistPtr

private

Definition at line 108 of file SBNNoise_tool.cc.

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

SBNNoise_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