icarus::details Namespace Reference

Classes
class	ChannelToWireMap
	Mapping of ROP channels into wires. More...
struct	ChannelRange_t
	A simple range of channels. More...
class	StableMerger
class	ROPnumberDispatcher
	Algorithm assigning IDs to readout planes. More...
class	ROPandTPCsetBuildingAlg
	Extracts TPC sets and readout planes from a list of cryostats. More...
class	IntegerRangesBase
	A sequence of contiguous ranges of integral numbers. More...
class	KeyedCSVparser
	Parser to fill a KeyValuesData structure out of a character buffer. More...
struct	KeyValuesConverter
struct	BaseWrapper
struct	KeyValuesConverter< icarus::details::BaseWrapper< T, Base >, Enable >
	Specialization for conversions with a numeric base. More...
class	KeyValueParser
	Parser to fill a KeyValuesData structure out of a character buffer. More...

Typedefs
using	TPCColl_t = std::vector< geo::TPCGeo const * >
	Type of collection of TPCs (pointers to geo::TPCGeo). More...
using	PlaneColl_t = std::vector< geo::PlaneGeo const * >
	Type of collection of planes (pointers to geo::PlaneGeo). More...

Functions
template<typename SetColl >
SetColl	stableMerge (SetColl const &sets)
template<typename T >
std::ostream &	operator<< (std::ostream &out, typename IntegerRangesBase< T >::Data_t const &range)
template<typename ConfigMap >
sbn::PMTconfiguration	extractPMTreadoutConfigurationImpl (ConfigMap const &configMap, icarus::PMTconfigurationExtractor extractor)
template<typename ConfigMap >
icarus::TriggerConfiguration	extractTriggerReadoutConfigurationImpl (ConfigMap const &configMap, icarus::TriggerConfigurationExtractor extractor)

Typedef Documentation

typedef std::vector< geo::PlaneGeo const * > icarus::details::PlaneColl_t

Type of collection of planes (pointers to geo::PlaneGeo).

Definition at line 35 of file GeometryObjectCollections.h.

typedef std::vector< geo::TPCGeo const * > icarus::details::TPCColl_t

Type of collection of TPCs (pointers to geo::TPCGeo).

Definition at line 32 of file GeometryObjectCollections.h.

Function Documentation

template<typename ConfigMap >

sbn::PMTconfiguration icarus::details::extractPMTreadoutConfigurationImpl	(	ConfigMap const &	configMap,
		icarus::PMTconfigurationExtractor	extractor
	)

Definition at line 418 of file PMTconfigurationExtractor.h.

  {
    
    /*
    * Requirements: ConfigMap is a mapping type supporting iteration and whose
    * elements support structured assignment into a pair, the first element
    * being an identifier (process name, parameter set ID...) and the second
    * being a `fhicl::ParameterSet` with the configuration (or something
    * offering the same interface).
    * 
    * The plan is to look in all the FHiCL configuration fragments we can find
    * in the input config, and find all the useful configuration therein.
    * Given that there may be multiple input files, there may also be multiple
    * configurations for the same detector components.
    * In that case, we will extract parameters from each and every one of the
    * configurations, and throw an exception if they are not all consistent.
    * 
    * Consistency is tested only for the extracted parameters, not for the whole
    * FHiCL configuration fragment.
    */
    
    using Key_t = std::tuple_element_t<0U, typename ConfigMap::value_type>;
    
    std::optional<std::pair<Key_t, sbn::PMTconfiguration>> config;
    
    // look in the global configuration for all parameter sets which contain
    // `configuration_documents` as a (direct) name;
    for (auto const& [ id, pset ]: configMap) {
      if (!extractor.mayHaveConfiguration(pset)) continue;
      
      fhicl::ParameterSet const configDocs
        = extractor.convertConfigurationDocuments
          (pset, "configuration_documents", { std::regex{ "icaruspmt.*" } })
        ;
      
      sbn::PMTconfiguration candidateConfig = extractor.extract(configDocs);
      if (config) {
        if (config->second == candidateConfig) continue;
        mf::LogError log("extractPMTreadoutConfiguration");
        log << "Found two candidate configurations differring:"
          "\nFirst [" << config->first << "]:\n" << config->second
          << "\nSecond [" << id << "]:\n" << candidateConfig
          ;
        throw cet::exception("extractPMTreadoutConfiguration")
          << "extractPMTreadoutConfiguration() found inconsistent configurations.\n";
      } // if incompatible configurations
      
      config.emplace(std::move(id), std::move(candidateConfig));
    } // for all configuration documents
    
    if (!config) {
      throw cet::exception("extractPMTreadoutConfiguration")
        << "extractPMTreadoutConfiguration() could not find a suitable configuration.\n";
    }
    
    return extractor.finalize(std::move(config->second));
  } // extractPMTreadoutConfigurationImpl(ConfigMap)

