|
| 1 | +// Copyright CERN and copyright holders of ALICE O2. This software is |
| 2 | +// distributed under the terms of the GNU General Public License v3 (GPL |
| 3 | +// Version 3), copied verbatim in the file "COPYING". |
| 4 | +// |
| 5 | +// See http://alice-o2.web.cern.ch/license for full licensing information. |
| 6 | +// |
| 7 | +// In applying this license CERN does not waive the privileges and immunities |
| 8 | +// granted to it by virtue of its status as an Intergovernmental Organization |
| 9 | +// or submit itself to any jurisdiction. |
| 10 | +#include <iosfwd> |
| 11 | +#include <bitset> |
| 12 | +#include <Rtypes.h> |
| 13 | +#include <CCDB/TObjectWrapper.h> // Needed to trigger dictionary build |
| 14 | + |
| 15 | +class TH2; |
| 16 | + |
| 17 | +namespace o2 |
| 18 | +{ |
| 19 | + |
| 20 | +namespace phos |
| 21 | +{ |
| 22 | + |
| 23 | +/// \class BadChannelMap |
| 24 | +/// \brief CCDB container for bad (masked) channels in PHOS |
| 25 | +/// \author Dmitri Peresunko, adopted from EMCAL (Markus Fasel) |
| 26 | +/// \since Aug. 1, 2019 |
| 27 | +/// |
| 28 | +/// # The PHOS Bad Channel Map |
| 29 | +/// |
| 30 | +/// The bad channel map contains channels which are marked to be |
| 31 | +/// bad and excluded from reonstruction: clusterization |
| 32 | +/// or other analysis processes. |
| 33 | +/// |
| 34 | +/// Bad channels can be added via |
| 35 | +/// bcm.addBadChannel(1234); |
| 36 | +/// goodness of channel can be restored with |
| 37 | +/// bcm.setChannelGood(1234) ; |
| 38 | +/// |
| 39 | +/// Reading the channel status is done via |
| 40 | +/// bool status = bcm.isChannelGood(1234); |
| 41 | +/// Calling isChannelGood for cells beyond PHOS |
| 42 | +/// will return the status bad. |
| 43 | +/// |
| 44 | +/// For visualization a 2D histogram with the cell status as function of x(phi) vs z |
| 45 | +/// for each module can be created on the fly from the bad channel map. As the histogram is |
| 46 | +/// created dynamically from the absolute cell ID an instance of the PHOS Geometry |
| 47 | +/// is required - otherwise an empty histogram is created. |
| 48 | +/// |
| 49 | +/// The bad channel map can be created from multiple bad channel |
| 50 | +/// maps using the operator +=. This allows for the combination |
| 51 | +/// of the bad channel map from multiple time slices. |
| 52 | +class BadChannelMap |
| 53 | +{ |
| 54 | + public: |
| 55 | + /// \brief Constructor |
| 56 | + BadChannelMap() = default; |
| 57 | + |
| 58 | + /// \brief Destructor |
| 59 | + ~BadChannelMap() = default; |
| 60 | + |
| 61 | + /// \brief Add bad channel map to this bad channel map |
| 62 | + /// \param rhs Bad channel map to be added to this bad channel map |
| 63 | + /// \return Reference to the combined bad channel map |
| 64 | + /// |
| 65 | + /// Adding bad channels of another bad channel map to this |
| 66 | + /// bad channel map. |
| 67 | + BadChannelMap& operator+=(const BadChannelMap& rhs) |
| 68 | + { |
| 69 | + mBadCells |= rhs.mBadCells; |
| 70 | + return *this; |
| 71 | + } |
| 72 | + |
| 73 | + /// \brief Comparison of two bad channel maps |
| 74 | + /// \return true if the bad channel maps are identical, false otherwise |
| 75 | + /// |
| 76 | + /// Testing two bad channel maps for equalness. |
| 77 | + bool operator==(const BadChannelMap& other) const { return mBadCells == other.mBadCells; } |
| 78 | + |
| 79 | + /// \brief Add bad cell to the container |
| 80 | + /// \param channelID Absolute ID of the bad channel |
| 81 | + /// \param mask type of the bad channel |
| 82 | + /// |
| 83 | + /// Adding new bad channel to the container. In case a cell |
| 84 | + /// with the same ID is already present in the container, |
| 85 | + /// the mask status is updated. Otherwise it is added. |
| 86 | + /// |
| 87 | + /// Only bad or warm cells are added to the container. In case |
| 88 | + /// the mask type is GOOD_CELL, the entry is removed from the |
| 89 | + /// container if present before, otherwise the cell is ignored. |
| 90 | + void addBadChannel(unsigned short channelID) { mBadCells.set(channelID); } //set bit to true |
| 91 | + |
| 92 | + /// \brief Mark channel as good |
| 93 | + /// \param channelID Absolute ID of the channel |
| 94 | + /// |
| 95 | + /// Setting channel as good. |
| 96 | + void setChannelGood(unsigned short channelID) { mBadCells.set(channelID, false); } |
| 97 | + |
| 98 | + /// \brief Get the status of a certain cell |
| 99 | + /// \param channelID channel for which to obtain the channel status |
| 100 | + /// \return true if good channel |
| 101 | + /// |
| 102 | + /// Provide the mask status of a cell. |
| 103 | + bool isChannelGood(unsigned short channelID) const { return !mBadCells.test(channelID); } |
| 104 | + |
| 105 | + /// \brief Convert map into 2D histogram representation |
| 106 | + /// \param mod Module number |
| 107 | + /// \param h Histogram of size 64*56 to be filled with the bad channel map. |
| 108 | + /// |
| 109 | + /// Convert bad channel map into a 2D map with phi(64) vs z(56) dimensions. |
| 110 | + /// Entries in the histogram are: |
| 111 | + /// - 0: GOOD_CELL |
| 112 | + /// - 1: BAD_CELL |
| 113 | + /// Attention: It is responsibility of user to create/delete histogram |
| 114 | + void getHistogramRepresentation(int mod, TH2* h) const; |
| 115 | + |
| 116 | + /// \brief Print bad channels on a given stream |
| 117 | + /// \param stream Stream on which the bad channel map is printed on |
| 118 | + /// |
| 119 | + /// Printing all bad channels store in the bad channel map |
| 120 | + /// on the stream. |
| 121 | + /// |
| 122 | + /// The function is called in the operator<< providing direct access |
| 123 | + /// to protected members. Explicit calls by the users is normally not |
| 124 | + /// necessary. |
| 125 | + void PrintStream(std::ostream& stream) const; |
| 126 | + |
| 127 | + private: |
| 128 | + static constexpr int NCHANNELS = 14337; ///< Number of channels starting from 1 (4*64*56+1 |
| 129 | + std::bitset<NCHANNELS> mBadCells; ///< Container for bad cells, 1 means bad sell |
| 130 | + |
| 131 | + ClassDefNV(BadChannelMap, 1); |
| 132 | +}; |
| 133 | + |
| 134 | +/// \brief Printing bad channel map on the stream |
| 135 | +/// \param in Stream where the bad channel map is printed on |
| 136 | +/// \param bcm Bad channel map to be printed |
| 137 | +/// \return Stream after printing the bad channel map |
| 138 | +/// |
| 139 | +/// Printing cellID of all bad channels stored in the bad channel map |
| 140 | +/// on the stream. |
| 141 | +std::ostream& operator<<(std::ostream& in, const BadChannelMap& bcm); |
| 142 | + |
| 143 | +} // namespace phos |
| 144 | + |
| 145 | +} // namespace o2 |
0 commit comments