AdcChannelFFT Class Reference

#include <AdcChannelFFT.h>

Inheritance diagram for AdcChannelFFT:

Public Types
using	Index = unsigned int
using	FloatVector = AdcSignalVector
using	DFT = DuneFFT::DFT
using	Name = std::string

Public Member Functions
	AdcChannelFFT (fhicl::ParameterSet const &ps)
	~AdcChannelFFT () override=default
DataMap	view (const AdcChannelData &acd) const override
DataMap	update (AdcChannelData &acd) const override

Private Member Functions
DataMap	viewTop (const AdcChannelData &acd) const
DataMap	updateTop (AdcChannelData &acd) const
void	internalView (const AdcChannelData &acd, FloatVector &sams, FloatVector &amps, FloatVector &phas, DataMap &ret) 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	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)

Private Attributes
int	m_LogLevel
Index	m_FirstTick
Index	m_NTick
Index	m_Action
Index	m_ReturnOpt
Name	m_DataView

Additional Inherited Members
Private Types inherited from AdcChannelTool
using	Index = unsigned int
Static Private Member Functions inherited from AdcChannelTool
static int	interfaceNotImplemented ()

Detailed Description

Definition at line 74 of file AdcChannelFFT.h.

Member Typedef Documentation

using AdcChannelFFT::DFT = DuneFFT::DFT

Definition at line 80 of file AdcChannelFFT.h.

using AdcChannelFFT::FloatVector = AdcSignalVector

Definition at line 79 of file AdcChannelFFT.h.

using AdcChannelFFT::Index = unsigned int

Definition at line 78 of file AdcChannelFFT.h.

using AdcChannelFFT::Name = std::string

Definition at line 81 of file AdcChannelFFT.h.

Constructor & Destructor Documentation

AdcChannelFFT::AdcChannelFFT

(

fhicl::ParameterSet const &

ps

)

Definition at line 24 of file AdcChannelFFT_tool.cc.

: m_LogLevel(ps.get<int>("LogLevel")), 
  m_FirstTick(ps.get<Index>("FirstTick")),
  m_NTick(ps.get<Index>("NTick")),
  m_Action(ps.get<Index>("Action")),
  m_ReturnOpt(ps.get<Index>("ReturnOpt")),
  m_DataView(ps.get<Name>("DataView")) {
  const string myname = "AdcChannelFFT::ctor: ";
  if ( m_LogLevel ) {
    cout << myname << "Configuration: " << endl;
    cout << myname << "            LogLevel: " << m_LogLevel << endl;
    cout << myname << "           FirstTick: " << m_FirstTick << endl;
    cout << myname << "               NTick: " << m_NTick << endl;
    cout << myname << "              Action: " << m_Action << endl;
    cout << myname << "           ReturnOpt: " << m_ReturnOpt << endl;
    cout << myname << "            DataView: " << m_DataView << endl;
  }
}

AdcChannelFFT::~AdcChannelFFT ( )

overridedefault

Member Function Documentation

void AdcChannelFFT::internalView ( const AdcChannelData &  acd, FloatVector &  sams, FloatVector &  amps, FloatVector &  phas, DataMap &  ret  ) const

private

