Inheritance diagram for icarus_tool::FieldResponse:

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

	~FieldResponse ()

void	configure (const fhicl::ParameterSet &) override

void	setResponse (double, double, double) override

void	outputHistograms (art::TFileDirectory &) const override

size_t	getPlane () const override

size_t	getResponseType () const override

size_t	getNumBins () const override

double	getBinCenter (int bin) const override

double	getBinContent (int bin) const override

double	getLowEdge () const override

double	getHighEdge () const override

double	getBinWidth () const override

double	getTOffset () const override

double	getIntegral () const override

double	interpolate (double x) const override

const icarusutil::TimeVec &	getResponseVec () const override

const icarusutil::FrequencyVec &	getResponseFFTVec () const override

Private Member Functions
std::string	numberToString (int number)

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

Private Attributes
bool	fIsValid

size_t	fThisPlane

size_t	fResponseType

geo::SigType_t	fSignalType

std::string	fFieldResponseFileName

std::string	fFieldResponseFileVersion

std::string	fFieldResponseHistName

double	fFieldResponseAmplitude

double	fTimeCorrectionFactor

TH1D *	fFieldResponseHist

icarusutil::TimeVec	fFieldResponseVec

icarusutil::FrequencyVec	fFieldResponseFFTVec

double	fT0Offset

std::unique_ptr < icarus_signal_processing::ICARUSFFT < double > >	fFFT
	Object to handle thread safe FFT. More...

Detailed Description

Definition at line 27 of file FieldResponse_tool.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 88 of file FieldResponse_tool.cc.

                                                           :
     fIsValid(false), fSignalType(geo::kMysteryType), fFFT(nullptr)
 {
     configure(pset);
 }

icarus_tool::FieldResponse::~FieldResponse ( )

inline

Definition at line 32 of file FieldResponse_tool.cc.

32 {}

Member Function Documentation

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

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 94 of file FieldResponse_tool.cc.

 {
     // Start by recovering the parameters
     fThisPlane                = pset.get< size_t      >("Plane");
     fResponseType             = pset.get< size_t      >("ResponseType");
     fSignalType               = pset.get< size_t      >("SignalType") == 0 ? geo::kInduction : geo::kCollection;
     fFieldResponseFileName    = pset.get< std::string >("FieldResponseFileName");
     fFieldResponseFileVersion = pset.get< std::string >("FieldResponseFileVersion");
     fFieldResponseHistName    = pset.get< std::string >("FieldResponseHistName");
     fFieldResponseAmplitude   = pset.get< double      >("FieldResponseAmplitude");
     fTimeCorrectionFactor     = pset.get< double      >("TimeCorrectionFactor");
     
     // Recover the input field response histogram
 //    std::string fileName = fFieldResponseFileName + "_vw" + numberToString(fThisPlane) + "_" + fFieldResponseFileVersion + ".root";
     std::string fileName = fFieldResponseFileName + "_vw" + numberToString(fResponseType) + "_" + fFieldResponseFileVersion + ".root";
     
     std::string fullFileName;
     cet::search_path searchPath("FW_SEARCH_PATH");
 
     std::cout << "************************** Field Response Plane " << fThisPlane << " type: " << fResponseType << " *****************************" << std::endl;
     std::cout << "FileName: " << fullFileName << std::endl;
 
     if (!searchPath.find_file(fileName, fullFileName))
         throw cet::exception("FieldResponse::configure") << "Can't find input file: '" << fileName << "'\n";
     
     TFile inputFile(fullFileName.c_str(), "READ");
     
     if (!inputFile.IsOpen())
         throw cet::exception("FieldResponse::configure") << "Unable to open input file: " << fileName << std::endl;
     
 //    std::string histName = fFieldResponseHistName + "_vw" + numberToString(fThisPlane) + "_" + fFieldResponseFileVersion + ".root";
     std::string histName = fFieldResponseHistName + "_vw" + numberToString(fResponseType) + "_" + fFieldResponseFileVersion + ".root";
 
     std::cout << "HistFile: " << histName << std::endl;
     
     fFieldResponseHist = (TH1D*)((TH1D*)inputFile.Get(histName.c_str()))->Clone();
     
     fFieldResponseHist->SetDirectory(nullptr);
     
     inputFile.Close();
     
     // Calculation of the T0 offset depends on the signal type
     int binOfInterest = fFieldResponseHist->GetMinimumBin();
     
     // For collection planes it is as simple as finding the maximum bin
     if (fSignalType == geo::kCollection) binOfInterest = fFieldResponseHist->GetMaximumBin(); 
     
     // Do a backwards search to find the first positive bin
     while(1)
     {
         // Did we go too far?
         if (binOfInterest < 0)
         {
             std::cout << "Cannot find zero-point crossover for induction response! Plane:" << fThisPlane << ", signal type: " << fSignalType << ", response type: " << fResponseType << std::endl;
             throw cet::exception("FieldResponse::configure") << "Cannot find zero-point crossover for induction response! Plane:" << fThisPlane << ", signal type: " << fSignalType << ", response type: " << fResponseType << std::endl;
         }
             
         double content = fFieldResponseHist->GetBinContent(binOfInterest);
         
         if (content >= 0.) break;
         
         binOfInterest--;
     }
     
     fT0Offset = -(fFieldResponseHist->GetXaxis()->GetBinCenter(binOfInterest) - fFieldResponseHist->GetXaxis()->GetBinCenter(1)) * fTimeCorrectionFactor;
     
     fIsValid = true;
 
     // Hoops to jump throught to find "correct" size for FFT
     // Find the next power of 2 that is larger than the vector we have
     size_t newVecSize(64);
     
     while(getNumBins() > newVecSize) newVecSize *= 2;
 
     // Check that we have initialized our FFT object
     fFFT = std::make_unique<icarus_signal_processing::ICARUSFFT<double>>(newVecSize);
     
     double integral = getIntegral();
     
     std::cout << "--> Plane: " << fThisPlane << ", integral: " << integral << std::endl;
     
     return;
 }