template<typename ConfigMap >

icarus::TriggerConfiguration icarus::details::extractTriggerReadoutConfigurationImpl	(	ConfigMap const &	configMap,
		icarus::TriggerConfigurationExtractor	extractor
	)

Definition at line 390 of file TriggerConfigurationExtractor.h.

  {
    
    /*
    * Requirements: ConfigMap is a mapping type supporting iteration and whose
    * elements support structured assignment into a pair, the first element
    * being an identifier (process name, parameter set ID...) and the second
    * being a `fhicl::ParameterSet` with the configuration (or something
    * offering the same interface).
    * 
    * The plan is to look in all the FHiCL configuration fragments we can find
    * in the input config, and find all the useful configuration therein.
    * Given that there may be multiple input files, there may also be multiple
    * configurations for the same detector components.
    * In that case, we will extract parameters from each and every one of the
    * configurations, and throw an exception if they are not all consistent.
    * 
    * Consistency is tested only for the extracted parameters, not for the whole
    * FHiCL configuration fragment.
    */
    
    using Key_t = std::tuple_element_t<0U, typename ConfigMap::value_type>;
    
    std::optional<std::pair<Key_t, icarus::TriggerConfiguration>> config;
    
    // look in the global configuration for all parameter sets which contain
    // `configuration_documents` as a (direct) name;
    for (auto const& [ id, pset ]: configMap) {
      if (!extractor.mayHaveConfiguration(pset)) continue;
      
      fhicl::ParameterSet const configDocs
        = extractor.convertConfigurationDocuments
          (pset, "configuration_documents", { std::regex{ "icarustrigger.*" } })
        ;
      
      icarus::TriggerConfiguration candidateConfig = extractor.extract(configDocs);
      if (config) {
        if (config->second == candidateConfig) continue;
        mf::LogError log("extractTriggerReadoutConfiguration");
        log << "Found two candidate configurations differring:"
          "\nFirst [" << config->first << "]:\n" << config->second
          << "\nSecond [" << id << "]:\n" << candidateConfig
          ;
        throw cet::exception("extractTriggerReadoutConfiguration")
          << "extractTriggerReadoutConfiguration() found inconsistent configurations.\n";
      } // if incompatible configurations
      
      config.emplace(std::move(id), std::move(candidateConfig));
    } // for all configuration documents
    
    if (!config) {
      throw cet::exception("extractTriggerReadoutConfiguration")
        << "extractTriggerReadoutConfiguration() could not find a suitable configuration.\n";
    }
    
    return std::move(config->second);
  } // extractPMTreadoutConfigurationImpl(ConfigMap)

template<typename T >

std::ostream& icarus::details::operator<<	(	std::ostream &	out,
		typename IntegerRangesBase< T >::Data_t const &	range
	)

template<typename SetColl >

SetColl icarus::details::stableMerge

(

SetColl const &

sets

)

Definition at line 92 of file ROPandTPCsetBuildingAlg.cxx.

  { return icarus::details::StableMerger<SetColl>::merge(sets); }