LAr2DWaveBase Class Reference

Per-channel class holding wave information in time bins. More...

#include <LAr2DWaveBase.h>

Inheritance diagram for LAr2DWaveBase:

Collaboration diagram for LAr2DWaveBase:

Public Member Functions
	LAr2DWaveBase ()
	Default constructor. More...
	LAr2DWaveBase (float timeOffset, float timeBinWidth, const std::vector< std::vector< float > > &wave0, const std::vector< std::vector< float > > &wave1)
	Constructor from wave data directly. More...
	LAr2DWaveBase (float timeOffset, float timeBinWidth, unsigned int nPhases, unsigned int nSamples, const std::vector< float > &wave0, const std::vector< float > &wave1, unsigned int index)
	Constructor from persistent data. More...
	LAr2DWaveBase (const LArCompactSubsetConstChannelProxy &other)
	Constructor for channel data from a compact subset. More...
void	setFrom (LAr2DWaveBase &other)
	Assign from another wave object. More...
bool	isEmpty () const
	Is there any data in this channel? More...
float	timeOffset () const
	Return the time offset for this channel. More...
float	timeBinWidth () const
	Return the time bin width for this channel. More...
size_t	waveSize (unsigned int which) const
	Return the number of time bins for a wave. More...
LArVectorProxy	wave (unsigned int which, size_t tbin) const
	Return wave data. More...

Static Public Attributes
static const unsigned int	nWaves = 2
	The number of different types of waves we store. More...

Private Attributes
float	m_timeOffset
	The time offset for this channel. More...
float	m_timeBinWidth
	The time bin width for this channel. More...
std::vector< std::vector< float > >	m_waves [nWaves]
	The wave data. More...

Detailed Description

Per-channel class holding wave information in time bins.

Definition at line 48 of file LAr2DWaveBase.h.

Constructor & Destructor Documentation

LAr2DWaveBase() [1/4]

LAr2DWaveBase::LAr2DWaveBase

(

)

Default constructor.

LAr2DWaveBase() [2/4]

LAr2DWaveBase::LAr2DWaveBase	(	float	timeOffset,
		float	timeBinWidth,
		const std::vector< std::vector< float > > &	wave0,
		const std::vector< std::vector< float > > &	wave1
	)

Constructor from wave data directly.

Parameters

timeOffset	Time offset value.
timeBinWidth	Time bin width value.
wave0	Data for first wave, as [tbin][sample].
wave0	Data for second wave, as [tbin][sample].

Definition at line 25 of file LAr2DWaveBase.cxx.

  : m_timeOffset(timeOffset),
    m_timeBinWidth(timeBinWidth)
{
  m_waves[0] = wave0;
  m_waves[1] = wave1;
} 

LAr2DWaveBase() [3/4]

LAr2DWaveBase::LAr2DWaveBase	(	float	timeOffset,
		float	timeBinWidth,
		unsigned int	nPhases,
		unsigned int	nSamples,
		const std::vector< float > &	wave0,
		const std::vector< float > &	wave1,
		unsigned int	index
	)

Constructor from persistent data.

Parameters

timeOffset	Time offset value.
timeBinWidth	Time bin width value.
nPhases	Number of time bins in the data.
nSamples	Number of samples in the data.
wave0	Packed data for first wave.
wave1	Packed data for second wave.
index	Start of the desired data in the packed data.

The packed data are formatted in blocks of nPhases * nSamples floats. The first word we should use is given by index.

Definition at line 50 of file LAr2DWaveBase.cxx.

 : m_timeOffset(timeOffset),
   m_timeBinWidth(timeBinWidth)
{
  assert (index + nPhases*nSamples <= wave0.size());
  assert (index + nPhases*nSamples <= wave1.size());
 
  m_waves[0].resize (nPhases);
  m_waves[1].resize (nPhases);
 
  for (unsigned int i = 0; i < nPhases; i++) {
    m_waves[0][i].assign (wave0.begin() + index,
                          wave0.begin() + index + nSamples);
    m_waves[1][i].assign (wave1.begin() + index,
                          wave1.begin() + index + nSamples);
    index += nSamples;
  }
}

LAr2DWaveBase() [4/4]

LAr2DWaveBase::LAr2DWaveBase

(

const LArCompactSubsetConstChannelProxy &

other

)

Constructor for channel data from a compact subset.

Parameters

other

Reference to the source channel data.

Definition at line 80 of file LAr2DWaveBase.cxx.

{
  if (!other.isValid()) {
    // Invalid source --- do the same as the default ctor.
    m_timeOffset = 0;
    m_timeBinWidth = 25./24.;
  }
  else {
    m_timeOffset = other.timeOffset();
    m_timeBinWidth = other.timeBinWidth();
    size_t chanSize = other.getSize();
    for (unsigned int which = 0; which < nWaves; ++which) {
      m_waves[which].resize (chanSize);
      for (unsigned int i = 0; i < chanSize; i++) {
        LArVectorProxy wave = other.getData (which, i);
        m_waves[which][i].assign (wave.begin(), wave.end());
      }
    }
  }
}

Member Function Documentation

isEmpty()

bool LAr2DWaveBase::isEmpty

(

)

const

Is there any data in this channel?

setFrom()

void LAr2DWaveBase::setFrom

(

LAr2DWaveBase &

other

)

Assign from another wave object.

Parameters

other

The source object. NOTE: We use move semantics; OTHER is left with no data.

Could write with an rvalue reference in the future?

Definition at line 109 of file LAr2DWaveBase.cxx.

{
  m_timeOffset = other.m_timeOffset;
  m_timeBinWidth = other.m_timeBinWidth;
  for (unsigned int which = 0; which < nWaves; ++which)
    m_waves[which].swap (other.m_waves[which]);
}

timeBinWidth()

float LAr2DWaveBase::timeBinWidth

(

)

const

Return the time bin width for this channel.

timeOffset()

float LAr2DWaveBase::timeOffset

(

)

const

Return the time offset for this channel.

wave()

LArVectorProxy LAr2DWaveBase::wave	(	unsigned int	which,
		size_t	tbin
	)		const

Return wave data.

Parameters

which	The type of wave to return.
tbin	The time bin to return.

waveSize()

size_t LAr2DWaveBase::waveSize

(

unsigned int

which

)

const

Return the number of time bins for a wave.

Parameters

which

The type of wave to query.

Member Data Documentation

m_timeBinWidth

float LAr2DWaveBase::m_timeBinWidth

private

The time bin width for this channel.

Definition at line 150 of file LAr2DWaveBase.h.

m_timeOffset

float LAr2DWaveBase::m_timeOffset

private

The time offset for this channel.

Definition at line 147 of file LAr2DWaveBase.h.

m_waves

std::vector<std::vector<float> > LAr2DWaveBase::m_waves[nWaves]

private

The wave data.

Definition at line 153 of file LAr2DWaveBase.h.

nWaves

const unsigned int LAr2DWaveBase::nWaves = 2

static

The number of different types of waves we store.

Definition at line 52 of file LAr2DWaveBase.h.

---

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

• LAr2DWaveBase.h
• LAr2DWaveBase.cxx