Retrieves channel information: pedestal and RMS. More...

#include "DetPedestalRetrievalAlg.h"

Inheritance diagram for lariov::DetPedestalRetrievalAlg:

Public Member Functions
	DetPedestalRetrievalAlg (const std::string &foldername, const std::string &url, const std::string &tag="")
	Constructors. More...

	DetPedestalRetrievalAlg (fhicl::ParameterSet const &p)

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 DetPedestal &	Pedestal (DBChannelID_t ch) const
	Retrieve pedestal information. More...

float	PedMean (DBChannelID_t ch) const override

float	PedRms (DBChannelID_t ch) const override

float	PedMeanErr (DBChannelID_t ch) const override

float	PedRmsErr (DBChannelID_t ch) const override

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

Static Public Attributes
static constexpr unsigned int	NCOLUMNS = 5

static constexpr const char *	FIELD_NAMES [NCOLUMNS]

static constexpr const char *	FIELD_TYPES [NCOLUMNS]

Protected Attributes
std::unique_ptr< DBFolder >	fFolder

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< DetPedestal >	fData

Detailed Description

Retrieves channel information: pedestal and RMS.

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
DefaultCollMean (real, default: 400.0): pedestal value returned for collection plane channels when /UseDB/ and /UseFile/ parameters are false
DefaultIndMean (real, default: 2048.0): pedestal value returned for induction plane channels when /UseDB/ and /UseFile/ parameters are false
DefaultCollRms (real, default: 0.3): pedestal RMS value returned for collection plane channels when /UseDB/ and /UseFile/ parameters are false
DefaultIndRms (real, default: 0.3): pedestal RMS value returned for induction plane channels when /UseDB/ and /UseFile/ parameters are false
DefaultMeanErr (real, default: 0.0): error on the pedestal value for all channels returned when /UseDB/ and /UseFile/ parameters are false
DefaultRmsErr (real, default: 0.0): error on the RMS value for all channels returned when /UseDB/ and /UseFile/ parameters are false

Definition at line 58 of file DetPedestalRetrievalAlg.h.

Constructor & Destructor Documentation

lariov::DetPedestalRetrievalAlg::DetPedestalRetrievalAlg	(	const std::string &	foldername,
		const std::string &	url,
		const std::string &	tag = `""`
	)

Constructors.

Definition at line 22 of file DetPedestalRetrievalAlg.cxx.

References fData, lariov::IOVTimeStamp::MaxTimeStamp(), lariov::IOVTimeStamp::SetStamp(), lariov::IOVTimeStamp::Stamp(), lariov::IOVTimeStamp::SubStamp(), and tmp.

     : DatabaseRetrievalAlg(foldername, url, tag)
     , fEventTimeStamp(0)
     , fCurrentTimeStamp(0)
     , fDataSource(DataSource::Database)
   {
     fData.Clear();
     IOVTimeStamp tmp = IOVTimeStamp::MaxTimeStamp();
     tmp.SetStamp(tmp.Stamp() - 1, tmp.SubStamp());
     fData.SetIoV(tmp, IOVTimeStamp::MaxTimeStamp());
   }

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

Definition at line 36 of file DetPedestalRetrievalAlg.cxx.

References Reconfigure().

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

Member Function Documentation

const IOVTimeStamp& lariov::DatabaseRetrievalAlg::Begin ( ) const

inlineinherited

Get Timestamp information.

Definition at line 63 of file DatabaseRetrievalAlg.h.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), DBUpdate(), and lariov::SIOVChannelStatusProvider::DBUpdate().

