detinfo::DetectorPropertiesServiceStandard Class Reference

"Standard" implementation of DetectorProperties service More...

#include "DetectorPropertiesServiceStandard.h"

Inheritance diagram for detinfo::DetectorPropertiesServiceStandard:

Classes
struct	ServiceConfiguration_t

Public Types
using	Parameters = art::ServiceTable< ServiceConfiguration_t >
typedef detinfo::DetectorProperties	provider_type

Public Member Functions
	DetectorPropertiesServiceStandard (fhicl::ParameterSet const &pset, art::ActivityRegistry &reg)
virtual void	reconfigure (fhicl::ParameterSet const &pset) override
void	preProcessEvent (const art::Event &evt)
void	postOpenFile (const std::string &filename)
virtual const provider_type *	provider () const override

Private Member Functions
bool	isDetectorPropertiesServiceStandard (const fhicl::ParameterSet &ps) const

Private Attributes
std::unique_ptr< detinfo::DetectorPropertiesStandard >	fProp
fhicl::ParameterSet	fPS
	Original parameter set. More...
bool	fInheritNumberTimeSamples
	Flag saying whether to inherit NumberTimeSamples. More...

Detailed Description

"Standard" implementation of DetectorProperties service

This class wraps DetectorPropertiesStandard provider into a art service. It delivers the provider via the standard interface:

detinfo::DetectorProperties const* detprop
  = art::ServiceHandle<detinfo::DetectorPropertiesStandard>()
  ->provider();

or, using the standard interface in "CoreUtils/ServiceUtil.h":

auto const* detprop
  = lar::providerFrom<detinfo::DetectorPropertiesStandard>();

In addition to the functionality of the provider, this service allows to read the configuration from the input file, inherited from a previous run.

Configuration parameters

This service passes the whole configuration down to its service provider, but it also reacts to:

• InheritNumberTimeSamples (boolean; default: false): if true, the configuration database in the ROOT input file is queried and if a configuration for this service is found, it's used instead of the one from the current FHiCL configuration

Definition at line 55 of file DetectorPropertiesServiceStandard.h.

Member Typedef Documentation

using detinfo::DetectorPropertiesServiceStandard::Parameters = art::ServiceTable<ServiceConfiguration_t>

Definition at line 77 of file DetectorPropertiesServiceStandard.h.

typedef detinfo::DetectorProperties detinfo::DetectorPropertiesService::provider_type

inherited

Definition at line 22 of file DetectorPropertiesService.h.

Constructor & Destructor Documentation

detinfo::DetectorPropertiesServiceStandard::DetectorPropertiesServiceStandard	(	fhicl::ParameterSet const &	pset,
		art::ActivityRegistry &	reg
	)

Definition at line 28 of file DetectorPropertiesServiceStandard_service.cc.

References lar::extractProviders(), postOpenFile(), preProcessEvent(), art::ActivityRegistry::sPostOpenFile, and art::ActivityRegistry::sPreProcessEvent.

    : fInheritNumberTimeSamples(pset.get<bool>("InheritNumberTimeSamples", false))
  {
    // Register for callbacks.

    reg.sPostOpenFile.watch    (this, &DetectorPropertiesServiceStandard::postOpenFile);
    reg.sPreProcessEvent.watch (this, &DetectorPropertiesServiceStandard::preProcessEvent);
/*
    // obtain the required dependency service providers and create our own
    const geo::GeometryCore* geo = lar::providerFrom<geo::Geometry>();
    
    const detinfo::LArProperties* lp = lar::providerFrom<detinfo::LArPropertiesService>();
    
    const detinfo::DetectorClocks* clks = lar::providerFrom<detinfo::DetectorClocksService>();
    
    fProp = std::make_unique<detinfo::DetectorPropertiesStandard>(pset,geo,lp,clks);
    */
    fProp = std::make_unique<detinfo::DetectorPropertiesStandard>(pset,
      lar::extractProviders<
        geo::Geometry, 
        detinfo::LArPropertiesService,
        detinfo::DetectorClocksService
        >(),
        std::set<std::string>({ "InheritNumberTimeSamples" })
      );
    
    // at this point we need and expect the provider to be fully configured
    fProp->CheckIfConfigured();
    
    // Save the parameter set.
    fPS = pset;
    
  }

