icarusDB::ICARUSChannelMapProvider Class Reference

#include <ICARUSChannelMapProvider.h>

Inheritance diagram for icarusDB::ICARUSChannelMapProvider:

Public Member Functions
	ICARUSChannelMapProvider (const fhicl::ParameterSet &pset)
bool	hasFragmentID (const unsigned int) const override
unsigned int	nTPCfragmentIDs () const override
	Returns the number of TPC fragment IDs known to the service. More...
const std::string &	getCrateName (const unsigned int) const override
const ReadoutIDVec &	getReadoutBoardVec (const unsigned int) const override
const TPCReadoutBoardToChannelMap &	getReadoutBoardToChannelMap () const override
bool	hasBoardID (const unsigned int) const override
unsigned int	nTPCboardIDs () const override
	Returns the number of TPC board IDs known to the service. More...
unsigned int	getBoardSlot (const unsigned int) const override
const ChannelPlanePairVec &	getChannelPlanePair (const unsigned int) const override
bool	hasPMTDigitizerID (const unsigned int) const override
unsigned int	nPMTfragmentIDs () const override
	Returns the number of PMT fragment IDs known to the service. More...
const DigitizerChannelChannelIDPairVec &	getChannelIDPairVec (const unsigned int) const override
unsigned int	getSimMacAddress (const unsigned int) const override
unsigned int	gettopSimMacAddress (const unsigned int) const override
std::pair< double, double >	getSideCRTCalibrationMap (int mac5, int chan) const override
	Returns the Gain and Pedestal for Side CRT. More...
Public Member Functions inherited from icarusDB::IICARUSChannelMap
virtual	~IICARUSChannelMap () noexcept=default

Static Public Member Functions
static constexpr unsigned int	PMTfragmentIDtoDBkey (unsigned int fragmentID)
	Returns the channel mapping database key for the specified PMT fragment ID. More...
static constexpr unsigned int	DBkeyToPMTfragmentID (unsigned int DBkey)
	Returns the PMT fragment ID for the specified channel mapping database key. More...

Private Member Functions
DigitizerChannelChannelIDPairVec const *	findPMTfragmentEntry (unsigned int fragmentID) const

Private Attributes
bool	fDiagnosticOutput
IChannelMapping::TPCFragmentIDToReadoutIDMap	fFragmentToReadoutMap
IChannelMapping::TPCReadoutBoardToChannelMap	fReadoutBoardToChannelMap
IChannelMapping::FragmentToDigitizerChannelMap	fFragmentToDigitizerMap
IChannelMapping::CRTChannelIDToHWtoSimMacAddressPairMap	fCRTChannelIDToHWtoSimMacAddressPairMap
IChannelMapping::TopCRTHWtoSimMacAddressPairMap	fTopCRTHWtoSimMacAddressPairMap
IChannelMapping::SideCRTChannelToCalibrationMap	fSideCRTChannelToCalibrationMap
std::unique_ptr< IChannelMapping >	fChannelMappingTool

Detailed Description

Definition at line 25 of file ICARUSChannelMapProvider.h.

Constructor & Destructor Documentation

icarusDB::ICARUSChannelMapProvider::ICARUSChannelMapProvider

(

const fhicl::ParameterSet &

pset

)

