Classes
struct	Channel

Public Member Functions
	HcalPedestalAnalyzer (const std::string &n, framework::Process &p)

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

void	analyze (const framework::Event &event) override
	Process the event and make histograms or summaries.

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

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 Member Functions
void	createAndFill (Channel &chan, ldmx::HcalDigiID detid)

Private Attributes
std::string	input_name_

std::string	input_pass_

std::string	output_file_

std::string	comments_

bool	make_histos_

bool	filter_no_tot_

bool	filter_no_toa_

int	low_cutoff_

int	high_cutoff_

std::map< ldmx::HcalDigiID, Channel >	pedestal_data_

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

Definition at line 9 of file HcalPedestalAnalyzer.h.

Constructor & Destructor Documentation

◆ HcalPedestalAnalyzer()

hcal::HcalPedestalAnalyzer::HcalPedestalAnalyzer	(	const std::string &	n,
		framework::Process &	p )

inline

Definition at line 39 of file HcalPedestalAnalyzer.h.

40 : framework::Analyzer(n, p) {}

framework::Analyzer

Base class for a module which does not produce a data product.

Definition EventProcessor.h:294

Member Function Documentation

◆ analyze()

void hcal::HcalPedestalAnalyzer::analyze ( const framework::Event & event )

overridevirtual

Process the event and make histograms or summaries.

Parameters

event The Event to analyze

Implements framework::Analyzer.

Definition at line 8 of file HcalPedestalAnalyzer.cxx.

                                                              {
  auto const& digis{
      event.getObject<ldmx::HgcrocDigiCollection>(input_name_, input_pass_)};
 
  for (std::size_t i_digi{0}; i_digi < digis.size(); i_digi++) {
    auto d{digis.getDigi(i_digi)};
    ldmx::HcalDigiID detid(d.id());
 
    Channel& chan = pedestal_data_[detid];
 
    bool has_tot = false;
    bool has_toa = false;
    bool has_under = false;
    bool has_over = false;
 
    for (int i = 0; i < digis.getNumSamplesPerDigi(); i++) {
      if (d.at(i).tot() > 0) has_tot = true;
      if (d.at(i).toa() > 0) has_toa = true;
      if (d.at(i).adcT() < low_cutoff_) has_under = true;
      if (d.at(i).adcT() > high_cutoff_) has_over = true;
    }
 
    if (has_tot && filter_no_tot_) chan.rejects_[0]++;
    if (has_toa && filter_no_toa_) chan.rejects_[1]++;
    if (has_under) chan.rejects_[2]++;
    if (has_over) chan.rejects_[3]++;
 
    if (has_tot && filter_no_tot_) continue;  // ignore this
    if (has_toa && filter_no_toa_) continue;  // ignore this
    if (has_under)
      continue;  // ignore this, set threshold to zero to disable requirement
    if (has_over)
      continue;  // ignore this, set threshold larger than 1024 to disable
                 // requirement
 
    for (int i = 0; i < digis.getNumSamplesPerDigi(); i++) {
      int adc = d.at(i).adcT();
 
      chan.sum_ += adc;
      chan.sum_sq_ += adc * adc;
      chan.entries_++;
      if (chan.hist_)
        chan.hist_->Fill(adc);
      else if (make_histos_)
        chan.adcs_.push_back(adc);
    }
 
    // histogram-related business
    if (make_histos_ && !chan.hist_ && chan.entries_ > 250)
      createAndFill(chan, detid);
  }
}

References hcal::HcalPedestalAnalyzer::Channel::adcs_, hcal::HcalPedestalAnalyzer::Channel::entries_, hcal::HcalPedestalAnalyzer::Channel::hist_, hcal::HcalPedestalAnalyzer::Channel::rejects_, hcal::HcalPedestalAnalyzer::Channel::sum_, and hcal::HcalPedestalAnalyzer::Channel::sum_sq_.

◆ configure()

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

inlineoverridevirtual

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 43 of file HcalPedestalAnalyzer.h.

                                                         {
    input_name_ = ps.getParameter<std::string>("input_name");
    input_pass_ = ps.getParameter<std::string>("input_pass");
    output_file_ = ps.getParameter<std::string>("output_file");
    comments_ = ps.getParameter<std::string>("comments");
 
    make_histos_ = ps.getParameter<bool>("make_histos", false);
 
    filter_no_tot_ = ps.getParameter<bool>("filter_noTOT", true);
    filter_no_toa_ = ps.getParameter<bool>("filter_noTOA", true);
    low_cutoff_ = ps.getParameter<int>("low_cutoff", 10);
    high_cutoff_ = ps.getParameter<int>("high_cutoff", 512);
  }

◆ createAndFill()

void hcal::HcalPedestalAnalyzer::createAndFill	(	Channel &	chan,
		ldmx::HcalDigiID	detid )