Member Function Documentation

bool detinfo::DetectorPropertiesServiceStandard::isDetectorPropertiesServiceStandard ( const fhicl::ParameterSet &  ps ) const

private

Definition at line 187 of file DetectorPropertiesServiceStandard_service.cc.

References d, DEFINE_ART_SERVICE_INTERFACE_IMPL, fhicl::ParameterSet::get(), fhicl::ParameterSet::get_if_present(), and s.

Referenced by postOpenFile().

  {
    // This method uses heuristics to determine whether the parameter
    // set passed as argument is a DetectorPropertiesService configuration
    // parameter set.
    
    return 
         (ps.get<std::string>("service_type", "") == "DetectorPropertiesService")
      && (ps.get<std::string>("service_provider", "") == "DetectorPropertiesServiceStandard")
      ;
#if 0
    // old heuristics here:
    std::string s;
    double d;
    int i;
    unsigned int u;
    
    bool result = !ps.get_if_present("module_label", s);
    result = result && ps.get_if_present("TriggerOffset", i);
    result = result && ps.get_if_present("SamplingRate", d);
    result = result && ps.get_if_present("NumberTimeSamples", u);
    result = result && ps.get_if_present("ReadOutWindowSize", u);

    return result;
#endif // 0
  }

void detinfo::DetectorPropertiesServiceStandard::postOpenFile

(

const std::string &

filename

)

Definition at line 83 of file DetectorPropertiesServiceStandard_service.cc.

References file, fInheritNumberTimeSamples, fProp, fPS, fhicl::ParameterSet::get(), isDetectorPropertiesServiceStandard(), and fhicl::make_ParameterSet().

Referenced by DetectorPropertiesServiceStandard().

  {
    // Use this method to figure out whether to inherit configuration
    // parameters from previous jobs.

    // There is no way currently to correlate parameter sets saved in
    // sqlite RootFileDB with process history (from MetaData tree).
    // Therefore, we use the approach of scanning every historical
    // parameter set in RootFileDB, and finding all parameter sets
    // that appear to be DetectorPropertiesService configurations.  If all
    // historical parameter sets are in agreement about the value of
    // an inherited parameter, then we accept the historical value,
    // print a message, and override the configuration parameter.  In
    // cases where the historical configurations are not in agreement
    // about the value of an inherited parameter, we ignore any
    // historical parameter values that are the same as the current
    // configured value of the parameter (that is, we resolve the
    // conflict in favor of parameters values that are different than
    // the current configuration).  If two or more historical values
    // differ from the current configuration, throw an exception.
    // Note that it is possible to give precendence to the current
    // configuration by disabling inheritance for that configuration
    // parameter.

    // Don't do anything if no parameters are supposed to be inherited.

    if(!fInheritNumberTimeSamples) return;

    // The only way to access art service metadata from the input file
    // is to open it as a separate TFile object.  Do that now.

    if(filename.size() != 0) {

      TFile* file = TFile::Open(filename.c_str(), "READ");
      if(file != 0 && !file->IsZombie() && file->IsOpen()) {

        // Open the sqlite datatabase.

        art::SQLite3Wrapper sqliteDB(file, "RootFileDB");

        // Loop over all stored ParameterSets.

        unsigned int iNumberTimeSamples = 0;  // Combined value of NumberTimeSamples.
        unsigned int nNumberTimeSamples = 0;  // Number of NumberTimeSamples parameters seen.

        sqlite3_stmt * stmt = 0;
        sqlite3_prepare_v2(sqliteDB, "SELECT PSetBlob from ParameterSets;", -1, &stmt, NULL);
        while (sqlite3_step(stmt) == SQLITE_ROW) {
          fhicl::ParameterSet ps;
          fhicl::make_ParameterSet(reinterpret_cast<char const *>(sqlite3_column_text(stmt, 0)), ps);
          // Is this a DetectorPropertiesService parameter set?

          bool psok = isDetectorPropertiesServiceStandard(ps);
          if(psok) {

            // Check NumberTimeSamples

            //      if(fInheritNumberTimeSamples) {
            unsigned int newNumberTimeSamples = ps.get<unsigned int>("NumberTimeSamples");
            
            // Ignore parameter values that match the current configuration.
            
            if(newNumberTimeSamples != fPS.get<unsigned int>("NumberTimeSamples")) {
              if(nNumberTimeSamples == 0)
                iNumberTimeSamples = newNumberTimeSamples;
              else if(newNumberTimeSamples != iNumberTimeSamples) {
                throw cet::exception(__FUNCTION__)
                  << "Historical values of NumberTimeSamples do not agree: "
                  << iNumberTimeSamples << " " << newNumberTimeSamples << "\n" ;
              }
              ++nNumberTimeSamples;
              //            }
            }
          }
        }

        // Done looping over parameter sets.
        // Now decide which parameters we will actually override.

        if(// fInheritNumberTimeSamples && 
           nNumberTimeSamples != 0 && 
           iNumberTimeSamples != fProp->NumberTimeSamples()) {
          mf::LogInfo("DetectorPropertiesServiceStandard")
            << "Overriding configuration parameter NumberTimeSamples using historical value.\n"
            << "  Configured value:        " << fProp->NumberTimeSamples() << "\n"
            << "  Historical (used) value: " << iNumberTimeSamples << "\n";
          fProp->SetNumberTimeSamples(iNumberTimeSamples);
        }
      }

      // Close file.
      if(file != 0) {
        if(file->IsOpen())
          file->Close();
        delete file;
      }
    }
    
  }

