This acts like a vector of FEB ID / channel vector pairs. More...

#include <LArCompactSubset.h>

Collaboration diagram for LArCompactSubsetVector:

Classes
class	const_iterator
	const_iterator class. More...
class	iterator
	Iterator class. More...

Public Types
typedef unsigned int	FebId
	Type for FEB IDs. Would be better to get this from somewhere common...

Public Member Functions
	LArCompactSubsetVector (size_t nfeb=0)
	Constructor.
size_t	size () const
	Return the size of this vector.
LArCompactSubsetFebPair	operator[] (size_t i)
	Vector indexing.
const LArCompactSubsetConstFebPair	operator[] (size_t i) const
	Vector indexing.
iterator	begin ()
	Begin iterator.
iterator	end ()
	End iterator.
const_iterator	begin () const
	Begin iterator.
const_iterator	end () const
	End iterator.
void	resize (size_t sz)
	Change the size of the vector.
void	shrink_to_fit ()
	Release any allocated but unused storage.
FebId &	febIdRef (size_t febIndex)
	Return a reference to a FEB ID variable.
const FebId &	febIdRef (size_t febIndex) const
	Return a reference to a FEB ID variable.
size_t	febSize (unsigned int febIndex) const
	Return the number of channels for a given FEB index.
unsigned int	chanIndex (unsigned int febIndex) const
	Return the index of the first channel for a FEB index.
void	resizeChanVec (size_t febIndex, size_t sz)
	Resize one channel vector.
size_t	getChanSize () const
	Return the number of time bins used in this subset.
size_t	getSize (unsigned int chan) const
	Return the number of time bins for channel index CHAN.
float	timeOffset (unsigned int chan) const
	Return the time offset for channel index CHAN.
float	timeBinWidth (unsigned int chan) const
	Return the time bin width for channel index CHAN.
LArVectorProxy	getData (unsigned int which, unsigned int chan, size_t tbin) const
	Retrieve wave data.
void	setTimings (unsigned int chan, float timeOffset, float timeBinWidth)
	Set timing information for a channel.
void	setData (unsigned int which, unsigned int chan, size_t tbin, size_t chanSize, const LArVectorProxy &from)
	Set wave data for a channel.

Static Public Member Functions
template<class T, class OTHERIT, class COPIER>
static void	copySubset (OTHERIT otherBeg, OTHERIT otherEnd, LArCompactSubsetVector &to, COPIER copier)
	Helper used by LArConditionsSubset::assign.

Static Public Attributes
static const unsigned int	nWaves = 2
	Number of wave types we store.

Private Attributes
unsigned int	m_chanSize
	Number of time bins per channels. 0 before any waves have been added.
unsigned int	m_nSamples
	Number of samples per wave. 0 before any waves have been added.
float	m_timeOffset
	Time parameters.
float	m_timeBinWidth
std::vector< FebId >	m_febids
	Vector of stored FebIds.
std::vector< unsigned int >	m_indices
	Map from FEB indices to channel indices.
std::vector< int >	m_slots
	Map from channel indices to wave slots.
std::vector< float >	m_data
	The wave data.

Detailed Description

This acts like a vector of FEB ID / channel vector pairs.

This is also the class which contains all the data.

Definition at line 529 of file LArCompactSubset.h.

Member Typedef Documentation

◆ FebId

typedef unsigned int LArCompactSubsetVector::FebId

Type for FEB IDs. Would be better to get this from somewhere common...

Definition at line 536 of file LArCompactSubset.h.

Constructor & Destructor Documentation

◆ LArCompactSubsetVector()

LArCompactSubsetVector::LArCompactSubsetVector ( size_t nfeb = 0 )

Constructor.

Parameters

nfeb	Initial number of FEBs to allocate.

Definition at line 47 of file LArCompactSubset.cxx.

  : m_chanSize (0),
    m_nSamples (0),
    m_timeOffset (0),
    m_timeBinWidth (0),
    m_febids (nfeb),
    m_indices (nfeb+1)
{
}

Member Function Documentation

◆ begin() [1/2]

iterator LArCompactSubsetVector::begin ( )

Begin iterator.

◆ begin() [2/2]

const_iterator LArCompactSubsetVector::begin ( ) const

Begin iterator.

◆ chanIndex()

unsigned int LArCompactSubsetVector::chanIndex ( unsigned int febIndex ) const

Return the index of the first channel for a FEB index.

Parameters

febIndex The index of the FEB to query.

If febIndex is the number of FEBs, then this returns the total number of channels.

◆ copySubset()

template<class T, class OTHERIT, class COPIER>

void LArCompactSubsetVector::copySubset	(	OTHERIT	otherBeg,
		OTHERIT	otherEnd,
		LArCompactSubsetVector &	to,
		COPIER	copier )

