lariov::SIOVPmtGainProvider Class Reference

Retrieves information: pmt gain. More...

#include "SIOVPmtGainProvider.h"

Inheritance diagram for lariov::SIOVPmtGainProvider:

Public Member Functions
	SIOVPmtGainProvider (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 PmtGain &	PmtGainObject (DBChannelID_t ch) const
	Retrieve gain information. More...
float	Gain (DBChannelID_t ch) const override
float	GainErr (DBChannelID_t ch) const override
CalibrationExtraInfo const &	ExtraInfo (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

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

Detailed Description

Retrieves information: pmt gain.

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

Definition at line 38 of file SIOVPmtGainProvider.h.

Constructor & Destructor Documentation

lariov::SIOVPmtGainProvider::SIOVPmtGainProvider

(

fhicl::ParameterSet const &

p

)

Constructors.

Definition at line 17 of file SIOVPmtGainProvider.cxx.

References Reconfigure().

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

Member Function Documentation

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

inlineinherited

Get Timestamp information.

Definition at line 59 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

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

{return fFolder->CachedStart();}

bool lariov::SIOVPmtGainProvider::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 115 of file SIOVPmtGainProvider.cxx.

References fEventTimeStamp.

Referenced by PmtGainObject(), and Update().

                                           {
    return DBUpdate(fEventTimeStamp);
  }

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

private

Definition at line 122 of file SIOVPmtGainProvider.cxx.

References lariov::DatabaseRetrievalAlg::Begin(), lariov::DatabaseRetrievalAlg::End(), fCurrentTimeStamp, fData, fDataSource, lariov::DatabaseRetrievalAlg::fFolder, and lariov::DatabaseRetrievalAlg::UpdateFolder().

                                                           {

    bool result = false;
    if (fDataSource == DataSource::Database && ts != fCurrentTimeStamp) {
      
      mf::LogInfo("SIOVPmtGainProvider") << "SIOVPmtGainProvider::DBUpdate called with new timestamp.";

      fCurrentTimeStamp = ts;     

      // Call non-const base class method.

      result = const_cast<SIOVPmtGainProvider*>(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;
          fFolder->GetNamedChannelData(*it, "gain",     gain);
          fFolder->GetNamedChannelData(*it, "gain_sigma", gain_err); 

          PmtGain pg(*it);
          pg.SetGain( (float)gain );
          pg.SetGainErr( (float)gain_err );
          pg.SetExtraInfo(CalibrationExtraInfo("PmtGain"));

          fData.AddOrReplaceRow(pg);
        }
      }
    }

    return result;
  }

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

inlineinherited

Definition at line 60 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

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

{return fFolder->CachedEnd();}

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

override

Definition at line 173 of file SIOVPmtGainProvider.cxx.

References PmtGainObject().

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

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

inlineinherited

Definition at line 55 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->FolderName();}

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

override

Definition at line 165 of file SIOVPmtGainProvider.cxx.

References PmtGainObject().

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

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

override

Definition at line 169 of file SIOVPmtGainProvider.cxx.

References PmtGainObject().

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

const PmtGain & lariov::SIOVPmtGainProvider::PmtGainObject

(

DBChannelID_t

ch

)

const

Retrieve gain information.

Definition at line 160 of file SIOVPmtGainProvider.cxx.

References DBUpdate(), and fData.

Referenced by ExtraInfo(), Gain(), and GainErr().

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

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

overridevirtual

Reconfigure function called by fhicl constructor.

Reimplemented from lariov::DatabaseRetrievalAlg.

Definition at line 25 of file SIOVPmtGainProvider.cxx.

References fData, fDataSource, file, fhicl::ParameterSet::get(), geo::GeometryCore::IsValidOpChannel(), geo::GeometryCore::NOpDets(), lariov::DatabaseRetrievalAlg::Reconfigure(), and tmp.

