CaloRecGPU::CellInfoArr Class Reference

Contains the per-event cell information: energy, timing, gain, quality and provenance. More...

#include <EventInfoDefinitions.h>

Inheritance diagram for CaloRecGPU::CellInfoArr:

Collaboration diagram for CaloRecGPU::CellInfoArr:

Public Member Functions
constexpr int	get_hash_ID (const int cell, const bool is_complete=false) const
constexpr int	get_cell_with_hash_ID (const int index, const bool is_complete=false) const
constexpr bool	is_bad (const int cell, const bool treat_L1_predicted_as_good=false, const bool is_complete=false) const
	GPU version of CaloBadCellHelper::isBad.
constexpr bool	passes_time_cut (const GeometryArr &geom, const int cell, const float threshold, const bool use_crosstalk, const float crosstalk_delta, const bool is_complete=false) const
	GPU equivalent of CaloTopoClusterMaker::passCellTimeCut.
constexpr bool	is_valid (const int hash_ID, const bool is_complete=false, const bool all_cells_are_valid=false) const
constexpr int	get_number_of_cells (const bool is_complete=false) const

Static Public Member Functions
static constexpr bool	is_bad_general (const bool is_tile, const QualityProvenance qp, const bool treat_L1_predicted_as_good=false)
	GPU version of CaloBadCellHelper::isBad.

Public Attributes
unsigned char	gain [NCaloCells]
float	energy [NCaloCells]
float	time [NCaloCells]
QualityProvenance::carrier	qualityProvenance [NCaloCells]
int	hashID [NCaloCells]
int	hashIDToCollection [NCaloCells]
bool	complete
bool	all_cells_valid
int	number

Detailed Description

Contains the per-event cell information: energy, timing, gain, quality and provenance.

Since this is ordered in the same way as the CPU cell collection, functionalities to map between cell hash ID and cell index within the collection

Definition at line 216 of file EventInfoDefinitions.h.

Member Function Documentation

get_cell_with_hash_ID()

int CaloRecGPU::CellInfoArr::get_cell_with_hash_ID ( const int index, const bool is_complete = false ) const

inlineconstexpr

Definition at line 240 of file EventInfoDefinitions.h.

    {
      if (is_complete)
        {
          return index;
        }
      else
        {
          return hashIDToCollection[index];
        }
    }

get_hash_ID()

int CaloRecGPU::CellInfoArr::get_hash_ID ( const int cell, const bool is_complete = false ) const

inlineconstexpr

Definition at line 228 of file EventInfoDefinitions.h.

    {
      if (is_complete)
        {
          return cell;
        }
      else
        {
          return hashID[cell];
        }
    }

get_number_of_cells()

int CaloRecGPU::CellBaseInfo::get_number_of_cells ( const bool is_complete = false ) const

inlineconstexprinherited

Definition at line 197 of file EventInfoDefinitions.h.

    {
      if (is_complete)
      {
        return NCaloCells;
      }
      else
      {
        return number;
      }
    }

is_bad()

bool CaloRecGPU::CellInfoArr::is_bad ( const int cell, const bool treat_L1_predicted_as_good = false, const bool is_complete = false ) const

inlineconstexpr

GPU version of CaloBadCellHelper::isBad.

If treat_L1_predicted_as_good is false, has the same effect as cell->badcell() (just like CaloBadCellHelper::isBad).

Definition at line 302 of file EventInfoDefinitions.h.

    {
      return is_bad_general(GeometryArr::is_tile(get_hash_ID(cell, is_complete)), qualityProvenance[cell], treat_L1_predicted_as_good);
    }

is_bad_general()

constexpr bool CaloRecGPU::CellInfoArr::is_bad_general ( const bool is_tile, const QualityProvenance qp, const bool treat_L1_predicted_as_good = false )

inlinestaticconstexpr

GPU version of CaloBadCellHelper::isBad.

If treat_L1_predicted_as_good is false, has the same effect as cell->badcell() (just like CaloBadCellHelper::isBad).

Definition at line 255 of file EventInfoDefinitions.h.

    {
      bool ret = false;
 
      if (is_tile)
        {
 
          const unsigned int mask = 0x08U;
 
          ret = (qp.tile_qbit1() & mask) && (qp.tile_qbit2() & mask);
          //From TileCell::badcell()
          //badch1() && badch2()
          //badch1() -> m_tileQual[2]&TileCell::MASK_BADCH
          //badch2() -> m_tileQual[3]&TileCell::MASK_BADCH
          //
          //TileCell::MASK_BADCH= 0x08
          //
          //From CaloCell:
          //union {
          //  int  m_quality ;
          //  uint16_t m_qualProv[2];
          //  uint8_t m_tileQual[4];
          //};
          //quality returns m_qualProv[0]
          //provenance returns m_qualProv[1]
          //These are used to build our QualityProvenance...
          //
          //It's packing and unpacking back and forth, how fun!
        }
      else
        {
          const unsigned int provenance = qp.provenance();
          ret = provenance & 0x0800U;
          //As in LArCell::badcell()
 
          if (treat_L1_predicted_as_good && (provenance & 0x0200U))
            //As in CaloBadCellHelper::isBad
            {
              ret = false;
            }
        }
      return ret;
    }

