AdcChannelData Class Reference

#include <AdcChannelData.h>

Public Types
using	Name = std::string
using	NameVector = std::vector< Name >
using	FloatMap = std::map< Name, float >
using	View = std::vector< AdcChannelData >
using	ViewMap = std::map< Name, View >
using	EventInfo = DuneEventInfo
using	EventInfoPtr = std::shared_ptr< const EventInfo >
using	ChannelInfo = DuneChannelInfo
using	ChannelInfoPtr = std::shared_ptr< const ChannelInfo >
using	Index = EventInfo::Index
using	LongIndex = EventInfo::LongIndex
using	Channel = ChannelInfo::Channel

Public Member Functions
void	setEventInfo (EventInfoPtr pevi)
void	setEventInfo (const EventInfo *pevi)
void	setEventInfo (Index a_run, Index a_event, Index a_subRun=badIndex(), time_t a_time=0, int a_timerem=0, Index a_trigger=badIndex(), LongIndex a_triggerClock=badLongIndex())
bool	hasEventInfo () const
EventInfoPtr	getEventInfoPtr () const
const DuneEventInfo &	getEventInfo () const
AdcIndex	run () const
AdcIndex	subRun () const
AdcIndex	event () const
time_t	time () const
int	timerem () const
AdcIndex	trigger () const
AdcLongIndex	triggerClock () const
AdcLongIndex	triggerTick0 () const
void	setChannelInfo (ChannelInfoPtr pchi)
void	setChannelInfo (const ChannelInfo *pchi)
void	setChannelInfo (Channel a_channel, Index a_fembID=badIndex(), Index a_fembChannel=badIndex(), Index a_channelStatus=badIndex())
bool	hasChannelInfo () const
ChannelInfoPtr	getChannelInfoPtr () const
const DuneChannelInfo &	getChannelInfo () const
Channel	channel () const
Index	fembID () const
Index	fembChannel () const
Index	channelStatus () const
AdcLongIndex	tickOffset () const
	AdcChannelData (const AdcChannelData &rhs)
AdcChannelData &	operator= (const AdcChannelData &)=delete
	AdcChannelData ()=default
	AdcChannelData (AdcChannelData &&)=default
AdcChannelData &	operator= (AdcChannelData &&)=default
bool	hasMetadata (Name mname) const
float	getMetadata (Name mname, float def=0.0) const
void	setMetadata (Name mname, float val)
bool	hasAttribute (Name mname, float def=0.0) const
float	getAttribute (Name mname, float def=0.0) const
void	clear ()
void	roisFromSignal ()
size_t	viewSize () const
NameVector	viewNames () const
bool	hasView (Name vnam) const
const View &	view (Name vnam) const
View &	updateView (Name vnam)
AdcIndex	viewSize (Name vpnam) const
const AdcChannelData *	viewEntry (Name vpnam, AdcIndex ient) const
AdcChannelData *	mutableViewEntry (Name vpnam, AdcIndex ient)

Static Public Member Functions
static Index	badIndex ()
static Index	badLongIndex ()
static Index	badChannel ()
static Index	badSignal ()
static const EventInfo &	badEventInfo ()
static const ChannelInfo &	badChannelInfo ()
static AdcIndex	dftNormalization ()

Public Attributes
AdcLongIndex	channelClock =0
AdcInt	tick0 = 0
AdcSignal	pedestal =badSignal()
AdcSignal	pedestalRms =0.0
AdcCountVector	raw
AdcSignalVector	samples
AdcSignalVectorVector	binSamples
Name	sampleUnit
AdcSignal	sampleNoise =0.0
AdcFlagVector	flags
AdcFilterVector	signal
AdcRoiVector	rois
AdcSignalVector	dftmags
AdcSignalVector	dftphases
FloatMap	metadata
AdcChannelData *	viewParent =nullptr
const raw::RawDigit *	digit =nullptr
const recob::Wire *	wire =nullptr
AdcIndex	digitIndex =badIndex()
AdcIndex	wireIndex =badIndex()

Private Attributes
EventInfoPtr	m_peventInfo
ChannelInfoPtr	m_pchanInfo
ViewMap	m_views

Detailed Description

Definition at line 95 of file AdcChannelData.h.

Member Typedef Documentation

