evd::details::RawDigitCacheDataClass Class Reference

Cached set of RawDigitInfo_t. More...

Classes
struct	BoolWithUpToDateMetadata

Public Member Functions
std::vector< RawDigitInfo_t > const &	Digits () const
	Returns the list of digit info. More...
RawDigitInfo_t const *	FindChannel (raw::ChannelID_t channel) const
	Returns a pointer to the digit info of given channel, nullptr if none. More...
size_t	MaxSamples () const
	Returns the largest number of samples in the unpacked raw digits. More...
bool	empty () const
	Returns whether the cache is empty() (STL-like interface) More...
void	Clear ()
	Empties the cache. More...
void	Refill (art::Handle< std::vector< raw::RawDigit >> &rdcol)
	Fills the cache from the specified raw digits product handle. More...
void	Invalidate ()
	Clears the cache and marks it as invalid (use Update() to fill it) More...
bool	Update (art::Event const &evt, CacheID_t const &new_timestamp)
template<typename Stream >
void	Dump (Stream &&out) const
	Dump the content of the cache. More...

Private Member Functions
BoolWithUpToDateMetadata	CheckUpToDate (CacheID_t const &ts, art::Event const *evt=nullptr) const
	Checks whether an update is needed; can load digits in the process. More...

Static Private Member Functions
static std::vector< raw::RawDigit > const *	ReadProduct (art::Event const &evt, art::InputTag label)

Private Attributes
std::vector< RawDigitInfo_t >	digits
	vector of raw digit information More...
CacheID_t	timestamp
	object expressing validity range of cached data More...
size_t	max_samples = 0
	the largest number of ticks in any digit More...

Detailed Description

Cached set of RawDigitInfo_t.

Definition at line 249 of file RawDataDrawer.cxx.

Member Function Documentation

RawDigitCacheDataClass::BoolWithUpToDateMetadata evd::details::RawDigitCacheDataClass::CheckUpToDate ( CacheID_t const &  ts, art::Event const *  evt = nullptr  ) const

private

Checks whether an update is needed; can load digits in the process.

Definition at line 1712 of file RawDataDrawer.cxx.

References evd::details::RawDigitInfo_t::Digit(), evd::details::RawDigitCacheDataClass::BoolWithUpToDateMetadata::digits, util::DataProductChangeTracker_t::inputLabel(), util::PlaneDataChangeTracker_t::sameProduct(), and Update().

    {
      BoolWithUpToDateMetadata res{ false, nullptr };
      
      // normally only if either the event or the product label have changed,
      // cache becomes invalid:
      if (!ts.sameProduct(timestamp)) return res; // outdated cache
      
      // But: our cache stores pointers to the original data, and on a new TPC
      // the event display may reload the event anew, removing the "old" data
      // from memory.
      // Since TPC can change with or without the data being invalidated,
      // a more accurate verification is needed.
      
      // if the cache is empty, well, it does not make much difference;
      // we invalidate it to be sure
      if (empty())
        return res; // outdated cache
      
      if (!evt)
        return res; // outdated, since we can't know better without the event
      
      // here we force reading of the product
      res.digits = ReadProduct(*evt, ts.inputLabel());
      if (!res.digits)
        return res; // outdated cache; this is actually an error
      
      if (res.digits->empty())
        return res; // outdated; no digits (strange!), invalidate just in case
      
      // use the first digit as test
      raw::ChannelID_t channel = res.digits->front().Channel();
      RawDigitInfo_t const* pInfo = FindChannel(channel);
      if (!pInfo)
        return res; // outdated: we don't even have this channel in cache!
      
      if (&(pInfo->Digit()) != &(res.digits->front()))
        return res; // outdated: different memory address for data
      
      res.bUpToDate = true;
      return res; // cache still valid
    } // RawDigitCacheDataClass::CheckUpToDate()

void evd::details::RawDigitCacheDataClass::Clear

(

)

Empties the cache.

Definition at line 1703 of file RawDataDrawer.cxx.

                                       {
      Invalidate();
      digits.clear();
      max_samples = 0;
    } // RawDigitCacheDataClass::Clear()

std::vector<RawDigitInfo_t> const& evd::details::RawDigitCacheDataClass::Digits ( ) const

inline

Returns the list of digit info.

Definition at line 253 of file RawDataDrawer.cxx.

Referenced by evd::details::begin(), and evd::details::end().

{ return digits; }

template<typename Stream >

void evd::details::RawDigitCacheDataClass::Dump

(

Stream &&

out

)

const

Dump the content of the cache.

Definition at line 1784 of file RawDataDrawer.cxx.

                                                        {
      out << "Cache at " << ((void*) this)
        << " with time stamp " << std::string(timestamp)
        << " and " << digits.size()
        << " entries (maximum sample: " << max_samples << ");"
        << " data at " << ((void*) digits.data());
      for (RawDigitInfo_t const& digitInfo: digits) {
        out << "\n  ";
        digitInfo.Dump(out);
      } // for
      out << "\n";
    } // RawDigitCacheDataClass::Dump()