is_valid()

bool CaloRecGPU::CellInfoArr::is_valid ( const int hash_ID, const bool is_complete = false, const bool all_cells_are_valid = false ) const

inlineconstexpr

Definition at line 365 of file EventInfoDefinitions.h.

    {
      if (all_cells_are_valid)
        {
          return true;
        }
      else if (is_complete)
        {
          return GainConversion::is_valid(gain[hash_ID]);
        }
      else
        {
          return hashIDToCollection[hash_ID] >= 0;
        }
    }

passes_time_cut()

bool CaloRecGPU::CellInfoArr::passes_time_cut ( const GeometryArr & geom, const int cell, const float threshold, const bool use_crosstalk, const float crosstalk_delta, const bool is_complete = false ) const

inlineconstexpr

GPU equivalent of CaloTopoClusterMaker::passCellTimeCut.

Definition at line 309 of file EventInfoDefinitions.h.

    {
      const int real_cell = get_hash_ID(cell, is_complete);
      const int sampling = geom.sampling(real_cell);
      if (sampling == CaloSampling::PreSamplerB ||
          sampling == CaloSampling::PreSamplerE ||
          sampling == CaloSampling::Unknown        )
        {
          return true;
        }
      else
        {
          const QualityProvenance qp = qualityProvenance[cell];
          const unsigned int mask = geom.is_tile(real_cell) ? 0x8080U : 0x2000U;
          if (qp.provenance() & mask)
            {
              const float this_time = time[cell];
              if (fabsf(this_time) >= threshold)
                {
                  if (use_crosstalk)
                    {
                      const float this_energy = energy[cell];
                      const bool eligible = (sampling == CaloSampling::EMB2 || (sampling == CaloSampling::EME2 && fabsf(geom.eta[real_cell]) < 2.5));
                      if (this_energy > 0 && eligible)
                        {
                          int neighbours[NMaxNeighbours] = {};
 
                          constexpr unsigned int neigh_options = LArNeighbours::neighbourOption::prevInPhi | LArNeighbours::neighbourOption::nextInPhi;
 
                          const int num_neighs = geom.get_neighbours(neigh_options, real_cell, neighbours);
 
                          for (int i = 0; i < num_neighs; ++i)
                            {
                              const int neigh_index = get_cell_with_hash_ID(neighbours[i], is_complete);
                              if (neigh_index >= 0 && energy[neigh_index] > 4 * this_energy)
                                {
                                  const QualityProvenance neigh_qp = qualityProvenance[neigh_index];
                                  if ( !(neigh_qp.provenance() & mask) || fabsf(time[neigh_index]) < threshold )
                                    {
                                      if (this_time > -threshold && this_time < threshold + crosstalk_delta)
                                        {
                                          return true;
                                        }
                                    }
                                }
                            }
                        }
                    }
                  return false;
                }
            }
        }
      return true;
    }

Member Data Documentation

all_cells_valid

bool CaloRecGPU::CellBaseInfo::all_cells_valid

inherited

Definition at line 194 of file EventInfoDefinitions.h.

complete

bool CaloRecGPU::CellBaseInfo::complete

inherited

Definition at line 193 of file EventInfoDefinitions.h.

energy

float CaloRecGPU::CellInfoArr::energy[NCaloCells]

Definition at line 219 of file EventInfoDefinitions.h.

gain

unsigned char CaloRecGPU::CellInfoArr::gain[NCaloCells]

Definition at line 218 of file EventInfoDefinitions.h.

hashID

int CaloRecGPU::CellInfoArr::hashID[NCaloCells]

Definition at line 225 of file EventInfoDefinitions.h.

hashIDToCollection

int CaloRecGPU::CellInfoArr::hashIDToCollection[NCaloCells]

Definition at line 226 of file EventInfoDefinitions.h.

number

int CaloRecGPU::CellBaseInfo::number

inherited

Definition at line 195 of file EventInfoDefinitions.h.

qualityProvenance

QualityProvenance::carrier CaloRecGPU::CellInfoArr::qualityProvenance[NCaloCells]

Definition at line 221 of file EventInfoDefinitions.h.

time

float CaloRecGPU::CellInfoArr::time[NCaloCells]

Definition at line 220 of file EventInfoDefinitions.h.

---

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

• EventInfoDefinitions.h