using AdcChannelData::Channel = ChannelInfo::Channel

Definition at line 110 of file AdcChannelData.h.

using AdcChannelData::ChannelInfo = DuneChannelInfo

Definition at line 106 of file AdcChannelData.h.

using AdcChannelData::ChannelInfoPtr = std::shared_ptr<const ChannelInfo>

Definition at line 107 of file AdcChannelData.h.

using AdcChannelData::EventInfo = DuneEventInfo

Definition at line 104 of file AdcChannelData.h.

using AdcChannelData::EventInfoPtr = std::shared_ptr<const EventInfo>

Definition at line 105 of file AdcChannelData.h.

using AdcChannelData::FloatMap = std::map<Name, float>

Definition at line 101 of file AdcChannelData.h.

using AdcChannelData::Index = EventInfo::Index

Definition at line 108 of file AdcChannelData.h.

using AdcChannelData::LongIndex = EventInfo::LongIndex

Definition at line 109 of file AdcChannelData.h.

using AdcChannelData::Name = std::string

Definition at line 99 of file AdcChannelData.h.

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

Definition at line 100 of file AdcChannelData.h.

using AdcChannelData::View = std::vector<AdcChannelData>

Definition at line 102 of file AdcChannelData.h.

using AdcChannelData::ViewMap = std::map<Name, View>

Definition at line 103 of file AdcChannelData.h.

Constructor & Destructor Documentation

AdcChannelData::AdcChannelData ( const AdcChannelData &  rhs )

inline

Definition at line 217 of file AdcChannelData.h.

                                            {
    channelClock  = rhs.channelClock;
    m_peventInfo  = rhs.m_peventInfo;
    m_pchanInfo  = rhs.m_pchanInfo;
  };

AdcChannelData::AdcChannelData ( )

default

AdcChannelData::AdcChannelData ( AdcChannelData &&  )

default

Member Function Documentation

static Index AdcChannelData::badChannel ( )

inlinestatic

Definition at line 114 of file AdcChannelData.h.

{ return EventInfo::badIndex(); }

static const ChannelInfo& AdcChannelData::badChannelInfo ( )

inlinestatic

Definition at line 121 of file AdcChannelData.h.

                                             {
    return ChannelInfo::badChannelInfo();
  }

static const EventInfo& AdcChannelData::badEventInfo ( )

inlinestatic

Definition at line 117 of file AdcChannelData.h.

                                         {
    return EventInfo::badEventInfo();
  }

static Index AdcChannelData::badIndex ( )

inlinestatic

Definition at line 112 of file AdcChannelData.h.

{ return EventInfo::badIndex(); }

static Index AdcChannelData::badLongIndex ( )

inlinestatic

Definition at line 113 of file AdcChannelData.h.

{ return EventInfo::badLongIndex(); }

static Index AdcChannelData::badSignal ( )

inlinestatic

Definition at line 115 of file AdcChannelData.h.

{ return -99999; }

Channel AdcChannelData::channel ( ) const

inline

Definition at line 199 of file AdcChannelData.h.

{ return getChannelInfo().channel; }

Index AdcChannelData::channelStatus ( ) const

inline

Definition at line 202 of file AdcChannelData.h.

{ return getChannelInfo().channelStatus; }

void AdcChannelData::clear ( )

inline

Definition at line 386 of file AdcChannelData.h.

                                  {
  channelClock = 0;
  pedestal = badSignal();
  pedestalRms = 0.0;
  tick0 = 0;
  raw.clear();
  samples.clear();
  sampleUnit = "";
  sampleNoise = 0.0;
  flags.clear();
  signal.clear();
  rois.clear();
  dftmags.clear();
  dftphases.clear();
  digit = nullptr;
  wire = nullptr;
  dftmags.clear();
  dftphases.clear();
  digitIndex = badIndex();
  wireIndex = badIndex();
  metadata.clear();
  m_peventInfo.reset();
  m_pchanInfo.reset();
}

static AdcIndex AdcChannelData::dftNormalization ( )

inlinestatic

Definition at line 336 of file AdcChannelData.h.

{ return 22; }

AdcIndex AdcChannelData::event ( ) const

inline

Definition at line 176 of file AdcChannelData.h.

{ return getEventInfo().event; }

