Public Member Functions
	HcalVetoProcessor (const std::string &name, framework::Process &process)
	Constructor.

virtual	~HcalVetoProcessor ()=default
	Destructor.

void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.

void	produce (framework::Event &event) override
	Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.

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	totalPEThreshold_ {5}
	Total PE threshold.

float	maxTime_ {50}
	Maximum hit time that should be considered by the veto.

float	backMinPE_ {1}
	The minimum number of PE in both bars needed for a hit to be considered in double ended readout mode.

ldmx::HcalHit	defaultMaxHit_

std::string	outputCollName_

std::string	inputHitCollName_

std::string	inputHitPassName_

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 25 of file HcalVetoProcessor.h.

Constructor & Destructor Documentation

◆ HcalVetoProcessor()

hcal::HcalVetoProcessor::HcalVetoProcessor	(	const std::string &	name,
		framework::Process &	process
	)

Constructor.

Definition at line 16 of file HcalVetoProcessor.cxx.

18 : Producer(name, process) {}

framework::Producer::Producer

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

Class constructor.

Definition EventProcessor.cxx:68

Member Function Documentation

◆ configure()

void hcal::HcalVetoProcessor::configure ( framework::config::Parameters & parameters )

overridevirtual

Configure the processor using the given user specified parameters.

Parameters

parameters Set of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 20 of file HcalVetoProcessor.cxx.

                                                                       {
  totalPEThreshold_ = parameters.getParameter<double>("pe_threshold");
  maxTime_ = parameters.getParameter<double>("max_time");
  outputCollName_ = parameters.getParameter<std::string>("output_coll_name");
  inputHitCollName_ =
      parameters.getParameter<std::string>("input_hit_coll_name");
  inputHitPassName_ =
      parameters.getParameter<std::string>("input_hit_pass_name");
  // A fake-hit that gets added for the rare case where no hit actually reaches
  // the maxPE < pe check to avoid producing uninitialized memory
  //
  // Default constructed hits have nonsense-but predictable values and are
  // harder to mistake for real hits
  defaultMaxHit_.Clear();
  defaultMaxHit_.setPE(-9999);
  defaultMaxHit_.setMinPE(-9999);
  defaultMaxHit_.setSection(-9999);
  defaultMaxHit_.setLayer(-9999);
  defaultMaxHit_.setStrip(-9999);
  defaultMaxHit_.setEnd(-999);
  defaultMaxHit_.setTimeDiff(-9999);
  defaultMaxHit_.setToaPos(-9999);
  defaultMaxHit_.setToaNeg(-9999);
  defaultMaxHit_.setAmplitudePos(-9999);
  defaultMaxHit_.setAmplitudeNeg(-9999);
 
  double maxDepth_ = parameters.getParameter<double>("max_depth", 0.);
  if (maxDepth_ != 0.) {
    EXCEPTION_RAISE(
        "InvalidParam",
        "Earlier versions of the Hcal veto defined a max depth for "
        "positions which is no longer implemented. Remove the "
        "parameter (max_depth) from your configuration. See "
        "https://github.com/LDMX-Software/Hcal/issues/61 for details");
  }
  backMinPE_ = parameters.getParameter<double>("back_min_pe");
}

References backMinPE_, ldmx::HcalHit::Clear(), framework::config::Parameters::getParameter(), maxTime_, ldmx::HcalHit::setAmplitudeNeg(), ldmx::HcalHit::setAmplitudePos(), ldmx::HcalHit::setEnd(), ldmx::HcalHit::setLayer(), ldmx::HcalHit::setMinPE(), ldmx::HcalHit::setPE(), ldmx::HcalHit::setSection(), ldmx::HcalHit::setStrip(), ldmx::HcalHit::setTimeDiff(), ldmx::HcalHit::setToaNeg(), ldmx::HcalHit::setToaPos(), and totalPEThreshold_.

◆ produce()

void hcal::HcalVetoProcessor::produce ( framework::Event & event )

overridevirtual

Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.

Parameters

event The event to process.

Implements framework::Producer.