void detinfo::DetectorPropertiesServiceStandard::preProcessEvent

(

const art::Event &

evt

)

Definition at line 74 of file DetectorPropertiesServiceStandard_service.cc.

References fProp.

Referenced by DetectorPropertiesServiceStandard().

  {
    // Make sure TPC Clock is updated with TimeService (though in principle it shouldn't change
    fProp->UpdateClocks(lar::providerFrom<detinfo::DetectorClocksService>());
  }

virtual const provider_type* detinfo::DetectorPropertiesServiceStandard::provider ( ) const

inlineoverridevirtual

Implements detinfo::DetectorPropertiesService.

Definition at line 86 of file DetectorPropertiesServiceStandard.h.

References fProp.

{ return fProp.get();}

void detinfo::DetectorPropertiesServiceStandard::reconfigure ( fhicl::ParameterSet const &  pset )

overridevirtual

Implements detinfo::DetectorPropertiesService.

Definition at line 63 of file DetectorPropertiesServiceStandard_service.cc.

References fProp, and fPS.

  {
    fProp->ValidateAndConfigure(p, { "InheritNumberTimeSamples" });
    
    // Save the parameter set.
    fPS = p;

    return;
  }

Member Data Documentation

bool detinfo::DetectorPropertiesServiceStandard::fInheritNumberTimeSamples

private

Flag saying whether to inherit NumberTimeSamples.

Definition at line 93 of file DetectorPropertiesServiceStandard.h.

Referenced by postOpenFile().

std::unique_ptr<detinfo::DetectorPropertiesStandard> detinfo::DetectorPropertiesServiceStandard::fProp

private

Definition at line 90 of file DetectorPropertiesServiceStandard.h.

Referenced by postOpenFile(), preProcessEvent(), provider(), and reconfigure().

fhicl::ParameterSet detinfo::DetectorPropertiesServiceStandard::fPS

private

Original parameter set.

Definition at line 91 of file DetectorPropertiesServiceStandard.h.

Referenced by postOpenFile(), and reconfigure().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/DetectorInfoServices/DetectorPropertiesServiceStandard.h
• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/DetectorInfoServices/DetectorPropertiesServiceStandard_service.cc