Fit a pulse shape to each SiStripWaveform and produce FittedSiStripHits. More...

#include <SiStripWaveformFitProcessor.h>

Public Member Functions
	SiStripWaveformFitProcessor (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	onProcessStart () override
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.

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

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

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

virtual void	process (Event &event) final
	Processing an event for a Producer is calling produce.

Public Member Functions inherited from framework::EventProcessor
	DECLARE_FACTORY (EventProcessor, EventProcessor *, const std::string &, Process &)
	declare that we have a factory for this class

	EventProcessor (const std::string &name, Process &process)
	Class constructor.

virtual	~EventProcessor ()=default
	Class destructor.

virtual void	beforeNewRun (ldmx::RunHeader &run_header)
	Callback for Producers to add parameters to the run header before conditions are initialized.

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

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

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

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
std::string	input_collection_ {"TrackerWaveforms"}

std::string	input_pass_name_ {""}

std::string	output_collection_ {"FittedSiStripHits"}

std::string	daq_map_file_ {""}

double	t_scan_min_ns_ {-50.0}

double	t_scan_max_ns_ {-1.0}

double	t_scan_step_ns_ {1.0}

double	max_chi2_ndf_ {-1.0}

TrackerDaqMap	daq_map_

std::unique_ptr< tracking::digitization::PulseShape >	pulse_shape_
	Pulse shape shared by every per-channel fitter (built in onProcessStart).

long	n_waveforms_ {0}
	waveforms seen

long	n_unmapped_ {0}
	skipped: (feb, hybrid) absent from the DAQ map

long	n_out_of_range_ {0}
	skipped: strip_id outside the sensor

long	n_fit_attempted_ {0}
	waveforms passed to the fitter

long	n_unconverged_ {0}
	skipped because the pulse fit did not converge

long	n_bad_chi2_ {0}
	skipped by the chi2/ndf cut

long	n_hits_ {0}
	emitted FittedSiStripHits

std::map< uint16_t, long >	unmapped_sensors_
	(feb, hybrid) pairs already warned about, so each is reported only once.

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

Protected Attributes inherited from framework::EventProcessor
HistogramPool	histograms_
	helper object for making and filling histograms

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

logging::logger	the_log_
	The logger for this EventProcessor.

Detailed Description

Fit a pulse shape to each SiStripWaveform and produce FittedSiStripHits.

This is the real-data counterpart of StripFitProcessor, and the bridge into the geometry-aware reconstruction.

Input : collection of ldmx::SiStripWaveform (pedestal-subtracted samples) Output : collection of ldmx::FittedSiStripHit

Configuration parameters

input_collection SiStripWaveform input collection. input_pass_name Pass name for the input collection. output_collection FittedSiStripHit output collection. daq_map_file Path to the DAQ map JSON (required). t_scan_min_ns Lower bound of the hit-time scan [ns] (default -50). t_scan_max_ns Upper bound of the hit-time scan [ns]; <= 0 means auto, i.e. n_samples * sampling interval (default -1). t_scan_step_ns Step size of the coarse scan [ns] (default 1). max_chi2_ndf If > 0, discard fits with chi2/ndf above this value (default -1 = off).

Definition at line 35 of file SiStripWaveformFitProcessor.h.

Constructor & Destructor Documentation

◆ SiStripWaveformFitProcessor()

tracking::reco::SiStripWaveformFitProcessor::SiStripWaveformFitProcessor	(	const std::string &	name,
		framework::Process &	process )

inline

Definition at line 37 of file SiStripWaveformFitProcessor.h.

39 : framework::Producer(name, process) {}

framework::Producer

Base class for a module which produces a data product.

Definition EventProcessor.h:257

framework::Producer::process

virtual void process(Event &event) final

Processing an event for a Producer is calling produce.

Definition EventProcessor.h:278

Member Function Documentation

◆ configure()

void tracking::reco::SiStripWaveformFitProcessor::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 class_name 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 SiStripWaveformFitProcessor.cxx.

                                                                         {
  input_collection_ =
      ps.get<std::string>("input_collection", input_collection_);
  input_pass_name_ = ps.get<std::string>("input_pass_name", input_pass_name_);
  output_collection_ =
      ps.get<std::string>("output_collection", output_collection_);
  daq_map_file_ = ps.get<std::string>("daq_map_file", daq_map_file_);
 
  t_scan_min_ns_ = ps.get<double>("t_scan_min_ns", t_scan_min_ns_);
  t_scan_max_ns_ = ps.get<double>("t_scan_max_ns", t_scan_max_ns_);
  t_scan_step_ns_ = ps.get<double>("t_scan_step_ns", t_scan_step_ns_);
  max_chi2_ndf_ = ps.get<double>("max_chi2_ndf", max_chi2_ndf_);
}

References framework::config::Parameters::get().

◆ onProcessEnd()

void tracking::reco::SiStripWaveformFitProcessor::onProcessEnd ( )

overridevirtual

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

Reimplemented from framework::EventProcessor.

Definition at line 157 of file SiStripWaveformFitProcessor.cxx.

                                               {
  const long n_converged = n_fit_attempted_ - n_unconverged_;
  const double fail_pct =
      n_fit_attempted_ > 0
          ? 100.0 * static_cast<double>(n_unconverged_) / n_fit_attempted_
          : 0.0;
  ldmx_log(info) << "Fit summary: " << n_fit_attempted_ << " attempted, "
                 << n_converged << " converged, " << n_unconverged_
                 << " failed (" << fail_pct << "%)";
  ldmx_log(info) << "SiStripWaveformFitProcessor summary: " << n_waveforms_
                 << " waveforms -> " << n_hits_ << " hits (" << n_unmapped_
                 << " unmapped, " << n_out_of_range_ << " out-of-range, "
                 << n_unconverged_ << " unconverged, " << n_bad_chi2_
                 << " bad chi2/ndf)";
  for (const auto& [k, n] : unmapped_sensors_) {
    ldmx_log(warn) << "  unmapped feb=" << (k >> 8) << " hybrid=" << (k & 0xFF)
                   << ": " << n << " waveforms dropped";
  }
}

References n_bad_chi2_, n_fit_attempted_, n_hits_, n_out_of_range_, n_unconverged_, n_unmapped_, n_waveforms_, and unmapped_sensors_.

◆ onProcessStart()

void tracking::reco::SiStripWaveformFitProcessor::onProcessStart ( )

overridevirtual

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

Reimplemented from framework::EventProcessor.

Definition at line 27 of file SiStripWaveformFitProcessor.cxx.

                                                 {
  using namespace tracking::digitization;
 
  if (daq_map_file_.empty()) {
    EXCEPTION_RAISE("BadConfig",
                    "SiStripWaveformFitProcessor requires a daq_map_file.");
  }
  // Loads eagerly so a missing/malformed map fails here, at start-up, with the
  // path in the message -- never as a silently empty event stream.
  daq_map_ = TrackerDaqMap::fromJsonFile(daq_map_file_);
 
  pulse_shape_ = PulseShape::make(std::string(PULSE_SHAPE_NAME),
                                  PEAKING_TIME_NS, SECOND_TIME_CONST_NS);
 
  ldmx_log(info) << "SiStripWaveformFitProcessor configured:"
                 << "  daq_map='" << daq_map_file_ << "' (" << daq_map_.size()
                 << " sensors)" << "  shape=" << PULSE_SHAPE_NAME
                 << "  tp=" << PEAKING_TIME_NS << " ns" << "  T scan ["
                 << t_scan_min_ns_ << ", "
                 << (t_scan_max_ns_ > 0.0 ? std::to_string(t_scan_max_ns_)
                                          : std::string("auto"))
                 << "] ns" << "  step=" << t_scan_step_ns_ << " ns";
}

References tracking::reco::TrackerDaqMap::fromJsonFile(), pulse_shape_, and tracking::reco::TrackerDaqMap::size().

◆ produce()

void tracking::reco::SiStripWaveformFitProcessor::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 51 of file SiStripWaveformFitProcessor.cxx.

                                                               {
  using namespace tracking::digitization;
 
  const auto& peds =
      getCondition<TrackerPedestals>(TrackerPedestals::CONDITIONS_NAME);
 
  const auto& waveforms = event.getCollection<ldmx::SiStripWaveform>(
      input_collection_, input_pass_name_);
 
  std::vector<ldmx::FittedSiStripHit> hits;
  hits.reserve(waveforms.size());
 
  for (const auto& wf : waveforms) {
    ++n_waveforms_;
 
    // -----------------------------------------------------------------------
    // Address first: an unmapped hybrid or an unbonded channel is dropped
    // before paying for the fit.
    // -----------------------------------------------------------------------
    const uint8_t feb = wf.getFebId();
    const uint8_t hybrid = wf.getHybridId();
 
    if (!daq_map_.has(feb, hybrid)) {
      ++n_unmapped_;
      const uint16_t k =
          static_cast<uint16_t>((static_cast<uint16_t>(feb) << 8) | hybrid);
      if (unmapped_sensors_[k]++ == 0) {
        ldmx_log(warn) << "No DAQ-map entry for feb=" << static_cast<int>(feb)
                       << " hybrid=" << static_cast<int>(hybrid)
                       << " -- dropping its waveforms (reported once)";
      }
      continue;
    }
 
    const auto& sensor = daq_map_.at(feb, hybrid);
    const int16_t pchannel = wf.getPchannel();
    const int strip_id = channelmap::stripId(
        pchannel, sensor.n_strips_, sensor.first_strip_, sensor.reversed_);
 
    // Reject channels that fall outside the bonded strip range (e.g. a read-out
    // but unbonded APV).  Counted so an unexpected layout shows up loudly.
    if (strip_id < sensor.first_strip_ ||
        strip_id >= sensor.first_strip_ + sensor.n_strips_) {
      ++n_out_of_range_;
      continue;
    }
 
    // -----------------------------------------------------------------------
    // Fit.  The noise enters the chi2, so the fitter is per channel; it is a
    // cheap value type over a shared pulse shape.
    // -----------------------------------------------------------------------
    uint8_t apv_id, channel;
    channelmap::apvChannelFromPchannel(pchannel, apv_id, channel);
    const float noise = peds.noise(feb, hybrid, apv_id, channel);
 
    const auto& samples = wf.getSamples();
    const int n_samples = static_cast<int>(samples.size());
    // Samples are pedestal-subtracted and lie on a uniform grid measured from
    // sample 0, so T may peak anywhere from before sample 0 to the last sample.
    const double t_scan_max = (t_scan_max_ns_ > 0.0)
                                  ? t_scan_max_ns_
                                  : n_samples * SAMPLING_INTERVAL_NS;
 
    StripPulseFitter fitter(*pulse_shape_,
                            /*t0_offset_ns=*/0.0, SAMPLING_INTERVAL_NS,
                            /*pedestal_adc=*/0.0,
                            /*noise_sigma_adc=*/noise, t_scan_min_ns_,
                            t_scan_max, t_scan_step_ns_);
    const auto fit = fitter.fit(samples);
    ++n_fit_attempted_;
 
    ldmx_log(trace) << "fit feb=" << static_cast<int>(feb)
                    << " hyb=" << static_cast<int>(hybrid)
                    << " pch=" << pchannel << " nsamp=" << n_samples
                    << " noise=" << noise
                    << " -> converged=" << (fit.converged ? "yes" : "no")
                    << " amp=" << fit.amplitude << " t0=" << fit.t0 << "ns"
                    << " chi2/ndf=" << fit.chi2 << "/" << fit.ndf << " ("
                    << (fit.ndf > 0 ? fit.chi2 / fit.ndf : 0.0) << ")";
 
    if (!fit.converged) {
      ++n_unconverged_;
      continue;
    }
 
    if (max_chi2_ndf_ > 0.0 && fit.ndf > 0) {
      if (fit.chi2 / fit.ndf > max_chi2_ndf_) {
        ++n_bad_chi2_;
        continue;
      }
    }
 
    hits.emplace_back(
        sensor.layer_id_, strip_id, static_cast<float>(fit.amplitude),
        static_cast<float>(fit.t0), static_cast<float>(fit.chi2), fit.ndf,
        /*track_id=*/-1, /*pdg_id=*/0, /*sim_hit_id=*/-1,
        /*edep=*/0.f, noise);
    ++n_hits_;
  }
 
  ldmx_log(debug) << "Produced " << hits.size() << " FittedSiStripHits from "
                  << waveforms.size() << " waveforms";
 
  event.add(output_collection_, hits);
}