CaloGPUOutput Class Reference

Standard tool to output the GPU data representation to the non-standard file format that we have been using for plotting and validation purposes. More...

#include <CaloGPUOutput.h>

Inheritance diagram for CaloGPUOutput:

Collaboration diagram for CaloGPUOutput:

Public Member Functions
	CaloGPUOutput (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	execute (const EventContext &ctx, const CaloRecGPU::ConstantDataHolder &constant_data, CaloRecGPU::EventDataHolder &event_data, void *temporary_buffer) const override
virtual	~CaloGPUOutput ()=default

Private Attributes
Gaudi::Property< std::string >	m_savePath {this, "SavePath", "./saved_clusters", "Path to where the files should be saved"}
	The path specifying the folder to which the files should be saved. More...
Gaudi::Property< std::string >	m_filePrefix {this, "FilePrefix", "", "Prefix of the saved files"}
	The prefix of the saved files. More...
Gaudi::Property< std::string >	m_fileSuffix {this, "FileSuffix", "", "Suffix of the saved files"}
	The suffix of the saved files. More...
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. More...
Gaudi::Property< bool >	m_sortedAndCutClusters {this, "UseSortedAndCutClusters", true, "Sort the clusters by transverse energy, apply a cut and ensure contiguous tags"}
	If true, sort the clusters by transverse energy and compactify the tags to ensure sequentiality. More...
Gaudi::Property< bool >	m_onlyCellInfo {this, "OnlyOutputCellInfo", false, "Only output cell info"}
	If true, only output cell info (useful for reducing disk usage when running the full standalone version of the algorithms). More...
std::atomic< bool >	m_constantDataSaved
	A flag to signal that the constant data has been adequately saved. More...
std::mutex	m_mutex
	This mutex is locked when saving the constant data on the first event to ensure thread safety. More...

Detailed Description

Standard tool to output the GPU data representation to the non-standard file format that we have been using for plotting and validation purposes.

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

30 May 2022 There are likely more elegant/general/generic/portable solutions, some of which might even avoid Root too, but our workflow was built around this one...

Definition at line 27 of file CaloGPUOutput.h.

Constructor & Destructor Documentation

CaloGPUOutput()

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

Definition at line 15 of file CaloGPUOutput.cxx.

                                                                                                     :
  base_class(type, name, parent),
  m_constantDataSaved(false)
{
}

~CaloGPUOutput()

virtual CaloGPUOutput::~CaloGPUOutput ( )

virtualdefault

Member Function Documentation

execute()

StatusCode CaloGPUOutput::execute ( const EventContext &  ctx, const CaloRecGPU::ConstantDataHolder &  constant_data, CaloRecGPU::EventDataHolder &  event_data, void *  temporary_buffer  ) const

overridevirtual

Definition at line 21 of file CaloGPUOutput.cxx.

{
  if (!m_constantDataSaved.load())
    {
      std::lock_guard<std::mutex> lock_guard(m_mutex);
      if (!m_constantDataSaved.load())
        {
          const auto err1 = StandaloneDataIO::save_constants_to_folder(std::string(m_savePath), constant_data.m_geometry_dev,
                                                                       constant_data.m_cell_noise_dev, m_filePrefix, m_fileSuffix);
          if (err1 != StandaloneDataIO::ErrorState::OK)
            {
              return StatusCode::FAILURE;
            }
          m_constantDataSaved.store(true);
        }
    }
 
  Helpers::CPU_object<CellInfoArr> cell_info(event_data.m_cell_info_dev);
 
  if (m_onlyCellInfo)
    {
      const auto err2 = StandaloneDataIO::save_cell_info_to_folder(ctx.evt(), std::string(m_savePath), cell_info, m_filePrefix, m_fileSuffix, m_numWidth);
 
      if (err2 != StandaloneDataIO::ErrorState::OK)
        {
          return StatusCode::FAILURE;
        }
 
      return StatusCode::SUCCESS;
    }
 
 
  Helpers::CPU_object<CellStateArr> cell_state(event_data.m_cell_state_dev);
  Helpers::CPU_object<ClusterInfoArr> clusters(event_data.m_clusters_dev);
 
  std::unordered_map<int, int> tag_map;
 
  if (m_sortedAndCutClusters)
    {
      std::vector<int> cluster_order(clusters->number);
 
      std::iota(cluster_order.begin(), cluster_order.end(), 0);
 
      std::sort(cluster_order.begin(), cluster_order.end(), [&](const int a, const int b)
      {
        if (clusters->seedCellID[a] < 0)
          {
            return false;
            //This means that clusters with no cells
            //(marked as invalid) always compare lower,
            //so they appear in the end.
          }
        else if (clusters->seedCellID[b] < 0)
          {
            return true;
          }
        return clusters->clusterEt[a] > clusters->clusterEt[b];
      } );
 
      int real_cluster_numbers = clusters->number;
 
      for (size_t i = 0; i < cluster_order.size(); ++i)
        {
          const int this_id = cluster_order[i];
          if (clusters->seedCellID[this_id] < 0)
            {
              tag_map[this_id] = -1;
              --real_cluster_numbers;
            }
          else
            {
              tag_map[this_id] = i;
            }
        }
 
      const Helpers::CPU_object<ClusterInfoArr> temp_clusters(clusters);
 
      clusters->number = real_cluster_numbers;
 
      for (int i = 0; i < temp_clusters->number; ++i)
        {
          clusters->clusterEnergy[i] = temp_clusters->clusterEnergy[cluster_order[i]];
          clusters->clusterEt[i] = temp_clusters->clusterEt[cluster_order[i]];
          clusters->clusterEta[i] = temp_clusters->clusterEta[cluster_order[i]];
          clusters->clusterPhi[i] = temp_clusters->clusterPhi[cluster_order[i]];
          clusters->seedCellID[i] = temp_clusters->seedCellID[cluster_order[i]];
        }
 
    }
  size_t shared_count = 0;
  for (int i = 0; i < NCaloCells; ++i)
    {
      if (!cell_info->is_valid(i))
        {
          continue;
        }
      const ClusterTag this_tag = cell_state->clusterTag[i];
      if (!this_tag.is_part_of_cluster())
        {
          cell_state->clusterTag[i] = ClusterTag::make_invalid_tag();
        }
      else if (this_tag.is_part_of_cluster() && m_sortedAndCutClusters)
        {
          const int old_idx = this_tag.cluster_index();
          const int new_idx = tag_map[old_idx];
          const int old_idx2 = this_tag.is_shared_between_clusters() ? this_tag.secondary_cluster_index() : -1;
          const int new_idx2 = old_idx2 >= 0 ? tag_map[old_idx2] : -1;
          if (new_idx < 0 && new_idx2 < 0)
            {
              cell_state->clusterTag[i] = ClusterTag::make_invalid_tag();
            }
          else if (new_idx < 0)
            {
              cell_state->clusterTag[i] = ClusterTag::make_tag(new_idx2);
            }
          else if (new_idx2 < 0)
            {
              cell_state->clusterTag[i] = ClusterTag::make_tag(new_idx);
            }
          else
            {
              ++shared_count;
              cell_state->clusterTag[i] = ClusterTag::make_tag(new_idx, this_tag.secondary_cluster_weight(), new_idx2);
            }
        }
    }
 
 
  ATH_MSG_INFO("Clusters:     " << clusters->number << " (" << tag_map.size() << " total)");
  ATH_MSG_INFO("Shared Cells: " << shared_count);
 
 
  const auto err2 = StandaloneDataIO::save_event_to_folder(ctx.evt(), std::string(m_savePath), cell_info, cell_state, clusters,
                                                           m_filePrefix, m_fileSuffix, m_numWidth);
 
  if (err2 != StandaloneDataIO::ErrorState::OK)
    {
      return StatusCode::FAILURE;
    }
 
  return StatusCode::SUCCESS;
 
 
}

Member Data Documentation

m_constantDataSaved

std::atomic<bool> CaloGPUOutput::m_constantDataSaved

mutableprivate

A flag to signal that the constant data has been adequately saved.

This is required for everything to work properly in a multi-threaded context...

Definition at line 79 of file CaloGPUOutput.h.

m_filePrefix

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

private

The prefix of the saved files.

Empty string by default.

Definition at line 53 of file CaloGPUOutput.h.

m_fileSuffix

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

private

The suffix of the saved files.

Empty string by default.

Definition at line 58 of file CaloGPUOutput.h.

m_mutex

std::mutex CaloGPUOutput::m_mutex

mutableprivate

This mutex is locked when saving the constant data on the first event to ensure thread safety.

Otherwise, it's unused.

Definition at line 84 of file CaloGPUOutput.h.

m_numWidth

Gaudi::Property<unsigned int> CaloGPUOutput::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 63 of file CaloGPUOutput.h.

m_onlyCellInfo

Gaudi::Property<bool> CaloGPUOutput::m_onlyCellInfo {this, "OnlyOutputCellInfo", false, "Only output cell info"}

private

If true, only output cell info (useful for reducing disk usage when running the full standalone version of the algorithms).

Definition at line 73 of file CaloGPUOutput.h.

m_savePath

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

private

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

Default ./saved_clusters

Definition at line 48 of file CaloGPUOutput.h.

m_sortedAndCutClusters

Gaudi::Property<bool> CaloGPUOutput::m_sortedAndCutClusters {this, "UseSortedAndCutClusters", true, "Sort the clusters by transverse energy, apply a cut and ensure contiguous tags"}

private

If true, sort the clusters by transverse energy and compactify the tags to ensure sequentiality.

Definition at line 68 of file CaloGPUOutput.h.

---

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

• CaloGPUOutput.h
• CaloGPUOutput.cxx