dqm::HcalGeometryVerifier Class Reference

Public Member Functions
	HcalGeometryVerifier (const std::string &name, framework::Process &process)
void	configure (framework::config::Parameters &parameters) override
	Callback for the EventProcessor to configure itself from the given set of parameters.
std::array< int, 3 >	determineIndices (const ldmx::HcalID id)
bool	hitOk (const ldmx::HcalID id, const std::array< double, 3 > &position)
void	analyze (const framework::Event &event) 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	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
std::string	hcal_sim_hits_collection_ {"HcalSimHits"}
std::string	hcal_rec_hits_collection_ {"HcalRecHits"}
std::string	hcal_sim_hits_pass_name_ {""}
std::string	hcal_rec_hits_pass_name_ {""}
double	tolerance_ {}
bool	stop_on_error_ {}

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 17 of file HcalGeometryVerifier.h.

Constructor & Destructor Documentation

HcalGeometryVerifier()

dqm::HcalGeometryVerifier::HcalGeometryVerifier ( const std::string & name, framework::Process & process )

inline

Definition at line 19 of file HcalGeometryVerifier.h.

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

Member Function Documentation

analyze()

void dqm::HcalGeometryVerifier::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 13 of file HcalGeometryVerfifier.cxx.

                                                              {
  const auto hcal_sim_hits = event.getCollection<ldmx::SimCalorimeterHit>(
      hcal_sim_hits_collection_, hcal_sim_hits_pass_name_);
  const auto hcal_rec_hits = event.getCollection<ldmx::HcalHit>(
      hcal_rec_hits_collection_, hcal_rec_hits_pass_name_);
 
  for (const auto &hit : hcal_sim_hits) {
    const ldmx::HcalID id{static_cast<unsigned int>(hit.getID())};
    const auto position{hit.getPosition()};
    auto ok{hitOk(id, {position[0], position[1], position[2]})};
    histograms_.fill("passes_sim", ok);
    switch (id.section()) {
      case ldmx::HcalID::HcalSection::BACK:
        histograms_.fill("passes_sim_back", ok);
        break;
      case ldmx::HcalID::HcalSection::TOP:
        histograms_.fill("passes_sim_top", ok);
        break;
      case ldmx::HcalID::HcalSection::BOTTOM:
        histograms_.fill("passes_sim_bottom", ok);
        break;
      case ldmx::HcalID::HcalSection::LEFT:
        histograms_.fill("passes_sim_left", ok);
        break;
      case ldmx::HcalID::HcalSection::RIGHT:
        histograms_.fill("passes_sim_right", ok);
        break;
    }
  }
  for (const auto &hit : hcal_rec_hits) {
    const ldmx::HcalID id{static_cast<unsigned int>(hit.getID())};
    auto ok{hitOk(id, {hit.getXPos(), hit.getYPos(), hit.getZPos()})};
    histograms_.fill("passes_rec", ok);
    switch (id.section()) {
      case ldmx::HcalID::HcalSection::BACK:
        histograms_.fill("passes_rec_back", ok);
        break;
      case ldmx::HcalID::HcalSection::TOP:
        histograms_.fill("passes_rec_top", ok);
        break;
      case ldmx::HcalID::HcalSection::BOTTOM:
        histograms_.fill("passes_rec_bottom", ok);
        break;
      case ldmx::HcalID::HcalSection::LEFT:
        histograms_.fill("passes_rec_left", ok);
        break;
      case ldmx::HcalID::HcalSection::RIGHT:
        histograms_.fill("passes_rec_right", ok);
        break;
    }
  }
 
}  // Analyze

References framework::HistogramPool::fill(), and framework::EventProcessor::histograms_.

configure()

void dqm::HcalGeometryVerifier::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 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 4 of file HcalGeometryVerfifier.cxx.

                                           {
  hcal_sim_hits_collection_ = parameters.get<std::string>("sim_coll_name");
  hcal_rec_hits_collection_ = parameters.get<std::string>("rec_coll_name");
  hcal_sim_hits_pass_name_ = parameters.get<std::string>("sim_pass_name");
  hcal_rec_hits_pass_name_ = parameters.get<std::string>("rec_pass_name");
  stop_on_error_ = parameters.get<bool>("stop_on_error");
  tolerance_ = parameters.get<double>("tolerance_");
}

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

determineIndices()

std::array< int, 3 > dqm::HcalGeometryVerifier::determineIndices

(

const ldmx::HcalID

id

)

