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

#include <SIOVChannelStatusProvider.h>

Inheritance diagram for lariov::SIOVChannelStatusProvider:

Public Member Functions
	SIOVChannelStatusProvider (fhicl::ParameterSet const &pset)
	Constructor. More...

virtual	~SIOVChannelStatusProvider ()=default
	Default destructor. More...

const ChannelStatus &	GetChannelStatus (raw::ChannelID_t channel) const
	Returns Channel Status. More...

Status_t	Status (raw::ChannelID_t channel) const override
	Returns a status integer with arbitrary meaning. More...

void	UpdateTimeStamp (DBTimeStamp_t ts)
	Update event time stamp. More...

Single channel queries
Returns whether the specified channel is physical and connected to wire
bool	IsPresent (raw::ChannelID_t channel) const override
	Returns whether the specified channel is physical and connected to wire. More...

bool	IsBad (raw::ChannelID_t channel) const override
	Returns whether the specified channel is bad in the current run. More...

bool	IsNoisy (raw::ChannelID_t channel) const override
	Returns whether the specified channel is noisy in the current run. More...

bool	IsGood (raw::ChannelID_t channel) const override
	Returns whether the specified channel is physical and good. More...

Global channel queries
Returns a copy of set of good channel IDs for the current run
ChannelSet_t	GoodChannels () const override
	Returns a copy of set of good channel IDs for the current run. More...

ChannelSet_t	BadChannels () const override
	Returns a copy of set of bad channel IDs for the current run. More...

ChannelSet_t	NoisyChannels () const override
	Returns a copy of set of noisy channel IDs for the current run. More...

Configuration functions
Prepares the object to provide information about the specified time
bool	Update (DBTimeStamp_t)

void	AddNoisyChannel (raw::ChannelID_t ch)
	Allows a service to add to the list of noisy channels. More...

Public Member Functions inherited from lariov::DatabaseRetrievalAlg
	DatabaseRetrievalAlg (const std::string &foldername, const std::string &url, const std::string &url2="", const std::string &tag="", bool usesqlite=false, bool testmode=false)
	Constructors. More...

	DatabaseRetrievalAlg (fhicl::ParameterSet const &p)

virtual	~DatabaseRetrievalAlg ()
	Default destructor. More...

virtual void	Reconfigure (fhicl::ParameterSet const &p)
	Configure using fhicl::ParameterSet. More...

bool	UpdateFolder (DBTimeStamp_t ts)
	Return true if fFolder is successfully updated. More...

const std::string &	URL () const
	Get connection information. More...

const std::string &	FolderName () const

const std::string &	Tag () const

const IOVTimeStamp &	Begin () const
	Get Timestamp information. More...

const IOVTimeStamp &	End () const

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 bool	HasStatus (raw::ChannelID_t channel) const
	Returns whether the specified status is a valid one. More...

Static Public Member Functions
static DBChannelID_t	rawToDBChannel (raw::ChannelID_t channel)
	Converts LArSoft channel ID in the one proper for the DB. More...

Static Public Member Functions inherited from lariov::ChannelStatusProvider
static bool	IsValidStatus (Status_t status)
	Returns whether the specified status is a valid one. More...

Private Member Functions
bool	DBUpdate () const
	Do actual database updates. More...

bool	DBUpdate (DBTimeStamp_t ts) const

ChannelSet_t	GetChannelsWithStatus (chStatus status) const

Private Attributes
DBTimeStamp_t	fEventTimeStamp

DBTimeStamp_t	fCurrentTimeStamp

DataSource::ds	fDataSource

Snapshot< ChannelStatus >	fData

Snapshot< ChannelStatus >	fNewNoisy

ChannelStatus	fDefault

Additional Inherited Members
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...

Static Public Attributes inherited from lariov::ChannelStatusProvider
static constexpr Status_t	InvalidStatus = std::numeric_limits<Status_t>::max()
	Value or invalid status. More...

Protected Attributes inherited from lariov::DatabaseRetrievalAlg
std::unique_ptr< DBFolder >	fFolder

Detailed Description

Class providing information about the quality of channels.

This class serves information read from a FHiCL configuration file and/or a database.

LArSoft interface to this class is through the service SIOVChannelStatusService.