Index AdcChannelData::fembChannel ( ) const

inline

Definition at line 201 of file AdcChannelData.h.

{ return getChannelInfo().fembChannel; }

Index AdcChannelData::fembID ( ) const

inline

Definition at line 200 of file AdcChannelData.h.

{ return getChannelInfo().fembID; }

float AdcChannelData::getAttribute ( Name  mname, float  def = 0.0  ) const

inline

Definition at line 291 of file AdcChannelData.h.

                                                       {
    if ( mname.substr(0,3) == "../" ) {
      if ( viewParent == nullptr ) return def;
      return viewParent->getAttribute(mname.substr(3));
    }
    // For basic types, return the value.
    if ( mname == "run" ) return run();
    if ( mname == "subRun" ) return subRun();
    if ( mname == "event" ) return event();
    if ( mname == "trigger" ) return trigger();
    if ( mname == "triggerClock" ) return triggerClock();  // lose precision here
    if ( mname == "channelClock" ) return channelClock;  // lose precision here
    if ( mname == "channelClockOffset" ) return channelClock - triggerClock();
    if ( mname == "channel" ) return channel();
    if ( mname == "fembID" ) return fembID();
    if ( mname == "fembChannel" ) return fembChannel();
    if ( mname == "pedestal" ) return pedestal;
    if ( mname == "pedestalRms" ) return pedestalRms;
    if ( mname == "sampleNoise" ) return sampleNoise;
    if ( mname == "digitIndex" ) return digitIndex;
    if ( mname == "wireIndex" ) return wireIndex;
    // For vectors, return the size.
    if ( mname == "raw" ) return raw.size();
    if ( mname == "samples" ) return samples.size();
    if ( mname == "flags" ) return flags.size();
    if ( mname == "signal" ) return signal.size();
    if ( mname == "rois" ) return rois.size();
    if ( mname == "dftmags" ) return dftmags.size();
    if ( mname == "dftphases" ) return dftphases.size();
    // For pointer, return false for null.
    if ( mname == "digit" ) return digit != nullptr;
    if ( mname == "wire" ) return wire != nullptr;
    if ( mname == "metadata" ) return metadata.size();
    // Otherwise return the metatdata field.
    return getMetadata(mname, def);
  }

const DuneChannelInfo& AdcChannelData::getChannelInfo ( ) const

inline

Definition at line 196 of file AdcChannelData.h.

                                                {
    return hasChannelInfo() ? *m_pchanInfo : badChannelInfo();
  }

ChannelInfoPtr AdcChannelData::getChannelInfoPtr ( ) const

inline

Definition at line 195 of file AdcChannelData.h.

{ return m_pchanInfo; }

const DuneEventInfo& AdcChannelData::getEventInfo ( ) const

inline

Definition at line 171 of file AdcChannelData.h.

                                            {
    return hasEventInfo() ? *m_peventInfo : badEventInfo();
  }

EventInfoPtr AdcChannelData::getEventInfoPtr ( ) const

inline

Definition at line 170 of file AdcChannelData.h.

{ return m_peventInfo; }

float AdcChannelData::getMetadata ( Name  mname, float  def = 0.0  ) const

inline

Definition at line 241 of file AdcChannelData.h.

                                                      {
    if ( mname.substr(0,3) == "../" ) {
      if ( viewParent == nullptr ) return def;
      return viewParent->getMetadata(mname.substr(3));
    }
    FloatMap::const_iterator imtd = metadata.find(mname);
    if ( imtd == metadata.end() ) return def;
    return imtd->second;
  }

bool AdcChannelData::hasAttribute ( Name  mname, float  def = 0.0  ) const

inline

