ldmx::ecal::TrigPrimResolutionAnalyzer Class Reference

Analyze the trigger primitives by comparing them to the precision hits_. More...

Public Member Functions
	TrigPrimResolutionAnalyzer (const std::string &name, framework::Process &process)
void	configure (framework::config::Parameters &parameters) final
	Callback for the EventProcessor to configure itself from the given set of parameters.
void	onProcessStart () final
	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
	Process the event and make histograms or summaries.
double	calculateEnergy (int layer_, double amplitude)
	Calculate the energy deposited estimate from a hit's amplitude.
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	trig_collection_name_ = "ecalTrigDigis"
std::string	trig_pass_name_ = ""
std::string	hit_collection_name_ = "EcalRecHits"
std::string	hit_pass_name_ = ""
double	total_trigger_mean_ = 876.28120
double	total_ampl_mean_ = 48.805244
double	nominal_ {1.0}
double	second_order_energy_correction_ = 4000. / 3940.5
double	mip_si_energy_ = 0.13
std::vector< double >	layer_weights_

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

Analyze the trigger primitives by comparing them to the precision hits_.

This analyzer goes through and compares differents sums between the trigger primitive level (groups of 9 cells for the ECal) and the precision hit level (individual cells).

Definition at line 18 of file TrigPrimResolutionAnalyzer.cxx.

Constructor & Destructor Documentation

TrigPrimResolutionAnalyzer()

ldmx::ecal::TrigPrimResolutionAnalyzer::TrigPrimResolutionAnalyzer ( const std::string & name, framework::Process & process )

inline

Definition at line 35 of file TrigPrimResolutionAnalyzer.cxx.

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

Member Function Documentation

analyze()

void ldmx::ecal::TrigPrimResolutionAnalyzer::analyze ( const framework::Event & event )

finalvirtual

Process the event and make histograms or summaries.

Parameters

event

The Event to analyze

add this trigger primitive to module_ sums

Implements framework::Analyzer.

