Retrieves information: electronics calibrations, specifically gain and shaping time. More...

#include <SIOVElectronicsCalibProvider.h>

Inheritance diagram for lariov::SIOVElectronicsCalibProvider:

Public Member Functions
	SIOVElectronicsCalibProvider (fhicl::ParameterSet const &p)
	Constructors. More...

void	Reconfigure (fhicl::ParameterSet const &p) override
	Reconfigure function called by fhicl constructor. More...

void	UpdateTimeStamp (DBTimeStamp_t ts)
	Update event time stamp. More...

bool	Update (DBTimeStamp_t ts)
	Update Snapshot and inherited DBFolder if using database. Return true if updated. More...

const ElectronicsCalib &	ElectronicsCalibObject (DBChannelID_t ch) const
	Retrieve electronics calibration information. More...

float	Gain (DBChannelID_t ch) const override

float	GainErr (DBChannelID_t ch) const override

float	ShapingTime (DBChannelID_t ch) const override

float	ShapingTimeErr (DBChannelID_t ch) const override

CalibrationExtraInfo const &	ExtraInfo (DBChannelID_t ch) const override

Public Member Functions inherited from lariov::DatabaseRetrievalAlg
	DatabaseRetrievalAlg (const std::string &foldername, const std::string &url, const std::string &url2="", const std::string &tag="", bool usesqlite=false, bool testmode=false)
	Constructors. More...

	DatabaseRetrievalAlg (fhicl::ParameterSet const &p)

virtual	~DatabaseRetrievalAlg ()
	Default destructor. More...

bool	UpdateFolder (DBTimeStamp_t ts)
	Return true if fFolder is successfully updated. More...

const std::string &	URL () const
	Get connection information. More...

const std::string &	FolderName () const

const std::string &	Tag () const

const IOVTimeStamp &	Begin () const
	Get Timestamp information. More...

const IOVTimeStamp &	End () const

Public Member Functions inherited from lariov::ElectronicsCalibProvider
virtual	~ElectronicsCalibProvider ()=default

virtual float	Gain (raw::ChannelID_t ch) const =0
	Retrieve pmt gain information. More...

virtual float	GainErr (raw::ChannelID_t ch) const =0

virtual float	ShapingTime (raw::ChannelID_t ch) const =0

virtual float	ShapingTimeErr (raw::ChannelID_t ch) const =0

virtual CalibrationExtraInfo const &	ExtraInfo (raw::ChannelID_t ch) const =0

Private Member Functions
bool	DBUpdate () const
	Do actual database updates. More...

bool	DBUpdate (DBTimeStamp_t ts) const

Private Attributes
DBTimeStamp_t	fEventTimeStamp

DBTimeStamp_t	fCurrentTimeStamp

DataSource::ds	fDataSource

Snapshot< ElectronicsCalib >	fData

Additional Inherited Members
Protected Attributes inherited from lariov::DatabaseRetrievalAlg
std::unique_ptr< DBFolder >	fFolder

Detailed Description

Retrieves information: electronics calibrations, specifically gain and shaping time.

Configuration parameters

DatabaseRetrievalAlg (parameter set, mandatory): configuration for the database; see lariov::DatabaseRetrievalAlg
UseDB (boolean, default: false): retrieve information from the database
UseFile (boolean, default: false): retrieve information from a file; not implemented yet
DefaultGain (real, default: ): Gain returned when /UseDB/ and /UseFile/ parameters are false
DefaultGainErr (real, default: ): Gain uncertainty returned when /UseDB/ and /UseFile/ parameters are false
DefaultShapingTime (real, default: ): Shaping Time returned when /UseDB/ and /UseFile/ parameters are false
DefaultShapingTimeErr (real, default: ): Shaping Time uncertainty returned when /UseDB/ and /UseFile/ parameters are false

Definition at line 42 of file SIOVElectronicsCalibProvider.h.

Constructor & Destructor Documentation

lariov::SIOVElectronicsCalibProvider::SIOVElectronicsCalibProvider ( fhicl::ParameterSet const & p )

Constructors.

Definition at line 14 of file SIOVElectronicsCalibProvider.cxx.

                                                                                        :
     DatabaseRetrievalAlg(p.get<fhicl::ParameterSet>("DatabaseRetrievalAlg")),
     fEventTimeStamp(0),
     fCurrentTimeStamp(0) {
 
     this->Reconfigure(p);
   }

