Router for fast addressing of hits in KM3NETDAQ::JDAQTimeslice data structure as a function of the optical module identifier and time. More...

#include <JTimesliceRouter.hh>

Inheritance diagram for JTRIGGER::JTimesliceRouter:

Classes
struct	JPair_t
	Auxiliary structure for indexing hits in a data frame. More...

Public Types
typedef JTOOLS::JElement2D< double, JPair_t >	element_type

typedef JTOOLS::JGridCollection< element_type >	grid_type

typedef JTOOLS::JRouter< int >	router_type

typedef JDAQTimeslice::const_iterator	const_iterator

Public Member Functions
	JTimesliceRouter (const int numberOfBins)
	Constructor. More...

	JTimesliceRouter (const JDAQTimeslice &timeslice, const int numberOfBins)
	Constructor. More...

void	configure (const JDAQTimeslice &timeslice)
	Configure. More...

const int	getAddress (const JDAQModuleIdentifier &module) const
	Get address of module. More...

bool	hasSuperFrame (const JDAQModuleIdentifier &module) const
	Check presence of module. More...

const JDAQSuperFrame &	getSuperFrame (const JDAQModuleIdentifier &module) const
	Get super frame. More...

JDAQFrameSubset	getFrameSubset (const JDAQModuleIdentifier &module, const JTimeRange &timeRange) const
	Get subset of frame given module identifier and range of hit times. More...

virtual const JDAQTimeslice *	get () const
	Get pointer. More...

virtual void	set (const JDAQTimeslice *p)
	Set pointer. More...

void	set (const JPointer< T > &pointer)
	Set pointer. More...

virtual void	reset ()
	Reset pointer. More...

void	reset (const JPointer< T > &pointer)
	Reset pointer. More...

void	reset (const JDAQTimeslice *p)
	Reset pointer. More...

const JDAQTimeslice *const &	getReference () const
	Get rereference to internal pointer. More...

const JDAQTimeslice *&	getReference ()
	Get rereference to internal pointer. More...

virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...

bool	is_valid () const
	Check validity of pointer. More...

const JDAQTimeslice *	operator-> () const
	Smart pointer operator. More...

	operator const JDAQTimeslice * () const
	Type conversion operator. More...

Protected Attributes
const JDAQTimeslice *	__p
	pointer to object More...

Private Attributes
int	number_of_bins

router_type	router

std::vector< grid_type >	table

Detailed Description

Router for fast addressing of hits in KM3NETDAQ::JDAQTimeslice data structure as a function of the optical module identifier and time.

Note that the data in a frame from the same PMT are time ordered but the data from different PMTs are not necessarily time orderd.
The fast routing is based on the assumption that the time difference between consecutive hits in the same frame is limited.
The access speed is then determined by this time difference.

The time slice router class comprises two internal look-up tables:

The first table consists of a one dimensional look-up table which is is used to map the module identifier to the index of the corresponding data frame in the time slice.
The second table consists of a two dimensional array. In this, the first index of matches with the index of the corresponding data frame in the time slice. Each first index is mapped to a one dimensional look-up table. This one dimensional look-up table maps an uncalibrated time t to a pair of indices (lpos,rpos), where:
1. lpos is the index of the first hit in the data frame with time >= t;
2. rpos is the index of the last hit in the data frame with time < t;

Definition at line 62 of file JTimesliceRouter.hh.

Member Typedef Documentation

◆ element_type

typedef JTOOLS::JElement2D<double, JPair_t> JTRIGGER::JTimesliceRouter::element_type

Definition at line 75 of file JTimesliceRouter.hh.

◆ grid_type

typedef JTOOLS::JGridCollection<element_type> JTRIGGER::JTimesliceRouter::grid_type

Definition at line 76 of file JTimesliceRouter.hh.

◆ router_type

typedef JTOOLS::JRouter<int> JTRIGGER::JTimesliceRouter::router_type

