lariov::SIOVChannelStatusProvider Class Reference

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
void	UpdateTimeStamp (DBTimeStamp_t ts)
	Update event time stamp. 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
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 bad in the current run. 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 bad 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)
	Allows a service to add to the list of noisy channels. More...
void	AddNoisyChannel (raw::ChannelID_t ch)
	Allows a service to add to the list of noisy channels. 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...

Protected Attributes
std::unique_ptr< DBFolder >	fFolder

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

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 35 of file SIOVChannelStatusProvider.h.

Constructor & Destructor Documentation

lariov::SIOVChannelStatusProvider::SIOVChannelStatusProvider

(

fhicl::ParameterSet const &

pset

)

Constructor.

Definition at line 34 of file SIOVChannelStatusProvider.cxx.

References fData, fDataSource, fDefault, file, and fhicl::ParameterSet::get().

    : 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 210 of file SIOVChannelStatusProvider.cxx.

References fNewNoisy, IsBad(), IsPresent(), and rawToDBChannel().

Referenced by Status().

                                                                   {
    
    // 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

override

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

Definition at line 194 of file SIOVChannelStatusProvider.cxx.

References GetChannelsWithStatus().

Referenced by Status().

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

const IOVTimeStamp& lariov::DatabaseRetrievalAlg::Begin ( ) const

inlineinherited

Get Timestamp information.

Definition at line 59 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), lariov::DetPedestalRetrievalAlg::DBUpdate(), and DBUpdate().

{return fFolder->CachedStart();}

bool lariov::SIOVChannelStatusProvider::DBUpdate ( ) const

private

Do actual database updates.

Definition at line 100 of file SIOVChannelStatusProvider.cxx.

References fEventTimeStamp.

Referenced by GetChannelStatus(), rawToDBChannel(), and Update().

                                                 {
    return DBUpdate(fEventTimeStamp);
  }

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

private

Definition at line 107 of file SIOVChannelStatusProvider.cxx.

References lariov::DatabaseRetrievalAlg::Begin(), lariov::DatabaseRetrievalAlg::End(), fCurrentTimeStamp, fData, fDataSource, lariov::DatabaseRetrievalAlg::fFolder, and lariov::DatabaseRetrievalAlg::UpdateFolder().

                                                                 {

    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 IOVTimeStamp& lariov::DatabaseRetrievalAlg::End ( ) const

inlineinherited

Definition at line 60 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), lariov::DetPedestalRetrievalAlg::DBUpdate(), and DBUpdate().

{return fFolder->CachedEnd();}

const std::string& lariov::DatabaseRetrievalAlg::FolderName ( ) const

inlineinherited

Definition at line 55 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->FolderName();}

const ChannelStatus & lariov::SIOVChannelStatusProvider::GetChannelStatus

(

raw::ChannelID_t

channel

)

const

Returns Channel Status.

Definition at line 143 of file SIOVChannelStatusProvider.cxx.

References DBUpdate(), fData, fDataSource, fDefault, fNewNoisy, and rawToDBChannel().

Referenced by GetChannelsWithStatus(), IsBad(), IsGood(), IsNoisy(), IsPresent(), and Status().

                                                                                          {
    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 159 of file SIOVChannelStatusProvider.cxx.

References fDataSource, fDefault, and GetChannelStatus().

Referenced by BadChannels(), GoodChannels(), and NoisyChannels().

                                                                        {
    
    ChannelSet_t retSet;
    retSet.clear();
    DBChannelID_t maxChannel = art::ServiceHandle<geo::Geometry>()->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

override

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

Definition at line 187 of file SIOVChannelStatusProvider.cxx.

References GetChannelsWithStatus().

Referenced by Status().

                                                {
    return GetChannelsWithStatus(kGOOD);
  }

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

inlineoverride

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

Definition at line 63 of file SIOVChannelStatusProvider.h.

References GetChannelStatus(), and IsPresent().

Referenced by AddNoisyChannel().

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

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

inlineoverride

Returns whether the specified channel is physical and good.

Definition at line 73 of file SIOVChannelStatusProvider.h.

References GetChannelStatus().

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

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

inlineoverride

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

Definition at line 68 of file SIOVChannelStatusProvider.h.

References GetChannelStatus().

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

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

inlineoverride

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

Definition at line 58 of file SIOVChannelStatusProvider.h.

References GetChannelStatus().

Referenced by AddNoisyChannel(), and IsBad().

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

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

override

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

Definition at line 204 of file SIOVChannelStatusProvider.cxx.

References GetChannelsWithStatus().

Referenced by Status().

                                                 {
    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 110 of file SIOVChannelStatusProvider.h.

References DBUpdate().

Referenced by AddNoisyChannel(), and GetChannelStatus().

        { return DBChannelID_t(channel); }

void lariov::DatabaseRetrievalAlg::Reconfigure ( fhicl::ParameterSet const &  p )

virtualinherited

Configure using fhicl::ParameterSet.

Reimplemented in lariov::DetPedestalRetrievalAlg, lariov::SIOVElectronicsCalibProvider, and lariov::SIOVPmtGainProvider.

Definition at line 9 of file DatabaseRetrievalAlg.cxx.

References lariov::DatabaseRetrievalAlg::fFolder, and fhicl::ParameterSet::get().

Referenced by lariov::DatabaseRetrievalAlg::DatabaseRetrievalAlg(), lariov::SIOVPmtGainProvider::Reconfigure(), lariov::SIOVElectronicsCalibProvider::Reconfigure(), lariov::DetPedestalRetrievalAlg::Reconfigure(), and lariov::DatabaseRetrievalAlg::~DatabaseRetrievalAlg().

                                                                   {

    std::string foldername = p.get<std::string>("DBFolderName");
    std::string url        = p.get<std::string>("DBUrl");
    std::string tag        = p.get<std::string>("DBTag", "");
    fFolder.reset(new DBFolder(foldername, url, tag));
  }

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

inlineoverride

Definition at line 78 of file SIOVChannelStatusProvider.h.

References AddNoisyChannel(), BadChannels(), GetChannelStatus(), GoodChannels(), NoisyChannels(), Update(), and UpdateTimeStamp().

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

const std::string& lariov::DatabaseRetrievalAlg::Tag ( ) const

inlineinherited

Definition at line 56 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->Tag();}

bool lariov::SIOVChannelStatusProvider::Update

(

DBTimeStamp_t

ts

)

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

Definition at line 91 of file SIOVChannelStatusProvider.cxx.

References DBUpdate(), fEventTimeStamp, and fNewNoisy.

Referenced by Status().

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

bool lariov::DatabaseRetrievalAlg::UpdateFolder ( DBTimeStamp_t  ts )

inlineinherited

Return true if fFolder is successfully updated.

Definition at line 49 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

Referenced by lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), lariov::DetPedestalRetrievalAlg::DBUpdate(), and DBUpdate().

                                          {
        return fFolder->UpdateData(ts);
      }       

void lariov::SIOVChannelStatusProvider::UpdateTimeStamp

(

DBTimeStamp_t

ts

)

Update event time stamp.

Definition at line 83 of file SIOVChannelStatusProvider.cxx.

References fEventTimeStamp, and fNewNoisy.

Referenced by lariov::SIOVChannelStatusService::PreProcessEvent(), and Status().

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

const std::string& lariov::DatabaseRetrievalAlg::URL ( ) const

inlineinherited

Get connection information.

Definition at line 54 of file DatabaseRetrievalAlg.h.

References lariov::DatabaseRetrievalAlg::fFolder.

{return fFolder->URL();}

Member Data Documentation

DBTimeStamp_t lariov::SIOVChannelStatusProvider::fCurrentTimeStamp

mutableprivate

Definition at line 123 of file SIOVChannelStatusProvider.h.

Referenced by DBUpdate().

Snapshot<ChannelStatus> lariov::SIOVChannelStatusProvider::fData

mutableprivate

Definition at line 126 of file SIOVChannelStatusProvider.h.

Referenced by DBUpdate(), GetChannelStatus(), and SIOVChannelStatusProvider().

DataSource::ds lariov::SIOVChannelStatusProvider::fDataSource

private

Definition at line 125 of file SIOVChannelStatusProvider.h.

Referenced by DBUpdate(), GetChannelStatus(), GetChannelsWithStatus(), and SIOVChannelStatusProvider().

ChannelStatus lariov::SIOVChannelStatusProvider::fDefault

private

Definition at line 128 of file SIOVChannelStatusProvider.h.

Referenced by GetChannelStatus(), GetChannelsWithStatus(), and SIOVChannelStatusProvider().

DBTimeStamp_t lariov::SIOVChannelStatusProvider::fEventTimeStamp

private

Definition at line 122 of file SIOVChannelStatusProvider.h.

Referenced by DBUpdate(), Update(), and UpdateTimeStamp().

std::unique_ptr<DBFolder> lariov::DatabaseRetrievalAlg::fFolder

protectedinherited

Definition at line 65 of file DatabaseRetrievalAlg.h.

Referenced by lariov::DatabaseRetrievalAlg::Begin(), lariov::SIOVPmtGainProvider::DBUpdate(), lariov::SIOVElectronicsCalibProvider::DBUpdate(), lariov::DetPedestalRetrievalAlg::DBUpdate(), DBUpdate(), lariov::DatabaseRetrievalAlg::End(), lariov::DatabaseRetrievalAlg::FolderName(), lariov::DatabaseRetrievalAlg::Reconfigure(), lariov::DatabaseRetrievalAlg::Tag(), lariov::DatabaseRetrievalAlg::UpdateFolder(), and lariov::DatabaseRetrievalAlg::URL().

Snapshot<ChannelStatus> lariov::SIOVChannelStatusProvider::fNewNoisy

private

Definition at line 127 of file SIOVChannelStatusProvider.h.

Referenced by AddNoisyChannel(), GetChannelStatus(), Update(), and UpdateTimeStamp().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larevt/v07_02_01/source/larevt/CalibrationDBI/Providers/SIOVChannelStatusProvider.h
• /cvmfs/larsoft.opensciencegrid.org/products/larevt/v07_02_01/source/larevt/CalibrationDBI/Providers/SIOVChannelStatusProvider.cxx