lariov::SimpleChannelStatus Class Reference

Class providing information about the quality of channels. More...

#include <SimpleChannelStatus.h>

Inheritance diagram for lariov::SimpleChannelStatus:

Public Types
using	ChannelSet_t = lariov::ChannelStatusProvider::ChannelSet_t
Public Types inherited from lariov::ChannelStatusProvider
using	Status_t = unsigned short
	type representing channel status More...
using	ChannelSet_t = std::set< raw::ChannelID_t >
	Type of set of channel IDs. More...

Public Member Functions
	SimpleChannelStatus (fhicl::ParameterSet const &pset)
	Configuration. More...
raw::ChannelID_t	MaxChannel () const
	Returns the ID of the largest known channel. More...
raw::ChannelID_t	MaxChannelPresent () const
	Returns the ID of the largest present channel. More...
Single channel queries
Returns whether the specified channel is physical and connected to wire
virtual bool	IsPresent (raw::ChannelID_t channel) const override
	Returns whether the specified channel is physical and connected to wire. More...
virtual bool	IsGood (raw::ChannelID_t channel) const override
	Returns whether the specified channel is physical and good. More...
virtual bool	IsBad (raw::ChannelID_t channel) const override
	Returns whether the specified channel is bad in the current run. More...
virtual bool	IsNoisy (raw::ChannelID_t channel) const override
	Returns whether the specified channel is noisy in the current run. More...
Global channel queries
Returns a copy of set of good channel IDs for the current run
virtual ChannelSet_t	GoodChannels () const override
	Returns a copy of set of good channel IDs for the current run. More...
virtual ChannelSet_t	BadChannels () const override
	Returns a copy of set of bad channel IDs for the current run. More...
virtual ChannelSet_t	NoisyChannels () const override
	Returns a copy of set of noisy channel IDs for the current run. More...
Configuration functions
void	Setup (raw::ChannelID_t MaxChannel, raw::ChannelID_t MaxGoodChannel)
	Sets the service provider up. More...
void	Setup (raw::ChannelID_t MaxChannel)
	Sets the service provider up. More...
Public Member Functions inherited from lariov::ChannelStatusProvider
	ChannelStatusProvider ()=default
	Default constructor. More...
	ChannelStatusProvider (ChannelStatusProvider const &)=delete
	ChannelStatusProvider (ChannelStatusProvider &&)=delete
ChannelStatusProvider &	operator= (ChannelStatusProvider const &)=delete
ChannelStatusProvider &	operator= (ChannelStatusProvider &&)=delete
virtual	~ChannelStatusProvider ()=default
	Virtual destructor; destructs nothing. More...
virtual Status_t	Status (raw::ChannelID_t channel) const
	Returns a status integer with arbitrary meaning. More...
virtual bool	HasStatus (raw::ChannelID_t channel) const
	Returns whether the specified status is a valid one. More...

Protected Member Functions
void	FillGoodChannels () const
	Fills the collection of good channels. More...

Protected Attributes
ChannelSet_t	fBadChannels
	set of bad channels More...
ChannelSet_t	fNoisyChannels
	set of noisy channels More...
raw::ChannelID_t	fMaxChannel
	largest ID among existing channels More...
raw::ChannelID_t	fMaxPresentChannel
	largest ID among present channels More...
std::unique_ptr< ChannelSet_t >	fGoodChannels
	cached set of good channels (lazy evaluation) More...

Additional Inherited Members
Static Public Member Functions inherited from lariov::ChannelStatusProvider
static bool	IsValidStatus (Status_t status)
	Returns whether the specified status is a valid one. More...
Static Public Attributes inherited from lariov::ChannelStatusProvider
static constexpr Status_t	InvalidStatus = std::numeric_limits<Status_t>::max()
	Value or invalid status. More...

Detailed Description

Class providing information about the quality of channels.

---

This class serves information read from a FHiCL configuration file. Time-dependent (or, run-dependent) information is not supported.

All and only the channels up to the one specified in the Setup() call (that one included) are considered present. If no valid ID is specified, all channels are supposed present.

LArSoft interface to this class is through the service SimpleChannelStatusService.

Configuration parameters

• BadChannels (list of integers, default: empty) list of ID of bad channels
• NoisyChannels (list of integers, default: empty) list of ID of noisy channels

Definition at line 49 of file SimpleChannelStatus.h.

Member Typedef Documentation