Definition at line 125 of file HcalGeometryVerfifier.cxx.

                         {
  const auto &geometry = getCondition<ldmx::HcalGeometry>(
      ldmx::HcalGeometry::CONDITIONS_OBJECT_NAME);
  const auto orientation{geometry.getScintillatorOrientation(id)};
  const auto is_lr{id.section() == ldmx::HcalID::HcalSection::LEFT ||
                   id.section() == ldmx::HcalID::HcalSection::RIGHT};
 
  int index_along{};
  int index_across{};
  int index_through{};
  if (id.section() == ldmx::HcalID::HcalSection::BACK) {
    index_through = 2;  // z
    if (orientation ==
        ldmx::HcalGeometry::ScintillatorOrientation::horizontal) {
      index_along = 0;   // x
      index_across = 1;  // y
    } else {
      index_across = 0;  // x
      index_along = 1;   // y
    }
  } else if (geometry.hasSide3DReadout()) {
    switch (orientation) {
      case ldmx::HcalGeometry::ScintillatorOrientation::horizontal:
        index_across = 2;   // z
        index_along = 0;    // x
        index_through = 1;  // y
        // Horizontal bar in side hcal -> x length, z width, y thick
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::vertical:
        // Vertical bar in side hcal -> y length, z width, x thick
        index_across = 2;   // z
        index_along = 1;    // y
        index_through = 0;  // x
        break;
      case ldmx::HcalGeometry::ScintillatorOrientation::depth:
        index_along = 2;  // z
        if (is_lr) {
          // Depth bar in side hcal (LR) -> z length, x thick, y width
          index_through = 0;  // x
          index_across = 1;   // y
        } else {
          // Depth bar in side hcal (TB) -> z length, y thick, x width
          index_through = 1;  // y
          index_across = 0;   // x
        }
        break;
    }
  } else {
    // v12 Side hcal
    index_across = 2;  // z
    if (orientation ==
        ldmx::HcalGeometry::ScintillatorOrientation::horizontal) {
      index_along = 0;    // x
      index_through = 1;  // y
    } else {
      index_along = 1;    // y
      index_through = 0;  // x
    }
  }
  return {index_along, index_across, index_through};
}

hitOk()

bool dqm::HcalGeometryVerifier::hitOk	(	const ldmx::HcalID	id,
		const std::array< double, 3 > &	position )

Definition at line 66 of file HcalGeometryVerfifier.cxx.

                                                                      {
  const auto &geometry = getCondition<ldmx::HcalGeometry>(
      ldmx::HcalGeometry::CONDITIONS_OBJECT_NAME);
  auto [index_along, index_across, index_through]{determineIndices(id)};
  const auto center_vec = geometry.getStripCenterPosition(id);
  const std::array<double, 3> center{center_vec.X(), center_vec.Y(),
                                     center_vec.Z()};
  const auto length{geometry.getScintillatorLength(id)};
  bool outside_bounds_along{
      std::abs(position[index_along] - center[index_along]) >
      length / 2 + tolerance_};
 
  const auto width{geometry.getScintillatorWidth()};
  bool outside_bounds_across{
      std::abs(position[index_across] - center[index_across]) >
      width / 2 + tolerance_};
 
  const auto thickness{geometry.getScintillatorThickness()};
  bool outside_bounds_through{
      std::abs(position[index_through] - center[index_through]) >
      thickness / 2 + tolerance_};
 
  if (outside_bounds_along || outside_bounds_across || outside_bounds_through) {
    std::stringstream ss;
    if (tolerance_ < 1) {
      // Assume tolerance_ is of form 1e-N
      //
      // Set precision so it will be clear if it is a floating point precision
      // issue or a problem
      ss.precision(-std::log10(tolerance_) + 1);
    }
    ss << std::boolalpha;
    double x{position[0]};
    double y{position[1]};
    double z{position[2]};
    ss << id << " has hit position at (" << x << ", " << y << ", " << z
       << ")\nwhich is not within the bounds of the Hcal strip center ("
       << center[0] << ", " << center[1] << ", " << center[2]
       << ") with tolerance_ " << tolerance_ << std::endl;
    ss << "Position along the bar: " << position[index_along] << " outside "
       << center[index_along] << " +- " << length / 2 << "? "
       << outside_bounds_along << std::endl;
    ss << "Position across the bar: " << position[index_across] << " outside "
       << center[index_across] << " +- " << width / 2 << "? "
       << outside_bounds_across << std::endl;
    ss << "Position through the bar: " << position[index_through] << " outside "
       << center[index_through] << " +- " << thickness / 2 << "? "
       << outside_bounds_through << std::endl;
 
    if (stop_on_error_) {
      EXCEPTION_RAISE("InvalidPosition", ss.str());
    } else {
      ldmx_log(warn) << ss.str();
    }
    return false;
  }
  return true;
}

Member Data Documentation

hcal_rec_hits_collection_

std::string dqm::HcalGeometryVerifier::hcal_rec_hits_collection_ {"HcalRecHits"}

private

Definition at line 47 of file HcalGeometryVerifier.h.

{"HcalRecHits"};

hcal_rec_hits_pass_name_

std::string dqm::HcalGeometryVerifier::hcal_rec_hits_pass_name_ {""}

private

Definition at line 49 of file HcalGeometryVerifier.h.

{""};

hcal_sim_hits_collection_

std::string dqm::HcalGeometryVerifier::hcal_sim_hits_collection_ {"HcalSimHits"}

private

Definition at line 46 of file HcalGeometryVerifier.h.

{"HcalSimHits"};

hcal_sim_hits_pass_name_

std::string dqm::HcalGeometryVerifier::hcal_sim_hits_pass_name_ {""}

private

Definition at line 48 of file HcalGeometryVerifier.h.

{""};

stop_on_error_

bool dqm::HcalGeometryVerifier::stop_on_error_ {}

private

Definition at line 54 of file HcalGeometryVerifier.h.

{};

tolerance_

double dqm::HcalGeometryVerifier::tolerance_ {}

private

Definition at line 53 of file HcalGeometryVerifier.h.

{};

---

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

• DQM/include/DQM/HcalGeometryVerifier.h
• DQM/src/DQM/HcalGeometryVerfifier.cxx