Definition at line 257 of file AdcChannelData.h.

                                                      {
    if ( mname.substr(0,3) == "../" ) {
      if ( viewParent == nullptr ) return false;
      return viewParent->hasAttribute(mname.substr(3));
    }
    if ( mname == "run" ) return true;
    if ( mname == "subRun" ) return true;
    if ( mname == "event" ) return true;;
    if ( mname == "trigger" ) return true;;
    if ( mname == "triggerClock" ) return true;
    if ( mname == "channelClock" ) return true;
    if ( mname == "channelClockOffset" ) return true;
    if ( mname == "channel" ) return true;
    if ( mname == "fembID" ) return true;
    if ( mname == "fembChannel" ) return true;
    if ( mname == "pedestal" ) return true;
    if ( mname == "pedestalRms" ) return true;
    if ( mname == "sampleNoise" ) return true;
    if ( mname == "digitIndex" ) return true;
    if ( mname == "wireIndex" ) return true;
    if ( mname == "raw" ) return true;
    if ( mname == "samples" ) return true;
    if ( mname == "flags" ) return true;
    if ( mname == "signal" ) return true;
    if ( mname == "rois" ) return true;
    if ( mname == "dftmags" ) return true;
    if ( mname == "dftphases" ) return true;
    if ( mname == "digit" ) return true;
    if ( mname == "wire" ) return true;
    if ( mname == "metadata" ) return metadata.size();
    return hasMetadata(mname);
  }

bool AdcChannelData::hasChannelInfo ( ) const

inline

Definition at line 194 of file AdcChannelData.h.

{ return bool(m_pchanInfo); }

bool AdcChannelData::hasEventInfo ( ) const

inline

Definition at line 169 of file AdcChannelData.h.

{ return bool(m_peventInfo); }

bool AdcChannelData::hasMetadata ( Name  mname ) const

inline

Definition at line 232 of file AdcChannelData.h.

                                     {
    if ( mname.substr(0,3) == "../" ) {
      if ( viewParent == nullptr ) return false;
      return viewParent->hasMetadata(mname.substr(3));
    }
    return metadata.find(mname) != metadata.end();
  }

bool AdcChannelData::hasView

(

Name

vnam

)

const

Definition at line 442 of file AdcChannelData.h.

                                             {
  if ( vpnam.size() == 0 ) return true;
  Name::size_type ipos = vpnam.find("/");
  if ( ipos == Name::npos ) return m_views.count(vpnam);
  Name vnam = vpnam.substr(0, ipos);
  if ( ! hasView(vnam) ) return false;
  Name vsnam = vpnam.substr(ipos + 1);
  for ( const AdcChannelData& acd : view(vnam) ) {
    if ( acd.hasView(vsnam) ) return true;
  }
  return false;
}

AdcChannelData * AdcChannelData::mutableViewEntry	(	Name	vpnam,
		AdcIndex	ient
	)

Definition at line 518 of file AdcChannelData.h.

                                                                          {
  if ( vpnam.size() == 0 ) {
    if ( ient == 0 ) return this;
    else return nullptr;
  }
  Name::size_type ipos = vpnam.find("/");
  if ( ipos == Name::npos ) {
    View& myview = updateView(vpnam);
    if ( ient < myview.size() ) return &myview[ient];
    return nullptr;
  }
  Name vnam = vpnam.substr(0, ipos);
  Name vsnam = vpnam.substr(ipos + 1);
  AdcIndex ientRem = ient;
  for ( AdcChannelData& dat : updateView(vnam) ) {
    AdcIndex nvie = dat.viewSize(vsnam);
    if ( ientRem < nvie ) return dat.mutableViewEntry(vsnam, ientRem);
    ientRem -= nvie;
  }
  return nullptr;
}

AdcChannelData& AdcChannelData::operator= ( const AdcChannelData &  )

delete

AdcChannelData& AdcChannelData::operator= ( AdcChannelData &&  )

default

void AdcChannelData::roisFromSignal ( )

inline

Definition at line 413 of file AdcChannelData.h.

                                           {
  rois.clear();
  bool inRoi = false;
  for ( unsigned int isig=0; isig<signal.size(); ++isig ) {
    if ( inRoi ) {
      AdcRoi& roi = rois.back();
      if ( signal[isig] ) roi.second = isig;
      else inRoi = false;
    } else {
      if ( signal[isig] ) {
        rois.push_back(AdcRoi(isig, isig));
        inRoi = true;
      }
    }
  }
}

AdcIndex AdcChannelData::run ( ) const

inline

Definition at line 174 of file AdcChannelData.h.

{ return getEventInfo().run; }

void AdcChannelData::setChannelInfo ( ChannelInfoPtr  pchi )

inline

Definition at line 184 of file AdcChannelData.h.

{ m_pchanInfo = pchi; }

void AdcChannelData::setChannelInfo ( const ChannelInfo *  pchi )

inline

Definition at line 185 of file AdcChannelData.h.

{ m_pchanInfo.reset(pchi); }

void AdcChannelData::setChannelInfo ( Channel  a_channel, Index  a_fembID = badIndex(), Index  a_fembChannel = badIndex(), Index  a_channelStatus = badIndex()  )

inline

Definition at line 186 of file AdcChannelData.h.

                                                         {
    setChannelInfo(new ChannelInfo(a_channel, a_fembID, a_fembChannel, a_channelStatus));
  }

void AdcChannelData::setEventInfo ( EventInfoPtr  pevi )

inline

Definition at line 160 of file AdcChannelData.h.

{ m_peventInfo = pevi; }

void AdcChannelData::setEventInfo ( const EventInfo *  pevi )

inline

Definition at line 161 of file AdcChannelData.h.

{ m_peventInfo.reset(pevi); }

void AdcChannelData::setEventInfo ( Index  a_run, Index  a_event, Index  a_subRun = badIndex(), time_t  a_time = 0, int  a_timerem = 0, Index  a_trigger = badIndex(), LongIndex  a_triggerClock = badLongIndex()  )

inline

Definition at line 162 of file AdcChannelData.h.

                                                                                           {
    setEventInfo(new EventInfo(a_run, a_event, a_subRun, a_time, a_timerem, a_trigger, a_triggerClock));
  }

void AdcChannelData::setMetadata ( Name  mname, float  val  )

inline

Definition at line 252 of file AdcChannelData.h.

                                          {
    metadata[mname] = val;
  }

AdcIndex AdcChannelData::subRun ( ) const

inline

Definition at line 175 of file AdcChannelData.h.

{ return getEventInfo().subRun; }

AdcLongIndex AdcChannelData::tickOffset ( ) const

inline

Definition at line 206 of file AdcChannelData.h.

                                  {
    AdcLongIndex tickoff = triggerTick0();
    if ( tickoff == EventInfo::badLongIndex() ) tickoff = 0;
    if ( tick0 < 0 ) return tickoff - AdcLongIndex(-tick0);
    return tickoff + AdcLongIndex(tick0);
  }

time_t AdcChannelData::time ( ) const

inline

Definition at line 177 of file AdcChannelData.h.

{ return getEventInfo().time; }

int AdcChannelData::timerem ( ) const

inline

Definition at line 178 of file AdcChannelData.h.

{ return getEventInfo().timerem; }

AdcIndex AdcChannelData::trigger ( ) const

inline

Definition at line 179 of file AdcChannelData.h.

{ return getEventInfo().trigger; }

AdcLongIndex AdcChannelData::triggerClock ( ) const

inline

Definition at line 180 of file AdcChannelData.h.

{ return getEventInfo().triggerClock; }

AdcLongIndex AdcChannelData::triggerTick0 ( ) const

inline

Definition at line 181 of file AdcChannelData.h.

{ return getEventInfo().triggerTick0; }

AdcChannelData::View & AdcChannelData::updateView

(

Name

vnam

)

Definition at line 466 of file AdcChannelData.h.

                                                        {
  const Name myname = "AdcChannelData::updateView: ";
  if ( vnam.size() == 0 ) {
    std::cout << myname << "WARNING: View name may not be blank." << std::endl;
    static View emptyView;
    if ( emptyView.size() ) {
      std::cout << myname << "ERROR: Empty view has been modified." << std::endl;
    }
    return emptyView;
  }
  return m_views[vnam];
}

const AdcChannelData::View & AdcChannelData::view

(

Name

vnam

)

const

Definition at line 457 of file AdcChannelData.h.

                                                              {
  static const View empty;
  ViewMap::const_iterator ivie = m_views.find(vnam);
  if ( ivie == m_views.end() ) return empty;
  return ivie->second;
}

const AdcChannelData * AdcChannelData::viewEntry	(	Name	vpnam,
		AdcIndex	ient
	)		const

Definition at line 494 of file AdcChannelData.h.

                                                                               {
  if ( vpnam.size() == 0 ) {
    if ( ient == 0 ) return this;
    else return nullptr;
  }
  Name::size_type ipos = vpnam.find("/");
  if ( ipos == Name::npos ) {
    const View& myview = view(vpnam);
    if ( ient < myview.size() ) return &myview[ient];
    return nullptr;
  }
  Name vnam = vpnam.substr(0, ipos);
  Name vsnam = vpnam.substr(ipos + 1);
  AdcIndex ientRem = ient;
  for ( const AdcChannelData& dat : view(vnam) ) {
    AdcIndex nvie = dat.viewSize(vsnam);
    if ( ientRem < nvie ) return dat.viewEntry(vsnam, ientRem);
    ientRem -= nvie;
  }
  return nullptr;
}

AdcChannelData::NameVector AdcChannelData::viewNames

(

)

const

Definition at line 432 of file AdcChannelData.h.

                                                         {
  NameVector vnams;
  for ( ViewMap::value_type ivie : m_views ) {
    vnams.push_back(ivie.first);
  }
  return vnams;
}

size_t AdcChannelData::viewSize ( ) const

inline

Definition at line 340 of file AdcChannelData.h.

{ return m_views.size(); }

AdcIndex AdcChannelData::viewSize

(

Name

vpnam

)

const

Definition at line 481 of file AdcChannelData.h.

                                                  {
  if ( vpnam.size() == 0 ) return 1;
  Name::size_type ipos = vpnam.find("/");
  if ( ipos == Name::npos ) return view(vpnam).size();
  Name vnam = vpnam.substr(0, ipos);
  Name vsnam = vpnam.substr(ipos + 1);
  AdcIndex nvie = 0;
  for ( const AdcChannelData& dat : view(vnam) ) nvie += dat.viewSize(vsnam);
  return nvie;
}

Member Data Documentation

AdcSignalVectorVector AdcChannelData::binSamples

Definition at line 132 of file AdcChannelData.h.

AdcLongIndex AdcChannelData::channelClock =0

Definition at line 126 of file AdcChannelData.h.

AdcSignalVector AdcChannelData::dftmags

Definition at line 138 of file AdcChannelData.h.

AdcSignalVector AdcChannelData::dftphases

Definition at line 139 of file AdcChannelData.h.

const raw::RawDigit* AdcChannelData::digit =nullptr

Definition at line 144 of file AdcChannelData.h.

AdcIndex AdcChannelData::digitIndex =badIndex()

Definition at line 146 of file AdcChannelData.h.

AdcFlagVector AdcChannelData::flags

Definition at line 135 of file AdcChannelData.h.

ChannelInfoPtr AdcChannelData::m_pchanInfo

private

Definition at line 152 of file AdcChannelData.h.

EventInfoPtr AdcChannelData::m_peventInfo

private

Definition at line 151 of file AdcChannelData.h.

ViewMap AdcChannelData::m_views

private

Definition at line 155 of file AdcChannelData.h.

FloatMap AdcChannelData::metadata

Definition at line 140 of file AdcChannelData.h.

AdcSignal AdcChannelData::pedestal =badSignal()

Definition at line 128 of file AdcChannelData.h.

AdcSignal AdcChannelData::pedestalRms =0.0

Definition at line 129 of file AdcChannelData.h.

AdcCountVector AdcChannelData::raw

Definition at line 130 of file AdcChannelData.h.

AdcRoiVector AdcChannelData::rois

Definition at line 137 of file AdcChannelData.h.

AdcSignal AdcChannelData::sampleNoise =0.0

Definition at line 134 of file AdcChannelData.h.

AdcSignalVector AdcChannelData::samples

Definition at line 131 of file AdcChannelData.h.

Name AdcChannelData::sampleUnit

Definition at line 133 of file AdcChannelData.h.

AdcFilterVector AdcChannelData::signal

Definition at line 136 of file AdcChannelData.h.

AdcInt AdcChannelData::tick0 = 0

Definition at line 127 of file AdcChannelData.h.

AdcChannelData* AdcChannelData::viewParent =nullptr

Definition at line 141 of file AdcChannelData.h.

const recob::Wire* AdcChannelData::wire =nullptr

Definition at line 145 of file AdcChannelData.h.

AdcIndex AdcChannelData::wireIndex =badIndex()

Definition at line 147 of file AdcChannelData.h.

---

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

• dunecore/dunecore/DuneInterface/Data/AdcChannelData.h