DetPedestalRetrievalAlg.h

Go to the documentation of this file.

/**
 * \file DetPedestalRetrievalAlg.h
 *
 * \ingroup WebDBI
 *
 * \brief Class def header for a class DetPedestalRetrievalAlg
 *
 * @author eberly@slac.stanford.edu
 */

/** \addtogroup WebDBI

    @{*/
#ifndef WEBDBI_DETPEDESTALRETRIEVALALG_H
#define WEBDBI_DETPEDESTALRETRIEVALALG_H

// C/C++ standard libraries
#include <string>

// LArSoft libraries
#include "larevt/CalibrationDBI/IOVData/DetPedestal.h"
#include "larevt/CalibrationDBI/IOVData/Snapshot.h"
#include "larevt/CalibrationDBI/IOVData/IOVDataConstants.h"
#include "larevt/CalibrationDBI/Interface/CalibrationDBIFwd.h"
#include "larevt/CalibrationDBI/Interface/DetPedestalProvider.h"
#include "larevt/CalibrationDBI/Providers/DatabaseRetrievalAlg.h"

namespace fhicl { class ParameterSet; }

namespace lariov {

  /**
   * @brief 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
   */
  class DetPedestalRetrievalAlg : public DatabaseRetrievalAlg, public DetPedestalProvider {

    public:

      /// Constructors
      DetPedestalRetrievalAlg(const std::string& foldername,
                              const std::string& url,
                              const std::string& tag="");

      DetPedestalRetrievalAlg(fhicl::ParameterSet const& p);

      /// Reconfigure function called by fhicl constructor
      void Reconfigure(fhicl::ParameterSet const& p) override;

      /// Update event time stamp.
      void UpdateTimeStamp(DBTimeStamp_t ts);

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

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

      //hardcoded information about database folder - useful for debugging cross checks
      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:

      /// Do actual database updates.

      bool DBUpdate() const;                    // Uses current event time.
      bool DBUpdate(DBTimeStamp_t ts) const;

      // Time stamps.

      DBTimeStamp_t fEventTimeStamp;            // Most recently seen time stamp.
      mutable DBTimeStamp_t fCurrentTimeStamp;  // Time stamp of cached data.

      DataSource::ds fDataSource;
      mutable Snapshot<DetPedestal> fData;
  };
}//end namespace lariov

#endif
 /** @} */ // end of doxygen group