Definition at line 77 of file JTimesliceRouter.hh.

◆ const_iterator

typedef JDAQTimeslice::const_iterator JTRIGGER::JTimesliceRouter::const_iterator

Definition at line 78 of file JTimesliceRouter.hh.

Constructor & Destructor Documentation

◆ JTimesliceRouter() [1/2]

JTRIGGER::JTimesliceRouter::JTimesliceRouter ( const int numberOfBins )

inline

Constructor.

Parameters

numberOfBins number of bins of the hit look-up table

Definition at line 86 of file JTimesliceRouter.hh.

                                              :
       number_of_bins(numberOfBins),
       router(-1)
     {}

◆ JTimesliceRouter() [2/2]

JTRIGGER::JTimesliceRouter::JTimesliceRouter	(	const JDAQTimeslice &	timeslice,
		const int	numberOfBins
	)

inline

Constructor.

Parameters

timeslice	timeslice
numberOfBins	number of bins of the hit look-up table

Definition at line 98 of file JTimesliceRouter.hh.

                                              :
       number_of_bins(numberOfBins),
       router(-1)
     {
       configure(timeslice);
     }

Member Function Documentation

◆ configure()

void JTRIGGER::JTimesliceRouter::configure ( const JDAQTimeslice & timeslice )

inline

Configure.

Parameters

timeslice timeslice

Definition at line 112 of file JTimesliceRouter.hh.

     {
       using namespace std;
       using namespace JPP;
       using namespace KM3NETDAQ;
  
  
       this->set(&timeslice);
  
  
       for (const_iterator i = this->get()->begin(); i != this->get()->end(); ++i) {
         router.put(i->getModuleID(), distance(this->get()->begin(), i));
       }
  
  
       const JDAQHit::JTDC_t TMIN = numeric_limits<JDAQHit::JTDC_t>::min();
       const JDAQHit::JTDC_t TMAX = numeric_limits<JDAQHit::JTDC_t>::max();
  
       double Tmin = getTimeSinceRTS(this->get()->getFrameIndex()) - 0.05 * getFrameTime();    // [ns]
       double Tmax = getTimeSinceRTS(this->get()->getFrameIndex()) + 1.05 * getFrameTime();    // [ns]
  
       if (Tmin < TMIN) { Tmin = TMIN; }
       if (Tmax > TMAX) { Tmax = TMAX; }
  
  
       int number_of_elements = 2;
  
       for (const_iterator i = this->get()->begin(); i != this->get()->end(); ++i) {
         if (i->size() > number_of_elements) {
           number_of_elements = i->size();
         }
       }
  
       if (number_of_bins > 1 && number_of_bins < number_of_elements) {
         number_of_elements = number_of_bins;
       }
  
  
       const JGrid<double> bounds(number_of_elements, Tmin, Tmax);
  
  
       typedef vector<JDAQHit::JTDC_t> JBuffer_t;                             // temporary buffer to store bin edges with proper data type
  
       JBuffer_t buffer(bounds.getSize() + 1);
  
       for (int i = 0; i != bounds.getSize(); ++i) {
         buffer[i] = (JDAQHit::JTDC_t) bounds.getX(i);
       }
  
       buffer[bounds.getSize()] = TMAX;
  
  
       table.resize(this->get()->size());                                      // same indexing as time slice
  
       const JDAQHit JDAQHitMin(0, TMIN, 0);                                   // begin marker
       const JDAQHit JDAQHitMax(0, TMAX, 0);                                   // end   marker
  
       typedef vector<JDAQHit>    JDAQFrame_t;
  
       JDAQFrame_t zbuf;                                                       // copy of raw data with additional begin and end marker
  
       vector<grid_type>::iterator grid = table.begin();
  
       for (const_iterator frame = this->get()->begin(); frame != this->get()->end(); ++frame, ++grid) {
  
         grid->configure(bounds);
  
         if (!frame->empty()) {
  
           if (frame-> begin()->getT() < grid->getXmin()) {
             THROW(JTriggerException, "Hit time out of range " << frame-> begin()->getT() << " < " << grid->getXmin());
           }
             
           if (frame->rbegin()->getT() > grid->getXmax()) {
             THROW(JTriggerException, "Hit time out of range " << frame->rbegin()->getT() << " > " << grid->getXmax());
           }
  
           zbuf.resize(frame->size() + 2);                                     // reserve space end markers
  
           copy(frame->begin(), frame->end(), zbuf.begin() + 1);
  
           *zbuf. begin() = JDAQHitMin;
           *zbuf.rbegin() = JDAQHitMax;
  
           {
             JDAQFrame_t::const_iterator hit = zbuf.begin(); ++hit;            // skip begin marker
             JBuffer_t  ::const_iterator t1  = buffer.begin();
  
             for (grid_type::iterator i = grid->begin(); i != grid->end(); ++i, ++t1) {
             
               while (hit->getT() < *t1) { ++hit; }
               
               i->getY().lpos = distance(static_cast<const JDAQFrame_t&>(zbuf).begin(), hit)        - 1;
             }
           }
  
           {
             JDAQFrame_t::const_reverse_iterator hit = zbuf.rbegin(); ++hit;   // skip end marker
             JBuffer_t  ::const_reverse_iterator t1  = buffer.rbegin();
  
             for (grid_type::reverse_iterator i = grid->rbegin(); i != grid->rend(); ++i, ++t1) {
                 
               while (hit->getT() >= *t1) { ++hit; }
               
               i->getY().rpos = distance(static_cast<const JDAQFrame_t&>(zbuf).begin(), hit.base()) - 1;
             }
           }
         }
       }
     }

