CnrByGroup Class Reference

#include <CnrByGroup.h>

Inheritance diagram for CnrByGroup:

Public Member Functions
	CnrByGroup (fhicl::ParameterSet const &ps)
	~CnrByGroup () override=default
DataMap	updateMap (AdcChannelDataMap &acds) const override

Private Types
using	Name = std::string
using	NameVector = std::vector< Name >
using	Index = unsigned int
using	IndexVector = std::vector< Index >
using	ChannelGroups = std::map< Name, IndexVector >
using	FloatVector = std::vector< float >
Private Types inherited from AdcChannelTool
using	Index = unsigned int

Private Member Functions
FloatVector	getCorrection (const IndexVector &channels, const AdcChannelDataMap &acds) const
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	update (AdcChannelData &) const
virtual DataMap	view (const AdcChannelData &acd) 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)

Private Attributes
int	m_LogLevel
NameVector	m_Groups
NameVector	m_Options
ChannelGroups	m_chg
bool	m_useMedian =false
bool	m_dropSignal =true
bool	m_requireGoodChannel =true

Additional Inherited Members
Static Private Member Functions inherited from AdcChannelTool
static int	interfaceNotImplemented ()

Detailed Description

Definition at line 28 of file CnrByGroup.h.

Member Typedef Documentation

using CnrByGroup::ChannelGroups = std::map<Name, IndexVector>

private

Definition at line 47 of file CnrByGroup.h.

using CnrByGroup::FloatVector = std::vector<float>

private

Definition at line 48 of file CnrByGroup.h.

using CnrByGroup::Index = unsigned int

private

Definition at line 45 of file CnrByGroup.h.

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

private

Definition at line 46 of file CnrByGroup.h.

using CnrByGroup::Name = std::string

private

Definition at line 43 of file CnrByGroup.h.

using CnrByGroup::NameVector = std::vector<Name>

private

Definition at line 44 of file CnrByGroup.h.

Constructor & Destructor Documentation

CnrByGroup::CnrByGroup

(

fhicl::ParameterSet const &

ps

)

Definition at line 20 of file CnrByGroup_tool.cc.

: m_LogLevel(ps.get<int>("LogLevel")),
  m_Groups(ps.get<NameVector>("Groups")),
  m_Options(ps.get<NameVector>("Options")) {
  const string myname = "CnrByGroup::ctor: ";
  // Decode the options.
  for ( Name sopt : m_Options ) {
    if ( sopt == "mean" ) m_useMedian = false;
    else if ( sopt == "median" ) m_useMedian = true;
    else cout << myname << "WARNING: Ignoring invalid option: " << sopt << endl;
  }
  // Build the channel map.
  string crtName = "channelGroups";
  DuneToolManager* ptm = DuneToolManager::instance();
  const IndexRangeGroupTool* pcrt = ptm == nullptr ? nullptr : ptm->getShared<IndexRangeGroupTool>(crtName);
  for ( Name sgrp : m_Groups ) {
    IndexRangeGroup grp;
    if ( pcrt != nullptr ) grp = pcrt->get(sgrp);
    if ( ! grp.isValid() ) {
      grp = IndexRangeGroup(sgrp);
    }
    if ( ! grp.isValid() ) {
      cout << myname << "WARNING: Unable to find range group " << sgrp << endl;
    } else {
      grp.getIndices(m_chg[grp.name]);
    }
  }
       
  // Log the configuration.
  if ( m_LogLevel >= 1 ) {
    cout << myname << "  LogLevel: " << m_LogLevel << endl;
    cout << myname << "    Groups: [";
    int count = 0;
    for ( Name nam : m_Groups ) {
      if ( count && count%10 == 0 ) cout << "\n             ";
      if ( count++ ) cout << ", ";
      cout << nam;
    }
    cout << "]" << endl;
    cout << myname << "   Options: [";
    count = 0;
    for ( Name nam : m_Options ) {
      if ( count++ ) cout << ", ";
      cout << nam;
    }
    cout << "]" << endl;
    cout << myname << "Using " << (m_useMedian ? "median" : "mean") << " correction." << endl;
    cout << myname << "Using " << (m_dropSignal ? "all" : "non-signal") << " samples." << endl;
    cout << myname << (m_requireGoodChannel ? "R" : "Not r") << "equiring good channel status." << endl;
    cout << myname << "    Group   #chan" << endl;
    for ( const auto& ient : m_chg ) {
      cout << myname << setw(10) << ient.first << setw(8) << ient.second.size() << endl;
    }
  }
}