63 { return fFolder->CachedStart(); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

bool lariov::DetPedestalRetrievalAlg::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 160 of file DetPedestalRetrievalAlg.cxx.

References fEventTimeStamp.

Referenced by Pedestal(), and Update().

   {
     return DBUpdate(fEventTimeStamp);
   }

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

private

Definition at line 168 of file DetPedestalRetrievalAlg.cxx.

References lariov::DatabaseRetrievalAlg::Begin(), lariov::DataSource::Database, lariov::DatabaseRetrievalAlg::End(), fCurrentTimeStamp, fData, fDataSource, lariov::DatabaseRetrievalAlg::fFolder, pmtana::mean(), lariov::DetPedestal::SetPedMean(), lariov::DetPedestal::SetPedMeanErr(), lariov::DetPedestal::SetPedRms(), lariov::DetPedestal::SetPedRmsErr(), and lariov::DatabaseRetrievalAlg::UpdateFolder().

   {
     // A static mutex that is shared across all invocations of the function.
     static std::mutex mutex;
     std::lock_guard<std::mutex> lock(mutex);
 
     bool result = false;
     if (fDataSource == DataSource::Database && ts != fCurrentTimeStamp) {
 
       mf::LogInfo("DetPedestalRetrievalAlg")
         << "DetPedestalRetrievalAlg::DBUpdate called with new timestamp.";
       fCurrentTimeStamp = ts;
 
       // Call non-const base class method.
 
       result = const_cast<DetPedestalRetrievalAlg*>(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 mean, mean_err, rms, rms_err;
           fFolder->GetNamedChannelData(*it, "mean", mean);
           fFolder->GetNamedChannelData(*it, "mean_err", mean_err);
           fFolder->GetNamedChannelData(*it, "rms", rms);
           fFolder->GetNamedChannelData(*it, "rms_err", rms_err);
 
           DetPedestal pd(*it);
           pd.SetPedMean((float)mean);
           pd.SetPedMeanErr((float)mean_err);
           pd.SetPedRms((float)rms);
           pd.SetPedRmsErr((float)rms_err);
 
           fData.AddOrReplaceRow(pd);
         }
       }
     }
 
     return result;
   }

const IOVTimeStamp& lariov::DatabaseRetrievalAlg::End ( ) const

inlineinherited

Definition at line 64 of file DatabaseRetrievalAlg.h.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), DBUpdate(), and lariov::SIOVChannelStatusProvider::DBUpdate().

