hit::DisambigCheater Class Reference

Inheritance diagram for hit::DisambigCheater:

Public Member Functions
	DisambigCheater (fhicl::ParameterSet const &p)
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 Member Functions
void	produce (art::Event &e) override
void	endJob () override
void	InitHitToWids (detinfo::DetectorClocksData const &clockData, const std::vector< art::Ptr< recob::Hit >> &ChHits)
void	MakeDisambigHit (art::Ptr< recob::Hit > const &hit, geo::WireID const &wid, art::Ptr< recob::Wire > const &wire, recob::HitCollectionCreator &hcol)

Private Attributes
art::ServiceHandle< geo::Geometry const >	geom
art::ServiceHandle< cheat::BackTrackerService const >	bt_serv
std::string	fChanHitLabel
std::string	fWidHitLabel
std::map< std::pair< double, double >, std::vector< geo::WireID > >	fHitToWids
unsigned int	fFalseChanHits
unsigned int	fBadIDENearestWire = 0
std::vector< unsigned int >	fMaxWireShift

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 31 of file DisambigCheater_module.cc.

Constructor & Destructor Documentation

hit::DisambigCheater::DisambigCheater ( fhicl::ParameterSet const &  p )

explicit

Definition at line 62 of file DisambigCheater_module.cc.

                                                             : EDProducer{p}
  {
    fChanHitLabel = p.get<std::string>("ChanHitLabel");

    // let HitCollectionCreator declare that we are going to produce
    // hits and associations with wires and raw digits
    // (with no particular product label)
    recob::HitCollectionCreator::declare_products(producesCollector(), "", true, false);

    // Space charge can shift true IDE postiion to far-off channels.
    // Calculate maximum number of wires to shift hit in order to be on correct channel.
    // Shift no more than half of the number of channels, as beyond there will
    //   have been a closer wire segment.
    if (geom->Ncryostats() != 1 || geom->NTPC() < 1) {
      fMaxWireShift.resize(3);
      fMaxWireShift[0] = 1;
      fMaxWireShift[1] = 1;
      fMaxWireShift[2] = 1;
    }
    else {
      // assume TPC 0 is typical of all in terms of number of channels
      unsigned int np = geom->Cryostat(0).TPC(0).Nplanes();
      fMaxWireShift.resize(np);
      for (unsigned int p = 0; p < np; ++p) {
        double xyz[3] = {0.};
        double xyz_next[3] = {0.};
        unsigned int nw = geom->Cryostat(0).TPC(0).Plane(p).Nwires();
        for (unsigned int w = 0; w < nw; ++w) {

          // for vertical planes
          if (geom->Cryostat(0).TPC(0).Plane(p).View() == geo::kZ) {
            fMaxWireShift[2] = geom->Cryostat(0).TPC(0).Plane(p).Nwires();
            break;
          }

          geom->Cryostat(0).TPC(0).Plane(p).Wire(w).GetCenter(xyz);
          geom->Cryostat(0).TPC(0).Plane(p).Wire(w + 1).GetCenter(xyz_next);

          if (xyz[2] == xyz_next[2]) {
            fMaxWireShift[p] = w;
            break;
          }
        } // end wire loop
      }   // end plane loop

      for (unsigned int i = 0; i < np; i++)
        fMaxWireShift[i] = std::floor(fMaxWireShift[i] / 2);
    }
  }

Member Function Documentation

void hit::DisambigCheater::endJob ( )

overrideprivatevirtual

Reimplemented from art::EDProducer.

Definition at line 300 of file DisambigCheater_module.cc.

  {

    if (fFalseChanHits > 0)
      mf::LogWarning("DisambigCheater")
        << fFalseChanHits << " hits had no associated IDE or WireIDs";
  }

void hit::DisambigCheater::InitHitToWids ( detinfo::DetectorClocksData const &  clockData, const std::vector< art::Ptr< recob::Hit >> &  ChHits  )

private

Todo:

: Why would an IDE xyz position be outside of a TPC?

Todo:

: Why would an IDE ossociated with a hit return a nearest wire not on the hit's channel? Usually only one off.