CnrByGroup::~CnrByGroup ( )

overridedefault

Member Function Documentation

CnrByGroup::FloatVector CnrByGroup::getCorrection ( const IndexVector &  channels, const AdcChannelDataMap &  acds  ) const

private

Definition at line 105 of file CnrByGroup_tool.cc.

                                                                                {
  const string myname = "CnrByGroup::getCorrection: ";
  Index nsam = 0;
  std::vector<FloatVector> samples;
  for ( Index ich : channels ) {
    auto iacd = acds.find(ich);
    if ( iacd == acds.end() ) continue;
    const AdcChannelData& acd = iacd->second;
    if ( m_requireGoodChannel && acd.channelStatus() ) continue;
    if ( acd.samples.size() > nsam ) {
      nsam = acd.samples.size();
      samples.resize(nsam);
    }
    for ( size_t isam=0; isam<acd.samples.size(); ++isam ) {
      if ( m_dropSignal && acd.signal.size()>isam && acd.signal[isam] ) continue;
      samples[isam].push_back(acd.samples[isam]);
    }
  }
  std::vector<float> correction(nsam, 0.0);
  Index nsamCor = 0;
  for ( Index isam=0; isam<nsam; ++isam ) {
    size_t nval = samples[isam].size();
    if ( nval < 2 ) continue;
    if ( m_useMedian ) {
      std::sort(samples[isam].begin(), samples[isam].end());
      if ( nval%2 == 0 ) correction[isam] = 0.5 * (samples[isam][nval/2-1] + samples[isam][nval/2]);
      else correction[isam] = samples[isam][nval/2];
    } else {
      float sum = 0.0;
      for ( float val : samples[isam] ) sum += val;
      correction[isam] = sum/float(samples[isam].size());
    }
    ++nsamCor;
  }
  if ( m_LogLevel >= 2 ) cout << myname << "Correcting " << nsamCor << "/" << nsam << " samples." << endl;
  return correction;
}

DataMap CnrByGroup::updateMap ( AdcChannelDataMap &  acds ) const

overridevirtual

Reimplemented from AdcChannelTool.

Definition at line 78 of file CnrByGroup_tool.cc.

                                                           {
  const string myname = "CnrByGroup::updateMap: ";
  DataMap ret;
  if ( acds.size() == 0 ) {
    std::cout << myname << "WARNING: No channels found." << std::endl;
    return ret.setStatus(1);
  }
  for ( const auto& entry : m_chg ) {   
    const IndexVector& channels = entry.second;
    std::vector<float> correction = getCorrection(channels, acds);
    for ( Index ich : channels) {
      auto iacd = acds.find(ich);
      if ( iacd == acds.end() ) continue;
      AdcChannelData& acd = iacd->second;
      if ( acd.samples.size() == 0 ) continue;
      if ( acd.samples.size() > correction.size() ) correction.resize(acd.samples.size(), 0.);
      for ( size_t isam=0; isam<acd.samples.size(); ++isam) {
        acd.samples[isam] -= correction[isam];  
      }
    }
  }
  return ret;
}

Member Data Documentation

ChannelGroups CnrByGroup::m_chg

private

Definition at line 56 of file CnrByGroup.h.

bool CnrByGroup::m_dropSignal =true

private

Definition at line 58 of file CnrByGroup.h.

NameVector CnrByGroup::m_Groups

private

Definition at line 52 of file CnrByGroup.h.

int CnrByGroup::m_LogLevel

private

Definition at line 51 of file CnrByGroup.h.

NameVector CnrByGroup::m_Options

private

Definition at line 53 of file CnrByGroup.h.

bool CnrByGroup::m_requireGoodChannel =true

private

Definition at line 59 of file CnrByGroup.h.

bool CnrByGroup::m_useMedian =false

private

Definition at line 57 of file CnrByGroup.h.

---

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

• dunedataprep/dunedataprep/DataPrep/Tool/CnrByGroup.h
• dunedataprep/dunedataprep/DataPrep/Tool/CnrByGroup_tool.cc