Infill::InfillChannels Class Reference

Inheritance diagram for Infill::InfillChannels:

Public Member Functions
	InfillChannels (fhicl::ParameterSet const &p)
	InfillChannels (InfillChannels const &)=delete
	InfillChannels (InfillChannels &&)=delete
InfillChannels &	operator= (InfillChannels const &)=delete
InfillChannels &	operator= (InfillChannels &&)=delete
void	produce (art::Event &e) override
void	beginJob () override
void	endJob () override
Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
const geo::GeometryCore *	fGeom
std::set< raw::ChannelID_t >	fBadChannels
std::set< raw::ChannelID_t >	fNoisyChannels
std::set< raw::ChannelID_t >	fDeadChannels
std::set< readout::ROPID >	fActiveRops
const std::string	fNetworkPath
const std::string	fNetworkNameInduction
const std::string	fNetworkNameCollection
torch::jit::script::Module	fInductionModule
torch::jit::script::Module	fCollectionModule
const std::string	fInputLabel

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Definition at line 43 of file InfillChannels_module.cc.

Constructor & Destructor Documentation

Infill::InfillChannels::InfillChannels ( fhicl::ParameterSet const &  p )

explicit

Definition at line 79 of file InfillChannels_module.cc.

  : EDProducer{p},
    fNetworkPath           (p.get<std::string> ("NetworkPath")),
    fNetworkNameInduction  (p.get<std::string> ("NetworkNameInduction")),
    fNetworkNameCollection (p.get<std::string> ("NetworkNameCollection")),
    fInputLabel            (p.get<std::string> ("InputLabel"))
{
  consumes<std::vector<raw::RawDigit>>(fInputLabel);

  produces<std::vector<raw::RawDigit>>();
}

Infill::InfillChannels::InfillChannels ( InfillChannels const &  )

delete

Infill::InfillChannels::InfillChannels ( InfillChannels &&  )

delete

Member Function Documentation

void Infill::InfillChannels::beginJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 178 of file InfillChannels_module.cc.

{
  fGeom = art::ServiceHandle<geo::Geometry>()->provider();

  // Dead channels = bad channels + noisy channels
  fBadChannels = art::ServiceHandle<lariov::ChannelStatusService const>()->GetProvider().BadChannels();
  fNoisyChannels = art::ServiceHandle<lariov::ChannelStatusService const>()->GetProvider().NoisyChannels();

  std::merge(
    fBadChannels.begin(), fBadChannels.end(), fNoisyChannels.begin(), fNoisyChannels.end(), 
    std::inserter(fDeadChannels, fDeadChannels.begin())
  );

  // Get active ROPs (not facing a wall and has dead channels)
  geo::ROP_id_iterator iRop, rBegin(fGeom, geo::ROP_id_iterator::begin_pos), 
    rEnd(fGeom, geo::ROP_id_iterator::end_pos);
  for (iRop = rBegin; iRop != rEnd; ++iRop) { // Iterate over ROPs in the detector
    bool hasDeadCh = false;
    for (raw::ChannelID_t ch : fDeadChannels) {
      if (fGeom->ChannelToROP(ch) == *iRop) {
        hasDeadCh = true;
        break;
      }
    }
    if (!hasDeadCh) continue; // Don't need to infill ROPs without dead channels

    for (const geo::TPCID tpcId : fGeom->ROPtoTPCs(*iRop)) {
      const geo::TPCGeo tpc = fGeom->TPC(tpcId);
      const TGeoVolume* tpcVol = tpc.ActiveVolume();
      
      if (tpcVol->Capacity() > 1000000) { // At least one of the ROP's TPCIDs needs to be active
        // Networks expect a fixed image size
        if(fGeom->SignalType(*iRop) == geo::kInduction && fGeom->Nchannels(*iRop) > 800) {
          std::cerr << "InfillChannels_module.cc: Induction view network cannot handle more then 800 channels\n";
          std::abort();
        }
        if(fGeom->SignalType(*iRop) == geo::kCollection && fGeom->Nchannels(*iRop) > 480) {
          std::cerr << "InfillChannels_module.cc: Collection view network cannot handle more then 400 channels\n";
          std::abort();
        }

        fActiveRops.insert(*iRop);
        break;
      }
    }
  }
  
  // Check dead channels resemble the dead channels used for training
  raw::ChannelID_t chGap = 1;
  for (const raw::ChannelID_t ch : fDeadChannels) {
    if (fDeadChannels.count(ch + 1)) {
      ++chGap;
      continue;
    }
    if (fGeom->ChannelToROP(ch - chGap) == fGeom->ChannelToROP(ch + 1)) {
      if (fGeom->SignalType(ch) == geo::kCollection && chGap > 3) {
        std::cerr << "There are dead channel gap larger than what was seen in training --- ";
        std::cerr << "**Consider retraining collection plane infill network**" << std::endl;
      }
      else if (fGeom->SignalType(ch) == geo::kInduction && chGap > 2) {
        std::cerr << "There are dead channel gap larger than what was seen in training --- ";
        std::cerr << "**Consider retraining induction plane infill network**" << std::endl;
      }
    }
    chGap = 1;
  }

  // Load torchscripts
  std::cout << "Loading modules..." << std::endl;
  const char* networkPath = std::getenv(fNetworkPath.c_str());
  if (networkPath == nullptr) {
    std::cerr << "InfillChannels_module.cc: Environment variable " << fNetworkPath << " was not found";
    std::abort();
  }
  const std::string networkLocInduction = std::string(networkPath) + "/" + fNetworkNameInduction;
  const std::string networkLocCollection = std::string(networkPath) + "/" + fNetworkNameCollection;

  try {
    fInductionModule = torch::jit::load(networkLocInduction);
    std::cout << "Induction module loaded from " << networkLocInduction <<std::endl;
  }
  catch (const c10::Error& err) {
    std::cerr << "error loading the model\n";
    std::cerr << err.what();
  }
  try {
    fCollectionModule = torch::jit::load(networkLocCollection);
    std::cout << "Collection module loaded from " << networkLocCollection << std::endl;
  }
  catch (const c10::Error& err) {
    std::cerr << "error loading the model\n";
    std::cerr << err.what();
  }
}