Definition at line 224 of file TrigPrimResolutionAnalyzer.cxx.

                                                                    {
  // called once on each event, get objects and fill histograms
  const auto& trigs = event.getCollection<ldmx::HgcrocTrigDigi>(
      trig_collection_name_, trig_pass_name_);
  // trigs are a std::vector<ldmx::HgcrocTrigDigi>
  const auto& hits =
      event.getCollection<ldmx::EcalHit>(hit_collection_name_, hit_pass_name_);
  // hits_ are a std::vector<ldmx::EcalHit>
  const ::ecal::EcalTriggerGeometry& geom =
      getCondition<::ecal::EcalTriggerGeometry>(
          ::ecal::EcalTriggerGeometry::CONDITIONS_OBJECT_NAME);
 
  std::map<UniqueModule, std::pair<int, double>> module_sums;
  int trig_prim_total{0};
  int trig_prim_total_first20{0};
  for (const auto& trig : trigs) {
    EcalTriggerID tid{trig.getId()};
    UniqueModule mod{tid};
    double trig_ampl = getEstimate(trig);
    double trig_energy = calculateEnergy(mod.layer_, trig_ampl) / nominal_;
 
    if (module_sums.find(mod) == module_sums.end()) {
      module_sums[mod] = {0, 0.0};
    }
 
    module_sums[mod].first += trig_energy;
    trig_prim_total += trig_energy;
    if (mod.layer_ <= 20) {
      trig_prim_total_first20 += trig_energy;
    }
 
    // calculate the sum of precision hits_ for the 9 cells in this
    // trigger grouping
    double trig_group_prec_total{0};
    double trig_group_prec_total_unweight{0};
    for (auto& prec_id : geom.contentsOfTriggerCell(tid)) {
      for (const auto& hit : hits) {
        if (prec_id == hit.getID()) {
          trig_group_prec_total +=
              calculateEnergy(mod.layer_, hit.getAmplitude());
          trig_group_prec_total_unweight += hit.getAmplitude();
        }
      }
    }
 
    // have trig_group_prec_total which is the sum of the precision hits_
    // in that trigger group and trig_ampl is the sum
    // as reported by the trigger itself
    double ratio_energy = trig_energy / trig_group_prec_total,
           ratio_ampl = trig_ampl / trig_group_prec_total_unweight / nominal_;
    histograms_.fill("trig_group", trig_group_prec_total);
    histograms_.fill("trig_group_trigger", trig_energy * nominal_);
    histograms_.fill("trig_group_v_trig", trig_group_prec_total,
                     trig_energy * nominal_);
    histograms_.fill("trig_group_ampl_v_ampl", trig_group_prec_total,
                     ratio_energy);
    histograms_.fill("trig_group_ampl_v_ampl_varbin", trig_group_prec_total,
                     ratio_energy);
    histograms_.fill("trig_group_ampl_v_ampl_varbin_fin", trig_group_prec_total,
                     ratio_energy);
    histograms_.fill("trig_group_ampl_unweight", trig_group_prec_total_unweight,
                     ratio_ampl);
  }
 
  double prec_ampl_total{0.};
  double prec_ampl_total_first20{0.};
  for (const auto& hit : hits) {
    EcalID id{static_cast<unsigned int>(hit.getID())};
    UniqueModule mod{id};
    if (module_sums.find(mod) == module_sums.end()) {
      module_sums[mod] = {0, 0.0};
    }
    double prec_energy = calculateEnergy(mod.layer_, hit.getAmplitude());
    module_sums[mod].second += prec_energy;
    prec_ampl_total += prec_energy;
    if (mod.layer_ <= 20) {
      prec_ampl_total_first20 += prec_energy;
    }
  }
 
  std::map<int, std::pair<int, double>> layer_sums;
  for (const auto& [unique_module, sum_pair] : module_sums) {
    if (layer_sums.find(unique_module.layer_) == layer_sums.end()) {
      // layer_ is not found in layer_sums map so start the sum at 0
      layer_sums[unique_module.layer_] = {0, 0.0};
    }
    // add this module_ total to running total for the layer_
    layer_sums[unique_module.layer_].first += sum_pair.first;
    layer_sums[unique_module.layer_].second += sum_pair.second;
  }
 
  int layer_id_tmp = {0};
  int module_id_tmp = {0};
  for (const auto& [mod_id, sum_pair] : module_sums) {
    /*    std::cout << " layer_ id " << mod_id.layer_ << " mod id " <<
     * mod_id.module_ << std::endl; */
    layer_id_tmp = mod_id.layer_;
    module_id_tmp = mod_id.module_;
    histograms_.fill("layer_id", layer_id_tmp);
    histograms_.fill("module_id", module_id_tmp);
    histograms_.fill("trig_sum_per_module", sum_pair.first);
    histograms_.fill("ampl_sum_per_module", sum_pair.second);
    histograms_.fill("trig_v_ampl_module", sum_pair.second, sum_pair.first);
    histograms_.fill("trig_ampl_v_ampl", sum_pair.second,
                     sum_pair.first / sum_pair.second);
    histograms_.fill("trig_ampl_v_ampl_binadjust", sum_pair.second,
                     sum_pair.first / sum_pair.second);
  }
 
  for (const auto& [layer_, layer_sum_pair] : layer_sums) {
    histograms_.fill("trig_sum_per_layer", layer_sum_pair.first);
    histograms_.fill("ampl_sum_per_layer", layer_sum_pair.second);
    histograms_.fill("trig_v_ampl_layer", layer_sum_pair.first,
                     layer_sum_pair.second);
    histograms_.fill("trig_ampl_v_ampl_layer", layer_sum_pair.second,
                     layer_sum_pair.first / layer_sum_pair.second);
  }
 
  histograms_.fill("total_trig_energy", trig_prim_total);
  histograms_.fill("total_ampl_energy", prec_ampl_total);
  histograms_.fill("total_trig_v_total_ampl", trig_prim_total, prec_ampl_total);
  histograms_.fill("trig_ampl_nominal", trig_prim_total / prec_ampl_total);
  histograms_.fill("trig_ampl_v_ampl_total", prec_ampl_total,
                   trig_prim_total / prec_ampl_total);
  histograms_.fill("trig_ampl_v_ampl_total_first20", prec_ampl_total_first20,
                   trig_prim_total_first20 / prec_ampl_total_first20);
}

