SimpleChannelStatus.h

Go to the documentation of this file.

#ifndef SIMPLECHANNELFILTER_H
#define SIMPLECHANNELFILTER_H 1

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "larevt/CalibrationDBI/Interface/ChannelStatusProvider.h"

// Utility libraries
namespace fhicl {
  class ParameterSet;
}

// C/C++ standard library
#include <memory> // std::unique_ptr<>

namespace lariov {

  class SimpleChannelStatus : public lariov::ChannelStatusProvider {
  public:
    using ChannelSet_t = lariov::ChannelStatusProvider::ChannelSet_t;

    explicit SimpleChannelStatus(fhicl::ParameterSet const& pset);

    //
    // interface methods
    //

    bool IsPresent(raw::ChannelID_t channel) const override;

    bool IsGood(raw::ChannelID_t channel) const override
    {
      return IsPresent(channel) && !IsBad(channel) && !IsNoisy(channel);
    }

    bool IsBad(raw::ChannelID_t channel) const override { return fBadChannels.count(channel) > 0; }

    bool IsNoisy(raw::ChannelID_t channel) const override
    {
      return fNoisyChannels.count(channel) > 0;
    }

    ChannelSet_t GoodChannels() const override;

    ChannelSet_t BadChannels() const override { return fBadChannels; }

    ChannelSet_t NoisyChannels() const override { return fNoisyChannels; }

    //
    // non-interface methods and configuration methods
    //

    raw::ChannelID_t MaxChannel() const { return fMaxChannel; }

    raw::ChannelID_t MaxChannelPresent() const { return fMaxPresentChannel; }


    void Setup(raw::ChannelID_t MaxChannel, raw::ChannelID_t MaxGoodChannel);

    void Setup(raw::ChannelID_t MaxChannel) { Setup(MaxChannel, MaxChannel); }


  protected:
    ChannelSet_t fBadChannels;   
    ChannelSet_t fNoisyChannels; 

    raw::ChannelID_t fMaxChannel;        
    raw::ChannelID_t fMaxPresentChannel; 

    mutable std::unique_ptr<ChannelSet_t> fGoodChannels;

    void FillGoodChannels() const;

  }; // class SimpleChannelStatus

} // namespace lariov

#endif // SIMPLECHANNELFILTER_H