Definition at line 30 of file ICARUSChannelMapProvider.cxx.

                                                                                {

    mf::LogInfo("ICARUSChannelMapProvider") << "Building the channel mapping" ;

    fDiagnosticOutput = pset.get<bool>("DiagnosticOutput", false);

    // Recover the vector of fhicl parameters for the ROI tools
    const fhicl::ParameterSet&channelMappingParams = pset.get<fhicl::ParameterSet>("ChannelMappingTool");

    // Get instance of the mapping tool (allowing switch between database instances)
    fChannelMappingTool = art::make_tool<IChannelMapping>(channelMappingParams);

    cet::cpu_timer theClockFragmentIDs;

    theClockFragmentIDs.start();

    if (fChannelMappingTool->BuildTPCFragmentIDToReadoutIDMap(fFragmentToReadoutMap))
    {
        throw cet::exception("ICARUSChannelMapProvider") << "Cannot recover the Fragment ID channel map from the database \n";
    }
    else if (fDiagnosticOutput)
    {
        std::cout << "FragmentID to Readout ID map has " << fFragmentToReadoutMap.size() << " elements";
        for(const auto& pair : fFragmentToReadoutMap) std::cout << "   Frag: " << std::hex << pair.first << ", Crate: " 
                                                                << pair.second.first << ", # boards: " << std::dec << pair.second.second.size() << std::endl;
        
    }

    theClockFragmentIDs.stop();

    double fragmentIDsTime = theClockFragmentIDs.accumulated_real_time();

    cet::cpu_timer theClockReadoutIDs;

    theClockReadoutIDs.start();

    if (fChannelMappingTool->BuildTPCReadoutBoardToChannelMap(fReadoutBoardToChannelMap))
    {
        std::cout << "******* FAILED TO CONFIGURE CHANNEL MAP ********" << std::endl;
        throw cet::exception("ICARUSChannelMapProvider") << "POS didn't read the F'ing database again \n";
    }

    // Do the channel mapping initialization
    if (fChannelMappingTool->BuildFragmentToDigitizerChannelMap(fFragmentToDigitizerMap))
      {
        throw cet::exception("ICARUSChannelMapProvider") << "Cannot recover the Fragment ID channel map from the database \n";
      }
    else if (fDiagnosticOutput)
      {
        std::cout << "FragmentID to Readout ID map has " << fFragmentToDigitizerMap.size() << " Fragment IDs";
         for(const auto& pair : fFragmentToDigitizerMap) std::cout << "   Frag: " << std::hex << pair.first << ", # pairs: " 
                                                                   << std::dec << pair.second.size() << std::endl;
      }
    
    // Do the channel mapping initialization for CRT
    if (fChannelMappingTool->BuildCRTChannelIDToHWtoSimMacAddressPairMap(fCRTChannelIDToHWtoSimMacAddressPairMap))
      {
        throw cet::exception("CRTDecoder") << "Cannot recover the HW MAC Address  from the database \n";
      }
    else if (fDiagnosticOutput)
      {
        std::cout << "ChannelID to MacAddress map has " << fCRTChannelIDToHWtoSimMacAddressPairMap.size() << " Channel IDs";
        for(const auto& pair : fCRTChannelIDToHWtoSimMacAddressPairMap) std::cout <<" ChannelID: "<< pair.first
                                                                                  << ", hw mac address: " << pair.second.first
                                                                                  <<", sim mac address: " << pair.second.second << std::endl;
        
      }
    
    
    // Do the channel mapping initialization for top CRT
    if (fChannelMappingTool->BuildTopCRTHWtoSimMacAddressPairMap(fTopCRTHWtoSimMacAddressPairMap))
      {
        throw cet::exception("CRTDecoder") << "Cannot recover the Top CRT HW MAC Address  from the database \n";
      }
    else if (fDiagnosticOutput)
      {
        std::cout << "Top CRT MacAddress map has " << fTopCRTHWtoSimMacAddressPairMap.size() << " rows";
        for(const auto& pair : fTopCRTHWtoSimMacAddressPairMap) std::cout << ", hw mac address: " << pair.first
                                                                          <<", sim mac address: " << pair.second << std::endl;
      }
    

    // Do the CRT Charge Calibration initialization
    if (fChannelMappingTool->BuildSideCRTCalibrationMap(fSideCRTChannelToCalibrationMap))
      {
        std::cout << "******* FAILED TO CONFIGURE CRT Calibration  ********" << std::endl;
        throw cet::exception("ICARUSChannelMapProvider") << "Cannot recover the charge calibration information from the database \n";
      }
    else if (fDiagnosticOutput)
      {
        std::cout << "side crt calibration map has " << fSideCRTChannelToCalibrationMap.size() << " list of rows \n";

        for(const auto& pair : fSideCRTChannelToCalibrationMap) std::cout <<" mac5: "<< pair.first.first
                                                                          << ", chan: " << pair.first.second
                                                                          << ", Gain: " << pair.second.first
                                                                          << ", Pedestal: " << pair.second.second << std::endl;

      }    
    
    theClockReadoutIDs.stop();

    double readoutIDsTime = theClockReadoutIDs.accumulated_real_time();


    mf::LogInfo("ICARUSChannelMapProvider") << "==> FragmentID map time: " << fragmentIDsTime << ", Readout IDs time: " << readoutIDsTime << std::endl;
    
    return;
}