References calculateEnergy(), framework::HistogramPool::fill(), framework::EventProcessor::getCondition(), ldmx::HgcrocTrigDigi::getId(), and framework::EventProcessor::histograms_.

calculateEnergy()

double ldmx::ecal::TrigPrimResolutionAnalyzer::calculateEnergy ( int layer_, double amplitude )

inline

Calculate the energy deposited estimate from a hit's amplitude.

We scale the amplitude by the layer_ weight with a few other factors.

Definition at line 48 of file TrigPrimResolutionAnalyzer.cxx.

                                                       {
    return (1 + layer_weights_[layer_] / mip_si_energy_) * amplitude *
           second_order_energy_correction_;
  }

Referenced by analyze().

configure()

void ldmx::ecal::TrigPrimResolutionAnalyzer::configure ( framework::config::Parameters & parameters )

finalvirtual

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 66 of file TrigPrimResolutionAnalyzer.cxx.

                                           {
  optional_update(trig_collection_name);
  optional_update(trig_pass_name);
  optional_update(hit_collection_name);
  optional_update(hit_pass_name);
  optional_update(total_trigger_mean);
  optional_update(total_ampl_mean);
  optional_update(second_order_energy_correction);
  optional_update(mip_si_energy);
  optional_update(layer_weights);
 
  // nominal scale separation between trigger and precision would be
  // determined experimentally by comparing their values
  // nominal_ = total_trigger_mean_ / total_ampl_mean_;
  // this has already been done so we just hardcode in the value
  // determined by Steven Metallo in 2024, but it can be updated
  // to use the ratio of the totals like above
  nominal_ = 18.14;
}

onProcessStart()

void ldmx::ecal::TrigPrimResolutionAnalyzer::onProcessStart ( )