Definition at line 191 of file DisambigCheater_module.cc.

  {

    unsigned int Ucount(0), Vcount(0);
    for (size_t h = 0; h < ChHits.size(); h++) {
      recob::Hit const& chit = *(ChHits[h]);
      if (ChHits[h]->View() == geo::kZ) continue;
      if (ChHits[h]->View() == geo::kU)
        Ucount++;
      else if (ChHits[h]->View() == geo::kV)
        Vcount++;
      std::vector<geo::WireID> cwids = geom->ChannelToWire(chit.Channel());
      std::pair<double, double> ChanTime((double)chit.Channel(),
                                         (double)chit.PeakTime()); // hit key value

      // get hit IDEs
      std::vector<const sim::IDE*> ides;
      try {
        ides = bt_serv->HitToSimIDEs_Ps(clockData, chit);
      }
      catch (...) {
      };

      // catch the hits that have no IDEs
      bool hasIDEs = !ides.empty();
      if (hasIDEs) {
        try {
          bt_serv->SimIDEsToXYZ(ides);
        } //What is this supposed to be doing? It get a vector, but never assigns it anywhere. There has to be a better way to do this check
        catch (...) {
          hasIDEs = false;
        }
      } // if
      if (!hasIDEs) {
        mf::LogVerbatim("DisambigCheat")
          << "Hit on channel " << chit.Channel() << " between " << chit.PeakTimeMinusRMS()
          << " and " << chit.PeakTimePlusRMS() << " matches no IDEs.";
        fHitToWids[ChanTime] = std::vector<geo::WireID>();
        continue;
      } // if no IDEs

      // see what wire ID(s) the hit-IDEs are on
      //  if none: hit maps to empty vector
      //  if one: we have a unique hit, vector of size 1
      //  if more than one: make a vector of all wids
      std::vector<geo::WireID> widsWithIdes;
      for (size_t i = 0; i < ides.size(); i++) {
        const double xyzIde[] = {ides[i]->x, ides[i]->y, ides[i]->z};

        // Occasionally, ide position is not in TPC
        /// \todo: Why would an IDE xyz position be outside of a TPC?
        geo::TPCID tpcID = geom->FindTPCAtPosition(xyzIde);
        if (!tpcID.isValid) {
          mf::LogWarning("DisambigCheat")
            << "IDE at x = " << xyzIde[0] << ", y = " << xyzIde[1] << ", z = " << xyzIde[2]
            << " does not correspond to a TPC.";
          continue;
        }
        unsigned int tpc = tpcID.TPC, cryo = tpcID.Cryostat;

        // NearestWire seems to be missing some correction that is applied in LArG4, and is
        // sometimes off by one or two wires. Use it and then correct it given channel
        /// \todo: Why would an IDE ossociated with a hit return a nearest wire not on the hit's channel? Usually only one off.
        geo::WireID IdeWid;
        try {
          IdeWid = geom->NearestWireID(xyzIde, cwids[0].Plane, tpc, cryo);
        }
        catch (geo::InvalidWireError const& e) { // adopt suggestion if possible
          if (!e.hasSuggestedWire()) throw;
          IdeWid = e.suggestedWireID();
          mf::LogError("DisambigCheat") << "Detected a point out of its wire plane:\n"
                                        << e.what() << "\nUsing suggested wire " << IdeWid << "\n";
        }
        geo::WireID storethis = IdeWid; // default...
        bool foundmatch(false);
        for (size_t w = 0; w < cwids.size(); w++) {
          if (cwids[w].TPC != tpc || cwids[w].Cryostat != cryo) continue;
          if ((unsigned int)std::abs((int)(IdeWid.Wire) - (int)(cwids[w].Wire)) <=
              fMaxWireShift[cwids[0].Plane]) {
            storethis = cwids[w]; // ...apply correction
            foundmatch = true;
            break;
          }
        }
        if (!foundmatch) {
          mf::LogWarning("DisambigCheat")
            << "IDE NearestWire return more than 1 off from channel wids: wire " << IdeWid.Wire;
          fBadIDENearestWire++;
        }

        bool alreadyStored(false);
        for (size_t wid = 0; wid < widsWithIdes.size(); wid++)
          if (storethis == widsWithIdes[wid]) alreadyStored = true;
        if (!alreadyStored) widsWithIdes.push_back(storethis);
      } // end loop through ides from HitToSimIdes

      fHitToWids[ChanTime] = widsWithIdes;

    } // end U/V channel hit loop

    if (fHitToWids.size() != Ucount + Vcount) {
      mf::LogWarning("DisambigCheat")
        << "Nhits mismatch: " << fHitToWids.size() << " " << Ucount + Vcount;
    }
  }