◆ getAddress()

const int JTRIGGER::JTimesliceRouter::getAddress ( const JDAQModuleIdentifier & module ) const

inline

Get address of module.

Parameters

module module

Returns: address

Definition at line 230 of file JTimesliceRouter.hh.

     {
       return router.get(module.getModuleID());
     }

◆ hasSuperFrame()

bool JTRIGGER::JTimesliceRouter::hasSuperFrame ( const JDAQModuleIdentifier & module ) const

inline

Check presence of module.

Parameters

module module

Returns: true if module present; else false

Definition at line 242 of file JTimesliceRouter.hh.

     {
       return router.has(module.getModuleID());
     }

◆ getSuperFrame()

const JDAQSuperFrame& JTRIGGER::JTimesliceRouter::getSuperFrame ( const JDAQModuleIdentifier & module ) const

inline

Get super frame.

Parameters

module module

Returns: super frame

Definition at line 254 of file JTimesliceRouter.hh.

     {
       return (*(this->get()))[this->getAddress(module)];
     }

◆ getFrameSubset()

JDAQFrameSubset JTRIGGER::JTimesliceRouter::getFrameSubset	(	const JDAQModuleIdentifier &	module,
		const JTimeRange &	timeRange
	)		const

inline

Get subset of frame given module identifier and range of hit times.

Note that the hit times should have been corrected for the maximal and minimal time offsets of the PMTs in the corresponding optical module.

Parameters

module	module
timeRange	time range [ns]

Returns: subset with begin and end iterators

Definition at line 270 of file JTimesliceRouter.hh.

     {
       const int address = this->getAddress(module);
  
       const grid_type&      grid  = table           [address];
       const JDAQSuperFrame& frame = (*(this->get()))[address];
  
       const int first  = grid.getIndex(timeRange.getLowerLimit());
       const int second = grid.getIndex(timeRange.getUpperLimit());
  
       if (first < 0 || second >= grid.getSize()) {
         THROW(JTriggerException, "Time range [ns] " << timeRange << " bounds " << grid.getXmin() << ' ' << grid.getXmax() << " indices " << first << ' ' << second);
       }
  
       return frame.subset(grid.getY(first).lpos, grid.getY(second).rpos);
     }