Member Function Documentation

constexpr unsigned int icarusDB::ICARUSChannelMapProvider::DBkeyToPMTfragmentID ( unsigned int  DBkey )

static

Returns the PMT fragment ID for the specified channel mapping database key.

Definition at line 291 of file ICARUSChannelMapProvider.cxx.

{
  /*
   * PMT channel mapping database stores the board number (0-23) as key.
   * Fragment ID are currently in the pattern 0x20xx, with xx the board number.
   */
  
  // protest if this is a fragment not from the PMT;
  // but make an exception for old PMT fragment IDs (legacy)
  assert((DBkey & 0xFF) < 24);
  
  return (DBkey & 0xFF) | 0x2000;
  
} // ICARUSChannelMapProvider::PMTfragmentIDtoDBkey()

auto icarusDB::ICARUSChannelMapProvider::findPMTfragmentEntry ( unsigned int  fragmentID ) const

private

Returns the list of board channel-to-PMT channel ID mapping within the specified fragment.

Returns

a pointer to the mapping list, or nullptr if invalid fragment

Definition at line 265 of file ICARUSChannelMapProvider.cxx.

{
  auto it = fFragmentToDigitizerMap.find(PMTfragmentIDtoDBkey(fragmentID));
  return (it == fFragmentToDigitizerMap.end())? nullptr: &(it->second);
}