private

Definition at line 61 of file HcalPedestalAnalyzer.cxx.

                                                               {
  if (chan.entries_ == 0) return;
 
  TDirectory* hdir = getHistoDirectory();
  hdir->cd();
  char hname[120];
  sprintf(hname, "pedestal_%d_%d_%d_%d", detid.section(), detid.layer(),
          detid.strip(), detid.end());
  // logic: 100 bins to +/- 5 sigma based on first 250 events.
  double mean = (chan.sum_ * 1.0) / chan.entries_;
  double rms = sqrt(chan.sum_sq_ / chan.entries_ - mean * mean);
  if (rms * 5 < 50)
    chan.hist_ = new TH1D(hname, hname, 30, int(mean) - 15, int(mean) + 15);
  else
    chan.hist_ = new TH1D(hname, hname, 100, mean - 5 * rms, mean + 5 * rms);
  for (auto x : chan.adcs_) chan.hist_->Fill(x);
  chan.adcs_.clear();
}

◆ onProcessEnd()

void hcal::HcalPedestalAnalyzer::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 81 of file HcalPedestalAnalyzer.cxx.

                                        {
  FILE* fout = fopen(output_file_.c_str(), "w");
 
  time_t t = time(NULL);
  struct tm* gmtm = gmtime(&t);
  char times[1024];
  strftime(times, sizeof(times), "%Y-%m-%d %H:%M:%S GMT", gmtm);
  fprintf(fout, "# %s\n", comments_.c_str());
  fprintf(fout, "# Produced %s\n", times);
  fprintf(fout, "DetID,PEDESTAL_ADC,PEDESTAL_RMS_ADC\n");
 
  for (auto ichan : pedestal_data_) {
    if (ichan.second.entries_ == 0) {
      std::cout << "All entries filtered for " << ichan.first << " for TOT "
                << ichan.second.rejects_[0] << " for TOA "
                << ichan.second.rejects_[1] << " for underthreshold "
                << ichan.second.rejects_[2] << " for overthreshold "
                << ichan.second.rejects_[3] << std::endl;
      continue;  // all entries were filtered out
    }
 
    double mean = ichan.second.sum_ * 1.0 / ichan.second.entries_;
    double rms =
        sqrt(ichan.second.sum_sq_ / ichan.second.entries_ - mean * mean);
    fprintf(fout, "0x%08x,%9.3f,%9.3f\n", ichan.first.raw(), mean, rms);
  }
 
  fclose(fout);
}

Member Data Documentation

◆ comments_

std::string hcal::HcalPedestalAnalyzer::comments_

private

Definition at line 11 of file HcalPedestalAnalyzer.h.

◆ filter_no_toa_

bool hcal::HcalPedestalAnalyzer::filter_no_toa_

private

Definition at line 14 of file HcalPedestalAnalyzer.h.

◆ filter_no_tot_

bool hcal::HcalPedestalAnalyzer::filter_no_tot_

private

Definition at line 13 of file HcalPedestalAnalyzer.h.

◆ high_cutoff_

int hcal::HcalPedestalAnalyzer::high_cutoff_

private

Definition at line 15 of file HcalPedestalAnalyzer.h.

◆ input_name_

std::string hcal::HcalPedestalAnalyzer::input_name_

private

Definition at line 10 of file HcalPedestalAnalyzer.h.

◆ input_pass_

std::string hcal::HcalPedestalAnalyzer::input_pass_

private

Definition at line 10 of file HcalPedestalAnalyzer.h.

◆ low_cutoff_

int hcal::HcalPedestalAnalyzer::low_cutoff_

private

Definition at line 15 of file HcalPedestalAnalyzer.h.

◆ make_histos_

bool hcal::HcalPedestalAnalyzer::make_histos_

private

Definition at line 12 of file HcalPedestalAnalyzer.h.

◆ output_file_

std::string hcal::HcalPedestalAnalyzer::output_file_

private

Definition at line 11 of file HcalPedestalAnalyzer.h.

◆ pedestal_data_

std::map<ldmx::HcalDigiID, Channel> hcal::HcalPedestalAnalyzer::pedestal_data_

private

Definition at line 34 of file HcalPedestalAnalyzer.h.

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

Hcal/include/Hcal/HcalPedestalAnalyzer.h
Hcal/src/Hcal/HcalPedestalAnalyzer.cxx

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HcalPedestalAnalyzer()

Member Function Documentation

◆ analyze()

◆ configure()

◆ createAndFill()

◆ onProcessEnd()

Member Data Documentation

◆ comments_

◆ filter_no_toa_

◆ filter_no_tot_

◆ high_cutoff_

◆ input_name_

◆ input_pass_

◆ low_cutoff_

◆ make_histos_

◆ output_file_

◆ pedestal_data_