ecal::test::EcalCheckEnergyReconstruction Class Reference

Checks. More...

Public Member Functions
	EcalCheckEnergyReconstruction (const std::string &name, framework::Process &p)
void	configure (framework::config::Parameters &parameters) final override
	Callback for the EventProcessor to configure itself from the given set of parameters.
void	onProcessStart () final override
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
void	analyze (const framework::Event &event) final override
	Process the event and make histograms or summaries.
Public Member Functions inherited from framework::Analyzer
	Analyzer (const std::string &name, Process &process)
	Class constructor.
virtual void	process (Event &event) final
	Processing an event for an Analyzer is calling analyze.
virtual void	beforeNewRun (ldmx::RunHeader &run_header) final
	Don't allow Analyzers to add parameters to the run header.
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	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.
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
std::string	ecal_simhits_passname_
std::string	ecal_digis_passname_
std::string	ecal_rechits_passname_
std::string	ecal_trig_digis_passname_
bool	check_trig_prim_

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

Checks.

• Amplitude of EcalRecHit matches SimCalorimeterHit EDep with the same ID
• Estimated energy at TP level matches sim energy

Assumptions

• Max one sim hit per event
• Noise generation has been turned off

Definition at line 244 of file EcalDigiPipelineTest.cxx.

Constructor & Destructor Documentation

EcalCheckEnergyReconstruction()

ecal::test::EcalCheckEnergyReconstruction::EcalCheckEnergyReconstruction ( const std::string & name, framework::Process & p )

inline

Definition at line 253 of file EcalDigiPipelineTest.cxx.

      : framework::Analyzer(name, p) {}

~EcalCheckEnergyReconstruction()

ecal::test::EcalCheckEnergyReconstruction::~EcalCheckEnergyReconstruction ( )

inline

Definition at line 255 of file EcalDigiPipelineTest.cxx.

{}

Member Function Documentation

analyze()

void ecal::test::EcalCheckEnergyReconstruction::analyze ( const framework::Event & event )

inlinefinaloverridevirtual

Process the event and make histograms or summaries.

Parameters

event

The Event to analyze

Implements framework::Analyzer.

Definition at line 286 of file EcalDigiPipelineTest.cxx.

                                                           {
    const auto sim_hits = event.getCollection<ldmx::SimCalorimeterHit>(
        "EcalSimHits", ecal_simhits_passname_);
 
    REQUIRE(sim_hits.size() == 1);
 
    float truth_energy = sim_hits.at(0).getEdep();
    ntuple_.setVar<float>("SimEnergy", truth_energy);
 
    const auto daq_digis{event.getObject<ldmx::HgcrocDigiCollection>(
        "EcalDigis", ecal_digis_passname_)};
 
    if (daq_digis.getNumDigis() == 1) {
      auto daq_digi = daq_digis.getDigi(0);
      ntuple_.setVar<int>("DaqDigi", daq_digi.soi().raw());
      bool is_in_adc_mode = daq_digi.isADC();
      ntuple_.setVar<int>("DaqDigiIsADC", is_in_adc_mode);
      ntuple_.setVar<int>("DaqDigiADC", daq_digi.soi().adcT());
      ntuple_.setVar<int>("DaqDigiTOT", daq_digi.tot());
 
      // arrival time of the hit at the chip, helpful when the failure
      // depends on where in the readout window the pulse lands
      INFO("sim hit arrival time = " << sim_hits.at(0).getContrib(0).time_
                                     << " ns");
      INFO("digi is " << (is_in_adc_mode ? "ADC" : "TOT") << " mode");
 
      const auto rec_hits = event.getCollection<ldmx::EcalHit>(
          "EcalRecHits", ecal_rechits_passname_);
      CHECK(rec_hits.size() == 1);
      // a hit that was read out but not reconstructed has nothing left
      // for us to check, keep going so that all events are checked
      if (rec_hits.size() != 1) return;
 
      auto hit = rec_hits.at(0);
      ldmx::EcalID id(hit.getID());
      CHECK_FALSE(hit.isNoise());
      CHECK(id.raw() == sim_hits.at(0).getID());
 
      double daq_energy{hit.getAmplitude()};
      CHECK_THAT(daq_energy, IsCloseEnough(truth_energy, MAX_ENERGY_ERROR_DAQ,
                                           MAX_ENERGY_PERCENT_ERROR_DAQ));
      ntuple_.setVar<float>("RecEnergy", hit.getAmplitude());
 
      if (not check_trig_prim_) return;
 
      const auto trig_digis{event.getObject<ldmx::HgcrocTrigDigiCollection>(
          "ecalTrigDigis", ecal_trig_digis_passname_)};
      CHECK(trig_digis.size() == 1);
 
      auto trig_digi = trig_digis.at(0);
      float tp_energy =
          8 * trig_digi.linearPrimitive() * 320. / 1024 * MEV_PER_FC;
 
      CHECK_THAT(tp_energy, IsCloseEnough(truth_energy, MAX_ENERGY_ERROR_TP,
                                          MAX_ENERGY_PERCENT_ERROR_TP));
      ntuple_.setVar<float>("TrigPrimEnergy", tp_energy);
      ntuple_.setVar<int>("TrigPrimDigiEncoded", trig_digi.getPrimitive());
      ntuple_.setVar<int>("TrigPrimDigiLinear", trig_digi.linearPrimitive());
    }
 
    return;
  }