64 { return fFolder->CachedEnd(); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

const std::string& lariov::DatabaseRetrievalAlg::FolderName ( ) const

inlineinherited

Definition at line 59 of file DatabaseRetrievalAlg.h.

59 { return fFolder->FolderName(); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

const DetPedestal & lariov::DetPedestalRetrievalAlg::Pedestal ( DBChannelID_t ch ) const

Retrieve pedestal information.

Definition at line 214 of file DetPedestalRetrievalAlg.cxx.

References DBUpdate(), and fData.

Referenced by PedMean(), PedMeanErr(), PedRms(), and PedRmsErr().

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

float lariov::DetPedestalRetrievalAlg::PedMean ( DBChannelID_t ch ) const

override

Definition at line 220 of file DetPedestalRetrievalAlg.cxx.

References Pedestal(), and lariov::DetPedestal::PedMean().

   {
     return this->Pedestal(ch).PedMean();
   }

float lariov::DetPedestalRetrievalAlg::PedMeanErr ( DBChannelID_t ch ) const

override

Definition at line 230 of file DetPedestalRetrievalAlg.cxx.

References Pedestal(), and lariov::DetPedestal::PedMeanErr().

   {
     return this->Pedestal(ch).PedMeanErr();
   }

float lariov::DetPedestalRetrievalAlg::PedRms ( DBChannelID_t ch ) const

override

Definition at line 225 of file DetPedestalRetrievalAlg.cxx.

References Pedestal(), and lariov::DetPedestal::PedRms().

   {
     return this->Pedestal(ch).PedRms();
   }

float lariov::DetPedestalRetrievalAlg::PedRmsErr ( DBChannelID_t ch ) const

override

Definition at line 235 of file DetPedestalRetrievalAlg.cxx.

References Pedestal(), and lariov::DetPedestal::PedRmsErr().

   {
     return this->Pedestal(ch).PedRmsErr();
   }

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

overridevirtual

Reconfigure function called by fhicl constructor.

Reimplemented from lariov::DatabaseRetrievalAlg.

Definition at line 42 of file DetPedestalRetrievalAlg.cxx.

References lariov::DataSource::Database, lariov::DataSource::Default, fData, fDataSource, file, lariov::DataSource::File, Get, fhicl::ParameterSet::get(), geo::kCollection, geo::kInduction, lariov::IOVTimeStamp::MaxTimeStamp(), lariov::DatabaseRetrievalAlg::Reconfigure(), lariov::ChData::SetChannel(), lariov::DetPedestal::SetPedMean(), lariov::DetPedestal::SetPedMeanErr(), lariov::DetPedestal::SetPedRms(), lariov::DetPedestal::SetPedRmsErr(), lariov::IOVTimeStamp::SetStamp(), lariov::IOVTimeStamp::Stamp(), lariov::IOVTimeStamp::SubStamp(), and tmp.

Referenced by DetPedestalRetrievalAlg().

   {
     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) {
       std::cout << "Using default pedestal values\n";
       float default_collmean = p.get<float>("DefaultCollMean", 400.0);
       float default_collrms = p.get<float>("DefaultCollRms", 0.3);
       float default_mean_err = p.get<float>("DefaultMeanErr", 0.0);
       float default_rms_err = p.get<float>("DefaultRmsErr", 0.0);
       float default_indmean = p.get<float>("DefaultIndMean", 2048.0);
       float default_indrms = p.get<float>("DefaultIndRms", 0.3);
 
       DetPedestal DefaultColl(0);
       DetPedestal DefaultInd(0);
 
       DefaultColl.SetPedMean(default_collmean);
       DefaultColl.SetPedMeanErr(default_mean_err);
       DefaultColl.SetPedRms(default_collrms);
       DefaultColl.SetPedRmsErr(default_rms_err);
 
       DefaultInd.SetPedMean(default_indmean);
       DefaultInd.SetPedMeanErr(default_mean_err);
       DefaultInd.SetPedRms(default_indrms);
       DefaultInd.SetPedRmsErr(default_rms_err);
 
       auto const& wireReadoutGeom = art::ServiceHandle<geo::WireReadout>()->Get();
       for (auto const& wid : wireReadoutGeom.Iterate<geo::WireID>()) {
         DBChannelID_t ch = wireReadoutGeom.PlaneWireToChannel(wid);
 
         if (wireReadoutGeom.SignalType(ch) == geo::kCollection) {
           DefaultColl.SetChannel(ch);
           fData.AddOrReplaceRow(DefaultColl);
         }
         else if (wireReadoutGeom.SignalType(ch) == geo::kInduction) {
           DefaultInd.SetChannel(ch);
           fData.AddOrReplaceRow(DefaultInd);
         }
         else
           throw IOVDataError("Wire type is not collection or induction!");
       }
     }
     else if (fDataSource == DataSource::File) {
       cet::search_path sp("FW_SEARCH_PATH");
       std::string abs_fp = sp.find_file(fileName);
       std::cout << "Using pedestals from local file: " << abs_fp << "\n";
       std::ifstream file(abs_fp);
       if (!file) {
         throw cet::exception("DetPedestalRetrievalAlg") << "File " << abs_fp << " is not found.";
       }
 
       std::string line;
       DetPedestal 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 ped = std::stof(
           line.substr(current_comma + 1, line.find(',', current_comma + 1) - (current_comma + 1)));
 
         current_comma = line.find(',', current_comma + 1);
         float rms = std::stof(
           line.substr(current_comma + 1, line.find(',', current_comma + 1) - (current_comma + 1)));
 
         current_comma = line.find(',', current_comma + 1);
         float ped_err = std::stof(
           line.substr(current_comma + 1, line.find(',', current_comma + 1) - (current_comma + 1)));
 
         current_comma = line.find(',', current_comma + 1);
         float rms_err = std::stof(line.substr(current_comma + 1));
 
         dp.SetChannel(ch);
         dp.SetPedMean(ped);
         dp.SetPedMeanErr(ped_err);
         dp.SetPedRms(rms);
         dp.SetPedRmsErr(rms_err);
         fData.AddOrReplaceRow(dp);
       }
     } // if source from file
     else {
       std::cout << "Using pedestals from conditions database\n";
     }
   }

