lariov::DetPedestalRetrievalAlg Class Reference

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
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::DetPedestalProvider
virtual	~DetPedestalProvider ()=default
virtual float	PedMean (raw::ChannelID_t ch) const =0
	Retrieve pedestal information. More...
virtual float	PedRms (raw::ChannelID_t ch) const =0
virtual float	PedMeanErr (raw::ChannelID_t ch) const =0
virtual float	PedRmsErr (raw::ChannelID_t ch) const =0

Static Public Attributes
static constexpr unsigned int	NCOLUMNS = 5
static constexpr const char *	FIELD_NAMES [NCOLUMNS] = {"channel", "mean", "mean_err", "rms", "rms_err"}
static constexpr const char *	FIELD_TYPES [NCOLUMNS] = {"unsigned int", "float", "float", "float", "float"}

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

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

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 56 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.

                                                                           :
    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 37 of file DetPedestalRetrievalAlg.cxx.

                                                                             :
    DatabaseRetrievalAlg(p.get<fhicl::ParameterSet>("DatabaseRetrievalAlg")) {

    this->Reconfigure(p);
  }

Member Function Documentation

bool lariov::DetPedestalRetrievalAlg::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 156 of file DetPedestalRetrievalAlg.cxx.

                                               {
    return DBUpdate(fEventTimeStamp);
  }

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

private

Definition at line 163 of file DetPedestalRetrievalAlg.cxx.

                                                               {

    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 DetPedestal & lariov::DetPedestalRetrievalAlg::Pedestal

(

DBChannelID_t

ch

)

const

Retrieve pedestal information.

Definition at line 205 of file DetPedestalRetrievalAlg.cxx.

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

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

override

Definition at line 210 of file DetPedestalRetrievalAlg.cxx.

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

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

override

Definition at line 218 of file DetPedestalRetrievalAlg.cxx.

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

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

override

Definition at line 214 of file DetPedestalRetrievalAlg.cxx.

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

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

override

Definition at line 222 of file DetPedestalRetrievalAlg.cxx.

                                                                 {
    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 43 of file DetPedestalRetrievalAlg.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) {
      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);

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

        if (geo->SignalType(ch) == geo::kCollection) {
          DefaultColl.SetChannel(ch);
          fData.AddOrReplaceRow(DefaultColl);
        }
        else if (geo->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";
    }
  }

bool lariov::DetPedestalRetrievalAlg::Update

(

DBTimeStamp_t

ts

)

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

Definition at line 148 of file DetPedestalRetrievalAlg.cxx.

                                                       {

    fEventTimeStamp = ts;
    return DBUpdate(ts);
  }

void lariov::DetPedestalRetrievalAlg::UpdateTimeStamp

(

DBTimeStamp_t

ts

)

Update event time stamp.

Definition at line 141 of file DetPedestalRetrievalAlg.cxx.

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

Member Data Documentation

DBTimeStamp_t lariov::DetPedestalRetrievalAlg::fCurrentTimeStamp

mutableprivate

Definition at line 100 of file DetPedestalRetrievalAlg.h.

Snapshot<DetPedestal> lariov::DetPedestalRetrievalAlg::fData

mutableprivate

Definition at line 103 of file DetPedestalRetrievalAlg.h.

DataSource::ds lariov::DetPedestalRetrievalAlg::fDataSource

private

Definition at line 102 of file DetPedestalRetrievalAlg.h.

DBTimeStamp_t lariov::DetPedestalRetrievalAlg::fEventTimeStamp

private

Definition at line 99 of file DetPedestalRetrievalAlg.h.

constexpr const char* lariov::DetPedestalRetrievalAlg::FIELD_NAMES[NCOLUMNS] = {"channel", "mean", "mean_err", "rms", "rms_err"}

static

Definition at line 86 of file DetPedestalRetrievalAlg.h.

constexpr const char* lariov::DetPedestalRetrievalAlg::FIELD_TYPES[NCOLUMNS] = {"unsigned int", "float", "float", "float", "float"}

static

Definition at line 88 of file DetPedestalRetrievalAlg.h.

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

static

Definition at line 84 of file DetPedestalRetrievalAlg.h.

---

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

• DetPedestalRetrievalAlg.h
• DetPedestalRetrievalAlg.cxx