CaloCellsCounterCPU Class Reference

Outputs counts of cells, both by type and cluster presence, with each cluster being identified by its cell with the largest signal-to-noise ratio. More...

#include <CaloCellsCounterCPU.h>

Inheritance diagram for CaloCellsCounterCPU:

Collaboration diagram for CaloCellsCounterCPU:

Public Member Functions
	CaloCellsCounterCPU (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *cluster_collection) const override
virtual	~CaloCellsCounterCPU ()=default
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.

Private Attributes
Gaudi::Property< std::string >	m_savePath {this, "SavePath", "./cell_counts", "Path to where the files should be saved"}
	The path specifying the folder to which the files should be saved.
Gaudi::Property< std::string >	m_filePrefix {this, "FilePrefix", "", "Prefix of the saved files"}
	The prefix of the saved files.
Gaudi::Property< std::string >	m_fileSuffix {this, "FileSuffix", "", "Suffix of the saved files"}
	The suffix of the saved files.
Gaudi::Property< unsigned int >	m_numWidth {this, "NumberWidth", 9, "The number of digits to reserve for the events"}
	The number of digits to reserve for the events.
SG::ReadHandleKey< CaloCellContainer >	m_cellsKey {this, "CellsName", "", "Name(s) of Cell Containers"}
	vector of names of the cell containers to use as input.
SG::ReadCondHandleKey< CaloNoise >	m_noiseCDOKey {this, "CaloNoiseKey", "totalNoise", "SG Key of CaloNoise data object"}
	Key of the CaloNoise Conditions data object.
Gaudi::Property< float >	m_seedThreshold {this, "SeedThresholdOnEorAbsEinSigma", 4., "Seed threshold (in units of noise Sigma)"}
	Value to consider for the seed threshold.
Gaudi::Property< float >	m_growThreshold {this, "NeighborThresholdOnEorAbsEinSigma", 2., "Neighbor (grow) threshold (in units of noise Sigma)"}
	Value to consider for the seed threshold.
Gaudi::Property< float >	m_cellThreshold {this, "CellThresholdOnEorAbsEinSigma", 0., "Cell (terminal) threshold (in units of noise Sigma)"}
	Value to consider for the seed threshold.
const CaloCell_ID *	m_calo_id {nullptr}
	Pointer to Calo ID Helper.

Detailed Description

Outputs counts of cells, both by type and cluster presence, with each cluster being identified by its cell with the largest signal-to-noise ratio.

Author

Nuno Fernandes nuno..nosp@m.dos..nosp@m.santo.nosp@m.s.fe.nosp@m.rnand.nosp@m.es@c.nosp@m.ern.c.nosp@m.h

Date

20 July 2022

Definition at line 27 of file CaloCellsCounterCPU.h.

Constructor & Destructor Documentation

CaloCellsCounterCPU()

CaloCellsCounterCPU::CaloCellsCounterCPU	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 17 of file CaloCellsCounterCPU.cxx.

                                                                                                                 :
  base_class(type, name, parent)
{
}

~CaloCellsCounterCPU()

virtual CaloCellsCounterCPU::~CaloCellsCounterCPU ( )

virtualdefault

Member Function Documentation

execute() [1/2]

StatusCode CaloCellsCounterCPU::execute ( const EventContext & ctx, xAOD::CaloClusterContainer * cluster_collection ) const

overridevirtual

Definition at line 60 of file CaloCellsCounterCPU.cxx.