void Infill::InfillChannels::endJob ( )

overridevirtual

Reimplemented from art::EDProducer.

Definition at line 273 of file InfillChannels_module.cc.

{
  // Implementation of optional member function here.
}

InfillChannels& Infill::InfillChannels::operator= ( InfillChannels const &  )

delete

InfillChannels& Infill::InfillChannels::operator= ( InfillChannels &&  )

delete

void Infill::InfillChannels::produce ( art::Event &  e )

overridevirtual

Implements art::EDProducer.

Definition at line 91 of file InfillChannels_module.cc.

{
  auto const detProp = art::ServiceHandle<detinfo::DetectorPropertiesService>()->DataFor(e);
  // Networks expect a fixed image size
  if (detProp.NumberTimeSamples() > 6000) {
    std::cerr << "InfillChannels_module.cc: Networks cannot handle more than 6000 time ticks\n";
    std::abort(); 
  } 
      
  typedef std::array<short, 6000> vecAdc;
  std::map<raw::ChannelID_t, vecAdc> infilledAdcs;
  torch::Tensor maskedRopTensor;
  torch::Tensor infilledRopTensor; 

  auto digs = e.getHandle<std::vector<raw::RawDigit> >(fInputLabel);

  // Get infilled adc ROP by ROP
  for (const readout::ROPID& currentRop : fActiveRops) {
    maskedRopTensor = torch::zeros(
      {1, 1 ,6000, fGeom->Nchannels(currentRop)}, torch::dtype(torch::kFloat32).device(torch::kCPU).requires_grad(false)
    );
    auto maskedRopTensorAccess = maskedRopTensor.accessor<float, 4>();

    const raw::ChannelID_t firstCh = fGeom->FirstChannelInROP(currentRop);

    // Fill ROP image
    for (const raw::RawDigit& dig : *digs) {
      if (fDeadChannels.count(dig.Channel())) continue;

      readout::ROPID rop = fGeom->ChannelToROP(dig.Channel());
      if (rop != currentRop) continue;

      raw::RawDigit::ADCvector_t adcs(dig.Samples());
      raw::Uncompress(dig.ADCs(), adcs, dig.Compression());
      
      for (unsigned int tick = 0; tick < adcs.size(); ++tick) {
        const int adc = adcs[tick] ? int(adcs[tick]) - dig.GetPedestal() : 0;

        maskedRopTensorAccess[0][0][tick][dig.Channel() - firstCh] = adc;
      } 
    }

    // Do the Infill
    std::vector<torch::jit::IValue> inputs;
    inputs.push_back(maskedRopTensor);
    if (fGeom->SignalType(currentRop) == geo::kInduction) {
      torch::NoGradGuard no_grad_guard; 
      infilledRopTensor = fInductionModule.forward(inputs).toTensor().detach();
    }
    else if (fGeom->SignalType(currentRop) == geo::kCollection) {
      torch::NoGradGuard no_grad_guard; 
      infilledRopTensor = fCollectionModule.forward(inputs).toTensor().detach();
    }

    // Store infilled ADC of dead channels
    auto infilledRopTensorAccess = infilledRopTensor.accessor<float, 4>();
    for (const raw::ChannelID_t ch : fDeadChannels) {
      if (fGeom->ChannelToROP(ch) == currentRop) {
        for (unsigned int tick = 0; tick < detProp.NumberTimeSamples(); ++tick) {
          infilledAdcs[ch][tick] = (short)std::round(infilledRopTensorAccess[0][0][tick][ch - firstCh]);
        }
      }
    } // Could break early if ch > last ch in currentRop to save a bit of looping?
  }

  // Encode infilled ADC into RawDigit and put back onto event 
  auto infilledDigs = std::make_unique<std::vector<raw::RawDigit>>();
  *infilledDigs = *digs;
  for (raw::RawDigit& dig : *infilledDigs) {
    if (infilledAdcs.count(dig.Channel())) {
      raw::RawDigit::ADCvector_t infilledAdc(
        infilledAdcs[dig.Channel()].begin(), (infilledAdcs[dig.Channel()].begin() + detProp.NumberTimeSamples())
      );

      // Get new pedestal
      auto infilledAdcMin = std::min_element(infilledAdc.begin(), infilledAdc.end());
      short ped = *infilledAdcMin < 0 ? std::abs(*infilledAdcMin) + 1 : 0;
      for (short& adc : infilledAdc) adc += ped;

      raw::Compress(infilledAdc, dig.Compression()); // need to consider compression parameters
      dig = raw::RawDigit(dig.Channel(), dig.Samples(), infilledAdc, dig.Compression());
      dig.SetPedestal(ped);
    }
  }
  e.put(std::move(infilledDigs)); 
}