Definition at line 37 of file SIOVChannelStatusProvider.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 27 of file SIOVChannelStatusProvider.cxx.

     : DatabaseRetrievalAlg(pset.get<fhicl::ParameterSet>("DatabaseRetrievalAlg"))
     , fEventTimeStamp(0)
     , fCurrentTimeStamp(0)
     , fDefault(0)
   {
 
     bool UseDB    = pset.get<bool>("UseDB", false);
     bool UseFile  = pset.get<bool>("UseFile", false);
     std::string fileName = pset.get<std::string>("FileName", "");
 
     //priority:  (1) use db, (2) use table, (3) use defaults
     //If none are specified, use defaults
     if ( UseDB )      fDataSource = DataSource::Database;
     else if (UseFile) fDataSource = DataSource::File;
     else              fDataSource = DataSource::Default;
 
     if (fDataSource == DataSource::Default) {
       std::cout << "Using default channel status value: "<<kGOOD<<"\n";
       fDefault.SetStatus(kGOOD);
     }
     else if (fDataSource == DataSource::File) {
       cet::search_path sp("FW_SEARCH_PATH");
       std::string abs_fp = sp.find_file(fileName);
       std::cout << "Using channel statuses from local file: "<<abs_fp<<"\n";
       std::ifstream file(abs_fp);
       if (!file) {
         throw cet::exception("SIOVChannelStatusProvider")
           << "File "<<abs_fp<<" is not found.";
       }
 
       std::string line;
       ChannelStatus cs(0);
       while (std::getline(file, line)) {
         DBChannelID_t ch = (DBChannelID_t)std::stoi(line.substr(0, line.find(',')));
         int status = std::stoi(line.substr(line.find(',')+1));
 
         cs.SetChannel(ch);
         cs.SetStatus( ChannelStatus::GetStatusFromInt(status) );
         fData.AddOrReplaceRow(cs);
       }
     } // if source from file
     else {
       std::cout << "Using channel statuses from conditions database\n";
     }
   }

virtual lariov::SIOVChannelStatusProvider::~SIOVChannelStatusProvider ( )

virtualdefault

Default destructor.

Member Function Documentation

void lariov::SIOVChannelStatusProvider::AddNoisyChannel ( raw::ChannelID_t ch )

Allows a service to add to the list of noisy channels.

Definition at line 203 of file SIOVChannelStatusProvider.cxx.

                                                                    {
 
     // for c2: ISO C++17 does not allow 'register' storage class specifier
     //register DBChannelID_t const dbch = rawToDBChannel(ch);
     DBChannelID_t const dbch = rawToDBChannel(ch);
     if (!this->IsBad(dbch) && this->IsPresent(dbch)) {
       ChannelStatus cs(dbch);
       cs.SetStatus(kNOISY);
       fNewNoisy.AddOrReplaceRow(cs);
     }
   }

SIOVChannelStatusProvider::ChannelSet_t lariov::SIOVChannelStatusProvider::BadChannels ( ) const

overridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 187 of file SIOVChannelStatusProvider.cxx.

                                                {
     ChannelSet_t dead = GetChannelsWithStatus(kDEAD);
     ChannelSet_t ln = GetChannelsWithStatus(kLOWNOISE);
     dead.insert(ln.begin(),ln.end());
     return dead;
   }

bool lariov::SIOVChannelStatusProvider::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 93 of file SIOVChannelStatusProvider.cxx.

                                                  {
     return DBUpdate(fEventTimeStamp);
   }

bool lariov::SIOVChannelStatusProvider::DBUpdate ( DBTimeStamp_t ts ) const

private

Definition at line 100 of file SIOVChannelStatusProvider.cxx.

                                                                  {
 
     bool result = false;
     if(fDataSource == DataSource::Database && ts != fCurrentTimeStamp) {
 
       mf::LogInfo("SIOVChannelStatusProvider") << "SIOVChannelStatusProvider::DBUpdate called with new timestamp.";
 
       fCurrentTimeStamp = ts;
 
       // Call non-const base class method.
 
       result = const_cast<SIOVChannelStatusProvider*>(this)->UpdateFolder(ts);
       if(result) {
         //DBFolder was updated, so now update the Snapshot
         fData.Clear();
         fData.SetIoV(this->Begin(), this->End());
 
         std::vector<DBChannelID_t> channels;
         fFolder->GetChannelList(channels);
         for (auto it = channels.begin(); it != channels.end(); ++it) {
 
           long status;
           fFolder->GetNamedChannelData(*it, "status", status);
 
           ChannelStatus cs(*it);
           cs.SetStatus( ChannelStatus::GetStatusFromInt((int)status) );
 
           fData.AddOrReplaceRow(cs);
         }
       }
     }
     return result;
   }

const ChannelStatus & lariov::SIOVChannelStatusProvider::GetChannelStatus ( raw::ChannelID_t channel ) const

Returns Channel Status.

Definition at line 136 of file SIOVChannelStatusProvider.cxx.

                                                                                           {
     if (fDataSource == DataSource::Default) {
       return fDefault;
     }
     DBUpdate();
     if (fNewNoisy.HasChannel(rawToDBChannel(ch))) {
       return fNewNoisy.GetRow(rawToDBChannel(ch));
     }
     else {
       return fData.GetRow(rawToDBChannel(ch));
     }
   }

SIOVChannelStatusProvider::ChannelSet_t lariov::SIOVChannelStatusProvider::GetChannelsWithStatus ( chStatus status ) const

private

Definition at line 152 of file SIOVChannelStatusProvider.cxx.

                                                                         {
 
     ChannelSet_t retSet;
     retSet.clear();
     DBChannelID_t maxChannel = art::ServiceHandle<geo::Geometry const>()->Nchannels() - 1;
     if (fDataSource == DataSource::Default) {
       if (fDefault.Status() == status) {
         std::vector<DBChannelID_t> chs;
         for (DBChannelID_t ch=0; ch != maxChannel; ++ch) {
           chs.push_back(ch);
         }
         retSet.insert(chs.begin(), chs.end());
       }
     }
     else {
       std::vector<DBChannelID_t> chs;
       for (DBChannelID_t ch=0; ch != maxChannel; ++ch) {
         if (this->GetChannelStatus(ch).Status() == status) chs.push_back(ch);
       }
 
       retSet.insert(chs.begin(), chs.end());
     }
     return retSet;
   }

SIOVChannelStatusProvider::ChannelSet_t lariov::SIOVChannelStatusProvider::GoodChannels ( ) const

overridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 180 of file SIOVChannelStatusProvider.cxx.

                                                 {
     return GetChannelsWithStatus(kGOOD);
   }

bool lariov::SIOVChannelStatusProvider::IsBad ( raw::ChannelID_t channel ) const

inlineoverridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 65 of file SIOVChannelStatusProvider.h.

                                                         {
         return GetChannelStatus(channel).IsDead() || GetChannelStatus(channel).IsLowNoise() || !IsPresent(channel);
       }

bool lariov::SIOVChannelStatusProvider::IsGood ( raw::ChannelID_t channel ) const

inlineoverridevirtual

Returns whether the specified channel is physical and good.

Reimplemented from lariov::ChannelStatusProvider.

Definition at line 75 of file SIOVChannelStatusProvider.h.

                                                          {
         return GetChannelStatus(channel).IsGood();
       }

bool lariov::SIOVChannelStatusProvider::IsNoisy ( raw::ChannelID_t channel ) const

inlineoverridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 70 of file SIOVChannelStatusProvider.h.

                                                           {
         return GetChannelStatus(channel).IsNoisy();
       }

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

inlineoverridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 60 of file SIOVChannelStatusProvider.h.

                                                             {
         return GetChannelStatus(channel).IsPresent();
       }

SIOVChannelStatusProvider::ChannelSet_t lariov::SIOVChannelStatusProvider::NoisyChannels ( ) const

overridevirtual

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

Implements lariov::ChannelStatusProvider.

Definition at line 197 of file SIOVChannelStatusProvider.cxx.

                                                  {
     return GetChannelsWithStatus(kNOISY);
   }

static DBChannelID_t lariov::SIOVChannelStatusProvider::rawToDBChannel ( raw::ChannelID_t channel )

inlinestatic

Converts LArSoft channel ID in the one proper for the DB.

Definition at line 112 of file SIOVChannelStatusProvider.h.

113 { return DBChannelID_t(channel); }

lariov::DBChannelID_t

std::uint32_t DBChannelID_t

Definition: CalibrationDBIFwd.h:10

Status_t lariov::SIOVChannelStatusProvider::Status ( raw::ChannelID_t channel ) const

inlineoverridevirtual

Returns a status integer with arbitrary meaning.

Reimplemented from lariov::ChannelStatusProvider.

Definition at line 80 of file SIOVChannelStatusProvider.h.

                                                              {
         return (Status_t) this->GetChannelStatus(channel).Status();
       }

bool lariov::SIOVChannelStatusProvider::Update ( DBTimeStamp_t ts )

Definition at line 84 of file SIOVChannelStatusProvider.cxx.

                                                          {
 
     fEventTimeStamp = ts;
     fNewNoisy.Clear();
     return DBUpdate(ts);
   }

void lariov::SIOVChannelStatusProvider::UpdateTimeStamp ( DBTimeStamp_t ts )

Update event time stamp.

Definition at line 76 of file SIOVChannelStatusProvider.cxx.

                                                                   {
     mf::LogInfo("SIOVChannelStatusProvider") << "SIOVChannelStatusProvider::UpdateTimeStamp called.";
     fNewNoisy.Clear();
     fEventTimeStamp = ts;
   }