bool evd::details::RawDigitCacheDataClass::empty ( ) const

inline

Returns whether the cache is empty() (STL-like interface)

Definition at line 262 of file RawDataDrawer.cxx.

References details::PointerToData_t< T >::Clear(), and Update().

Referenced by evd::RawDataDrawer::FillTQHisto(), and evd::RawDataDrawer::RunOperation().

{ return digits.empty(); }

RawDigitInfo_t const * evd::details::RawDigitCacheDataClass::FindChannel

(

raw::ChannelID_t

channel

)

const

Returns a pointer to the digit info of given channel, nullptr if none.

Definition at line 1666 of file RawDataDrawer.cxx.

Referenced by evd::RawDataDrawer::FillTQHisto().

    {
      auto iDigit = std::find_if(
        digits.cbegin(), digits.cend(), 
        [channel](evd::details::RawDigitInfo_t const& digit)
          { return digit.Channel() == channel; }
        );
      return (iDigit == digits.cend())? nullptr: &*iDigit;
    } // RawDigitCacheDataClass::FindChannel()

void evd::details::RawDigitCacheDataClass::Invalidate

(

)

Clears the cache and marks it as invalid (use Update() to fill it)

Definition at line 1698 of file RawDataDrawer.cxx.

                                            {
      timestamp.clear();
    } // RawDigitCacheDataClass::Invalidate()

size_t evd::details::RawDigitCacheDataClass::MaxSamples ( ) const

inline

Returns the largest number of samples in the unpacked raw digits.

Definition at line 259 of file RawDataDrawer.cxx.

{ return max_samples; }

std::vector< raw::RawDigit > const * evd::details::RawDigitCacheDataClass::ReadProduct ( art::Event const &  evt, art::InputTag  label  )

staticprivate

Definition at line 1677 of file RawDataDrawer.cxx.

References art::DataViewImpl::getByLabel().

    {
      art::Handle< std::vector<raw::RawDigit>> rdcol;
      if (!evt.getByLabel(label, rdcol)) return nullptr;
      return &*rdcol;
    } // RawDigitCacheDataClass::ReadProduct()

void evd::details::RawDigitCacheDataClass::Refill

(

art::Handle< std::vector< raw::RawDigit >> &

rdcol

)

Fills the cache from the specified raw digits product handle.

Definition at line 1686 of file RawDataDrawer.cxx.

References raw::RawDigit::Samples().

    {
      digits.resize(rdcol->size());
      for(size_t iDigit = 0; iDigit < rdcol->size(); ++iDigit) {
        art::Ptr<raw::RawDigit> pDigit(rdcol, iDigit);
        digits[iDigit].Fill(pDigit);
        size_t samples = pDigit->Samples();
        if (samples > max_samples) max_samples = samples;
      } // for
    } // RawDigitCacheDataClass::Refill()

bool evd::details::RawDigitCacheDataClass::Update	(	art::Event const &	evt,
		CacheID_t const &	new_timestamp
	)

Updates the cache for new_timestamp using the specified event

Returns

true if it needed to update (that might have failed)

Definition at line 1757 of file RawDataDrawer.cxx.

References art::DataViewImpl::getByLabel(), util::DataProductChangeTracker_t::inputLabel(), and LOG_DEBUG.

Referenced by evd::RawDataDrawer::GetRawDigits().

    {
      BoolWithUpToDateMetadata update_info = CheckUpToDate(new_timestamp, &evt);
      
      if (update_info) return false; // already up to date: move on!
      
      LOG_DEBUG("RawDataDrawer")
        << "Refilling raw digit cache RawDigitCacheDataClass["
        << ((void*) this ) << "] for " << new_timestamp;
      
      Clear();
      
      art::Handle< std::vector<raw::RawDigit>> rdcol;
      if (!evt.getByLabel(new_timestamp.inputLabel(), rdcol)) {
        mf::LogWarning("RawDataDrawer") << "no RawDigit collection '"
          << new_timestamp.inputLabel() << "' found";
        return true;
      }
      
      Refill(rdcol);
      
      timestamp = new_timestamp;
      return true;
    } // RawDigitCacheDataClass::Update()

Member Data Documentation

std::vector<RawDigitInfo_t> evd::details::RawDigitCacheDataClass::digits

private

vector of raw digit information

Definition at line 297 of file RawDataDrawer.cxx.

size_t evd::details::RawDigitCacheDataClass::max_samples = 0

private

the largest number of ticks in any digit

Definition at line 301 of file RawDataDrawer.cxx.

CacheID_t evd::details::RawDigitCacheDataClass::timestamp

private

object expressing validity range of cached data

Definition at line 299 of file RawDataDrawer.cxx.

---

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

• lareventdisplay/v06_22_00/source/lareventdisplay/EventDisplay/RawDataDrawer.cxx