hit::TTHitFinder Class Reference

Inheritance diagram for hit::TTHitFinder:

Public Member Functions
	TTHitFinder (fhicl::ParameterSet const &pset)
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 &evt) override
float	getTotalCharge (const float *, int, float)
	Collection wire hit width (in time ticks) More...

Private Attributes
std::string	fCalDataModuleLabel
float	fMinSigPeakInd
	Input caldata module name. More...
float	fMinSigPeakCol
	Induction wire signal height threshold at peak. More...
float	fMinSigTailInd
	Collection wire signal height threshold at peak. More...
float	fMinSigTailCol
	Induction wire signal height threshold outside peak. More...
int	fIndWidth
	Collection wire signal height threshold outside peak. More...
int	fColWidth
	Induction wire hit width (in time ticks) More...

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 32 of file TTHitFinder_module.cc.

Constructor & Destructor Documentation

hit::TTHitFinder::TTHitFinder ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 54 of file TTHitFinder_module.cc.

    : EDProducer{pset}
  {
    fCalDataModuleLabel = pset.get< std::string >("CalDataModuleLabel");
    fMinSigPeakInd      = pset.get< float       >("MinSigPeakInd");
    fMinSigPeakCol      = pset.get< float       >("MinSigPeakCol");
    fMinSigTailInd      = pset.get< float       >("MinSigTailInd",-99); //defaulting to well-below zero
    fMinSigTailCol      = pset.get< float       >("MinSigTailCol",-99); //defaulting to well-below zero
    fIndWidth           = pset.get< int         >("IndWidth", 3); //defaulting to 3
    fColWidth           = pset.get< int         >("ColWidth", 3); //defaulting to 3

    //enforce a minimum width
    if(fIndWidth<1){
      mf::LogWarning("TTHitFinder") << "IndWidth must be 1 at minimum. Resetting width to one time tick";
      fIndWidth = 1;
    }
    if(fColWidth<1){
      mf::LogWarning("TTHitFinder") << "ColWidth must be 1 at minimum. Resetting width to one time tick";
      fColWidth = 1;
    }

    // let HitCollectionCreator declare that we are going to produce
    // hits and associations with wires and raw digits
    recob::HitCollectionCreator::declare_products(producesCollector(), "uhits");
    recob::HitCollectionCreator::declare_products(producesCollector(), "vhits");
    recob::HitCollectionCreator::declare_products(producesCollector(), "yhits");

  }

Member Function Documentation

float hit::TTHitFinder::getTotalCharge ( const float *  signal_vector, int  width = 3, float  threshold = -99  )

private

Collection wire hit width (in time ticks)

Definition at line 224 of file TTHitFinder_module.cc.

                                                                                             {

    float totalCharge = 0;
    for(int tick=0; tick<width; tick++){
      if(signal_vector[tick] < threshold){
        totalCharge = -999; //special value for being below threshold
        break;
      }
      totalCharge += signal_vector[tick];
    }
    return totalCharge;

  }//end getTotalCharge method