unsigned int icarusDB::ICARUSChannelMapProvider::getBoardSlot ( const unsigned int  boardID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 188 of file ICARUSChannelMapProvider.cxx.

{
    IChannelMapping::TPCReadoutBoardToChannelMap::const_iterator readoutBoardItr = fReadoutBoardToChannelMap.find(boardID);

    if (readoutBoardItr == fReadoutBoardToChannelMap.end())
        throw cet::exception("ICARUSChannelMapProvider") << "Board ID " << boardID << " not found in lookup map when looking up board slot \n";

    return readoutBoardItr->second.first;
}

const DigitizerChannelChannelIDPairVec & icarusDB::ICARUSChannelMapProvider::getChannelIDPairVec ( const unsigned int  fragmentID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 220 of file ICARUSChannelMapProvider.cxx.

{
    DigitizerChannelChannelIDPairVec const* digitizerPair = findPMTfragmentEntry(fragmentID);
    
    if (digitizerPair) return *digitizerPair;
    throw cet::exception("ICARUSChannelMapProvider") << "Fragment ID " << fragmentID << " not found in lookup map when looking for PMT channel info \n";
    
}

const ChannelPlanePairVec & icarusDB::ICARUSChannelMapProvider::getChannelPlanePair ( const unsigned int  boardID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 198 of file ICARUSChannelMapProvider.cxx.

{
    IChannelMapping::TPCReadoutBoardToChannelMap::const_iterator readoutBoardItr = fReadoutBoardToChannelMap.find(boardID);

    if (readoutBoardItr == fReadoutBoardToChannelMap.end())
        throw cet::exception("ICARUSChannelMapProvider") << "Board ID " << boardID << " not found in lookup map when looking up channel/plane pair \n";

    return readoutBoardItr->second.second;

}

const std::string & icarusDB::ICARUSChannelMapProvider::getCrateName ( const unsigned int  fragmentID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 150 of file ICARUSChannelMapProvider.cxx.

{
    IChannelMapping::TPCFragmentIDToReadoutIDMap::const_iterator fragToReadoutItr = fFragmentToReadoutMap.find(fragmentID);

    if (fragToReadoutItr == fFragmentToReadoutMap.end())
        throw cet::exception("ICARUSChannelMapProvider") << "Fragment ID " << fragmentID << " not found in lookup map when looking up crate name \n";

    return fragToReadoutItr->second.first;
}

const TPCReadoutBoardToChannelMap & icarusDB::ICARUSChannelMapProvider::getReadoutBoardToChannelMap ( ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 171 of file ICARUSChannelMapProvider.cxx.

{
    return fReadoutBoardToChannelMap;
}

const ReadoutIDVec & icarusDB::ICARUSChannelMapProvider::getReadoutBoardVec ( const unsigned int  fragmentID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 160 of file ICARUSChannelMapProvider.cxx.

{
    IChannelMapping::TPCFragmentIDToReadoutIDMap::const_iterator fragToReadoutItr = fFragmentToReadoutMap.find(fragmentID);

    if (fragToReadoutItr == fFragmentToReadoutMap.end())
        throw cet::exception("ICARUSChannelMapProvider") << "Fragment ID " << fragmentID << " not found in lookup map when looking up board vector \n";

    return fragToReadoutItr->second.second;

}

std::pair< double, double > icarusDB::ICARUSChannelMapProvider::getSideCRTCalibrationMap ( int  mac5, int  chan  ) const

overridevirtual

Returns the Gain and Pedestal for Side CRT.

Implements icarusDB::IICARUSChannelMap.

Definition at line 258 of file ICARUSChannelMapProvider.cxx.

  {
    auto const itGainAndPedestal = fSideCRTChannelToCalibrationMap.find({ mac5, chan });
    return (itGainAndPedestal == fSideCRTChannelToCalibrationMap.cend())
      ? std::pair{ -99., -99. }: itGainAndPedestal->second;
  }

unsigned int icarusDB::ICARUSChannelMapProvider::getSimMacAddress ( const unsigned int  hwmacaddress ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 229 of file ICARUSChannelMapProvider.cxx.

  {
    unsigned int   simmacaddress = 0;

    for(const auto& pair : fCRTChannelIDToHWtoSimMacAddressPairMap){
      if (pair.second.first == hwmacaddress)
        simmacaddress = pair.second.second;
    }

    return simmacaddress;
  }

unsigned int icarusDB::ICARUSChannelMapProvider::gettopSimMacAddress ( const unsigned int  hwmacaddress ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 241 of file ICARUSChannelMapProvider.cxx.

  {
    unsigned int   simmacaddress = 0;

    for(const auto& pair : fTopCRTHWtoSimMacAddressPairMap){
      if (pair.first == hwmacaddress)
        simmacaddress = pair.second;
    }

    return simmacaddress;
    
    /* untested:
    auto const it = fTopCRTHWtoSimMacAddressPairMap.find(hwmacaddress);
    return (it == fTopCRTHWtoSimMacAddressPairMap.end())? 0: it->second;
    */
  }

bool icarusDB::ICARUSChannelMapProvider::hasBoardID ( const unsigned int  boardID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 177 of file ICARUSChannelMapProvider.cxx.

{
    return fReadoutBoardToChannelMap.find(boardID) != fReadoutBoardToChannelMap.end();
}

bool icarusDB::ICARUSChannelMapProvider::hasFragmentID ( const unsigned int  fragmentID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 139 of file ICARUSChannelMapProvider.cxx.

{
    return fFragmentToReadoutMap.find(fragmentID) != fFragmentToReadoutMap.end();
}

bool icarusDB::ICARUSChannelMapProvider::hasPMTDigitizerID ( const unsigned int  fragmentID ) const

overridevirtual

Implements icarusDB::IICARUSChannelMap.

Definition at line 209 of file ICARUSChannelMapProvider.cxx.

{
    return findPMTfragmentEntry(fragmentID) != nullptr;
}

unsigned int icarusDB::ICARUSChannelMapProvider::nPMTfragmentIDs ( ) const

overridevirtual

Returns the number of PMT fragment IDs known to the service.

Implements icarusDB::IICARUSChannelMap.

Definition at line 215 of file ICARUSChannelMapProvider.cxx.

                                                             {
  return fFragmentToDigitizerMap.size();
}

unsigned int icarusDB::ICARUSChannelMapProvider::nTPCboardIDs ( ) const

overridevirtual

Returns the number of TPC board IDs known to the service.

Implements icarusDB::IICARUSChannelMap.

Definition at line 183 of file ICARUSChannelMapProvider.cxx.

                                                          {
  return fReadoutBoardToChannelMap.size();
}

unsigned int icarusDB::ICARUSChannelMapProvider::nTPCfragmentIDs ( ) const

overridevirtual

Returns the number of TPC fragment IDs known to the service.

Implements icarusDB::IICARUSChannelMap.

Definition at line 145 of file ICARUSChannelMapProvider.cxx.

                                                             {
  return fFragmentToReadoutMap.size();
}

constexpr unsigned int icarusDB::ICARUSChannelMapProvider::PMTfragmentIDtoDBkey ( unsigned int  fragmentID )

static

Returns the channel mapping database key for the specified PMT fragment ID.

Definition at line 274 of file ICARUSChannelMapProvider.cxx.

{
  /*
   * PMT channel mapping database stores the board number (0-23) as key.
   * Fragment ID are currently in the pattern 0x20xx, with xx the board number.
   */
  
  // protest if this is a fragment not from the PMT;
  // but make an exception for old PMT fragment IDs (legacy)
  assert(((fragmentID & ~0xFF) == 0x00) || ((fragmentID & ~0xFF) == 0x20));
  
  return fragmentID & 0xFF;
  
} // ICARUSChannelMapProvider::PMTfragmentIDtoDBkey()

Member Data Documentation

std::unique_ptr<IChannelMapping> icarusDB::ICARUSChannelMapProvider::fChannelMappingTool

private

Definition at line 85 of file ICARUSChannelMapProvider.h.

IChannelMapping::CRTChannelIDToHWtoSimMacAddressPairMap icarusDB::ICARUSChannelMapProvider::fCRTChannelIDToHWtoSimMacAddressPairMap

private

Definition at line 79 of file ICARUSChannelMapProvider.h.

bool icarusDB::ICARUSChannelMapProvider::fDiagnosticOutput

private

Definition at line 71 of file ICARUSChannelMapProvider.h.

IChannelMapping::FragmentToDigitizerChannelMap icarusDB::ICARUSChannelMapProvider::fFragmentToDigitizerMap

private

Definition at line 77 of file ICARUSChannelMapProvider.h.

IChannelMapping::TPCFragmentIDToReadoutIDMap icarusDB::ICARUSChannelMapProvider::fFragmentToReadoutMap

private

Definition at line 73 of file ICARUSChannelMapProvider.h.

IChannelMapping::TPCReadoutBoardToChannelMap icarusDB::ICARUSChannelMapProvider::fReadoutBoardToChannelMap

private

Definition at line 75 of file ICARUSChannelMapProvider.h.

IChannelMapping::SideCRTChannelToCalibrationMap icarusDB::ICARUSChannelMapProvider::fSideCRTChannelToCalibrationMap

private

Definition at line 83 of file ICARUSChannelMapProvider.h.

IChannelMapping::TopCRTHWtoSimMacAddressPairMap icarusDB::ICARUSChannelMapProvider::fTopCRTHWtoSimMacAddressPairMap

private

Definition at line 81 of file ICARUSChannelMapProvider.h.

---

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

• ICARUSChannelMapProvider.h
• ICARUSChannelMapProvider.cxx