double icarus_tool::FieldResponse::getBinCenter ( int bin ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 312 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->GetBinCenter(bin);
 }

double icarus_tool::FieldResponse::getBinContent ( int bin ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 320 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->GetBinContent(bin);
 }

double icarus_tool::FieldResponse::getBinWidth ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 338 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->GetBinWidth(1) * fTimeCorrectionFactor;
 }

double icarus_tool::FieldResponse::getHighEdge ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 328 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     size_t nBins = getNumBins();
     
     return fFieldResponseHist->GetBinCenter(nBins) + 0.5 * fFieldResponseHist->GetBinWidth(nBins);
 }

double icarus_tool::FieldResponse::getIntegral ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 354 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->Integral();
 }

double icarus_tool::FieldResponse::getLowEdge ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 304 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->GetBinCenter(1) - 0.5 * fFieldResponseHist->GetBinWidth(1);
 }

size_t icarus_tool::FieldResponse::getNumBins ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 296 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fFieldResponseHist->GetXaxis()->GetNbins();
 }

size_t icarus_tool::FieldResponse::getPlane ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 280 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fThisPlane;
 }

const icarusutil::FrequencyVec& icarus_tool::FieldResponse::getResponseFFTVec ( ) const

inlineoverridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 51 of file FieldResponse_tool.cc.

51 {return fFieldResponseFFTVec;}

icarus_tool::FieldResponse::fFieldResponseFFTVec

icarusutil::FrequencyVec fFieldResponseFFTVec

Definition: FieldResponse_tool.cc:77

size_t icarus_tool::FieldResponse::getResponseType ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 288 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getResponseType") << "Attempting to access response info when tool is invalid state" << std::endl;
     
     return fResponseType;
 }

const icarusutil::TimeVec& icarus_tool::FieldResponse::getResponseVec ( ) const

inlineoverridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 50 of file FieldResponse_tool.cc.

50 {return fFieldResponseVec;}

icarus_tool::FieldResponse::fFieldResponseVec

icarusutil::TimeVec fFieldResponseVec

Definition: FieldResponse_tool.cc:74

double icarus_tool::FieldResponse::getTOffset ( ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 346 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     return fT0Offset;
 }