Member Function Documentation

bool lariov::SIOVElectronicsCalibProvider::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 123 of file SIOVElectronicsCalibProvider.cxx.

                                                     {
     return DBUpdate(fEventTimeStamp);
   }

bool lariov::SIOVElectronicsCalibProvider::DBUpdate ( DBTimeStamp_t ts ) const

private

Definition at line 130 of file SIOVElectronicsCalibProvider.cxx.

                                                                     {
 
     bool result = false;
     if (fDataSource == DataSource::Database && ts != fCurrentTimeStamp) {
 
       mf::LogInfo("SIOVElectronicsCalibProvider") << "SIOVElectronicsCalibProvider::DBUpdate called with new timestamp.";
 
       fCurrentTimeStamp = ts;
 
       // Call non-const base class method.
 
       result = const_cast<SIOVElectronicsCalibProvider*>(this)->UpdateFolder(ts);
       if(result) {
         //DBFolder was updated, so now update the Snapshot
         fData.Clear();
         fData.SetIoV(this->Begin(), this->End());
 
         std::vector<DBChannelID_t> channels;
         fFolder->GetChannelList(channels);
         for (auto it = channels.begin(); it != channels.end(); ++it) {
 
           double gain, gain_err, shaping_time, shaping_time_err;
           fFolder->GetNamedChannelData(*it, "gain",     gain);
           fFolder->GetNamedChannelData(*it, "gain_err", gain_err);
           fFolder->GetNamedChannelData(*it, "shaping_time",     shaping_time);
           fFolder->GetNamedChannelData(*it, "shaping_time_err", shaping_time_err);
 
 
           ElectronicsCalib pg(*it);
           pg.SetGain( (float)gain );
           pg.SetGainErr( (float)gain_err );
           pg.SetShapingTime( (float)shaping_time );
           pg.SetShapingTimeErr( (float)shaping_time_err );
           pg.SetExtraInfo(CalibrationExtraInfo("ElectronicsCalib"));
 
           fData.AddOrReplaceRow(pg);
         }
       }
     }
 
     return result;
   }

const ElectronicsCalib & lariov::SIOVElectronicsCalibProvider::ElectronicsCalibObject ( DBChannelID_t ch ) const

Retrieve electronics calibration information.

Definition at line 173 of file SIOVElectronicsCalibProvider.cxx.

                                                                                                      {
     DBUpdate();
     return fData.GetRow(ch);
   }

CalibrationExtraInfo const & lariov::SIOVElectronicsCalibProvider::ExtraInfo ( DBChannelID_t ch ) const

override

Definition at line 194 of file SIOVElectronicsCalibProvider.cxx.

                                                                                             {
     return this->ElectronicsCalibObject(ch).ExtraInfo();
   }

float lariov::SIOVElectronicsCalibProvider::Gain ( DBChannelID_t ch ) const

override

Definition at line 178 of file SIOVElectronicsCalibProvider.cxx.

                                                                  {
     return this->ElectronicsCalibObject(ch).Gain();
   }

float lariov::SIOVElectronicsCalibProvider::GainErr ( DBChannelID_t ch ) const

override

Definition at line 182 of file SIOVElectronicsCalibProvider.cxx.

                                                                     {
     return this->ElectronicsCalibObject(ch).GainErr();
   }

void lariov::SIOVElectronicsCalibProvider::Reconfigure ( fhicl::ParameterSet const & p )

overridevirtual

Reconfigure function called by fhicl constructor.

Reimplemented from lariov::DatabaseRetrievalAlg.