void hit::DisambigCheater::MakeDisambigHit ( art::Ptr< recob::Hit > const &  hit, geo::WireID const &  wid, art::Ptr< recob::Wire > const &  wire, recob::HitCollectionCreator &  hcol  )

private

Definition at line 172 of file DisambigCheater_module.cc.

  {

    if (!wid.isValid) {
      mf::LogWarning("InvalidWireID") << "wid is invalid, hit not being made\n";
      return;
    }

    // create a hit copy of the original one, but with a different wire ID
    recob::HitCreator hit(*original_hit, wid);
    hcol.emplace_back(hit.move(), wire);
  }

void hit::DisambigCheater::produce ( art::Event &  e )

overrideprivatevirtual

Todo:

: Decide how to handle the hits with multiple-wid activity. For now, randomly choose.

Implements art::EDProducer.

Definition at line 114 of file DisambigCheater_module.cc.

  {
    // get hits on channels
    art::Handle<std::vector<recob::Hit>> ChanHits;
    evt.getByLabel(fChanHitLabel, ChanHits);
    std::vector<art::Ptr<recob::Hit>> ChHits;
    art::fill_ptr_vector(ChHits, ChanHits);

    // also get the associated wires and raw digits;
    // we assume they have been created by the same module as the hits
    const bool doRawDigitAssns = false;

    art::FindOneP<recob::Wire> ChannelHitWires(ChanHits, evt, fChanHitLabel);
    const bool doWireAssns = ChannelHitWires.isValid();

    // this object contains the hit collection
    // and its associations to wires and raw digits
    // (if the original objects have them):
    recob::HitCollectionCreator hits(evt, doWireAssns, doRawDigitAssns);

    // find the wireIDs each hit is on
    auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
    this->InitHitToWids(clockData, ChHits);

    // make all of the hits
    for (size_t h = 0; h < ChHits.size(); h++) {

      // get the objects associated with this hit
      art::Ptr<recob::Wire> wire;
      if (doWireAssns) wire = ChannelHitWires.at(h);

      // the trivial Z hits
      if (ChHits[h]->View() == geo::kZ) {
        this->MakeDisambigHit(ChHits[h], ChHits[h]->WireID(), wire, hits);
        continue;
      }

      // make U/V hits if any wire IDs are associated
      // count hits without a wireID
      /// \todo: Decide how to handle the hits with multiple-wid activity. For now, randomly choose.
      std::pair<double, double> ChanTime(ChHits[h]->Channel() * 1., ChHits[h]->PeakTime() * 1.);
      if (fHitToWids[ChanTime].size() == 1)
        this->MakeDisambigHit(ChHits[h], fHitToWids[ChanTime][0], wire, hits);
      else if (fHitToWids[ChanTime].size() == 0)
        fFalseChanHits++;
      else if (fHitToWids[ChanTime].size() > 1)
        this->MakeDisambigHit(ChHits[h], fHitToWids[ChanTime][0], wire, hits); // same thing for now

    } // for

    // put the hit collection and associations into the event
    hits.put_into(evt);

    fHitToWids.clear();
  }

Member Data Documentation

art::ServiceHandle<cheat::BackTrackerService const> hit::DisambigCheater::bt_serv

private

Definition at line 40 of file DisambigCheater_module.cc.

unsigned int hit::DisambigCheater::fBadIDENearestWire = 0

private

Definition at line 56 of file DisambigCheater_module.cc.

std::string hit::DisambigCheater::fChanHitLabel

private

Definition at line 42 of file DisambigCheater_module.cc.

unsigned int hit::DisambigCheater::fFalseChanHits

private

Initial value:

=
      0

Definition at line 54 of file DisambigCheater_module.cc.

std::map<std::pair<double, double>, std::vector<geo::WireID> > hit::DisambigCheater::fHitToWids

private

Definition at line 45 of file DisambigCheater_module.cc.

std::vector<unsigned int> hit::DisambigCheater::fMaxWireShift

private

Definition at line 58 of file DisambigCheater_module.cc.

std::string hit::DisambigCheater::fWidHitLabel

private

Definition at line 43 of file DisambigCheater_module.cc.

art::ServiceHandle<geo::Geometry const> hit::DisambigCheater::geom

private

Definition at line 39 of file DisambigCheater_module.cc.

---

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

• larreco/larreco/HitFinder/DisambigCheater_module.cc