void hit::TTHitFinder::produce ( art::Event &  evt )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 84 of file TTHitFinder_module.cc.

  {

    // these objects contain the hit collections
    // and their associations to wires and raw digits:
    recob::HitCollectionCreator hitCollection_U(evt, "uhits");
    recob::HitCollectionCreator hitCollection_V(evt, "vhits");
    recob::HitCollectionCreator hitCollection_Y(evt, "yhits");

    // Read in the wire List object(s).
    art::Handle< std::vector<recob::Wire> > wireVecHandle;
    evt.getByLabel(fCalDataModuleLabel,wireVecHandle);
    std::vector<recob::Wire> const& wireVec(*wireVecHandle);

    // also get the raw digits associated with wires
    art::FindOneP<raw::RawDigit> WireToRawDigits
      (wireVecHandle, evt, fCalDataModuleLabel);

    art::ServiceHandle<geo::Geometry const> geom;

    //initialize some variables that will be in the loop.
    float threshold_peak = 0;
    float threshold_tail = -99;
    int   width = 3;

    //Loop over wires
    for(unsigned int wireIter = 0; wireIter < wireVec.size(); wireIter++) {

      //get our wire
      art::Ptr<recob::Wire> wire(wireVecHandle, wireIter);
      art::Ptr<raw::RawDigit> const& rawdigits = WireToRawDigits.at(wireIter);

      std::vector<float> signal(wire->Signal());
      std::vector<float>::iterator timeIter;   // iterator for time bins
      geo::WireID wire_id = (geom->ChannelToWire(wire->Channel())).at(0); //just grabbing the first one


      //set the thresholds and widths based on wire type
      geo::SigType_t sigType = geom->SignalType(wire->Channel());
      if(sigType == geo::kInduction){
        threshold_peak = fMinSigPeakInd;
        threshold_tail = fMinSigTailInd;
        width          = fIndWidth;
      }
      else if(sigType == geo::kCollection){
        threshold_peak = fMinSigPeakCol;
        threshold_tail = fMinSigTailCol;
        width          = fColWidth;
      }

      //make a half_width variable to be the search window around each time tick.
      float half_width = ((float)width-1)/2.;

      //now do the loop over the time ticks on the wire
      int time_bin = -1;
      float peak_val = 0;
      for(timeIter = signal.begin(); timeIter < signal.end(); timeIter++){
        time_bin++;

        //set the peak value, taking average between ticks if desired total width is even
        if(width%2==1) peak_val = *timeIter;
        else if(width%2==0) peak_val = 0.5 * (*timeIter + *(timeIter+1));

        //continue immediately if we are not above the threshold
        if(peak_val < threshold_peak) continue;

        //continue if we are too close to the edge
        if( time_bin-half_width < 0 ) continue;
        if( time_bin+half_width > signal.size() ) continue;

        //if necessary, do loop over hit width, and check tail thresholds
        int begin_tail_tick = std::floor(time_bin-half_width);
        float totalCharge = getTotalCharge(&signal[begin_tail_tick],width,threshold_tail);
        if(totalCharge==-999) {
          MF_LOG_DEBUG("TTHitFinder") << "Rejecting would be hit at (plane,wire,time_bin,first_bin,last_bin)=("
                                   << wire_id.Plane << "," << wire_id.Wire << "," << time_bin << "," << begin_tail_tick << "," << begin_tail_tick+width-1 << "): "
                                   << signal.at(time_bin-1) << " "
                                   << signal.at(time_bin) << " "
                                   << signal.at(time_bin+1);
          continue;
        }

        //OK, if we've passed all tests up to this point, we have a hit!

        float hit_time = time_bin;
        if(width%2==0) hit_time = time_bin+0.5;

        // hit time region is 2 widths (4 RMS) wide
        const raw::TDCtick_t start_tick = hit_time - width,
          end_tick = hit_time + width;

        // make the hit
        recob::HitCreator hit(
          *wire,                     // wire
          wire_id,                   // wireID
          start_tick,                // start_tick
          end_tick,                  // end_tick
          width / 2.,                // rms
          hit_time,                  // peak_time
          0.,                        // sigma_peak_time
          peak_val,                  // peak_amplitude
          0.,                        // sigma_peak_amplitude
          totalCharge,               // hit_integral
          0.,                        // hit_sigma_integral
          totalCharge,               // summedADC
          1,                         // multiplicity (dummy value)
          0,                         // local_index (dummy value)
          1.,                        // goodness_of_fit (dummy value)
          0                          // dof
          );
        if(wire_id.Plane==0)
          hitCollection_U.emplace_back(hit.move(), wire, rawdigits);
        else if(wire_id.Plane==1)
          hitCollection_V.emplace_back(hit.move(), wire, rawdigits);
        else if(wire_id.Plane==2)
          hitCollection_Y.emplace_back(hit.move(), wire, rawdigits);

      }//End loop over time ticks on wire

      MF_LOG_DEBUG("TTHitFinder") << "Finished wire " << wire_id.Wire << " (plane " << wire_id.Plane << ")"
                               << "\tTotal hits (U,V,Y)= ("
                               << hitCollection_U.size() << ","
                               << hitCollection_V.size() << ","
                               << hitCollection_Y.size() << ")";

    }//End loop over all wires

    // put the hit collection and associations into the event
    mf::LogInfo("TTHitFinder") << "Total TTHitFinder hits (U,V,Y)=("
                               << hitCollection_U.size() << ","
                               << hitCollection_V.size() << ","
                               << hitCollection_Y.size() << ")";
    hitCollection_U.put_into(evt); // reminder: instance name was "uhits"
    hitCollection_V.put_into(evt); // reminder: instance name was "vhits"
    hitCollection_Y.put_into(evt); // reminder: instance name was "yhits"

  } // End of produce()

Member Data Documentation

std::string hit::TTHitFinder::fCalDataModuleLabel

private

Definition at line 41 of file TTHitFinder_module.cc.

int hit::TTHitFinder::fColWidth

private

Induction wire hit width (in time ticks)

Definition at line 47 of file TTHitFinder_module.cc.

int hit::TTHitFinder::fIndWidth

private

Collection wire signal height threshold outside peak.

Definition at line 46 of file TTHitFinder_module.cc.

float hit::TTHitFinder::fMinSigPeakCol

private

Induction wire signal height threshold at peak.

Definition at line 43 of file TTHitFinder_module.cc.

float hit::TTHitFinder::fMinSigPeakInd

private

Input caldata module name.

Definition at line 42 of file TTHitFinder_module.cc.

float hit::TTHitFinder::fMinSigTailCol

private

Induction wire signal height threshold outside peak.

Definition at line 45 of file TTHitFinder_module.cc.

float hit::TTHitFinder::fMinSigTailInd

private

Collection wire signal height threshold at peak.

Definition at line 44 of file TTHitFinder_module.cc.

---

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

• larreco/larreco/HitFinder/TTHitFinder_module.cc