finalvirtual

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 87 of file TrigPrimResolutionAnalyzer.cxx.

                                                {
  // variable bins
  std::vector<double> binsx = {0.,   10.,  20.,  30.,  40.,  50.,  60.,
                               70.,  80.,  90.,  100., 110., 120., 130.,
                               140., 150., 300., 575., 1000.};
  std::vector<double> binsy = {
      0.6,  0.608, 0.616, 0.624, 0.632, 0.64, 0.648, 0.656, 0.664, 0.672,
      0.68, 0.688, 0.696, 0.704, 0.712, 0.72, 0.728, 0.736, 0.744, 0.752,
      0.76, 0.768, 0.776, 0.784, 0.792, 0.8,  0.808, 0.816, 0.824, 0.832,
      0.84, 0.848, 0.856, 0.864, 0.872, 0.88, 0.888, 0.896, 0.904, 0.912,
      0.92, 0.928, 0.936, 0.944, 0.952, 0.96, 0.968, 0.976, 0.984, 0.992,
      1.,   1.008, 1.016, 1.024, 1.032, 1.04, 1.048, 1.056, 1.064, 1.072,
      1.08, 1.088, 1.096, 1.104, 1.112, 1.12, 1.128, 1.136, 1.144, 1.152,
      1.16, 1.168, 1.176, 1.184, 1.192, 1.2,  1.208, 1.216, 1.224, 1.232,
      1.24, 1.248, 1.256, 1.264, 1.272, 1.28, 1.288, 1.296, 1.304, 1.312,
      1.32, 1.328, 1.336, 1.344, 1.352, 1.36, 1.368, 1.376, 1.384, 1.392,
      1.4};
  std::vector<double> binsx_fin = {0.,  10., 20.,  30.,  40.,  50.,  60.,  70.,
                                   80., 90., 100., 150., 300., 575., 1000.};
 
  // initialize processing by making histograms and such
  // first, we get the directory for this processor in the histogram file
  getHistoDirectory();
  // then we can create histograms within it
  histograms_.create(
      "total_trig_energy" /* name - as written in output ROOT file */,
      "Total of all Trig Digis [MeV]" /* xlabel - axis label of histogram */,
      100 /* number of bins */, 0 /* minimum value */, 8000 /* maximum value */
  );
  histograms_.create("total_ampl_energy",
                     "Total of Precision Hit Amplitudes [MeV]", 100, 0, 8000);
  histograms_.create("total_trig_v_total_ampl", "Total of all Trig Digis [MeV]",
                     1000, 0, 8000, "Total of Precision Hit Amplitudes [MeV]",
                     100, 0, 8000);
  histograms_.create("trig_ampl_nominal", "Total trig / total ampl", 100, 0.85,
                     1.15);
  histograms_.create("module_id", "Module id", 7, 0, 7);
  histograms_.create("layer_id", "Layer id", 34, 0, 34);
  histograms_.create("trig_sum_per_module", "module_ trigger sum [MeV]", 100, 0,
                     2000);
  histograms_.create("ampl_sum_per_module", "module_ precision ampl sum [MeV]",
                     100, 0, 2000);
  histograms_.create("trig_v_ampl_module", "Module-sum full readout [MeV]", 100,
                     0, 2000, "Module-sum trigger [MeV]", 100, 0, 2000);
  histograms_.create("trig_sum_per_layer", "layer_ trigger sum [MeV]", 100, 0,
                     2000);
  histograms_.create("ampl_sum_per_layer", "layer_ precision ampl sum [MeV]",
                     100, 0, 2000);
  histograms_.create("trig_v_ampl_layer", "Layer trigger total [MeV]", 100, 0,
                     2500, "Layer ampl total [MeV]", 100, 0, 2500);
  histograms_.create("trig_ampl_v_ampl", "module_ precision ampl sum [MeV]",
                     100, 0, 1000, "module_ trigger / module_ precision ampl",
                     100, 0.4, 1.2);
  histograms_.create("trig_ampl_v_ampl_binadjust",
                     "module_ precision trig sum [MeV]", 100, 0, 2000,
                     "module_ trigger / module_ precision ampl", 100, 0.4, 1.2);
  histograms_.create("trig_ampl_v_ampl_layer",
                     "layer_ precision ampl sum [MeV]", 100, 0, 1000,
                     "layer_ trigger / layer_ precision ampl", 100, 0.4, 1.2);
  histograms_.create("trig_ampl_v_ampl_total", "total precision ampl sum [MeV]",
                     100, 0, 8000, "total trigger / total precision ampl", 100,
                     0.9, 1.1);
  histograms_.create("trig_ampl_v_ampl_total_first20", "Full readout sum [MeV]",
                     100, 0, 6000, "Trigger / Full readout", 100, 0.95, 1.05);
  histograms_.create("trig_group", "trigger group total precision hits_ [MeV]",
                     100, 0, 2000);
  histograms_.create("trig_group_trigger", "trigger group trigger [MeV]", 100,
                     0, 8000);
  histograms_.create("trig_group_v_trig",
                     "trigger group total precision hits_ [MeV]", 100, 0, 2000,
                     "trigger group trigger [MeV]", 100, 0, 8000);
  histograms_.create("trig_group_ampl_v_ampl",
                     "Trigger group full readout [MeV]", 100, 0, 1000,
                     "Trigger group ratio / nominal", 200, 0.6, 1.4);
  histograms_.create("trig_group_ampl_v_ampl_varbin",
                     "Trigger group full readout [MeV]", binsx,
                     "Trigger group ratio / nominal", binsy);
  histograms_.create("trig_group_ampl_unweight",
                     "unweighted trigger group total precision hits_ [MeV]",
                     100, 0, 20,
                     "trigger group trigger / unweighted trigger group total "
                     "prec hits_ / nominal",
                     200, 0.6, 1.4);
  histograms_.create("trig_group_ampl_v_ampl_varbin_fin",
                     "Trigger group full readout [MeV]", binsx_fin,
                     "Trigger group ratio / nominal", binsy);
}