static

Helper used by LArConditionsSubset::assign.

Parameters

otherBeg	Start of the range to copy.
otherEnd	End of the range to copy.
to	The subset to which to copy.
copier	Helper to copy a single payload object.

◆ end() [1/2]

iterator LArCompactSubsetVector::end ( )

End iterator.

◆ end() [2/2]

const_iterator LArCompactSubsetVector::end ( ) const

End iterator.

◆ febIdRef() [1/2]

FebId & LArCompactSubsetVector::febIdRef ( size_t febIndex )

Return a reference to a FEB ID variable.

Parameters

febIndex Index of the desired FEB ID.

◆ febIdRef() [2/2]

const FebId & LArCompactSubsetVector::febIdRef ( size_t febIndex ) const

Return a reference to a FEB ID variable.

Parameters

febIndex Index of the desired FEB ID.

◆ febSize()

size_t LArCompactSubsetVector::febSize ( unsigned int febIndex ) const

Return the number of channels for a given FEB index.

Parameters

febIndex The index of the FEB to query.

◆ getChanSize()

size_t LArCompactSubsetVector::getChanSize ( ) const

Return the number of time bins used in this subset.

◆ getData()

LArVectorProxy LArCompactSubsetVector::getData	(	unsigned int	which,
		unsigned int	chan,
		size_t	tbin ) const

Retrieve wave data.

Parameters

which	The wave type to retrieve.
chan	The index of the channel to retrieve.
tbin	The time bin index to retrieve.

Definition at line 122 of file LArCompactSubset.cxx.

{
  assert (which < nWaves);
  int slot = m_slots[chan * m_chanSize + tbin];
  const float* beg = nullptr;
  const float* end = nullptr;
  if (slot >= 0) {
    size_t nsamp = m_nSamples;
    const float* chanstart = &m_data[slot * nWaves * nsamp];
    beg = chanstart + which * nsamp;
    end = beg + nsamp;
  }
  return LArVectorProxy (beg, end);
}

◆ getSize()

size_t LArCompactSubsetVector::getSize ( unsigned int chan ) const

Return the number of time bins for channel index CHAN.

Parameters

chan	The channel index to query.

This is either the same as getChanSize(), or 0 if this channel is empty.

◆ operator[]() [1/2]

LArCompactSubsetFebPair LArCompactSubsetVector::operator[] ( size_t i )

Vector indexing.

Parameters

i	Index to look up.

◆ operator[]() [2/2]

const LArCompactSubsetConstFebPair LArCompactSubsetVector::operator[] ( size_t i ) const

Vector indexing.

Parameters

i	Index to look up.

◆ resize()

void LArCompactSubsetVector::resize ( size_t sz )

Change the size of the vector.

Parameters

sz New size.

Restriction: The size can only be increased.

Definition at line 64 of file LArCompactSubset.cxx.

{
  size_t oldsz = m_febids.size();
  m_febids.resize (sz);
  m_indices.resize (sz+1);
  
  if (sz >= oldsz) {
    for (size_t j = oldsz+1; j < sz+1; j++)
      m_indices[j] = m_indices[oldsz];
  }
  else {
    abort();
    // Unimplemented.
  }
}

◆ resizeChanVec()

void LArCompactSubsetVector::resizeChanVec	(	size_t	febIndex,
		size_t	sz )

Resize one channel vector.

Parameters

febIndex	The index of the vector to resize.
sz	The new size of the vector.

Restriction: Only the last index may be resized.

Definition at line 102 of file LArCompactSubset.cxx.

{
  assert (m_indices[febIndex+1] == m_indices.back());
  size_t cursz = m_indices[febIndex+1] - m_indices[febIndex];
  if (sz == cursz) return;
  int newend = m_indices[febIndex] + sz;
  for (size_t j = febIndex+1; j < m_indices.size(); j++)
    m_indices[j] = newend;
  m_slots.resize (m_slots.size() + (sz - cursz) * m_chanSize, -1);
}

◆ setData()

void LArCompactSubsetVector::setData	(	unsigned int	which,
		unsigned int	chan,
		size_t	tbin,
		size_t	chanSize,
		const LArVectorProxy &	from )

Set wave data for a channel.

Parameters

which	Wave type to set.
chan	Channel index to set.
tbin	Time bin index to set.
chanSize	Number of time bins for this channel.
from	Wave data.

We currently assume that all non-empty channels within a subset have the same number of time bins and samples. We'll trip an assertion if that's not the case.

Definition at line 177 of file LArCompactSubset.cxx.