Definition at line 151 of file AdcChannelFFT_tool.cc.

                                                                                                                     {
  const string myname = "AdcChannelFFT::internalView: ";
  bool doForward = false;
  bool doInverse = false;
  if ( m_Action <= 4 ) {
    if ( m_Action > 0 ) {
      if ( m_Action == 2 || m_Action == 4 ) {
        doForward = acd.dftmags.size() == 0;
      } else {
        doForward = true;
      }
    }
  } else if ( m_Action >= 10  && m_Action <= 14 ) {
    if ( m_Action != 10 ) {
      if ( m_Action == 12 || m_Action == 14 ) {
        doInverse = acd.samples.size() == 0;
      } else {
        doInverse = true;
      }
    }
  } else {
    cout << myname << "ERROR: Invalid action: " << m_Action << endl;
    ret.setStatus(1);
    return;
  }
  Index isam0 = 0;
  Index nsam = 0;
  RealDftNormalization dftNorm(AdcChannelData::dftNormalization());
  DFT dft(dftNorm);
  int passLog = m_LogLevel < 3 ? 0 : m_LogLevel - 3;
  if ( doForward ) {
    isam0 = m_FirstTick;
    if ( isam0 >= acd.samples.size() ) {
      cout << myname << "WARNING: No data in range." << endl;
      ret.setStatus(11);
      return;
    }
    nsam = acd.samples.size() - isam0;
    if ( m_LogLevel >= 3 ) cout << myname << "Forward FFT with " << nsam << " samples." << endl;
    if ( m_NTick > 0 && m_NTick < nsam ) nsam = m_NTick;
    int rstat = DuneFFT::fftForward(nsam, &acd.samples[isam0], dft, passLog);
    if ( rstat ) {
      ret.setStatus(10+rstat);
      cout << myname << "WARNING: Forward FFT failed." << endl;
      return;
    }
  } else if ( doInverse ) {
    dft.copyIn(acd.dftmags, acd.dftphases);
    if ( ! dft.isValid() ) {
      ret.setStatus(20);
      cout << "ERROR: Unable to find DFT in AdcChannelData." << endl;
      return;
    }
    int rstat = DuneFFT::fftInverse(dft, sams, passLog);
    xams = acd.dftmags;
    xphs = acd.dftphases;
    if ( m_LogLevel >= 3 ) cout << myname << "Inverse FFT for " << dft.size() << " samples." << endl;
    if ( rstat ) {
      ret.setStatus(20+rstat);
      cout << myname << "WARNING: Inverse FFT failed." << endl;
      return;
    }
  }
  // Fetch return data stored in the DFT.
  Index dftRet = m_ReturnOpt % 10;
  if ( dftRet >= 3 ) {
    FloatVector fftres(nsam);
    FloatVector fftims(nsam);
    for ( Index ifrq=0; ifrq<nsam; ++ifrq ) {
      fftres[ifrq] = dft.real(ifrq);
      fftims[ifrq] = dft.imag(ifrq);
    }
    ret.setFloatVector("fftReals", fftres);
    ret.setFloatVector("fftImags", fftims);
  }
  // Move data out of the DFT (leaving it invalid).
  if ( doForward ) dft.moveOut(xams, xphs);
  // Fetch return data not stored in the DFT.
  if ( m_ReturnOpt >= 1 ) {
    ret.setInt("fftTick0", isam0);
    ret.setInt("fftNTick", nsam);
  }
  if ( dftRet >= 1 ) {
    ret.setInt("fftNMag",   xams.size());
    ret.setInt("fftNPhase", xphs.size());
  }
  if ( dftRet >= 2 ) {
    ret.setFloatVector("fftMags",   xams);
    ret.setFloatVector("fftPhases", xphs);
  }
  if ( m_ReturnOpt >= 10 ) {
    if ( sams.size() ) ret.setFloatVector("fftSamples", sams);
    else ret.setFloatVector("fftSamples", acd.samples);
  }
  return;
}

DataMap AdcChannelFFT::update ( AdcChannelData &  acd ) const

overridevirtual

Reimplemented from AdcChannelTool.

Definition at line 73 of file AdcChannelFFT_tool.cc.

                                                       {
  const string myname = "AdcChannelFFT::update: ";
  if ( m_DataView.size() == 0 ) return updateTop(acd);
  DataMap retTop;
  if ( ! acd.hasView(m_DataView) ) {
    if ( m_LogLevel >= 2 ) {
      cout << myname << "View " << m_DataView << " not found for event " << acd.event()
           << " channel " << acd.channel() << endl;
    }
    return retTop.setStatus(1);
  }
  Index nproc = 0;
  Index nfail = 0;
  AdcIndex nent = acd.viewSize(m_DataView);
  for ( AdcIndex ient=0; ient<nent; ++ient ) {
    AdcChannelData* pacd = acd.mutableViewEntry(m_DataView, ient);
    DataMap ret;
    if ( pacd == nullptr ) {
      cout << myname << "Channel " << acd.channel() << " view entry "
           << m_DataView << "[" << ient << "] is null." << endl;
      ret.setStatus(99);
    } else {
      ret = updateTop(*pacd);
    }
    ++nproc;
    if ( ret ) ++nfail;
  }
  retTop.setInt("fftNproc", nproc);
  retTop.setInt("fftNfail", nproc);
  if ( nfail ) retTop.setStatus(2);
  if ( m_LogLevel >= 3 ) {
    cout << myname << "Channel " << acd.channel() << " entry counts: "
         << nproc << " processed, " << nfail << " failed." << endl;
  }
  return retTop;
}