{
 
  SG::ReadHandle<CaloCellContainer> cell_collection(m_cellsKey, ctx);
  if ( !cell_collection.isValid() )
    {
      ATH_MSG_ERROR( " Cannot retrieve CaloCellContainer: " << cell_collection.name()  );
      return StatusCode::FAILURE;
    }
 
 
  SG::ReadCondHandle<CaloNoise> noise_handle(m_noiseCDOKey, ctx);
  const CaloNoise * noise_tool = *noise_handle;
 
  unsigned int gain_counts[GainConversion::num_gain_values()] = {0};
 
  size_struct global_counts, global_cluster_counts;
 
  for (CaloCellContainer::const_iterator iCells = cell_collection->begin(); iCells != cell_collection->end(); ++iCells)
    {
      const CaloCell * cell = (*iCells);
 
      const float energy = cell->energy();
 
      float SNR = energy / noise_tool->getNoise(m_calo_id->calo_cell_hash(cell->ID()), cell->gain());
 
      const unsigned int gain = GainConversion::from_standard_gain(cell->gain());
 
      ++gain_counts[gain - GainConversion::min_gain_value()];
 
      SNR = std::abs(SNR);
 
      if (SNR > m_seedThreshold)
        {
          ++global_counts.seed;
        }
      else if (SNR > m_growThreshold)
        {
          ++global_counts.grow;
        }
      else if (SNR > m_cellThreshold)
        {
          ++global_counts.term;
        }
      else
        {
          ++global_counts.invalid;
        }
    }
 
  struct cluster_cell_info
  {
    const xAOD::CaloCluster * cl_1 = nullptr, * cl_2 = nullptr;
    double w_1 = -1, w_2 = -1, energy = -9e99, SNR = -9e99;
    void add_cluster(const int cell_id, const xAOD::CaloCluster * cl, const double w)
    {
      if (cl_1 == nullptr)
        {
          cl_1 = cl;
          w_1 = w;
        }
      else if (cl_2 == nullptr)
        {
          cl_2 = cl;
          w_2 = w;
        }
      else
        {
          std::cout << "WARNING! Multiple shared cell: " << cell_id << " " << cl_1 << " " << cl_2 << " " << cl << std::endl;
        }
    }
 
    bool is_shared() const
    {
      return cl_1 != nullptr && cl_2 != nullptr;
    }
 
  };
 
  std::map<int, cluster_cell_info> cluster_cells;
 
 
  for (const xAOD::CaloCluster * cluster : *cluster_collection)
    {
      //const xAOD::CaloCluster * cluster = (*cluster_iter);
      const CaloClusterCellLink * cell_links = cluster->getCellLinks();
      if (!cell_links)
        {
          ATH_MSG_ERROR("Can't get valid links to CaloCells (CaloClusterCellLink)!");
          return StatusCode::FAILURE;
        }
 
      for (auto it = cell_links->begin(); it != cell_links->end(); ++it)
        {
          const CaloCell * cell = *it;
          const float weight = it.weight();
 
          const float this_energy = std::abs(cell->energy());
 
          const float this_snr = std::abs(this_energy / noise_tool->getNoise(m_calo_id->calo_cell_hash(cell->ID()), cell->gain()));
 
          const IdentifierHash this_hash = m_calo_id->calo_cell_hash(cell->ID());
 
          auto & info = cluster_cells[this_hash];
 
          info.energy = this_energy;
          info.SNR = this_snr;
 
          info.add_cluster(this_hash, cluster, weight);
 
        }
    }
 
  std::unordered_map<const xAOD::CaloCluster *, cluster_info_struct> cluster_sizes;
 
  auto update_clusters = [&](const cluster_cell_info & cci, const int cell)
  {
    auto update_one = [&](const xAOD::CaloCluster * cl)
    {
      if (cl)
        {
          auto & c_info = cluster_sizes[cl];
          ++c_info.size.total;
          if (cci.SNR > m_seedThreshold)
            {
              ++c_info.size.seed;
            }
          else if (cci.SNR > m_growThreshold)
            {
              ++c_info.size.grow;
            }
          else if (cci.SNR > m_cellThreshold)
            {
              ++c_info.size.term;
            }
          else
            {
              ++c_info.size.invalid;
            }
 
          if (cci.is_shared())
            {
              ++c_info.size.shared;
            }
          else
            {
              if (cci.SNR > c_info.seed_snr || (cci.SNR == c_info.seed_snr && cell > c_info.seed_index))
                {
                  c_info.seed_index = cell;
                  c_info.seed_snr = cci.SNR;
                  c_info.seed_energy = cci.energy;
                }
            }
        }
    };
 
    if (cci.cl_1 != nullptr || cci.cl_2 != nullptr)
      {
        ++global_cluster_counts.total;
        if (cci.SNR > m_seedThreshold)
          {
            ++global_cluster_counts.seed;
          }
        else if (cci.SNR > m_growThreshold)
          {
            ++global_cluster_counts.grow;
          }
        else if (cci.SNR > m_cellThreshold)
          {
            ++global_cluster_counts.term;
          }
        else
          {
            ++global_cluster_counts.invalid;
          }
        if (cci.is_shared())
          {
            ++global_cluster_counts.shared;
          }
      }
 
    update_one(cci.cl_1);
    update_one(cci.cl_2);
  };
 
  for (auto & it : cluster_cells)
    {
      update_clusters(it.second, it.first);
    }
 
  std::vector<cluster_info_struct> sorted_info;
 
  sorted_info.reserve(cluster_sizes.size());
 
  for (auto & v : cluster_sizes)
    {
      sorted_info.push_back(v.second);
    }
 
  std::sort(sorted_info.begin(), sorted_info.end(),
            [](const auto & a, const auto & b)
  {
    return a.seed_index < b.seed_index;
  });
 
 
  const auto err1 = StandaloneDataIO::prepare_folder_for_output(std::string(m_savePath));
  if (err1 != StandaloneDataIO::ErrorState::OK)
    {
      return StatusCode::FAILURE;
    }
 
  const std::filesystem::path save_file = m_savePath + "/" + StandaloneDataIO::build_filename((m_filePrefix.size() > 0 ? m_filePrefix + "_counts" : "counts"),
                                                                                                ctx.evt(), m_fileSuffix, "txt", m_numWidth);
 
  std::ofstream out_file(save_file);
 
  if (!out_file.is_open())
    {
      return StatusCode::FAILURE;
    }
 
  out_file << "Cell counts: " << global_counts << "\n\n";
 
  out_file << "Cells in clusters count: " << global_cluster_counts << "\n\n";
  out_file << "Clusters:\n\n";
 
  for (const auto & info : sorted_info)
    {
      out_file << info << "\n";
    }
 
  out_file << std::endl;
 
  if (!out_file.good())
    {
      return StatusCode::FAILURE;
    }
 
  out_file.close();
 
  return StatusCode::SUCCESS;
 
}