{
  assert (which < nWaves);
 
  if (m_chanSize == 0 &&
      m_nSamples == 0)
  {
    m_chanSize = chanSize;
    m_nSamples = from.size();
    m_slots.resize (m_indices.back() * m_chanSize, -1);
  }
  else {
    assert (m_chanSize == chanSize);
    assert (m_nSamples == from.size());
  }
 
  int slot = m_slots[chan * m_chanSize + tbin];
  if (slot < 0) {
    slot = m_data.size() / (nWaves * m_nSamples);
    m_data.resize ((slot+1) * (nWaves * m_nSamples));
    m_slots[chan * m_chanSize + tbin] = slot;
  }
 
  std::copy (from.begin(), from.end(),
             &m_data[(slot * nWaves + which) * m_nSamples]);
}

◆ setTimings()

void LArCompactSubsetVector::setTimings	(	unsigned int	chan,
		float	timeOffset,
		float	timeBinWidth )

Set timing information for a channel.

Parameters

chan	Channel index to set.
timeOffset	Time offset to set.
timeBinWidth	Time bin width to set.

We currently assume that all non-empty channels within a subset have the same values for these parameters. We'll trip an assertion if that's not the case.

Definition at line 150 of file LArCompactSubset.cxx.

{
  if (m_data.empty()) {
    m_timeOffset = timeOffset;
    m_timeBinWidth = timeBinWidth;
  }
  else {
    assert (m_timeOffset == timeOffset);
    assert (m_timeBinWidth == timeBinWidth);
  }
}

◆ shrink_to_fit()

void LArCompactSubsetVector::shrink_to_fit ( )

Release any allocated but unused storage.

Called by the P->T converter after conversion is complete.

Definition at line 85 of file LArCompactSubset.cxx.

{
  std::vector<float> tmp_data (m_data);
  m_data.swap (tmp_data);
 
  std::vector<int> tmp_slots (m_slots);
  m_slots.swap (tmp_slots);
}

◆ size()

size_t LArCompactSubsetVector::size ( ) const

Return the size of this vector.

◆ timeBinWidth()

float LArCompactSubsetVector::timeBinWidth ( unsigned int chan ) const

Return the time bin width for channel index CHAN.

Parameters

chan	The channel index to query.

We currently assume that this is the same for all channels, so CHAN is ignored.

◆ timeOffset()

float LArCompactSubsetVector::timeOffset ( unsigned int chan ) const

Return the time offset for channel index CHAN.

Parameters

chan	The channel index to query.

We currently assume that this is the same for all channels, so CHAN is ignored.

Member Data Documentation

◆ m_chanSize

unsigned int LArCompactSubsetVector::m_chanSize

private

Number of time bins per channels. 0 before any waves have been added.

Definition at line 881 of file LArCompactSubset.h.

◆ m_data

std::vector<float> LArCompactSubsetVector::m_data

private

The wave data.

Definition at line 910 of file LArCompactSubset.h.

◆ m_febids

std::vector<FebId> LArCompactSubsetVector::m_febids

private

Vector of stored FebIds.

Definition at line 894 of file LArCompactSubset.h.

◆ m_indices

std::vector<unsigned int> LArCompactSubsetVector::m_indices

private

Map from FEB indices to channel indices.

Definition at line 899 of file LArCompactSubset.h.

◆ m_nSamples

unsigned int LArCompactSubsetVector::m_nSamples

private

Number of samples per wave. 0 before any waves have been added.

Definition at line 884 of file LArCompactSubset.h.

◆ m_slots

std::vector<int> LArCompactSubsetVector::m_slots

private

Map from channel indices to wave slots.

Definition at line 905 of file LArCompactSubset.h.

◆ m_timeBinWidth

float LArCompactSubsetVector::m_timeBinWidth

private

Definition at line 889 of file LArCompactSubset.h.

◆ m_timeOffset

float LArCompactSubsetVector::m_timeOffset

private

Time parameters.

We assume that these are the same for all non-empty channels within a subset.

Definition at line 888 of file LArCompactSubset.h.

◆ nWaves

const unsigned int LArCompactSubsetVector::nWaves = 2

static

Number of wave types we store.

Definition at line 533 of file LArCompactSubset.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FebId

Constructor & Destructor Documentation

◆ LArCompactSubsetVector()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ chanIndex()

◆ copySubset()

◆ end() [1/2]

◆ end() [2/2]

◆ febIdRef() [1/2]

◆ febIdRef() [2/2]

◆ febSize()

◆ getChanSize()

◆ getData()

◆ getSize()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ resize()

◆ resizeChanVec()

◆ setData()

◆ setTimings()

◆ shrink_to_fit()

◆ size()

◆ timeBinWidth()

◆ timeOffset()

Member Data Documentation

◆ m_chanSize

◆ m_data

◆ m_febids

◆ m_indices

◆ m_nSamples

◆ m_slots

◆ m_timeBinWidth

◆ m_timeOffset

◆ nWaves