Definition at line 58 of file HcalVetoProcessor.cxx.

                                                     {
  // Get the collection of sim particles from the event
  const std::vector<ldmx::HcalHit> hcalRecHits =
      event.getCollection<ldmx::HcalHit>(inputHitCollName_, inputHitPassName_);
 
  // Loop over all of the Hcal hits and calculate to total photoelectrons
  // in the event.
  [[maybe_unused]] float totalPe{0};
  float maxPE{-1000};
 
  const ldmx::HcalHit *maxPEHit{&defaultMaxHit_};
  for (const ldmx::HcalHit &hcalHit : hcalRecHits) {
    // If the hit time is outside the readout window, don't consider it.
    if (hcalHit.getTime() >= maxTime_) {
      continue;
    }
 
    // Get the total PE in the bar
    float pe = hcalHit.getPE();
 
    // Keep track of the total PE
    // TODO: This is currently not used anywhere
    totalPe += pe;
 
    // Check that both sides of the bar have a PE value above threshold.
    // If not, don't consider the hit.  Double sided readout is only
    // being used for the back HCal bars.  For the side HCal, just
    // use the maximum PE as before.
    ldmx::HcalID id(hcalHit.getID());
    if ((id.section() == ldmx::HcalID::BACK) &&
        (hcalHit.getMinPE() < backMinPE_))
      continue;
 
    // Find the maximum PE in the list
    if (maxPE < pe) {
      maxPE = pe;
      maxPEHit = &hcalHit;
    }
  }
 
  // If the maximum PE found is below threshold, it passes the veto.
  bool passesVeto = (maxPE < totalPEThreshold_);
 
  ldmx::HcalVetoResult result;
  result.setVetoResult(passesVeto);
  result.setMaxPEHit(*maxPEHit);
 
  if (passesVeto) {
    setStorageHint(framework::hint_shouldKeep);
  } else {
    setStorageHint(framework::hint_shouldDrop);
  }
 
  event.add(outputCollName_, result);
}

References backMinPE_, ldmx::HcalHit::getPE(), framework::hint_shouldDrop, framework::hint_shouldKeep, maxTime_, ldmx::HcalVetoResult::setMaxPEHit(), framework::EventProcessor::setStorageHint(), ldmx::HcalVetoResult::setVetoResult(), and totalPEThreshold_.

Member Data Documentation

◆ backMinPE_

float hcal::HcalVetoProcessor::backMinPE_ {1}

private

The minimum number of PE in both bars needed for a hit to be considered in double ended readout mode.

Definition at line 57 of file HcalVetoProcessor.h.

57{1};

Referenced by configure(), and produce().

◆ defaultMaxHit_

ldmx::HcalHit hcal::HcalVetoProcessor::defaultMaxHit_

private

Definition at line 74 of file HcalVetoProcessor.h.

◆ inputHitCollName_

std::string hcal::HcalVetoProcessor::inputHitCollName_

private

Definition at line 77 of file HcalVetoProcessor.h.

◆ inputHitPassName_

std::string hcal::HcalVetoProcessor::inputHitPassName_

private

Definition at line 78 of file HcalVetoProcessor.h.

◆ maxTime_

float hcal::HcalVetoProcessor::maxTime_ {50}

private

Maximum hit time that should be considered by the veto.

Definition at line 53 of file HcalVetoProcessor.h.

53{50}; // ns

Referenced by configure(), and produce().

◆ outputCollName_

std::string hcal::HcalVetoProcessor::outputCollName_

private

Definition at line 76 of file HcalVetoProcessor.h.

◆ totalPEThreshold_

double hcal::HcalVetoProcessor::totalPEThreshold_ {5}

private

Total PE threshold.

Definition at line 50 of file HcalVetoProcessor.h.

50{5};

Referenced by configure(), and produce().

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

Hcal/include/Hcal/HcalVetoProcessor.h
Hcal/src/Hcal/HcalVetoProcessor.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HcalVetoProcessor()

Member Function Documentation

◆ configure()

◆ produce()

Member Data Documentation

◆ backMinPE_

◆ defaultMaxHit_

◆ inputHitCollName_

◆ inputHitPassName_

◆ maxTime_

◆ outputCollName_

◆ totalPEThreshold_