using lariov::SimpleChannelStatus::ChannelSet_t = lariov::ChannelStatusProvider::ChannelSet_t

Definition at line 51 of file SimpleChannelStatus.h.

Constructor & Destructor Documentation

lariov::SimpleChannelStatus::SimpleChannelStatus ( fhicl::ParameterSet const &  pset )

explicit

Configuration.

Definition at line 29 of file SimpleChannelStatus.cpp.

    : fMaxChannel(raw::InvalidChannelID)
    , fMaxPresentChannel(raw::InvalidChannelID)
  {
    using chan_vect_t = std::vector<raw::ChannelID_t>;

    // Read the bad channels as a vector, then convert it into a set
    auto BadChannels = pset.get<chan_vect_t>("BadChannels", {});
    cet::copy_all(BadChannels,
                  std::inserter(fBadChannels, fBadChannels.begin()));

    // Read the noise channels as a vector, then convert it into a set
    auto NoisyChannels = pset.get<chan_vect_t>("NoisyChannels", {});
    cet::copy_all(NoisyChannels,
                  std::inserter(fNoisyChannels, fNoisyChannels.begin()));

  } // SimpleChannelStatus::SimpleChannelStatus()

Member Function Documentation

virtual ChannelSet_t lariov::SimpleChannelStatus::BadChannels ( ) const

inlineoverridevirtual

Returns a copy of set of bad channel IDs for the current run.

Implements lariov::ChannelStatusProvider.

Definition at line 85 of file SimpleChannelStatus.h.

      { return fBadChannels; }

void lariov::SimpleChannelStatus::FillGoodChannels ( ) const

protected

Fills the collection of good channels.

Definition at line 80 of file SimpleChannelStatus.cpp.

                                                   {

    if (!fGoodChannels) fGoodChannels.reset(new ChannelSet_t);

    ChannelSet_t& GoodChannels = *fGoodChannels;
    GoodChannels.clear();

    std::vector
      <std::pair<ChannelSet_t::const_iterator, ChannelSet_t::const_iterator>>
      VetoedIDs;

    VetoedIDs.emplace_back(fBadChannels.cbegin(), fBadChannels.cend());
    VetoedIDs.emplace_back(fNoisyChannels.cbegin(), fNoisyChannels.cend());

    // go for the first (lowest) channel ID...
    raw::ChannelID_t channel = 0;
    while (!raw::isValidChannelID(channel)) ++channel;

    // ... to the last present one
    raw::ChannelID_t last_channel = fMaxChannel;
    if (raw::isValidChannelID(fMaxPresentChannel)
      && (fMaxPresentChannel < last_channel))
      last_channel = fMaxPresentChannel;

    // if we don't know how many channels
    if (!raw::isValidChannelID(last_channel)) {
      // this exception means that the Setup() function was not called
      // or it was called with an invalid value
      throw cet::exception("SimpleChannelStatus")
        << "Can't fill good channel list since no largest channel was set up\n";
    } // if

    // add the channels to the set one by one
    while (channel <= last_channel) {
      bool bGood = true;

      // check if this channel is in any of the vetoed lists
      for (auto iter: VetoedIDs) {

        // check all the remaining vetoed channels in this list
        while (iter.first != iter.second) {
          // if the first vetoed channel is larger than the tested channel,
          // we are done with this list
          if (*(iter.first) > channel) break;

          if (*(iter.first) == channel) { // vetoed!
            bGood = false;
            ++(iter.first); // we have found this already
            break;
          }

          // the last vetoed channel is smaller than the tested channel;
          // maybe the next vetoed channel will be it!
          ++(iter.first);
        } // while

        if (!bGood) break; // already known bad, we are done
      } // for

      // add the channel
      if (bGood) GoodChannels.insert(channel);
      ++channel;
    } // while

  } // SimpleChannelStatus::GoodChannels()

SimpleChannelStatus::ChannelSet_t lariov::SimpleChannelStatus::GoodChannels ( ) const

overridevirtual

Returns a copy of set of good channel IDs for the current run.

Implements lariov::ChannelStatusProvider.

Definition at line 71 of file SimpleChannelStatus.cpp.

                                                                          {

    if (!fGoodChannels) FillGoodChannels();
    return *fGoodChannels;

  } // SimpleChannelStatus::GoodChannels()

virtual bool lariov::SimpleChannelStatus::IsBad ( raw::ChannelID_t  channel ) const

inlineoverridevirtual

Returns whether the specified channel is bad in the current run.