double icarus_tool::FieldResponse::interpolate ( double x ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 362 of file FieldResponse_tool.cc.

 {
     if (!fIsValid)
         throw cet::exception("FieldResponse::getPlane") << "Attempting to access plane info when tool is invalid state" << std::endl;
     
     Double_t intVal = fFieldResponseHist->Interpolate(x);
     
     return intVal; //fFieldResponseHist->Interpolate(x);
 }

std::string icarus_tool::FieldResponse::numberToString ( int number )

private

Definition at line 372 of file FieldResponse_tool.cc.

 {
     std::ostringstream string;
     
     string << std::setfill('0') << std::setw(2) << number;
     
     return string.str();
 }

void icarus_tool::FieldResponse::outputHistograms ( art::TFileDirectory & histDir ) const

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 212 of file FieldResponse_tool.cc.

 {
     // It is assumed that the input TFileDirectory has been set up to group histograms into a common
     // folder at the calling routine's level. Here we create one more level of indirection to keep
     // histograms made by this tool separate.
     art::TFileDirectory dir = histDir.mkdir(fFieldResponseHistName.c_str());
     
     TProfile* hist = dir.make<TProfile>(fFieldResponseHistName.c_str(), "Field Response; Time(us)", getNumBins(), getLowEdge(), getHighEdge());
     
     double binWidth = getBinWidth() / fTimeCorrectionFactor;
     
     std::vector<double> histResponseVec(getNumBins());
     
     for(size_t idx = 0; idx < getNumBins(); idx++)
     {
         double xBin   = getLowEdge() + idx * binWidth;
         double binVal = fFieldResponseHist->GetBinContent(idx);
         
         hist->Fill(xBin, binVal, 1.);
         histResponseVec.at(idx) = binVal;
     }
 
     // Grab some useful tools
     icarus_signal_processing::WaveformTools<double> waveformTool;
 
     // Make a copy of the response vec
     std::vector<double> smoothedResponseVec;
     
     // Run the triangulation smoothing
     waveformTool.triangleSmooth(histResponseVec, smoothedResponseVec);
 
     // Now make histogram of this
     std::string histName = "Smooth_" + fFieldResponseHistName;
     
     TProfile* smoothHist = dir.make<TProfile>(histName.c_str(), "Field Response; Time(us)", getNumBins(), getLowEdge(), getHighEdge());
     
     for(size_t idx = 0; idx < smoothedResponseVec.size(); idx++)
     {
         double xBin = getLowEdge() + idx * binWidth;
         
         smoothHist->Fill(xBin,smoothedResponseVec.at(idx), 1.);
     }
     
     // Get the FFT of the response
     size_t halfFFTDataSize(fFieldResponseFFTVec.size()/2);
 
     std::vector<double> powerVec(halfFFTDataSize);
     
     std::transform(fFieldResponseFFTVec.begin(), fFieldResponseFFTVec.begin() + halfFFTDataSize, powerVec.begin(), [](const auto& val){return std::abs(val);});
     
     // Now we can plot this...
     double maxFreq   = 0.5 / binWidth;   // binWidth will be in us, maxFreq will be units of MHz
     double freqWidth = maxFreq / powerVec.size();
     
     histName = "FFT_" + fFieldResponseHistName;
     
     TProfile* fftHist = dir.make<TProfile>(histName.c_str(), "Field Response FFT; Frequency(MHz)", powerVec.size(), 0., maxFreq);
     
     for(size_t idx = 0; idx < powerVec.size(); idx++)
     {
         double bin = (idx + 0.5) * freqWidth;
         
         fftHist->Fill(bin, powerVec.at(idx), 1.);
     }
     
     return;
 }

void icarus_tool::FieldResponse::setResponse	(	double	weight,
		double	correction3D,
		double	timeScaleFctr
	)

overridevirtual

Implements icarus_tool::IFieldResponse.

Definition at line 178 of file FieldResponse_tool.cc.

 {
     // This sets the field response in the time domain
     double timeFactor    = correction3D * timeScaleFctr;
     size_t numBins       = getNumBins();
     size_t nResponseBins = numBins * timeFactor;
     
     fFieldResponseVec.resize(nResponseBins);
 
     double x0     = getBinCenter(1);
     double deltaX = fFieldResponseHist->GetBinWidth(1);  // This gets returned in us
     
     for(size_t bin = 1; bin <= nResponseBins; bin++)
     {
         double xVal = x0 + deltaX * (bin-1) / timeFactor;
         
         fFieldResponseVec[bin-1] = interpolate(xVal) * fFieldResponseAmplitude * weight;
     }
     
     // Find the next power of 2 that is larger than the vector we have
     size_t newVecSize(64);
     
     while(fFieldResponseVec.size() > newVecSize) newVecSize *= 2;
     
     // Resize and pad with zeroes
     fFieldResponseVec.resize(newVecSize,0.);
     
     fFieldResponseFFTVec.resize(newVecSize);
     
     fFFT->forwardFFT(fFieldResponseVec, fFieldResponseFFTVec);
     
     return;
 }

Member Data Documentation

std::unique_ptr<icarus_signal_processing::ICARUSFFT<double> > icarus_tool::FieldResponse::fFFT

private

Object to handle thread safe FFT.

Definition at line 83 of file FieldResponse_tool.cc.

double icarus_tool::FieldResponse::fFieldResponseAmplitude

private

Definition at line 67 of file FieldResponse_tool.cc.

icarusutil::FrequencyVec icarus_tool::FieldResponse::fFieldResponseFFTVec

private

Definition at line 77 of file FieldResponse_tool.cc.

std::string icarus_tool::FieldResponse::fFieldResponseFileName

private

Definition at line 64 of file FieldResponse_tool.cc.

std::string icarus_tool::FieldResponse::fFieldResponseFileVersion

private

Definition at line 65 of file FieldResponse_tool.cc.

TH1D* icarus_tool::FieldResponse::fFieldResponseHist

private

Definition at line 71 of file FieldResponse_tool.cc.

std::string icarus_tool::FieldResponse::fFieldResponseHistName

private

Definition at line 66 of file FieldResponse_tool.cc.

icarusutil::TimeVec icarus_tool::FieldResponse::fFieldResponseVec

private

Definition at line 74 of file FieldResponse_tool.cc.

bool icarus_tool::FieldResponse::fIsValid

private

Definition at line 58 of file FieldResponse_tool.cc.

size_t icarus_tool::FieldResponse::fResponseType

private

Definition at line 62 of file FieldResponse_tool.cc.

geo::SigType_t icarus_tool::FieldResponse::fSignalType

private

Definition at line 63 of file FieldResponse_tool.cc.

double icarus_tool::FieldResponse::fT0Offset

private

Definition at line 80 of file FieldResponse_tool.cc.

size_t icarus_tool::FieldResponse::fThisPlane

private

Definition at line 61 of file FieldResponse_tool.cc.

double icarus_tool::FieldResponse::fTimeCorrectionFactor

private

Definition at line 68 of file FieldResponse_tool.cc.

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

FieldResponse_tool.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation