FclStickyCodeFlagger Class Reference

#include <FclStickyCodeFlagger.h>

Inheritance diagram for FclStickyCodeFlagger:

Public Types
using	Index = unsigned int
using	IndexVector = std::vector< Index >
using	IndexVectorMap = std::map< Index, IndexVector >
using	IndexPair = std::pair< Index, Index >
using	IndexPairMap = std::multimap< Index, IndexPair >
using	Name = std::string

Public Member Functions
	FclStickyCodeFlagger (fhicl::ParameterSet const &ps)
	~FclStickyCodeFlagger () override=default
DataMap	update (AdcChannelData &acds) const override

Private Attributes
int	m_LogLevel
AdcFlag	m_StickyCode
IndexVectorMap	m_stickyCodes
IndexPairMap	m_stickyRanges

Additional Inherited Members
Private Types inherited from AdcChannelTool
using	Index = unsigned int
Private Member Functions inherited from TpcDataTool
virtual DataMap	updateTpcData (TpcData &) const
virtual DataMap	viewTpcData (const TpcData &) const
virtual int	forwardTpcData () const
Private Member Functions inherited from AdcChannelTool
virtual	~AdcChannelTool ()=default
virtual DataMap	view (const AdcChannelData &acd) const
virtual DataMap	updateMap (AdcChannelDataMap &acds) const
virtual DataMap	viewMap (const AdcChannelDataMap &acds) const
virtual bool	updateWithView () const
virtual bool	viewWithUpdate () const
virtual DataMap	beginEvent (const DuneEventInfo &) const
virtual DataMap	endEvent (const DuneEventInfo &) const
virtual DataMap	close (const DataMap *dmin=nullptr)
Static Private Member Functions inherited from AdcChannelTool
static int	interfaceNotImplemented ()

Detailed Description

Definition at line 38 of file FclStickyCodeFlagger.h.

Member Typedef Documentation

using FclStickyCodeFlagger::Index = unsigned int

Definition at line 42 of file FclStickyCodeFlagger.h.

using FclStickyCodeFlagger::IndexPair = std::pair<Index, Index>

Definition at line 45 of file FclStickyCodeFlagger.h.

using FclStickyCodeFlagger::IndexPairMap = std::multimap<Index, IndexPair>

Definition at line 46 of file FclStickyCodeFlagger.h.

using FclStickyCodeFlagger::IndexVector = std::vector<Index>

Definition at line 43 of file FclStickyCodeFlagger.h.

using FclStickyCodeFlagger::IndexVectorMap = std::map<Index, IndexVector>

Definition at line 44 of file FclStickyCodeFlagger.h.

using FclStickyCodeFlagger::Name = std::string

Definition at line 47 of file FclStickyCodeFlagger.h.

Constructor & Destructor Documentation

FclStickyCodeFlagger::FclStickyCodeFlagger

(

fhicl::ParameterSet const &

ps

)

Definition at line 71 of file FclStickyCodeFlagger_tool.cc.

: m_LogLevel(ps.get<int>("LogLevel")),
  m_StickyCode(ps.get<AdcFlag>("StickyCode")) {
  const string myname = "FclStickyCodeFlagger::ctor: ";
  // Display configuration.
  if ( m_LogLevel ) {
    cout << myname << "Configuration: " << endl;
    cout << myname << "          LogLevel: " << m_LogLevel << endl;
    cout << myname << "        StickyCode: " << m_StickyCode << endl;
  }
  // Check the sticky code.
  if ( m_StickyCode < AdcStuck || m_StickyCode >= AdcMitigated ) {
    cout << myname << "WARNING: Flag for sticky code has an unexpected value: "
         << m_StickyCode << endl;
  }
  // Build the sticky code map.
  fhicl::ParameterSet pstabsc = ps.get<fhicl::ParameterSet>("StickyCodes");
  IndexVectorMultiMap mvmap;
  int nerr = readFclIndexMap("chan", "Sticky codes", m_LogLevel, pstabsc, mvmap);
  for ( const IndexVectorMultiMap::value_type& imma : mvmap ) {
    Index icha = imma.first;
    const IndexVector& newcodes = imma.second;
    IndexVector& codes = m_stickyCodes[icha];
    codes.insert(codes.end(), newcodes.begin(), newcodes.end());
  }
  Index ncha = m_stickyCodes.size();
  Index ncod = 0;
  for ( IndexVectorMap::value_type& ient : m_stickyCodes ) ncod += ient.second.size();
  cout << myname << "Found " << ncod << " sticky code" << (ncod == 1 ? "" : "s") << " for "
       << ncha << " channel" << (ncha == 1 ? "" : "s") << "." << endl;
  if ( nerr ) {
    cout << myname << "WARNING: Found " << nerr << " error" << (nerr == 1 ? "" : "s")
                   << " while parsing the sticky code map." << endl;
  }
  // Build the sticky code range map.
  fhicl::ParameterSet pstabsr = ps.get<fhicl::ParameterSet>("StickyRanges");
  nerr = readFclIndexMap("chan", "Sticky ranges", m_LogLevel, pstabsr, m_stickyRanges);
  IndexSet chset;
  Index nran = m_stickyRanges.size();
  for ( IndexPairMap::value_type& ient : m_stickyRanges ) chset.insert(ient.first);
  ncha = chset.size();
  cout << myname << "Found " << nran << " sticky range" << (nran == 1 ? "" : "s") << " for "
       << ncha << " channel" << (ncha == 1 ? "" : "s") << "." << endl;
  if ( nerr ) {
    cout << myname << "WARNING: Found " << nerr << " error" << (nerr == 1 ? "" : "s")
                   << " while parsing the sticky range map." << endl;
  }
}

FclStickyCodeFlagger::~FclStickyCodeFlagger ( )

overridedefault

Member Function Documentation

DataMap FclStickyCodeFlagger::update ( AdcChannelData &  acds ) const

overridevirtual

Reimplemented from AdcChannelTool.

Definition at line 122 of file FclStickyCodeFlagger_tool.cc.

                                                              {
  const string myname = "FclStickyCodeFlagger::view: ";
  DataMap ret;
  // Make sure flags is as long as raw.
  if ( acd.flags.size() < acd.raw.size() ) {
    cout << myname << "WARNING: Increasing size of the flags vector for channel " << acd.channel() << endl;
    acd.flags.resize(acd.raw.size(), AdcGood);
  }
  IndexSet samplesToFlag;
  // Find samples with sticky codes.
  IndexVectorMap::const_iterator icod = m_stickyCodes.find(acd.channel());
  if ( icod != m_stickyCodes.end() ) {
    const IndexVector& codes = icod->second;
    for ( Index isam=0; isam<acd.raw.size(); ++isam ) {
      if ( std::find(codes.begin(), codes.end(), acd.raw[isam]) != codes.end() ) samplesToFlag.insert(isam);
    }
  }
  // Find samples with in sticky code ranges.
  using IndexPairRange = std::pair<IndexPairMap::const_iterator, IndexPairMap::const_iterator>;
  IndexPairRange irans = m_stickyRanges.equal_range(acd.channel());
  for ( IndexPairMap::const_iterator iran=irans.first; iran!=irans.second; ++iran ) {
    IndexPair ran = iran->second;
    for ( Index isam=0; isam<acd.raw.size(); ++isam ) {
      AdcIndex adc = acd.raw[isam];
      if ( adc >= ran.first && adc <= ran.second ) samplesToFlag.insert(isam);
    }
  }
  // Set flags.
  for ( AdcIndex isam : samplesToFlag ) acd.flags[isam] = m_StickyCode;
  // Fill output data map and return.
  ret.setInt("stickyChannel", acd.channel());
  ret.setInt("stickyCodeCount", samplesToFlag.size());
  return ret;
}

Member Data Documentation

int FclStickyCodeFlagger::m_LogLevel

private

Definition at line 58 of file FclStickyCodeFlagger.h.

AdcFlag FclStickyCodeFlagger::m_StickyCode

private

Definition at line 59 of file FclStickyCodeFlagger.h.

IndexVectorMap FclStickyCodeFlagger::m_stickyCodes

private

Definition at line 62 of file FclStickyCodeFlagger.h.

IndexPairMap FclStickyCodeFlagger::m_stickyRanges

private

Definition at line 63 of file FclStickyCodeFlagger.h.

---

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

• dunedataprep/dunedataprep/DataPrep/Tool/FclStickyCodeFlagger.h
• dunedataprep/dunedataprep/DataPrep/Tool/FclStickyCodeFlagger_tool.cc