Implements lariov::ChannelStatusProvider.

Definition at line 70 of file SimpleChannelStatus.h.

      { return fBadChannels.count(channel) > 0; }

virtual bool lariov::SimpleChannelStatus::IsGood ( raw::ChannelID_t  channel ) const

inlineoverridevirtual

Returns whether the specified channel is physical and good.

Reimplemented from lariov::ChannelStatusProvider.

Definition at line 66 of file SimpleChannelStatus.h.

      { return IsPresent(channel) && !IsBad(channel) && !IsNoisy(channel); }

virtual bool lariov::SimpleChannelStatus::IsNoisy ( raw::ChannelID_t  channel ) const

inlineoverridevirtual

Returns whether the specified channel is noisy in the current run.

Implements lariov::ChannelStatusProvider.

Definition at line 74 of file SimpleChannelStatus.h.

      { return fNoisyChannels.count(channel) > 0; }

bool lariov::SimpleChannelStatus::IsPresent ( raw::ChannelID_t  channel ) const

overridevirtual

Returns whether the specified channel is physical and connected to wire.

Implements lariov::ChannelStatusProvider.

Definition at line 63 of file SimpleChannelStatus.cpp.

                                                                  {
    return raw::isValidChannelID(fMaxPresentChannel)
      ? raw::isValidChannelID(channel) && (channel <= fMaxPresentChannel)
      : true;
  } // SimpleChannelStatus::isPresent()

raw::ChannelID_t lariov::SimpleChannelStatus::MaxChannel ( ) const

inline

Returns the ID of the largest known channel.

Definition at line 99 of file SimpleChannelStatus.h.

{ return fMaxChannel; }

raw::ChannelID_t lariov::SimpleChannelStatus::MaxChannelPresent ( ) const

inline

Returns the ID of the largest present channel.

Definition at line 102 of file SimpleChannelStatus.h.

{ return fMaxPresentChannel; }

virtual ChannelSet_t lariov::SimpleChannelStatus::NoisyChannels ( ) const

inlineoverridevirtual

Returns a copy of set of noisy channel IDs for the current run.

Implements lariov::ChannelStatusProvider.

Definition at line 89 of file SimpleChannelStatus.h.

      { return fNoisyChannels; }

void lariov::SimpleChannelStatus::Setup	(	raw::ChannelID_t	MaxChannel,
		raw::ChannelID_t	MaxGoodChannel
	)

Sets the service provider up.

Parameters

MaxChannel	ID of the last channel
MaxGoodChannel	ID of the last good channel

Sets the largest ID of a physically present channel. All valid IDs smaller than this one are also considered present. If MaxGoodChannel is invalid, all channels are considered present.

Definition at line 50 of file SimpleChannelStatus.cpp.

  {

    fMaxChannel = MaxChannel;
    fMaxPresentChannel = MaxGoodChannel;

    // clear the caches, if any
    fGoodChannels.reset();

  } // SimpleChannelStatus::Setup()

void lariov::SimpleChannelStatus::Setup ( raw::ChannelID_t  MaxChannel )

inline

Sets the service provider up.

Parameters

MaxChannel

ID of the last channel

As Setup(raw::ChannelID_t, raw::ChannelID_t), but assumes all channels to be present.

Definition at line 127 of file SimpleChannelStatus.h.

{ Setup(MaxChannel, MaxChannel); }

Member Data Documentation

ChannelSet_t lariov::SimpleChannelStatus::fBadChannels

protected

set of bad channels

Definition at line 139 of file SimpleChannelStatus.h.

std::unique_ptr<ChannelSet_t> lariov::SimpleChannelStatus::fGoodChannels

mutableprotected

cached set of good channels (lazy evaluation)

Definition at line 146 of file SimpleChannelStatus.h.

raw::ChannelID_t lariov::SimpleChannelStatus::fMaxChannel

protected

largest ID among existing channels

Definition at line 142 of file SimpleChannelStatus.h.

raw::ChannelID_t lariov::SimpleChannelStatus::fMaxPresentChannel

protected

largest ID among present channels

Definition at line 143 of file SimpleChannelStatus.h.

ChannelSet_t lariov::SimpleChannelStatus::fNoisyChannels

protected

set of noisy channels

Definition at line 140 of file SimpleChannelStatus.h.

---

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

• larevt/larevt/Filters/SimpleChannelStatus.h
• larevt/larevt/Filters/SimpleChannelStatus.cpp