execute() [2/2]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinal

Execute on an entire collection of clusters.

Parameters

collection

The container of clusters. (deprecated)

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

initialize()

StatusCode CaloCellsCounterCPU::initialize ( )

overridevirtual

Definition at line 23 of file CaloCellsCounterCPU.cxx.

{
  ATH_CHECK( m_noiseCDOKey.initialize() );
  ATH_CHECK( m_cellsKey.initialize() );
  ATH_CHECK( detStore()->retrieve(m_calo_id, "CaloCell_ID") );
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_calo_id

const CaloCell_ID* CaloCellsCounterCPU::m_calo_id {nullptr}

private

Pointer to Calo ID Helper.

Definition at line 96 of file CaloCellsCounterCPU.h.

{nullptr};

m_cellsKey

SG::ReadHandleKey<CaloCellContainer> CaloCellsCounterCPU::m_cellsKey {this, "CellsName", "", "Name(s) of Cell Containers"}

private

vector of names of the cell containers to use as input.

Definition at line 69 of file CaloCellsCounterCPU.h.

{this, "CellsName", "", "Name(s) of Cell Containers"};

m_cellThreshold

Gaudi::Property<float> CaloCellsCounterCPU::m_cellThreshold {this, "CellThresholdOnEorAbsEinSigma", 0., "Cell (terminal) threshold (in units of noise Sigma)"}

private

Value to consider for the seed threshold.

Should be consistent with the one used in Topological Clustering to ensure cell classification is correct.

Definition at line 89 of file CaloCellsCounterCPU.h.

{this, "CellThresholdOnEorAbsEinSigma", 0., "Cell (terminal) threshold (in units of noise Sigma)"};

m_filePrefix

Gaudi::Property<std::string> CaloCellsCounterCPU::m_filePrefix {this, "FilePrefix", "", "Prefix of the saved files"}

private

The prefix of the saved files.

Empty string by default.

Definition at line 54 of file CaloCellsCounterCPU.h.

{this, "FilePrefix", "", "Prefix of the saved files"};

m_fileSuffix

Gaudi::Property<std::string> CaloCellsCounterCPU::m_fileSuffix {this, "FileSuffix", "", "Suffix of the saved files"}

private

The suffix of the saved files.

Empty string by default.

Definition at line 59 of file CaloCellsCounterCPU.h.

{this, "FileSuffix", "", "Suffix of the saved files"};

m_growThreshold

Gaudi::Property<float> CaloCellsCounterCPU::m_growThreshold {this, "NeighborThresholdOnEorAbsEinSigma", 2., "Neighbor (grow) threshold (in units of noise Sigma)"}

private

Value to consider for the seed threshold.

Should be consistent with the one used in Topological Clustering to ensure cell classification is correct.

Definition at line 84 of file CaloCellsCounterCPU.h.

{this, "NeighborThresholdOnEorAbsEinSigma", 2., "Neighbor (grow) threshold (in units of noise Sigma)"};

m_noiseCDOKey

SG::ReadCondHandleKey<CaloNoise> CaloCellsCounterCPU::m_noiseCDOKey {this, "CaloNoiseKey", "totalNoise", "SG Key of CaloNoise data object"}

private

Key of the CaloNoise Conditions data object.

Typical values are '"electronicNoise', 'pileupNoise', or '"totalNoise' (default)

Definition at line 74 of file CaloCellsCounterCPU.h.

{this, "CaloNoiseKey", "totalNoise", "SG Key of CaloNoise data object"};

m_numWidth

Gaudi::Property<unsigned int> CaloCellsCounterCPU::m_numWidth {this, "NumberWidth", 9, "The number of digits to reserve for the events"}

private

The number of digits to reserve for the events.

9 by default.

Definition at line 64 of file CaloCellsCounterCPU.h.

{this, "NumberWidth", 9, "The number of digits to reserve for the events"};

m_savePath

Gaudi::Property<std::string> CaloCellsCounterCPU::m_savePath {this, "SavePath", "./cell_counts", "Path to where the files should be saved"}

private

The path specifying the folder to which the files should be saved.

Default ./cell_counts

Definition at line 49 of file CaloCellsCounterCPU.h.

{this, "SavePath", "./cell_counts", "Path to where the files should be saved"};

m_seedThreshold

Gaudi::Property<float> CaloCellsCounterCPU::m_seedThreshold {this, "SeedThresholdOnEorAbsEinSigma", 4., "Seed threshold (in units of noise Sigma)"}

private

Value to consider for the seed threshold.

Should be consistent with the one used in Topological Clustering to ensure cell classification is correct.

Definition at line 79 of file CaloCellsCounterCPU.h.

{this, "SeedThresholdOnEorAbsEinSigma", 4., "Seed threshold (in units of noise Sigma)"};

---

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

• CaloCellsCounterCPU.h
• CaloCellsCounterCPU.cxx