References framework::HistogramPool::create(), framework::EventProcessor::getHistoDirectory(), and framework::EventProcessor::histograms_.

Member Data Documentation

hit_collection_name_

std::string ldmx::ecal::TrigPrimResolutionAnalyzer::hit_collection_name_ = "EcalRecHits"

private

Definition at line 21 of file TrigPrimResolutionAnalyzer.cxx.

hit_pass_name_

std::string ldmx::ecal::TrigPrimResolutionAnalyzer::hit_pass_name_ = ""

private

Definition at line 22 of file TrigPrimResolutionAnalyzer.cxx.

layer_weights_

std::vector<double> ldmx::ecal::TrigPrimResolutionAnalyzer::layer_weights_

private

Initial value:

= {
      2.312,  4.312,  6.522,  7.490,  8.595,  10.253, 10.915, 10.915, 10.915,
      10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915,
      10.915, 10.915, 10.915, 10.915, 10.915, 14.783, 18.539, 18.539, 18.539,
      18.539, 18.539, 18.539, 18.539, 18.539, 18.539, 9.938}

Definition at line 28 of file TrigPrimResolutionAnalyzer.cxx.

                                     {
      2.312,  4.312,  6.522,  7.490,  8.595,  10.253, 10.915, 10.915, 10.915,
      10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915, 10.915,
      10.915, 10.915, 10.915, 10.915, 10.915, 14.783, 18.539, 18.539, 18.539,
      18.539, 18.539, 18.539, 18.539, 18.539, 18.539, 9.938};

mip_si_energy_

double ldmx::ecal::TrigPrimResolutionAnalyzer::mip_si_energy_ = 0.13

private

Definition at line 27 of file TrigPrimResolutionAnalyzer.cxx.

nominal_

double ldmx::ecal::TrigPrimResolutionAnalyzer::nominal_ {1.0}

private

Definition at line 25 of file TrigPrimResolutionAnalyzer.cxx.

{1.0};

second_order_energy_correction_

double ldmx::ecal::TrigPrimResolutionAnalyzer::second_order_energy_correction_ = 4000. / 3940.5

private

Definition at line 26 of file TrigPrimResolutionAnalyzer.cxx.

total_ampl_mean_

double ldmx::ecal::TrigPrimResolutionAnalyzer::total_ampl_mean_ = 48.805244

private

Definition at line 24 of file TrigPrimResolutionAnalyzer.cxx.

total_trigger_mean_

double ldmx::ecal::TrigPrimResolutionAnalyzer::total_trigger_mean_ = 876.28120

private

Definition at line 23 of file TrigPrimResolutionAnalyzer.cxx.

trig_collection_name_

std::string ldmx::ecal::TrigPrimResolutionAnalyzer::trig_collection_name_ = "ecalTrigDigis"

private

Definition at line 19 of file TrigPrimResolutionAnalyzer.cxx.

trig_pass_name_

std::string ldmx::ecal::TrigPrimResolutionAnalyzer::trig_pass_name_ = ""

private

Definition at line 20 of file TrigPrimResolutionAnalyzer.cxx.

---

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

• Ecal/src/Ecal/TrigPrimResolutionAnalyzer.cxx