Member Data Documentation

std::set<readout::ROPID> Infill::InfillChannels::fActiveRops

private

Definition at line 69 of file InfillChannels_module.cc.

std::set<raw::ChannelID_t> Infill::InfillChannels::fBadChannels

private

Definition at line 65 of file InfillChannels_module.cc.

torch::jit::script::Module Infill::InfillChannels::fCollectionModule

private

Definition at line 75 of file InfillChannels_module.cc.

std::set<raw::ChannelID_t> Infill::InfillChannels::fDeadChannels

private

Definition at line 67 of file InfillChannels_module.cc.

const geo::GeometryCore* Infill::InfillChannels::fGeom

private

Definition at line 63 of file InfillChannels_module.cc.

torch::jit::script::Module Infill::InfillChannels::fInductionModule

private

Definition at line 74 of file InfillChannels_module.cc.

const std::string Infill::InfillChannels::fInputLabel

private

Definition at line 76 of file InfillChannels_module.cc.

const std::string Infill::InfillChannels::fNetworkNameCollection

private

Definition at line 73 of file InfillChannels_module.cc.

const std::string Infill::InfillChannels::fNetworkNameInduction

private

Definition at line 72 of file InfillChannels_module.cc.

const std::string Infill::InfillChannels::fNetworkPath

private

Definition at line 71 of file InfillChannels_module.cc.

std::set<raw::ChannelID_t> Infill::InfillChannels::fNoisyChannels

private

Definition at line 66 of file InfillChannels_module.cc.

---

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

• dunereco/dunereco/InfillChannels/art/InfillChannels_module.cc