◆ get()

virtual const JDAQTimeslice * JLANG::JPointer< const JDAQTimeslice >::get ( ) const

inlinevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< const JDAQTimeslice >.

Definition at line 64 of file JPointer.hh.

     {
       return this->__p;
     }

◆ set() [1/2]

virtual void JLANG::JPointer< const JDAQTimeslice >::set ( const JDAQTimeslice * p )

inlinevirtualinherited

Set pointer.

Parameters

p	pointer to object

Implements JLANG::JAbstractPointer< const JDAQTimeslice >.

Definition at line 75 of file JPointer.hh.

     {
       this->__p = p;
     }

◆ set() [2/2]

void JLANG::JPointer< const JDAQTimeslice >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

     {
       this->set(pointer.get());
     }

◆ reset() [1/3]

virtual void JLANG::JPointer< const JDAQTimeslice >::reset ( )

inlinevirtualinherited

Reset pointer.

Implements JLANG::JAbstractPointer< const JDAQTimeslice >.

Definition at line 84 of file JPointer.hh.

     { 
       this->__p = NULL;
     }

◆ reset() [2/3]

void JLANG::JPointer< const JDAQTimeslice >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

     {
       this->reset(pointer.get());
     }

◆ reset() [3/3]

void JLANG::JAbstractPointer< const JDAQTimeslice >::reset ( const JDAQTimeslice * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

     {
       if (this->get() != p) {
  
         this->reset();
  
         if (p != NULL) {
           this->set(p);
         }
       }
     }

◆ getReference() [1/2]

const JDAQTimeslice * const& JLANG::JPointer< const JDAQTimeslice >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

     {
       return __p;
     }

◆ getReference() [2/2]

const JDAQTimeslice * & JLANG::JPointer< const JDAQTimeslice >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

     {
       return __p;
     }

◆ equals()

virtual bool JLANG::JAbstractPointer< const JDAQTimeslice >::equals ( const JAbstractPointer< const JDAQTimeslice > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

     {
       return this->get() == object.get();
     }

◆ is_valid()

bool JLANG::JAbstractPointer< const JDAQTimeslice >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

     { 
       return this->get() != NULL; 
     }

◆ operator->()

const JDAQTimeslice * JLANG::JAbstractPointer< const JDAQTimeslice >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

     { 
       if (!is_valid())
         throw JNullPointerException("JAbstractPointer::operator->()");
       else
         return this->get();
     }

◆ operator const JDAQTimeslice *()

JLANG::JAbstractPointer< const JDAQTimeslice >::operator const JDAQTimeslice * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

     {
       return this->get();
     }

Member Data Documentation

◆ number_of_bins

int JTRIGGER::JTimesliceRouter::number_of_bins

private

Definition at line 288 of file JTimesliceRouter.hh.

◆ router

router_type JTRIGGER::JTimesliceRouter::router

private

Definition at line 289 of file JTimesliceRouter.hh.

◆ table

std::vector<grid_type> JTRIGGER::JTimesliceRouter::table

private

Definition at line 290 of file JTimesliceRouter.hh.

◆ __p

const JDAQTimeslice * JLANG::JPointer< const JDAQTimeslice >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

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

JTimesliceRouter.hh

Classes

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ element_type

◆ grid_type

◆ router_type

◆ const_iterator

Constructor & Destructor Documentation

◆ JTimesliceRouter() [1/2]

◆ JTimesliceRouter() [2/2]

Member Function Documentation

◆ configure()

◆ getAddress()

◆ hasSuperFrame()

◆ getSuperFrame()

◆ getFrameSubset()

◆ get()

◆ set() [1/2]

◆ set() [2/2]

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ getReference() [1/2]

◆ getReference() [2/2]

◆ equals()

◆ is_valid()

◆ operator->()

◆ operator const JDAQTimeslice *()

Member Data Documentation

◆ number_of_bins

◆ router

◆ table

◆ __p