Definition at line 22 of file SIOVElectronicsCalibProvider.cxx.

                                                                            {
 
     this->DatabaseRetrievalAlg::Reconfigure(p.get<fhicl::ParameterSet>("DatabaseRetrievalAlg"));
     fData.Clear();
     IOVTimeStamp tmp = IOVTimeStamp::MaxTimeStamp();
     tmp.SetStamp(tmp.Stamp()-1, tmp.SubStamp());
     fData.SetIoV(tmp, IOVTimeStamp::MaxTimeStamp());
 
     bool UseDB      = p.get<bool>("UseDB", false);
     bool UseFile    = p.get<bool>("UseFile", false);
     std::string fileName = p.get<std::string>("FileName", "");
 
     //priority:  (1) use db, (2) use table, (3) use defaults
     //If none are specified, use defaults
     if ( UseDB )      fDataSource = DataSource::Database;
     else if (UseFile) fDataSource = DataSource::File;
     else              fDataSource = DataSource::Default;
 
     if (fDataSource == DataSource::Default) {
       float default_gain     = p.get<float>("DefaultGain");
       float default_gain_err = p.get<float>("DefaultGainErr");
       float default_st       = p.get<float>("DefaultShapingTime");
       float default_st_err   = p.get<float>("DefaultShapingTimeErr");
 
       ElectronicsCalib defaultCalib(0);
 
       defaultCalib.SetGain(default_gain);
       defaultCalib.SetGainErr(default_gain_err);
       defaultCalib.SetShapingTime(default_st);
       defaultCalib.SetShapingTimeErr(default_st_err);
       defaultCalib.SetExtraInfo(CalibrationExtraInfo("ElectronicsCalib"));
 
       art::ServiceHandle<geo::Geometry const> geo;
       geo::wire_id_iterator itW = geo->begin_wire_id();
       for (; itW != geo->end_wire_id(); ++itW) {
         DBChannelID_t ch = geo->PlaneWireToChannel(*itW);
         defaultCalib.SetChannel(ch);
         fData.AddOrReplaceRow(defaultCalib);
       }
 
     }
     else if (fDataSource == DataSource::File) {
       cet::search_path sp("FW_SEARCH_PATH");
       std::string abs_fp = sp.find_file(fileName);
       std::cout << "Using electronics calibrations from local file: "<<abs_fp<<"\n";
       std::ifstream file(abs_fp);
       if (!file) {
         throw cet::exception("SIOVElectronicsCalibProvider")
           << "File "<<abs_fp<<" is not found.";
       }
 
       std::string line;
       ElectronicsCalib dp(0);
       while (std::getline(file, line)) {
         size_t current_comma = line.find(',');
         DBChannelID_t ch = (DBChannelID_t)std::stoi(line.substr(0, current_comma));
         float gain             = std::stof( line.substr(current_comma+1, line.find(',',current_comma+1)-(current_comma+1)) );
 
         current_comma = line.find(',',current_comma+1);
         float gain_err         = std::stof( line.substr(current_comma+1, line.find(',',current_comma+1)-(current_comma+1)) );
 
         current_comma = line.find(',',current_comma+1);
         float shaping_time     = std::stof( line.substr(current_comma+1, line.find(',',current_comma+1)-(current_comma+1)) );
 
         current_comma = line.find(',',current_comma+1);
         float shaping_time_err = std::stof( line.substr(current_comma+1) );
 
         CalibrationExtraInfo info("ElectronicsCalib");
 
         dp.SetChannel(ch);
         dp.SetGain(gain);
         dp.SetGainErr(gain_err);
         dp.SetShapingTime(shaping_time);
         dp.SetShapingTimeErr(shaping_time_err);
         dp.SetExtraInfo(info);
 
         fData.AddOrReplaceRow(dp);
       }
     }
     else {
       std::cout << "Using electronics calibrations from conditions database"<<std::endl;
     }
   }

float lariov::SIOVElectronicsCalibProvider::ShapingTime ( DBChannelID_t ch ) const

override

Definition at line 186 of file SIOVElectronicsCalibProvider.cxx.

                                                                         {
     return this->ElectronicsCalibObject(ch).ShapingTime();
   }

float lariov::SIOVElectronicsCalibProvider::ShapingTimeErr ( DBChannelID_t ch ) const

override

Definition at line 190 of file SIOVElectronicsCalibProvider.cxx.

                                                                            {
     return this->ElectronicsCalibObject(ch).ShapingTimeErr();
   }

bool lariov::SIOVElectronicsCalibProvider::Update ( DBTimeStamp_t ts )

Update Snapshot and inherited DBFolder if using database. Return true if updated.

Definition at line 115 of file SIOVElectronicsCalibProvider.cxx.

                                                             {
 
     fEventTimeStamp = ts;
     return DBUpdate(ts);
   }

void lariov::SIOVElectronicsCalibProvider::UpdateTimeStamp ( DBTimeStamp_t ts )

Update event time stamp.

Definition at line 108 of file SIOVElectronicsCalibProvider.cxx.

                                                                      {
     mf::LogInfo("SIOVElectronicsCalibProvider") << "SIOVElectronicsCalibProvider::UpdateTimeStamp called.";
     fEventTimeStamp = ts;
   }