Public Member Functions
	TrigScintFirmwareTracker (const std::string &name, framework::Process &process)

void	configure (framework::config::Parameters &ps) override
	Callback for the EventProcessor to configure itself from the given set of parameters.

void	produce (framework::Event &event) override
	Process the event and put new data products into it.

ldmx::TrigScintTrack	makeTrack (Track outTrk)

Public Member Functions inherited from framework::Producer
	Producer (const std::string &name, Process &process)
	Class constructor.

virtual void	beforeNewRun (ldmx::RunHeader &header)
	Handle allowing producers to modify run headers before the run begins.

Public Member Functions inherited from framework::EventProcessor
	EventProcessor (const std::string &name, Process &process)
	Class constructor.

virtual	~EventProcessor ()
	Class destructor.

virtual void	onNewRun (const ldmx::RunHeader &runHeader)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.

virtual void	onFileOpen (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.

virtual void	onFileClose (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.

virtual void	onProcessStart ()
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.

virtual void	onProcessEnd ()
	Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

template<class T >
const T &	getCondition (const std::string &condition_name)
	Access a conditions object for the current event.

TDirectory *	getHistoDirectory ()
	Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.

void	setStorageHint (framework::StorageControl::Hint hint)
	Mark the current event as having the given storage control hint from this module.

void	setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
	Mark the current event as having the given storage control hint from this module and the given purpose string.

int	getLogFrequency () const
	Get the current logging frequency from the process.

int	getRunNumber () const
	Get the run number from the process.

std::string	getName () const
	Get the processor name.

void	createHistograms (const std::vector< framework::config::Parameters > &histos)
	Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.

Private Attributes
double	minThr_ {0.}
	add a hit at index idx to a cluster

int	verbose_ {0}

double	padTime_ {0.}

double	timeTolerance_ {0.}

std::string	output_collection_

std::string	digis1_collection_

std::string	digis2_collection_

std::string	digis3_collection_

std::vector< ldmx::TrigScintTrack >	tracks_

std::string	passName_ {""}

std::vector< unsigned int >	v_addedIndices_

std::vector< unsigned int >	v_usedIndices_

std::map< int, int >	hitChannelMap_

Additional Inherited Members
Static Public Member Functions inherited from framework::EventProcessor
static void	declare (const std::string &classname, int classtype, EventProcessorMaker *)
	Internal function which is part of the PluginFactory machinery.

Static Public Attributes inherited from framework::Producer
static const int	CLASSTYPE {1}
	Constant used to track EventProcessor types by the PluginFactory.

Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.

Protected Attributes inherited from framework::EventProcessor
HistogramHelper	histograms_
	Interface class for making and filling histograms.

NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.

logging::logger	theLog_
	The logger for this EventProcessor.

Detailed Description

Definition at line 27 of file TrigScintFirmwareTracker.h.

Constructor & Destructor Documentation

◆ TrigScintFirmwareTracker()

trigscint::TrigScintFirmwareTracker::TrigScintFirmwareTracker	(	const std::string &	name,
		framework::Process &	process )

inline

Definition at line 29 of file TrigScintFirmwareTracker.h.

30 : Producer(name, process) {}

framework::Producer::Producer

Producer(const std::string &name, Process &process)

Class constructor.

Definition EventProcessor.cxx:68

Member Function Documentation

◆ configure()

void trigscint::TrigScintFirmwareTracker::configure ( framework::config::Parameters & parameters )

overridevirtual

Callback for the EventProcessor to configure itself from the given set of parameters.

The parameters a processor has access to are the member variables of the python class in the sequence that has className equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 13 of file TrigScintFirmwareTracker.cxx.

                                                                      {
  minThr_ = ps.getParameter<double>("clustering_threshold");
  digis1_collection_ = ps.getParameter<std::string>("digis1_collection");
  digis2_collection_ = ps.getParameter<std::string>("digis2_collection");
  digis3_collection_ = ps.getParameter<std::string>("digis3_collection");
  passName_ = ps.getParameter<std::string>("input_pass_name");
  output_collection_ = ps.getParameter<std::string>("output_collection");
  verbose_ = ps.getParameter<int>("verbosity");
  timeTolerance_ = ps.getParameter<double>("time_tolerance");
  padTime_ = ps.getParameter<double>("pad_time");
 
  if (verbose_) {
    ldmx_log(info) << "In TrigScintFirmwareTracker: configure done!";
    ldmx_log(info) << "\nClustering threshold: " << minThr_
                   << "\nExpected pad hit time: " << padTime_
                   << "\nMax hit time delay: " << timeTolerance_
                   << "\ndigis1 collection:     " << digis1_collection_
                   << "\ndigis2 collection:     " << digis2_collection_
                   << "\ndigis3 collection:     " << digis3_collection_
                   << "\nInput pass name:     " << passName_
                   << "\nOutput collection:    " << output_collection_
                   << "\nVerbosity: " << verbose_;
  }
 
  return;
}

References minThr_.

◆ makeTrack()

ldmx::TrigScintTrack trigscint::TrigScintFirmwareTracker::makeTrack ( Track outTrk )

Definition at line 295 of file TrigScintFirmwareTracker.cxx.

                                                                   {
  // This takes a firmware track object and reverts it into an ldmx track
  // object, unfortunately only retaining that information of the track that is
  // retained in the firmware track.
  ldmx::TrigScintTrack tr;
  float pe{0.};
  pe += static_cast<float>(outTrk.Pad1.Seed.Amp) +
        static_cast<float>(outTrk.Pad1.Sec.Amp);
  pe += static_cast<float>(outTrk.Pad2.Seed.Amp) +
        static_cast<float>(outTrk.Pad2.Sec.Amp);
  pe += static_cast<float>(outTrk.Pad3.Seed.Amp) +
        static_cast<float>(outTrk.Pad3.Sec.Amp);
  tr.setCentroid(calcTCent(outTrk));
  calcResid(outTrk);
  tr.setPE(pe);
  return tr;
}

◆ produce()

void trigscint::TrigScintFirmwareTracker::produce ( framework::Event & event )

overridevirtual

Process the event and put new data products into it.

Parameters

event The Event to process.

Implements framework::Producer.

Definition at line 40 of file TrigScintFirmwareTracker.cxx.

                                                            {
  // This processor takes in TS digis and outputs a track collection. It does so
  // using clusterproducer_sw and trackproducer_hw, which are validated pieces
  // of HLS code (though clusterproducer_sw has had its instances of pragmas
  // excluded. I will comment on how clusterproducer and trackproducer work more
  // thouroughly in them respectively, but generally the clusterproducer makes
  // only two hit clusters (as ready that was all that was made from the
  // original sw) and does so by making a digi map and running along channels
  // numerically and pairing if possible. The trackproducer takes a LOOKUP array
  // as a LUT and does track pattern mathcing. This depends on alignment through
  // the A vector below.
 
  if (verbose_) {
    ldmx_log(debug)
        << "TrigScintFirmwareTracker: produce() starts! Event number: "
        << event.getEventHeader().getEventNumber();
  }
 
  // A is the mis-alignment vector
  ap_int<12> A[3] = {0, 0, 0};
  ap_int<12> LOOKUP[NCENT][COMBO][2];
 
  // Initialize the LOOKUP table to zero
  for (int i = 0; i < NCENT; ++i) {
    for (int j = 0; j < COMBO; ++j) {
      for (int k = 0; k < 2; ++k) {
        LOOKUP[i][j][k] = ap_int<12>(-1);
      }
    }
  }
 
  // This line fills in the LOOKUP table used for patter matching latter. The
  // array takes in as its first argument the centroid of a first pad cluster,
  // then the next two take on which track pattern (of ~9) we are matching to
  // and the last if we are matching to a cluster with two hits
  for (int i = 0; i < NCENT; i++) {
    for (int j = 0; j < COMBO; j++) {
      LOOKUP[i][j][0] = (i - A[1] + A[0]);
      LOOKUP[i][j][1] = (i - A[2] + A[0]);
      if (j / 3 == 0) {
        LOOKUP[i][j][0] -= 1;
      } else if (j / 3 == 2) {
        LOOKUP[i][j][0] += 1;
      }
      if (j % 3 == 0) {
        LOOKUP[i][j][1] -= 1;
      } else if (j % 3 == 2) {
        LOOKUP[i][j][1] += 1;
      }
      if (not((LOOKUP[i][j][0] >= 0) and (LOOKUP[i][j][1] >= 0) and
              (LOOKUP[i][j][0] < NCENT) and (LOOKUP[i][j][1] < NCENT))) {
        LOOKUP[i][j][0] = -1;
        LOOKUP[i][j][1] = -1;
      }
    }
  }
  // Here we instantiate arrays necessary to do the rest of it.
  Hit HPad1[NHITS];
  Hit HPad2[NHITS];
  Hit HPad3[NHITS];
 
  // Pad1 goes with NTRK bc of firmware bandwidth constraints
  // It is also expected on Pad1 to have 1 cluster per track
  Cluster Pad1[NTRK];
  Cluster Pad2[NCLUS];
  Cluster Pad3[NCLUS];
  Track outTrk[NTRK];
 
  for (int j = 0; j < NHITS; j++) {
    clearHit(HPad1[j]);
    clearHit(HPad2[j]);
    clearHit(HPad3[j]);
  }
  for (int j = 0; j < NCLUS; j++) {
    if (j < NTRK) {
      clearClus(Pad1[j]);
    }
    clearClus(Pad2[j]);
    clearClus(Pad3[j]);
  }
  for (int j = 0; j < NTRK; j++) {
    clearTrack(outTrk[j]);
  }
  // I am reading in the three digi collections
  const auto &digis1{
      event.getCollection<ldmx::TrigScintHit>(digis1_collection_, passName_)};
  const auto &digis2{
      event.getCollection<ldmx::TrigScintHit>(digis2_collection_, passName_)};
  const auto &digis3{
      event.getCollection<ldmx::TrigScintHit>(digis3_collection_, passName_)};
 
  if (verbose_) {
    ldmx_log(debug) << "Got digi collection " << digis1_collection_ << "_"
                    << passName_ << " with " << digis1.size() << " entries ";
  }
 
  // The next collection of things fill in the firmware hit objects from reading
  // in the digi collections the necessary information. The firmware hit objects
  // only keep bID,mID,Time, and PE count.
  int occupied[NCHAN];
  for (int i = 0; i < NCHAN; i++) {
    occupied[i] = -1;
  }
  int count = 0;
  for (const auto &digi : digis1) {
    if ((digi.getPE() > minThr_) and (digi.getBarID() <= NCHAN) and
        (digi.getBarID() >= 0)) {
      ap_int<12> bID = (ap_int<12>)(digi.getBarID());
      ap_int<12> Amp = (ap_int<12>)(digi.getPE());
      if (occupied[digi.getBarID()] >= 0) {
        if (HPad1[occupied[digi.getBarID()]].Amp < digi.getPE()) {
          HPad1[occupied[digi.getBarID()]].bID = (ap_int<12>)(digi.getBarID());
          HPad1[occupied[digi.getBarID()]].mID =
              (ap_int<12>)(digi.getModuleID());
          HPad1[occupied[digi.getBarID()]].Amp = (ap_int<12>)(digi.getPE());
          HPad1[occupied[digi.getBarID()]].Time = (ap_int<12>)(digi.getTime());
        }
      } else {
        HPad1[count].bID = (ap_int<12>)(digi.getBarID());
        HPad1[count].mID = (ap_int<12>)(digi.getModuleID());
        HPad1[count].Amp = (ap_int<12>)(digi.getPE());
        HPad1[count].Time = (ap_int<12>)(digi.getTime());
        occupied[digi.getBarID()] = count;
        count++;
      }
    }
  }
 
  for (int i = 0; i < NCHAN; i++) {
    occupied[i] = -1;
  }
  count = 0;
  for (const auto &digi : digis2) {
    if ((digi.getPE() > minThr_) and (digi.getBarID() <= NCHAN) and
        (digi.getBarID() >= 0)) {
      ap_int<12> bID = (ap_int<12>)(digi.getBarID());
      ap_int<12> Amp = (ap_int<12>)(digi.getPE());
      if (occupied[digi.getBarID()] >= 0) {
        if (HPad2[occupied[digi.getBarID()]].Amp < digi.getPE()) {
          HPad2[occupied[digi.getBarID()]].bID = (ap_int<12>)(digi.getBarID());
          HPad2[occupied[digi.getBarID()]].mID =
              (ap_int<12>)(digi.getModuleID());
          HPad2[occupied[digi.getBarID()]].Amp = (ap_int<12>)(digi.getPE());
          HPad2[occupied[digi.getBarID()]].Time = (ap_int<12>)(digi.getTime());
        }
      } else {
        HPad2[count].bID = (ap_int<12>)(digi.getBarID());
        HPad2[count].mID = (ap_int<12>)(digi.getModuleID());
        HPad2[count].Amp = (ap_int<12>)(digi.getPE());
        HPad2[count].Time = (ap_int<12>)(digi.getTime());
        occupied[digi.getBarID()] = count;
        count++;
      }
    }
  }
  for (int i = 0; i < NCHAN; i++) {
    occupied[i] = -1;
  }
  count = 0;
  for (const auto &digi : digis3) {
    if ((digi.getPE() > minThr_) and (digi.getBarID() <= NCHAN) and
        (digi.getBarID() >= 0)) {
      ap_int<12> bID = (ap_int<12>)(digi.getBarID());
      ap_int<12> Amp = (ap_int<12>)(digi.getPE());
      if (occupied[digi.getBarID()] >= 0) {
        if (HPad3[occupied[digi.getBarID()]].Amp < digi.getPE()) {
          HPad3[occupied[digi.getBarID()]].bID = (ap_int<12>)(digi.getBarID());
          HPad3[occupied[digi.getBarID()]].mID =
              (ap_int<12>)(digi.getModuleID());
          HPad3[occupied[digi.getBarID()]].Amp = (ap_int<12>)(digi.getPE());
          HPad3[occupied[digi.getBarID()]].Time = (ap_int<12>)(digi.getTime());
        }
      } else {
        HPad3[count].bID = (ap_int<12>)(digi.getBarID());
        HPad3[count].mID = (ap_int<12>)(digi.getModuleID());
        HPad3[count].Amp = (ap_int<12>)(digi.getPE());
        HPad3[count].Time = (ap_int<12>)(digi.getTime());
        occupied[digi.getBarID()] = count;
        count++;
      }
    }
  }
  // These next lines here calls clusterproducer_sw(HPad1), which is just the
  // validated firmware module. Since ap_* class is messy, I had to do some
  // post-call cleanup before looping over the clusters and putting them into
  // Point i which is feed into track producer
  int counterN = 0;
  std::array<Cluster, NCLUS> Point1 = clusterproducer_sw(HPad1);
  int topSeed = 0;
  for (int i = 0; i < NCLUS; i++) {
    if ((Point1[i].Seed.Amp < 450) and (Point1[i].Seed.Amp > 30) and
        (Point1[i].Seed.bID < (NCHAN + 1)) and (Point1[i].Seed.bID >= 0) and
        (Point1[i].Sec.Amp < 450) and (counterN < NTRK)) {
      if (Point1[i].Seed.bID >= topSeed) {
        cpyHit(Pad1[counterN].Seed, Point1[i].Seed);
        cpyHit(Pad1[counterN].Sec, Point1[i].Sec);
        calcCent(Pad1[counterN]);
        counterN++;
        topSeed = Point1[i].Seed.bID;
      }
    }
  }
  std::array<Cluster, NCLUS> Point2 = clusterproducer_sw(HPad2);
  topSeed = 0;
  for (int i = 0; i < NCLUS; i++) {
    if ((Point2[i].Seed.Amp < 450) and (Point2[i].Seed.Amp > 30) and
        (Point2[i].Seed.bID < (NCHAN + 1)) and (Point2[i].Seed.bID >= 0) and
        (Point2[i].Sec.Amp < 450)) {
      if (Point2[i].Seed.bID >= topSeed) {
        cpyHit(Pad2[i].Seed, Point2[i].Seed);
        cpyHit(Pad2[i].Sec, Point2[i].Sec);
        calcCent(Pad2[i]);
        topSeed = Point2[i].Seed.bID;
      }
    }
  }
  std::array<Cluster, NCLUS> Point3 = clusterproducer_sw(HPad3);
  topSeed = 0;
  for (int i = 0; i < NCLUS; i++) {
    if ((Point3[i].Seed.Amp < 450) and (Point3[i].Seed.Amp > 30) and
        (Point3[i].Seed.bID < (NCHAN + 1)) and (Point3[i].Seed.bID >= 0) and
        (Point3[i].Sec.Amp < 450)) {
      if (Point3[i].Seed.bID >= topSeed) {
        cpyHit(Pad3[i].Seed, Point3[i].Seed);
        cpyHit(Pad3[i].Sec, Point3[i].Sec);
        calcCent(Pad3[i]);
        topSeed = Point3[i].Seed.bID;
      }
    }
  }
  // I have stagged the digis into firmware digi objects and paired them into
  // firmware cluster objects, so at this point I can insert them and the LUT
  // into the trackproducer_hw to create the track collection I use makeTrack to
  // revert the firmware track object back into a regular track object for
  // analysis purposes
  //
  // NOTE: Pad1 has NTRK instead of NCLUS clusters for a reason: the firmware
  // cannot facilitate NCLUS many tracks within its alloted bandwidth , we have
  // to put a cut on them which is facilitated by a cut on the number of
  // clusters in Pad1. Do not change this.
  trackproducer_hw(Pad1, Pad2, Pad3, outTrk, LOOKUP);
  for (int I = 0; I < NTRK; I++) {
    if (outTrk[I].Pad1.Seed.Amp > 0. && outTrk[I].Pad1.Sec.Amp >= 0. &&
        outTrk[I].Pad2.Seed.Amp > 0. && outTrk[I].Pad2.Sec.Amp >= 0. &&
        outTrk[I].Pad3.Seed.Amp > 0. && outTrk[I].Pad3.Sec.Amp >= 0.) {
      ldmx::TrigScintTrack trk = makeTrack(outTrk[I]);
      tracks_.push_back(trk);
    }
  }
  event.add(output_collection_, tracks_);
  tracks_.resize(0);
 
  return;
}

References minThr_.

Member Data Documentation

◆ digis1_collection_

std::string trigscint::TrigScintFirmwareTracker::digis1_collection_

private

Definition at line 59 of file TrigScintFirmwareTracker.h.

◆ digis2_collection_

std::string trigscint::TrigScintFirmwareTracker::digis2_collection_

private

Definition at line 60 of file TrigScintFirmwareTracker.h.

◆ digis3_collection_

std::string trigscint::TrigScintFirmwareTracker::digis3_collection_

private

Definition at line 61 of file TrigScintFirmwareTracker.h.

◆ hitChannelMap_

std::map<int, int> trigscint::TrigScintFirmwareTracker::hitChannelMap_

private

Definition at line 75 of file TrigScintFirmwareTracker.h.

◆ minThr_

double trigscint::TrigScintFirmwareTracker::minThr_ {0.}

private

add a hit at index idx to a cluster

Definition at line 44 of file TrigScintFirmwareTracker.h.

44{0.};

Referenced by configure(), and produce().

◆ output_collection_

std::string trigscint::TrigScintFirmwareTracker::output_collection_

private

Definition at line 56 of file TrigScintFirmwareTracker.h.

◆ padTime_

double trigscint::TrigScintFirmwareTracker::padTime_ {0.}

private

Definition at line 50 of file TrigScintFirmwareTracker.h.

50{0.};

◆ passName_

std::string trigscint::TrigScintFirmwareTracker::passName_ {""}

private

Definition at line 66 of file TrigScintFirmwareTracker.h.

66{""};

◆ timeTolerance_

double trigscint::TrigScintFirmwareTracker::timeTolerance_ {0.}

private

Definition at line 53 of file TrigScintFirmwareTracker.h.

53{0.};

◆ tracks_

std::vector<ldmx::TrigScintTrack> trigscint::TrigScintFirmwareTracker::tracks_

private

Definition at line 63 of file TrigScintFirmwareTracker.h.

◆ v_addedIndices_

std::vector<unsigned int> trigscint::TrigScintFirmwareTracker::v_addedIndices_

private

Definition at line 69 of file TrigScintFirmwareTracker.h.

◆ v_usedIndices_

std::vector<unsigned int> trigscint::TrigScintFirmwareTracker::v_usedIndices_

private

Definition at line 72 of file TrigScintFirmwareTracker.h.

◆ verbose_

int trigscint::TrigScintFirmwareTracker::verbose_ {0}

private

Definition at line 47 of file TrigScintFirmwareTracker.h.

47{0};

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

TrigScint/include/TrigScint/TrigScintFirmwareTracker.h
TrigScint/src/TrigScint/TrigScintFirmwareTracker.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrigScintFirmwareTracker()

Member Function Documentation

◆ configure()

◆ makeTrack()

◆ produce()

Member Data Documentation

◆ digis1_collection_

◆ digis2_collection_

◆ digis3_collection_

◆ hitChannelMap_

◆ minThr_

◆ output_collection_

◆ padTime_

◆ passName_

◆ timeTolerance_

◆ tracks_

◆ v_addedIndices_

◆ v_usedIndices_

◆ verbose_