References framework::EventProcessor::ntuple_, and framework::NtupleManager::setVar().

configure()

void ecal::test::EcalCheckEnergyReconstruction::configure ( framework::config::Parameters & parameters )

inlinefinaloverridevirtual

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 257 of file EcalDigiPipelineTest.cxx.

                                                                       {
    // the trigger primitives are an in-time, single-sample estimate,
    // so they are not expected to see out-of-time hits
    check_trig_prim_ = parameters.get<bool>("check_trig_prim", true);
    ecal_simhits_passname_ =
        parameters.get<std::string>("ecal_simhits_passname", "");
    ecal_digis_passname_ =
        parameters.get<std::string>("ecal_digis_passname", "");
    ecal_rechits_passname_ =
        parameters.get<std::string>("ecal_rechits_passname", "");
    ecal_trig_digis_passname_ =
        parameters.get<std::string>("ecal_trig_digis_passname", "");
  }

onProcessStart()

void ecal::test::EcalCheckEnergyReconstruction::onProcessStart ( )

inlinefinaloverridevirtual

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 271 of file EcalDigiPipelineTest.cxx.

                                       {
    getHistoDirectory();
    ntuple_.create("EcalDigiTest");
    ntuple_.addVar<float>("EcalDigiTest", "SimEnergy");
    ntuple_.addVar<float>("EcalDigiTest", "RecEnergy");
    ntuple_.addVar<float>("EcalDigiTest", "TrigPrimEnergy");
 
    ntuple_.addVar<int>("EcalDigiTest", "DaqDigi");
    ntuple_.addVar<int>("EcalDigiTest", "DaqDigiIsADC");
    ntuple_.addVar<int>("EcalDigiTest", "DaqDigiADC");
    ntuple_.addVar<int>("EcalDigiTest", "DaqDigiTOT");
    ntuple_.addVar<int>("EcalDigiTest", "TrigPrimDigiEncoded");
    ntuple_.addVar<int>("EcalDigiTest", "TrigPrimDigiLinear");
  }

References framework::NtupleManager::addVar(), framework::NtupleManager::create(), framework::EventProcessor::getHistoDirectory(), and framework::EventProcessor::ntuple_.

Member Data Documentation

check_trig_prim_

bool ecal::test::EcalCheckEnergyReconstruction::check_trig_prim_

private

Definition at line 250 of file EcalDigiPipelineTest.cxx.

ecal_digis_passname_

std::string ecal::test::EcalCheckEnergyReconstruction::ecal_digis_passname_

private

Definition at line 247 of file EcalDigiPipelineTest.cxx.

ecal_rechits_passname_

std::string ecal::test::EcalCheckEnergyReconstruction::ecal_rechits_passname_

private

Definition at line 248 of file EcalDigiPipelineTest.cxx.

ecal_simhits_passname_

std::string ecal::test::EcalCheckEnergyReconstruction::ecal_simhits_passname_

private

Definition at line 246 of file EcalDigiPipelineTest.cxx.

ecal_trig_digis_passname_

std::string ecal::test::EcalCheckEnergyReconstruction::ecal_trig_digis_passname_

private

Definition at line 249 of file EcalDigiPipelineTest.cxx.

---

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

• Ecal/test/EcalDigiPipelineTest.cxx