Referenced by SIOVPmtGainProvider().

                                                                  {
    
    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");

      PmtGain defaultGain(0);

      defaultGain.SetGain(default_gain);
      defaultGain.SetGainErr(default_gain_err);
      defaultGain.SetExtraInfo(CalibrationExtraInfo("PmtGain"));
      
      art::ServiceHandle<geo::Geometry> geo;
      for (unsigned int od=0; od!=geo->NOpDets(); ++od) {
        if (geo->IsValidOpChannel(od)) {
          defaultGain.SetChannel(od);
          fData.AddOrReplaceRow(defaultGain);
        }
      }
      
    }
    else if (fDataSource == DataSource::File) {
      cet::search_path sp("FW_SEARCH_PATH");
      std::string abs_fp = sp.find_file(fileName);
      std::cout << "Using pmt gains from local file: "<<abs_fp<<"\n";
      std::ifstream file(abs_fp);
      if (!file) {
        throw cet::exception("SIOVPmtGainProvider")
          << "File "<<abs_fp<<" is not found.";
      }

      std::string line;
      PmtGain dp(0);
      while (std::getline(file, line)) {
        if (line[0] == '#') continue;
        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) );

        CalibrationExtraInfo info("PmtGain");

        dp.SetChannel(ch);
        dp.SetGain(gain);
        dp.SetGainErr(gain_err);
        dp.SetExtraInfo(info);
        
        fData.AddOrReplaceRow(dp);
      }
    }
    else {
      std::cout << "Using pmt gains from conditions database"<<std::endl;
    }
  }

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

inlineinherited

Definition at line 56 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->Tag();}

bool lariov::SIOVPmtGainProvider::Update

(

DBTimeStamp_t

ts

)

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

Definition at line 107 of file SIOVPmtGainProvider.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 49 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

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

                                          {
        return fFolder->UpdateData(ts);
      }       

void lariov::SIOVPmtGainProvider::UpdateTimeStamp

(

DBTimeStamp_t

ts

)

Update event time stamp.

Definition at line 100 of file SIOVPmtGainProvider.cxx.

References fEventTimeStamp.

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

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

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

inlineinherited

Get connection information.

Definition at line 54 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->URL();}

Member Data Documentation

DBTimeStamp_t lariov::SIOVPmtGainProvider::fCurrentTimeStamp

mutableprivate

Definition at line 70 of file SIOVPmtGainProvider.h.

Referenced by DBUpdate().

Snapshot<PmtGain> lariov::SIOVPmtGainProvider::fData

mutableprivate

Definition at line 74 of file SIOVPmtGainProvider.h.

Referenced by DBUpdate(), PmtGainObject(), and Reconfigure().

DataSource::ds lariov::SIOVPmtGainProvider::fDataSource

private

Definition at line 72 of file SIOVPmtGainProvider.h.

Referenced by DBUpdate(), and Reconfigure().

DBTimeStamp_t lariov::SIOVPmtGainProvider::fEventTimeStamp

private

Definition at line 69 of file SIOVPmtGainProvider.h.

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

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

protectedinherited

Definition at line 65 of file DatabaseRetrievalAlg.h.

Referenced by lariov::DatabaseRetrievalAlg::Begin(), DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), lariov::DetPedestalRetrievalAlg::DBUpdate(), lariov::SIOVChannelStatusProvider::DBUpdate(), lariov::DatabaseRetrievalAlg::End(), lariov::DatabaseRetrievalAlg::FolderName(), lariov::DatabaseRetrievalAlg::Reconfigure(), lariov::DatabaseRetrievalAlg::Tag(), lariov::DatabaseRetrievalAlg::UpdateFolder(), and lariov::DatabaseRetrievalAlg::URL().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larevt/v07_02_01/source/larevt/CalibrationDBI/Providers/SIOVPmtGainProvider.h
• /cvmfs/larsoft.opensciencegrid.org/products/larevt/v07_02_01/source/larevt/CalibrationDBI/Providers/SIOVPmtGainProvider.cxx