DataMap AdcChannelFFT::updateTop ( AdcChannelData &  acd ) const

private

Definition at line 124 of file AdcChannelFFT_tool.cc.

                                                          {
  const string myname = "AdcChannelFFT::update: ";
  DataMap ret;
  DataMap::FloatVector sams;
  DataMap::FloatVector mags;
  DataMap::FloatVector phas;
  internalView(acd, sams, mags, phas, ret);
  if ( ret ) return ret;
  if ( m_Action == 3 || m_Action == 4 ) {
    if ( mags.size() ) {
      if ( m_LogLevel >= 2 ) cout << myname << "Saving DFT." << endl;
      acd.dftmags = mags;
      acd.dftphases = phas;
    }
  }
  if ( m_Action == 13 || m_Action == 14 ) {
    if ( sams.size() ) {
      if ( m_LogLevel >= 2 ) cout << myname << "Saving samples." << endl;
      acd.samples = sams;
    }
  }
  return ret;
}

DataMap AdcChannelFFT::view ( const AdcChannelData &  acd ) const

overridevirtual

Reimplemented from AdcChannelTool.

Definition at line 45 of file AdcChannelFFT_tool.cc.

                                                           {
  const string myname = "AdcChannelFFT::view: ";
  DataMap retTop;
  if ( m_DataView.size() == 0 ) return viewTop(acd);
  if ( ! acd.hasView(m_DataView) ) {
    if ( m_LogLevel >= 2 ) {
      cout << myname << "View " << m_DataView << " not found for event " << acd.event()
           << " channel " << acd.channel() << endl;
    }
    return retTop.setStatus(1);
  }
  Index nproc = 0;
  Index nfail = 0;
  AdcIndex nvie = acd.viewSize(m_DataView);
  for ( AdcIndex ivie=0; ivie<nvie; ++ivie ) {
    const AdcChannelData* pacd = acd.viewEntry(m_DataView, ivie);
    DataMap ret = viewTop(*pacd);
    ++nproc;
    if ( ret ) ++nfail;
  }
  retTop.setInt("fftNproc", nproc);
  retTop.setInt("fftNfail", nproc);
  if ( nfail ) retTop.setStatus(2);
  return retTop;
}

DataMap AdcChannelFFT::viewTop ( const AdcChannelData &  acd ) const

private

Definition at line 112 of file AdcChannelFFT_tool.cc.

                                                              {
  const string myname = "AdcChannelFFT::view: ";
  DataMap ret;
  DataMap::FloatVector sams;
  DataMap::FloatVector mags;
  DataMap::FloatVector phas;
  internalView(acd, sams, mags, phas, ret);
  return ret;
}

Member Data Documentation

Index AdcChannelFFT::m_Action

private

Definition at line 109 of file AdcChannelFFT.h.

Name AdcChannelFFT::m_DataView

private

Definition at line 111 of file AdcChannelFFT.h.

Index AdcChannelFFT::m_FirstTick

private

Definition at line 107 of file AdcChannelFFT.h.

int AdcChannelFFT::m_LogLevel

private

Definition at line 106 of file AdcChannelFFT.h.

Index AdcChannelFFT::m_NTick

private

Definition at line 108 of file AdcChannelFFT.h.

Index AdcChannelFFT::m_ReturnOpt

private

Definition at line 110 of file AdcChannelFFT.h.

---

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

• dunedataprep/dunedataprep/DataPrep/Tool/AdcChannelFFT.h
• dunedataprep/dunedataprep/DataPrep/Tool/AdcChannelFFT_tool.cc