const std::string& lariov::DatabaseRetrievalAlg::Tag ( ) const

inlineinherited

Definition at line 60 of file DatabaseRetrievalAlg.h.

60 { return fFolder->Tag(); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

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

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

Definition at line 152 of file DetPedestalRetrievalAlg.cxx.

References DBUpdate(), and fEventTimeStamp.

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

bool lariov::DatabaseRetrievalAlg::UpdateFolder ( DBTimeStamp_t ts )

inlineinherited

Return true if fFolder is successfully updated.

Definition at line 55 of file DatabaseRetrievalAlg.h.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), DBUpdate(), and lariov::SIOVChannelStatusProvider::DBUpdate().

55 { return fFolder->UpdateData(ts); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

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

Update event time stamp.

Definition at line 144 of file DetPedestalRetrievalAlg.cxx.

References fEventTimeStamp.

Referenced by lariov::SIOVDetPedestalService::PreProcessEvent().

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

const std::string& lariov::DatabaseRetrievalAlg::URL ( ) const

inlineinherited

Get connection information.

Definition at line 58 of file DatabaseRetrievalAlg.h.

58 { return fFolder->URL(); }

lariov::DatabaseRetrievalAlg::fFolder

std::unique_ptr< DBFolder > fFolder

Definition: DatabaseRetrievalAlg.h:67

Member Data Documentation

DBTimeStamp_t lariov::DetPedestalRetrievalAlg::fCurrentTimeStamp

mutableprivate

Definition at line 106 of file DetPedestalRetrievalAlg.h.

Referenced by DBUpdate().

Snapshot<DetPedestal> lariov::DetPedestalRetrievalAlg::fData

mutableprivate

Definition at line 109 of file DetPedestalRetrievalAlg.h.

Referenced by DBUpdate(), DetPedestalRetrievalAlg(), Pedestal(), and Reconfigure().

DataSource::ds lariov::DetPedestalRetrievalAlg::fDataSource

private

Definition at line 108 of file DetPedestalRetrievalAlg.h.

Referenced by DBUpdate(), and Reconfigure().

DBTimeStamp_t lariov::DetPedestalRetrievalAlg::fEventTimeStamp

private

Definition at line 105 of file DetPedestalRetrievalAlg.h.

Referenced by DBUpdate(), Update(), and UpdateTimeStamp().

std::unique_ptr<DBFolder> lariov::DatabaseRetrievalAlg::fFolder

protectedinherited

Definition at line 67 of file DatabaseRetrievalAlg.h.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), DBUpdate(), lariov::SIOVChannelStatusProvider::DBUpdate(), and lariov::DatabaseRetrievalAlg::Reconfigure().

constexpr const char* lariov::DetPedestalRetrievalAlg::FIELD_NAMES[NCOLUMNS]

static

Initial value:

= {"channel",
                                                          "mean",
                                                          "mean_err",
                                                          "rms",
                                                          "rms_err"}

Definition at line 86 of file DetPedestalRetrievalAlg.h.

constexpr const char* lariov::DetPedestalRetrievalAlg::FIELD_TYPES[NCOLUMNS]

static

Initial value:

= {"unsigned int",
                                                          "float",
                                                          "float",
                                                          "float",
                                                          "float"}

Definition at line 91 of file DetPedestalRetrievalAlg.h.

constexpr unsigned int lariov::DetPedestalRetrievalAlg::NCOLUMNS = 5

static

Definition at line 85 of file DetPedestalRetrievalAlg.h.

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

larevt/v10_00_06/source/larevt/CalibrationDBI/Providers/DetPedestalRetrievalAlg.h
larevt/v10_00_06/source/larevt/CalibrationDBI/Providers/DetPedestalRetrievalAlg.cxx

Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Configuration parameters

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation