icarus::PMTconfigurationExtractor Class Reference

Class to extract PMT readout board configuration. More...

#include <PMTconfigurationExtractor.h>

Inheritance diagram for icarus::PMTconfigurationExtractor:

Public Member Functions
	PMTconfigurationExtractor ()=default
	Constructor: no channel mapping, channel IDs won't be finalize()'d. More...
	PMTconfigurationExtractor (icarusDB::IICARUSChannelMap const &channelMappingService)
	Constructor: use channel mapping to finalize() channel IDs. More...
Public Member Functions inherited from icarus::PMTconfigurationExtractorBase
ConfigurationData_t	extract (fhicl::ParameterSet const &config) const
	Extracts all supported PMT configuration from config. More...
ConfigurationData_t	finalize (ConfigurationData_t config) const
	Finalizes the content of config and returns it. More...

Private Member Functions
sbn::V1730Configuration	extractV1730configuration (fhicl::ParameterSet const &pset, std::string const &boardName) const
	Extracts PMT readout board configuration from pset. More...
sbn::V1730channelConfiguration	extractChannelConfiguration (fhicl::ParameterSet const &boardPSet, unsigned short int channelNo) const
	Returns the specified V1730 readout channel configuration. More...
std::optional < fhicl::ParameterSet >	readBoardConfig (fhicl::ParameterSet const &pset, std::string const &key) const
	Returns the specified PMT readout board configuration. More...

Static Private Member Functions
static unsigned int	readoutBoardDBfragmentID (sbn::V1730Configuration const &boardConfig)
	Returns the fragment ID of the specified board as known by the database. More...

Private Attributes
icarusDB::IICARUSChannelMap const *	fChannelMap = nullptr
	Hardware PMT channel mapping to LArSoft's. More...

Static Private Attributes
static std::vector< std::regex > const	ConfigurationNames { std::regex{ "icaruspmt.*" } }
	Regular expressions matching all names of supported PMT configurations. More...

Interface
sbn::PMTconfiguration	extract (fhicl::ParameterSet const &config) const
	Extracts all supported PMT configuration from config. More...
sbn::PMTconfiguration	finalize (sbn::PMTconfiguration config) const
	Assigns unique channel IDs to the channel information. More...
static bool	mayHaveConfiguration (fhicl::ParameterSet const &pset)
	Returns whether pset may contain the needed configuration. More...
static bool	isGoodConfiguration (fhicl::ParameterSet const &pset, std::string const &key)
	Returns whether the specified key of pset is a good configuration. More...

Additional Inherited Members
Public Types inherited from icarus::PMTconfigurationExtractorBase
using	ConfigurationData_t = sbn::PMTconfiguration
Static Public Member Functions inherited from icarus::PMTconfigurationExtractorBase
static fhicl::ParameterSet	convertConfigurationDocuments (fhicl::ParameterSet const &container, std::string const &configListKey, std::initializer_list< std::regex const > components)
	Returns a parameter set with the content of configuration_documents key from container. More...
template<typename RBegin , typename REnd >
static bool	matchKey (std::string const &key, RBegin rbegin, REnd rend)
static bool	mayHaveConfiguration (fhicl::ParameterSet const &pset)
	Returns whether pset may contain the needed configuration. More...

Detailed Description

Class to extract PMT readout board configuration.

This is an example of PMT readout board configuration taken from ICARUS run 4774 (destinations and metrics have been omitted):

icaruspmteetop01: {
  daq: {
    fragment_receiver: {
      BaselineCh1: 14768
      BaselineCh10: 14843
      BaselineCh11: 14846
      BaselineCh12: 14840
      BaselineCh13: 14981
      BaselineCh14: 14896
      BaselineCh15: 14966
      BaselineCh16: 14800
      BaselineCh2: 14836
      BaselineCh3: 14806
      BaselineCh4: 14954
      BaselineCh5: 14766
      BaselineCh6: 14835
      BaselineCh7: 14861
      BaselineCh8: 14857
      BaselineCh9: 14949
      BoardChainNumber: 0
      CalibrateOnConfig: true
      ChargePedstalBitCh1: 14400
      CircularBufferSize: 5e8
      CombineReadoutWindows: false
      GetNextFragmentBunchSize: 20
      GetNextSleep: 100
      InterruptEventNumber: 1
      InterruptLevel: 0
      InterruptStatusID: 0
      LVDSLogicValueG1: 3
      LVDSLogicValueG2: 3
      LVDSLogicValueG3: 3
      LVDSLogicValueG4: 3
      LVDSLogicValueG5: 3
      LVDSLogicValueG6: 3
      LVDSLogicValueG7: 3
      LVDSLogicValueG8: 3
      LVDSOutWidthC1: 20
      LVDSOutWidthC10: 20
      LVDSOutWidthC11: 20
      LVDSOutWidthC12: 20
      LVDSOutWidthC13: 20
      LVDSOutWidthC14: 20
      LVDSOutWidthC15: 20
      LVDSOutWidthC16: 20
      LVDSOutWidthC2: 20
      LVDSOutWidthC3: 20
      LVDSOutWidthC4: 20
      LVDSOutWidthC5: 20
      LVDSOutWidthC6: 20
      LVDSOutWidthC7: 20
      LVDSOutWidthC8: 20
      LVDSOutWidthC9: 20
      LockTempCalibration: false
      MajorityCoincidenceWindow: 1
      MajorityLevel: 0
      MajorityTimeWindow: 4
      ModeLVDS: 1
      SWTrigger: false
      SelfTrigBit: 16
      SelfTriggerMask: 255
      SelfTriggerMode: 0
      TimeOffsetNanoSec: 0
      UseTimeTagForTimeStamp: false
      Verbosity: 1
      acqMode: 0
      allowTriggerOverlap: false
      analogMode: 1
      boardId: 0
      board_id: 18
      channelEnable0: true
      channelEnable1: true
      channelEnable10: true
      channelEnable11: true
      channelEnable12: true
      channelEnable13: true
      channelEnable14: true
      channelEnable15: true
      channelEnable2: true
      channelEnable3: true
      channelEnable4: true
      channelEnable5: true
      channelEnable6: true
      channelEnable7: true
      channelEnable8: true
      channelEnable9: true
      channelPedestal0: 6554
      channelPedestal1: 6554
      channelPedestal10: 6554
      channelPedestal11: 6554
      channelPedestal12: 6554
      channelPedestal13: 6554
      channelPedestal14: 6554
      channelPedestal15: 6554
      channelPedestal2: 6554
      channelPedestal3: 6554
      channelPedestal4: 6554
      channelPedestal5: 6554
      channelPedestal6: 6554
      channelPedestal7: 6554
      channelPedestal8: 6554
      channelPedestal9: 6554
      dacValue: 32768
      data_buffer_depth_fragments: 10000
      data_buffer_depth_mb: 2000
      debugLevel: 7
      destinations: {} # ...
      dynamicRange: 0
      enableReadout: 1
      eventCounterWarning: 1
      eventsPerInterrupt: 1
      extTrgMode: 3
      fragment_id: 18
      fragment_type: "CAENV1730"
      generator: "CAENV1730Readout"
      ioLevel: 1
      irqWaitTime: 1
      link: 2
      maxEventsPerTransfer: 1
      max_fragment_size_bytes: 1e7
      memoryAlmostFull: 2
      multicast_interface_ip: "192.168.191.0"
      nChannels: 16
      outputSignalMode: 0
      postPercent: 70
      readoutMode: 0
      receive_requests: true
      recordLength: 25000
      request_address: "227.128.1.129"
      request_mode: "sequence"
      request_port: 3502
      routing_table_config: { use_routing_master: false }
      runSyncMode: 0
      separate_data_thread: true
      swTrgMode: 0
      testPattern: 0
      triggerPolarity: 0
      triggerPulseWidth: 20
      triggerThreshold0: 14368
      triggerThreshold1: 14436
      triggerThreshold10: 14446
      triggerThreshold11: 14440
      triggerThreshold12: 14581
      triggerThreshold13: 14596
      triggerThreshold14: 14566
      triggerThreshold15: 14400
      triggerThreshold2: 14406
      triggerThreshold3: 14554
      triggerThreshold4: 14366
      triggerThreshold5: 14435
      triggerThreshold6: 14461
      triggerThreshold7: 14457
      triggerThreshold8: 14549
      triggerThreshold9: 14443
      usePedestals: false
    }
    metrics: {} # ...
  }
}

Definition at line 312 of file PMTconfigurationExtractor.h.

Constructor & Destructor Documentation

icarus::PMTconfigurationExtractor::PMTconfigurationExtractor ( )

default

Constructor: no channel mapping, channel IDs won't be finalize()'d.

icarus::PMTconfigurationExtractor::PMTconfigurationExtractor

(

icarusDB::IICARUSChannelMap const &

channelMappingService

)

Constructor: use channel mapping to finalize() channel IDs.

Definition at line 406 of file PMTconfigurationExtractor.h.

  : fChannelMap(&channelMappingService)
  {}

Member Function Documentation

sbn::PMTconfiguration icarus::PMTconfigurationExtractor::extract

(

fhicl::ParameterSet const &

config

)

const

Extracts all supported PMT configuration from config.

Parameters

config

a FHiCL parameter set with component configuration

Returns

an object with the supported PMT configuration

All PMT-related configuration that is known to this code is extracted and returned.

Definition at line 77 of file PMTconfigurationExtractor.cxx.

{
  
  sbn::PMTconfiguration config;
  
  for (std::string const& key: pset.get_names()) {
    
    std::optional<fhicl::ParameterSet> boardConfig
      = readBoardConfig(pset, key);
    
    if (!boardConfig) continue;
    
    config.boards.push_back(extractV1730configuration(*boardConfig, key));
    
  } // for
  
  return config;
} // icarus::PMTconfigurationExtractor::extract()

sbn::V1730channelConfiguration icarus::PMTconfigurationExtractor::extractChannelConfiguration ( fhicl::ParameterSet const &  boardPSet, unsigned short int  channelNo  ) const

private

Returns the specified V1730 readout channel configuration.

Parameters

boardPSet	readout board configuration
channelNo	number of channel on board (0-15)

Returns

the configuration of the specified channel

Definition at line 129 of file PMTconfigurationExtractor.cxx.

{
  std::string const ChannelStr = std::to_string(channelNo);
  
  sbn::V1730channelConfiguration channel;
  
  channel.channelNo = channelNo;
  
  channel.baseline = boardPSet.get<short signed int>
    ("BaselineCh" + std::to_string(channelNo + 1));
  channel.threshold = boardPSet.get<short signed int>
    ("triggerThreshold" + ChannelStr);
  channel.enabled = boardPSet.get<bool>("channelEnable" + ChannelStr);
  
  return channel;
} // icarus::PMTconfigurationExtractor::extractChannelConfiguration()

auto icarus::PMTconfigurationExtractor::extractV1730configuration ( fhicl::ParameterSet const &  pset, std::string const &  boardName  ) const

private

Extracts PMT readout board configuration from pset.

Parameters

pset	information source (FHiCL configuration)
boardName	name of the board we are given the configuration of

Returns

the requested configuration

Definition at line 99 of file PMTconfigurationExtractor.cxx.

{
  
  auto const& boardParams
    = pset.get<fhicl::ParameterSet>("daq.fragment_receiver");
  
  sbn::V1730Configuration rc; // readout config, for friends
  rc.boardName = boardName;
  
  rc.boardID = boardParams.get<unsigned int>("board_id");
  rc.fragmentID = boardParams.get<unsigned int>("fragment_id");
  
  rc.bufferLength = boardParams.get<int>("recordLength");
  rc.postTriggerFrac = boardParams.get<float>("postPercent") / 100.0f;
  
  rc.nChannels = boardParams.get<unsigned int>("nChannels");
  
  rc.useTimeTagForTimeStamp = boardParams.get("UseTimeTagForTimeStamp", false);
  
  for (unsigned short int channelNo = 0; channelNo < 16; ++channelNo)
    rc.channels.push_back(extractChannelConfiguration(boardParams, channelNo));
  
  return rc;
} // icarus::PMTconfigurationExtractor::extractV1730configuration()

sbn::PMTconfiguration icarus::PMTconfigurationExtractor::finalize

(

sbn::PMTconfiguration

config

)

const

Assigns unique channel IDs to the channel information.

Definition at line 149 of file PMTconfigurationExtractor.cxx.

{

  for (sbn::V1730Configuration& readoutBoardConfig: config.boards) {
    auto const fragmentID = readoutBoardDBfragmentID(readoutBoardConfig);
    if (!fChannelMap->hasPMTDigitizerID(fragmentID)) {
      mf::LogWarning("PMTconfigurationExtractor")
        << "No entry found in PMT channel mapping database for board '"
        << readoutBoardConfig.boardName << "' (fragment ID: "
        << readoutBoardConfig.fragmentID << " => " << std::hex << fragmentID
        << ")\n";
      continue;
    }
  
    icarusDB::DigitizerChannelChannelIDPairVec const& digitizerChannelVec
      = fChannelMap->getChannelIDPairVec(fragmentID);
    
    // finds the channel ID matching the specified channel number of this board
    auto const toChannelID = [&channelIDs=digitizerChannelVec]
      (short unsigned int channelNo)
      {
        auto const it = std::find_if(channelIDs.begin(), channelIDs.end(),
          [channelNo](auto const& p){ return p.first == channelNo; });
        return (it != channelIDs.end())
          ? it->second
          : sbn::V1730channelConfiguration::NoChannelID
          ;
      };
    
    for (auto& channelInfo: readoutBoardConfig.channels)
      channelInfo.channelID = toChannelID(channelInfo.channelNo);
    
  } // for boards
  
  return config;
} // icarus::PMTconfigurationExtractor::finalize()

bool icarus::PMTconfigurationExtractor::isGoodConfiguration ( fhicl::ParameterSet const &  pset, std::string const &  key  )

static

Returns whether the specified key of pset is a good configuration.

Definition at line 69 of file PMTconfigurationExtractor.cxx.

{
  return matchKey(key, ConfigurationNames.begin(), ConfigurationNames.end());
} // icarus::PMTconfigurationExtractor::isGoodConfiguration()

static bool icarus::PMTconfigurationExtractor::mayHaveConfiguration ( fhicl::ParameterSet const &  pset )

inlinestatic

Returns whether pset may contain the needed configuration.

Definition at line 331 of file PMTconfigurationExtractor.h.

    { return pset.has_key("configuration_documents"); }

std::optional< fhicl::ParameterSet > icarus::PMTconfigurationExtractor::readBoardConfig ( fhicl::ParameterSet const &  pset, std::string const &  key  ) const

private

Returns the specified PMT readout board configuration.

Parameters

pset	parameter set including key
key	key of the PMT readout configuration candidate

Returns

the configuration, or an empty object if key does not represent one

Definition at line 190 of file PMTconfigurationExtractor.cxx.

{
  static std::string const ExpectedFragmentType = "CAENV1730";
  
  std::optional<fhicl::ParameterSet> config;
  
  do { // fake loop for fast exit
    
    // it must be a parameter set
    if (!pset.has_key(key) || !pset.is_key_to_table(key)) break;
    
    auto boardPSet = pset.get<fhicl::ParameterSet>(key);
    
    // its "fragment_type" must be the expected one
    std::string fragmentType;
    if (!boardPSet.get_if_present("daq.fragment_receiver.fragment_type", fragmentType))
      break;
    if (fragmentType != ExpectedFragmentType) break;
    
    config.emplace(std::move(boardPSet)); // success
  } while (false);
  return config;
} // icarus::PMTconfigurationExtractor::readBoardConfig()

unsigned int icarus::PMTconfigurationExtractor::readoutBoardDBfragmentID ( sbn::V1730Configuration const &  boardConfig )

staticprivate

Returns the fragment ID of the specified board as known by the database.

Definition at line 246 of file PMTconfigurationExtractor.cxx.

{
  return boardConfig.fragmentID & 0xFF; // secret recipe
} // icarus::PMTconfigurationExtractor::readoutBoardDBfragmentID()

Member Data Documentation

std::vector< std::regex > const icarus::PMTconfigurationExtractor::ConfigurationNames { std::regex{ "icaruspmt.*" } }

staticprivate

Regular expressions matching all names of supported PMT configurations.

Definition at line 359 of file PMTconfigurationExtractor.h.

icarusDB::IICARUSChannelMap const* icarus::PMTconfigurationExtractor::fChannelMap = nullptr

private

Hardware PMT channel mapping to LArSoft's.

Definition at line 362 of file PMTconfigurationExtractor.h.

---

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

• PMTconfigurationExtractor.h
• PMTconfigurationExtractor.cxx