JTRIGGER Namespace Reference

Auxiliary classes and methods for triggering. More...

Classes
struct	JAssertBit
	This class will generate a compiler error if trigger bit is out of range. More...
struct	JAssertBit< N, true >
	Implementation of a valid trigger bit. More...
struct	JAttributes
	Module attributes. More...
class	JBinder2nd
	Auxiliary class to convert binary JMatch operator and given hit to unary match operator. More...
struct	JBuild
	Auxiliary base class for hit building. More...
struct	JBuildHelper
	Auxiliary class to extend hit building functionality to all DAQ data types. More...
class	JBuildL0
	Template L0 hit builder. More...
class	JBuildL0< JHitL0 >
	Template specialisation of L0 builder for JHitL0 data type. More...
class	JBuildL0< JHitR0 >
	Template specialisation of L0 builder for JHitR0 data type. More...
class	JBuildL0< JHitR1 >
	Template specialisation of L0 builder for JHitR1 data type. More...
class	JBuildL1
	Template L1 hit builder. More...
class	JBuildL1< JHitL1 >
	Template specialisation of L1 builder for JHitL1 data type. More...
class	JBuildL1< JHitR1 >
	Template specialisation of L1 builder for JHitR1 data type. More...
struct	JBuildL1Parameters
	Auxiliary data structure for L1 build parameters. More...
class	JBuildL2
	Template L2 builder. More...
class	JBuildL2< JHitL2 >
	Template specialisation of L2 builder for JHitL2 data type. More...
class	JBuildL2< JHitR2 >
	Template specialisation of L2 builder for JHitR2 data type. More...
struct	JChecksum
	Auxiliary class to perform check-sum on raw data. More...
class	JCLBRunByRunSimulator
	CLB simulation based on run-by-run information. More...
class	JClone
	Clone of a container. More...
struct	JDAQHitDefaultSelector
	Default class to select DAQ hits. More...
struct	JDAQHitSelector
	Auxiliary class to select DAQ hits. More...
struct	JDAQHitToTSelector
	Auxiliary class to select DAQ hits based on time-over-treshold value. More...
class	JDOMToPMTMaskMap
class	JEvent
	Triggered event. More...
class	JEventOverlap
	Match of two events considering overlap in time. More...
class	JFrame
	Data frame for calibrated hits of one PMT. More...
class	JFrame_t
	Data frame with end marker. More...
class	JFrameClone
	Clone of JFrame. More...
struct	JGetRiseTime
	Auxiliary class for rise time evaluation. More...
class	JHit
	Hit data structure. More...
class	JHitL0
	Data structure for L0 hit. More...
class	JHitL1
	Data structure for L1 hit. More...
class	JHitR0
	Reduced data structure for L0 hit. More...
class	JHitR1
	Reduced data structure for L1 hit. More...
struct	JHitToolkit
	Template definition of hit toolkit. More...
struct	JHitToolkit< JDAQHit, false >
	Template specialisation of hit toolkit for JDAQHit class. More...
struct	JHitToolkit< JHit, false >
	Template specialisation of hit toolkit for JHit class. More...
struct	JHitToolkit< JHit_t, true >
	Template specialisation of hit toolkit for any primitive data type. More...
struct	JHitToolkit< JHitR0, false >
	Template specialisation of hit toolkit for JHitR0 class. More...
class	JK40RunByRunSimulator
	K40 simulation based on run-by-run information. More...
struct	JL2Parameters
	Data structure for L2 parameters. More...
class	JMatch
	Function object interface for hit matching. More...
class	JMatch1D
	1D match criterion. More...
class	JMatch3B
	3D match criterion with road width. More...
class	JMatch3D
	3D match criterion. More...
class	JMatch3G
	3G match criterion. More...
class	JMatchFixer
	Auxiliary class to fix match. More...
class	JMatchHelper
	Auxiliary class to handle pointer to match function. More...
class	JMatchL0
	L0 match criterion. More...
struct	JModuleCounter
	Auxiliary class for counting unique modules. More...
struct	JModuleHeader
	Header for Module. More...
struct	JParametersHelper
	Wrapper class to share parameters. More...
struct	JPMTHeader
	Header for PMT. More...
class	JPMTIdentifier_t
class	JPMTMask
	Auxiliary class for PMT mask. More...
class	JPMTRunByRunSimulator
	PMT simulation based on run-by-run information. More...
struct	JPMTSelector
	Auxiliary data structure for set of PMT identifiers. More...
struct	JPreprocessor
	Auxiliary class for specifying the way of pre-processing of hits. More...
class	JPrescaler
	Auxiliary class for prescaling. More...
class	JSummaryRouter
	Router for fast addressing of summary data in JDAQSummaryslice data structure as a function of the optical module identifier. More...
class	JSuperFrame1D
	1-dimensional frame with time calibrated data from one optical module. More...
class	JSuperFrame2D
	2-dimensional frame with time calibrated data from one optical module. More...
class	JSuperFrameClone1D
	Clone of JSuperFrame1D. More...
class	JSuperFrameClone2D
	Clone of JSuperFrame2D. More...
class	JTimeslice
	Time slice with calibrated data. More...
class	JTimesliceClone
	Clone of JTimeslice. More...
class	JTimesliceL1
	Auxiliary class to build JDAQTimeslice for L1 timeslice. More...
struct	JTimesliceRouter
	Router for fast addressing of hits in KM3NETDAQ::JDAQTimeslice data structure as a function of the optical module identifier and time. More...
struct	JTimesliceRouter_t
	Auxiliary base class for JTimesliceRouter. More...
class	JTrigger3D
	General purpose majority trigger. More...
class	JTrigger3DMuon
	Muon trigger. More...
struct	JTrigger3DMuon_t
	Muon trigger parameters. More...
class	JTrigger3DShower
	Shower trigger. More...
struct	JTrigger3DShower_t
	Shower trigger parameters. More...
class	JTrigger3N
	General purpose muon trigger. More...
struct	JTriggerBit
	This class is used to map trigger class to trigger bit. More...
class	JTriggeredEvent
	Auxiliary class to build JDAQEvent for a triggered event. More...
class	JTriggeredHit
	Data structure for triggered hit. More...
class	JTriggerException
	General exception. More...
class	JTriggerInput
	Data structure for input to trigger algorithm. More...
class	JTriggerInterface
	Trigger interface. More...
class	JTriggerMXShower
	Shower trigger. More...
struct	JTriggerMXShower_t
	Shower trigger parameters. More...
class	JTriggerNB
	Nano-beacon trigger. More...
struct	JTriggerNB_t
	Nano-beacon trigger parameters. More...
class	JTriggerOutput
	Set of triggered events. More...
class	JTriggerParameters
	Data structure for all trigger parameters. More...

Typedefs
typedef JHitL1	JHitL2
	Type definition of L2 hit.
typedef JHitR1	JHitR2
	Type definition of R2 hit.
typedef unsigned int	JPMTMask_t
	Type definition of PMT mask.
typedef unsigned int	JTriggerbit_t
	Type definition of trigger bit.

Functions
template<class JHitIterator_t , class JMatch_t >
JHitIterator_t	clusterize (JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t &match, const int Nmin=1)
	Partition data according given binary match operator.
template<class JHitIterator_t , class JComparator_t , class JMatch_t >
JHitIterator_t	clusterize (JHitIterator_t __begin, JHitIterator_t __end, const JComparator_t &comparator, const JMatch_t &match)
	Select best root hit according given comparator and partition remaining data according given binary match operator and this root hit.
template<class JHitIterator_t , class JMatch_t >
JHitIterator_t	reverse_clusterize (JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t &match)
	Partition data according given binary match operator.
template<class JHitIterator_t , class JMatch_t >
JHitIterator_t	clusterizeWeight (JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t &match)
	Partition data according given binary match operator.
template<class JHit_t >
bool	weightSorter (const JHit_t &first, const JHit_t &second)
	Compare two hits by weight.
template<class JHit_t >
bool	timeSorter (const JHit_t &first, const JHit_t &second)
	Compare two hits by weight.
template<class JHit_t >
JBinder2nd< JHit_t >	JBind2nd (const JMatch< JHit_t > &match, const JHit_t &second)
	Auxiliary method to create JBinder2nd object.
bool	operator< (const JEvent &first, const JEvent &second)
	Less than operator for events.
JTimeRange	getTimeRange (const JEvent &event)
	Get time range (i.e. earlist and latest hit time) of triggered event.
bool	operator< (const JHit &first, const JHit &second)
	Less than operator for hits.
bool	operator< (const JHit &hit, const double t1)
	Less than operator for hits.
bool	operator== (const JHit &first, const JHit &second)
	Equal operator for hits.
template<class T >
int	getCount (const T &hit)
	Get hit count.
template<class T >
int	getCount (T __begin, T __end)
	Get hit count.
double	getTime (const JDAQHit &hit, const JCalibration &cal)
	Get calibrated time of DAQ hit.
double	getToT (const JDAQHit &hit, const JCalibration &cal)
	Get calibrated time-over-threshold of DAQ hit.
template<class JHit_t >
JMatchHelper< JHit_t >	make_match (bool(*match)(const JHit_t &, const JHit_t &))
	Auxiliary method to make JMatch object based on pointer to match function.
bool	operator== (const JPMTIdentifier_t &first, const JPMTIdentifier_t &second)
	Equal operator for PMT identifiers.
bool	operator< (const JPMTIdentifier_t &first, const JPMTIdentifier_t &second)
	Less than operator for PMT identifiers.
JPMTMask_t	getPMTMask (const unsigned int bit)
	Convert PMT bit to PMT mask.
	setTriggerBit (JTrigger3DShower, JTRIGGER3DSHOWER)
	setTriggerBit (JTriggerMXShower, JTRIGGERMXSHOWER)
	setTriggerBit (JTrigger3DMuon, JTRIGGER3DMUON)
	setTriggerBit (JTriggerNB, JTRIGGERNB)
bool	operator< (const JTriggeredHit &first, const JTriggeredHit &second)
	Less than operator for triggered hits.
bool	operator== (const JTriggeredHit &first, const JTriggeredHit &second)
	Equal operator for triggered hits.
template<class JTrigger_t >
JTriggerbit_t	getTriggerBit ()
	Get the trigger bit.
template<class JTrigger_t >
JTriggerbit_t	getTriggerBit (const JTrigger_t &event)
	Get the trigger bit.
const char *	getTriggerName (JTriggerbit_t bit)
	Get trigger name.
void	setAttributes (const JModule &first, const JModule &second, JAttributes &attributes)
	Set module attributes.
void	randomize (JTrigger3DMuon_t::JParameters *p)
	Randomize trigger parameters.
void	randomize (JTrigger3DShower_t::JParameters *p)
	Randomize trigger parameters.
void	randomize (JTriggerMXShower_t::JParameters *p)
	Randomize trigger parameters.
void	randomize (JTriggerNB_t::JParameters *p)
	Randomize trigger parameters.
void	randomize (JTriggerParameters *p)
	Randomize trigger parameters.
JTimeRange	getTimeRange (const JTriggerParameters &parameters)
	Get time range of snapshot.
JTimeRange	getTimeRange (const JTriggerNB_t::JParameters &parameters)
	Get time range of snapshot.
bool	getDAQStatus (const JDAQFrameStatus &frame, const JStatus &status)
	Test status of DAQ.
bool	getDAQStatus (const JDAQFrameStatus &frame, const JModule &module, const int pmt)
	Test status of DAQ.
bool	getPMTStatus (const JStatus &status)
	Test status of PMT.
bool	getPMTStatus (const JDAQFrameStatus &frame, const JStatus &status, const int pmt)
	Test status of PMT.
bool	getPMTStatus (const JDAQFrameStatus &frame, const JModule &module, const int pmt)
	Test status of PMT.
double	getRate (const JDAQSummaryFrame &frame, const int pmt, const double factor=1.0)
	Get corrected rate of PMT.

Variables
static int	MAXIMAL_FRAME_SIZE = std::numeric_limits<int>::max()
	Maximal frame size.
static const JChecksum	checksum
	Function object to perform check-sum of raw data.
static const JGetRiseTime	getRiseTime
	Function object for rise time evaluation.
static const JModuleCounter	getNumberOfModules
	Function object to count unique modules.
static const unsigned int	NUMBER_OF_PMT_BITS = 31
	Number of PMT bits.

Detailed Description

Auxiliary classes and methods for triggering.

Trigger algorithms, support classes and auxiliary methods.

Author

mdejong

rbruijn

rgruiz

Typedef Documentation

JHitL2

typedef JHitL1 JTRIGGER::JHitL2

Type definition of L2 hit.

Definition at line 20 of file JHitL2.hh.

JHitR2

typedef JHitR1 JTRIGGER::JHitR2

Type definition of R2 hit.

Definition at line 20 of file JHitR2.hh.

JPMTMask_t

typedef unsigned int JTRIGGER::JPMTMask_t

Type definition of PMT mask.

Definition at line 29 of file JPMTMask.hh.

JTriggerbit_t

typedef unsigned int JTRIGGER::JTriggerbit_t

Type definition of trigger bit.

Definition at line 29 of file JTriggerInterface.hh.

Function Documentation

clusterize() [1/2]

template<class JHitIterator_t , class JMatch_t >

JHitIterator_t JTRIGGER::clusterize ( JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t & match, const int Nmin = 1 )

inline

Partition data according given binary match operator.

The underlying algorithm is known in literature as 'clique'. The result is (likely to be) the maximal sub-set with all elements matched to each other. The complexity is quadratic, i.e. at most (number of elements x number of elements) operations. The algorithm will sort the data such that all clusterized hits are at the front. The return value points the first non clusterized hit.

The hit iterator refers to a data structure which should conform with the match operator.

Parameters

__begin	begin of data
__end	end of data
match	binary match operator
Nmin	minimum cluster size

Returns

end of data

Definition at line 38 of file JAlgorithm.hh.

  {
    using namespace std;
 
    const int N = distance(__begin,__end);
 
    JHitIterator_t buffer = __begin;
    
    if (N >= Nmin) {
 
      int i, j;
      int n = N;
 
      // Determine number of associated hits for each hit.
 
      std::vector<int> count(N, 1);      // Assume always a match with itself.
 
      for (i = 0; i != N; ++i) {
        for (j = i; ++j != N; ) {
          if (match(buffer[i], buffer[j])) {
            ++count[i];
            ++count[j];
          }
        }
      }
 
      // Remove hit with the smallest number of associated hits.
      // This procedure stops when:
      // 1) number of associated hits is equal to the number of (remaining) hits or
      // 2) maximal number of associated hits is less than the specified minimum.
 
      for ( ; ; ) {
      
        int M = (count[0] >= Nmin ? 1 : 0);
      
        j = 0;
 
        for (i = 1; i != n; ++i) {
          if (count[i] < count[j]) {
            j = i;
          }
          if (count[i] >= Nmin) {
            ++M;
          }
        }
      
        // Ready?
 
        if (count[j] == n) {
          return buffer + n;
        }
 
        if (M < Nmin) {
          return buffer;
        }
      
        // Reduce effective size.
 
        --n;
      
        // Swap the selected hit to end.
 
        swap(buffer[j], buffer[n]); 
        swap(count [j], count [n]);
 
        // Decrease number of associated hits for each associated hit.
 
        for (i = 0; i != n && count[n] != 1; ++i) {
          if (match(buffer[i], buffer[n])) {
            --count[i];
            --count[n];
          }
        }
      }
    }
 
    return buffer;
  }

clusterize() [2/2]

template<class JHitIterator_t , class JComparator_t , class JMatch_t >

JHitIterator_t JTRIGGER::clusterize ( JHitIterator_t __begin, JHitIterator_t __end, const JComparator_t & comparator, const JMatch_t & match )

inline

Select best root hit according given comparator and partition remaining data according given binary match operator and this root hit.

The complexity is linear, i.e. at most number of elements operations. The algorithm will sort the data such that all selected hits are at the front.

Parameters

__begin	begin of data
__end	end of data
comparator	comparator
match	binary match operator

Returns

end of data

Definition at line 134 of file JAlgorithm.hh.

  {
    if (__begin != __end) {
 
      std::sort(__begin, __end, comparator);
 
      JHitIterator_t root = __begin;
 
      return std::partition(++__begin, __end, JBind2nd(match, *root));
 
    } else {
 
      return __end;
    }
  }

reverse_clusterize()

template<class JHitIterator_t , class JMatch_t >

JHitIterator_t JTRIGGER::reverse_clusterize ( JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t & match )

inline

Partition data according given binary match operator.

The underlying algorithm is known in literature as reverse 'clique'. The result is (likely to be) the maximal sub-set with all elements matched to each other. The complexity is quadratic, i.e. at most (number of elements x number of elements) operations. The algorithm will sort the data such that all clusterized hits are at the front. The return value points the first non clusterized hit.

The hit iterator refers to a data structure which should conform with the match operator.

Parameters

__begin	begin of data
__end	end of data
match	binary match operator

Returns

end of data

Definition at line 171 of file JAlgorithm.hh.

  {
    using namespace std;
 
    const int N = distance(__begin,__end);
 
    JHitIterator_t buffer = __begin;
 
    if (N != 0) {
 
      int i, j;
 
      // Determine number of associated hits for each hit.
 
      std::vector<int> count(N, 1);      // Assume always a match with itself.
 
      for (i = 0; i != N; ++i) {
        for (j = 0; j != i; ++j) {
          if (match(buffer[i], buffer[j])) {
            ++count[i];
            ++count[j];
          }
        }
      }
 
      // Keep hit with the largest number of associated hits.
      // This procedure stops when the number of associated hits is equal to one.
 
      for (int n = 0; ; ++n) {
 
        j = n;
      
        for (i = j; ++i != N; ) {
          if (count[i] > count[j]) {
            j = i;
          }
        }
      
        // Ready?
 
        if (count[j] == 1) {
          return buffer + n;
        }
 
        // Swap the selected hit to begin.
 
        swap(buffer[j], buffer[n]);
        swap(count [j], count [n]);
 
        // Decrease number of associated hits for each associated hit.
 
        for (i = n; ++i != N; ) {
          if (match(buffer[i], buffer[n])) {
            --count[i];
            --count[n];
          }
        }
      }
    }
 
    return buffer;
  }

clusterizeWeight()

template<class JHitIterator_t , class JMatch_t >

JHitIterator_t JTRIGGER::clusterizeWeight ( JHitIterator_t __begin, JHitIterator_t __end, const JMatch_t & match )

inline

Partition data according given binary match operator.

The underlying algorithm is known in literature as reverse 'clique'. The result is (likely to be) the maximal sub-set with all elements matched to each other. The complexity is quadratic, i.e. at most (number of elements x number of elements) operations. The algorithm will sort the data such that all clusterized hits are at the front. The return value points the first non clusterized hit. Note that the weight is assumed to be positive definite and the larger the weight the better.

The hit iterator refers to a data structure which should conform with the match operator. In addition, it should have the following member method:

• double getW(); // [a.u.]

Parameters

__begin	begin of data
__end	end of data
match	binary match operator

Returns

end of data

Definition at line 257 of file JAlgorithm.hh.

  {
    using namespace std;
 
    const int N = distance(__begin,__end);
 
    JHitIterator_t buffer = __begin;
 
    if (N != 0) {
 
      int i, j;
 
      // Determine weight of each hit.
 
      std::vector<double> weight(N);
 
      for (i = 0; i != N; ++i) {      
        weight[i] = buffer[i].getW();    // Assume always a match with itself.
      }
 
      for (i = 0; i != N; ++i) {
        for (j = i; ++j != N; ) {
          if (match(buffer[i], buffer[j])) {
            weight[i] += buffer[j].getW();
            weight[j] += buffer[i].getW();
          }
        }
      }
 
      // Remove hit with the smallest weight of associated hits.
      // This procedure stops when the weight of associated hits
      // is equal to the maximal weight of (remaining) hits.
    
      int    n = N;
      double W;
    
      for ( ; ; ) {
      
        j = 0;
        W = weight[j];
 
        for (i = 1; i != n; ++i) {
          if      (weight[i] < weight[j])
            j = i;
          else if (weight[i] > W)
            W = weight[i];
        }
      
        // Ready?
      
        if (weight[j] == W) {
          return buffer + n;
        }
      
        // Reduce effective size.
      
        --n;
      
        // Swap the selected hit to end.
 
        swap(buffer[j], buffer[n]);
        swap(weight[j], weight[n]);
 
        // Decrease weight of associated hits for each associated hit.
 
        for (i = 0; i != n && weight[n] > buffer[n].getW(); ++i) {
          if (match(buffer[i], buffer[n])) {
            weight[i] -= buffer[n].getW();
            weight[n] -= buffer[i].getW();
          }
        }
      }
    }
 
    return buffer;
  }

weightSorter()

template<class JHit_t >

bool JTRIGGER::weightSorter ( const JHit_t & first, const JHit_t & second )

inline

Compare two hits by weight.

The template argument JHit_t refers to a data structure which should have the following member method:

• double getW(); // [a.u.]

Parameters

first	first hit
second	second hit

Returns

true if first hit has larger weight than second; else false

Definition at line 348 of file JAlgorithm.hh.

  {
    return first.getW() > second.getW();
  }

timeSorter()

template<class JHit_t >

bool JTRIGGER::timeSorter ( const JHit_t & first, const JHit_t & second )

inline

Compare two hits by weight.

The template argument JHit_t refers to a data structure which should have the following member methods:

• double getT(); // [a.u.]

Parameters

first	first hit
second	second hit

Returns

true if first hit earlier than second; else false

Definition at line 365 of file JAlgorithm.hh.

  {
    return first.getT() < second.getT();
  }

JBind2nd()

template<class JHit_t >

JBinder2nd< JHit_t > JTRIGGER::JBind2nd ( const JMatch< JHit_t > & match, const JHit_t & second )

inline

Auxiliary method to create JBinder2nd object.

Parameters

match	match operator
second	second hit

Returns

JBinder2nd

Definition at line 66 of file JBind2nd.hh.

  {
    return JBinder2nd<JHit_t>(match, second);
  }

operator<() [1/5]

bool JTRIGGER::operator< ( const JEvent & first, const JEvent & second )

inline

Less than operator for events.

The less than operator is applied to the first hit in the events.

Parameters

first	first event
second	second event

Returns

true if first event earliear than second; else false

Definition at line 215 of file JTrigger/JEvent.hh.

  {
    if (first.empty() || second.empty()) {
      throw JTriggerException("Comparison with empty event(s).");
    }
 
    return first.begin()->getT() < second.begin()->getT();
  }

getTimeRange() [1/3]

JTimeRange JTRIGGER::getTimeRange ( const JEvent & event )

inline

Get time range (i.e. earlist and latest hit time) of triggered event.

Parameters

event

event

Returns

time range

Definition at line 26 of file JEventToolkit.hh.

  {
    if (!event.empty())
      return JTimeRange(event.begin()->getT(), event.rbegin()->getT());
    else
      return JTimeRange::DEFAULT_RANGE();
  }

operator<() [2/5]

bool JTRIGGER::operator< ( const JHit & first, const JHit & second )

inline

Less than operator for hits.

The less than operator is applied to the time of the hits.

Parameters

first	first hit
second	second hit

Returns

true if first hit earlier; else false

Definition at line 231 of file JTrigger/JHit.hh.

  {
    return first.getT() < second.getT();
  }

operator<() [3/5]

bool JTRIGGER::operator< ( const JHit & hit, const double t1 )

inline

Less than operator for hits.

The less than operator is applied to the time of the hits.

Parameters

hit	hit
t1	time [ns]

Returns

true if hit earlier than t; else false

Definition at line 246 of file JTrigger/JHit.hh.

  {
    return hit.getT() < t1;
  }

operator==() [1/3]

bool JTRIGGER::operator== ( const JHit & first, const JHit & second )

inline

Equal operator for hits.

The equal operator is applied to the time of the hits.

Parameters

first	hit
second	hit

Returns

true if first hit time equal to second hit time; else false

Definition at line 261 of file JTrigger/JHit.hh.

  {
    return first.getT() == second.getT();
  }

getCount() [1/2]

template<class T >

int JTRIGGER::getCount ( const T & hit )

inline

Get hit count.

The hit refers to a data structure which should have the following member method:

• int getN();

Parameters

hit

hit

Returns

count

Definition at line 277 of file JTrigger/JHit.hh.

  {
    return hit.getN();
  }

getCount() [2/2]

template<class T >

int JTRIGGER::getCount ( T __begin, T __end )

inline

Get hit count.

The hit iterator refers to a data structure which should have the following member method:

• int getN();

Parameters

__begin	begin of data
__end	end of data

Returns

count

Definition at line 294 of file JTrigger/JHit.hh.

  {
    int count = 0;
 
    for (T hit = __begin; hit !=__end; ++hit) {
      count += getCount(*hit);
    }
 
    return count;
  }

getTime()

double JTRIGGER::getTime ( const JDAQHit & hit, const JCalibration & cal )

inline

Get calibrated time of DAQ hit.

Parameters

hit	DAQ hit
cal	calibration

Returns

time [ns]

Definition at line 34 of file JHitToolkit.hh.

  {
    return getTime(hit.getT(), cal);
  }

getToT()

double JTRIGGER::getToT ( const JDAQHit & hit, const JCalibration & cal )

inline

Get calibrated time-over-threshold of DAQ hit.

Parameters

hit	DAQ hit
cal	calibration

Returns

time-over-threshold [ns]

Definition at line 47 of file JHitToolkit.hh.

  {
    return getToT(hit.getToT(), cal);
  }

make_match()

template<class JHit_t >

JMatchHelper< JHit_t > JTRIGGER::make_match

(

bool(*

match )(const JHit_t &, const JHit_t &)

)

Auxiliary method to make JMatch object based on pointer to match function.

Parameters

match

pointer to match function

Returns

match object

Definition at line 115 of file JMatch.hh.

  {
    return JMatchHelper<JHit_t>(match);
  }  

operator==() [2/3]

bool JTRIGGER::operator== ( const JPMTIdentifier_t & first, const JPMTIdentifier_t & second )

inline

Equal operator for PMT identifiers.

Parameters

first	PMT identifier
second	PMT identifier

Returns

true if first PMT equal second PMT; else false

Definition at line 169 of file JPMTIdentifier_t.hh.

  {
    return (first.getModuleID()   == second.getModuleID()  &&
            first.getPMTAddress() == second.getPMTAddress());
  }

operator<() [4/5]

bool JTRIGGER::operator< ( const JPMTIdentifier_t & first, const JPMTIdentifier_t & second )

inline

Less than operator for PMT identifiers.

The less than operator is applied first to the module identifer and then to the PMT address.

Parameters

first	PMT identifier
second	PMT identifier

Returns

true if first PMT lower than second PMT; else false

Definition at line 185 of file JPMTIdentifier_t.hh.

  {
    if (first.getModuleID() == second.getModuleID())
      return first.getPMTAddress() < second.getPMTAddress();
    else
      return first.getModuleID()   < second.getModuleID();
  }

getPMTMask()

JPMTMask_t JTRIGGER::getPMTMask ( const unsigned int bit )

inline

Convert PMT bit to PMT mask.

Parameters

bit

PMT bit

Returns

PMT mask

Definition at line 44 of file JPMTMask.hh.

  {
    if (bit < NUMBER_OF_PMT_BITS)
      return JPMTMask_t(1) << bit;
    else
      return 0;
  }

setTriggerBit() [1/4]

JTRIGGER::setTriggerBit	(	JTrigger3DShower	,
		JTRIGGER3DSHOWER	)

setTriggerBit() [2/4]

JTRIGGER::setTriggerBit	(	JTriggerMXShower	,
		JTRIGGERMXSHOWER	)

setTriggerBit() [3/4]

JTRIGGER::setTriggerBit	(	JTrigger3DMuon	,
		JTRIGGER3DMUON	)

setTriggerBit() [4/4]

JTRIGGER::setTriggerBit	(	JTriggerNB	,
		JTRIGGERNB	)

operator<() [5/5]

bool JTRIGGER::operator< ( const JTriggeredHit & first, const JTriggeredHit & second )

inline

Less than operator for triggered hits.

The less than operator is applied first to JTRIGGER::JHit and then to the KM3NETDAQ::JDAQPMTIdentifier. Hence, the ordering by JTRIGGER::JHit is maintained. This allows for the use of STL sort() and set_union() algorithms.

Parameters

first	first hit
second	second hit

Returns

true if first hit earlier or lower PMT identifier if equal; else false

Definition at line 86 of file JTriggeredHit.hh.

  {
    if (std::equal_to<JHit>()(first,second))
      return std::less<JDAQPMTIdentifier>()(first,second);
    else
      return std::less<JHit>             ()(first,second);
  }

operator==() [3/3]

bool JTRIGGER::operator== ( const JTriggeredHit & first, const JTriggeredHit & second )

inline

Equal operator for triggered hits.

The equal operator is applied to JTRIGGER::JHit and to the KM3NETDAQ::JDAQPMTIdentifier.

Parameters

first	first hit
second	second hit

Returns

true if first hit equal second hit; else false

Definition at line 104 of file JTriggeredHit.hh.

  {
    return (std::equal_to<JDAQPMTIdentifier>()(first,second) &&
            std::equal_to<JHit>             ()(first,second));
  }

getTriggerBit() [1/2]

template<class JTrigger_t >

JTriggerbit_t JTRIGGER::getTriggerBit ( )

inline

Get the trigger bit.

Returns

trigger bit

Definition at line 206 of file JTriggerInterface.hh.

  {
    return JTriggerBit<JTrigger_t>::value;
  }

getTriggerBit() [2/2]

template<class JTrigger_t >

JTriggerbit_t JTRIGGER::getTriggerBit ( const JTrigger_t & event )

inline

Get the trigger bit.

Parameters

event

triggered event

Returns

trigger bit

Definition at line 219 of file JTriggerInterface.hh.

  {
    return JTriggerBit<JTrigger_t>::value;
  }

getTriggerName()

const char * JTRIGGER::getTriggerName ( JTriggerbit_t bit )

inline

Get trigger name.

param bit trigger bit

Returns

trigger name

Definition at line 231 of file JTriggerInterface.hh.

  {
    return JTriggerInterface::getTriggerName(bit);
  }

setAttributes()

void JTRIGGER::setAttributes ( const JModule & first, const JModule & second, JAttributes & attributes )

inline

Set module attributes.

Parameters

first	first module
second	second module
attributes	module attributes

Definition at line 54 of file JTriggerMXShower.hh.

  {
    using namespace JPP;
 
    typedef JTriggerMXShower_t::JParameters  JParameters_t;
 
    // get trigger parameters
 
    const JParameters_t& parameters = JParametersHelper<JParameters_t>::getParameters();
 
    const double d = getDistance(first.getPosition(), second.getPosition());
 
    double t1 = 0.0;
 
    if      (d <= 0.5 * parameters.DMax_m)
      t1 =  d                      * getIndexOfRefraction() * getInverseSpeedOfLight()  +  parameters.TMaxExtra_ns;
    else if (d <= parameters.DMax_m)
      t1 = (parameters.DMax_m - d) * getIndexOfRefraction() * getInverseSpeedOfLight()  +  parameters.TMaxExtra_ns;
 
    attributes.Tmin_ns = -t1;
    attributes.Tmax_ns = +t1;
  }

randomize() [1/5]

void JTRIGGER::randomize ( JTrigger3DMuon_t::JParameters * p )

inline

Randomize trigger parameters.

Parameters

p	pointer to valid object

Definition at line 26 of file JTriggerTestkit.hh.

  {
    p->enabled         =  getRandom<bool>();
    p->numberOfHits    =  getRandom<int>(1, 10);
    p->numberOfModules =  getRandom<int>(1, 10);
    p->DMax_m          =  getRandom<double>( 0.0, 999.0, 1.0);
    p->roadWidth_m     =  getRandom<double>(50.0, 250.0, 1.0);
    p->gridAngle_deg   =  getRandom<double>( 1.0,  10.0, 1.0);
    p->TMaxExtra_ns    =  getRandom<double>(10.0,  50.0, 1.0);
    p->factoryLimit    =  getRandom<double>(100,  200);
  }

randomize() [2/5]

void JTRIGGER::randomize ( JTrigger3DShower_t::JParameters * p )

inline

Randomize trigger parameters.

Parameters

p	pointer to valid object

Definition at line 44 of file JTriggerTestkit.hh.

  {
    p->enabled         =  getRandom<bool>();
    p->numberOfHits    =  getRandom<int>(1, 10);
    p->numberOfModules =  getRandom<int>(1, 10);
    p->DMax_m          =  getRandom<double>( 0.0, 999.0, 1.0);
    p->TMaxExtra_ns    =  getRandom<double>(10.0,  50.0, 1.0);
    p->factoryLimit    =  getRandom<double>(100,  200);
  }

randomize() [3/5]

void JTRIGGER::randomize ( JTriggerMXShower_t::JParameters * p )

inline

Randomize trigger parameters.

Parameters

p	pointer to valid object

Definition at line 60 of file JTriggerTestkit.hh.

  {
    p->enabled         =  getRandom<bool>();
    p->numberOfHits    =  getRandom<int>(1, 10);
    p->numberOfModules =  getRandom<int>(1, 10);
    p->DMax_m          =  getRandom<double>( 0.0, 999.0, 1.0);
    p->TMaxExtra_ns    =  getRandom<double>(10.0,  50.0, 1.0);
    p->factoryLimit    =  getRandom<double>(100,  200);
  }

randomize() [4/5]

void JTRIGGER::randomize ( JTriggerNB_t::JParameters * p )

inline

Randomize trigger parameters.

Parameters

p	pointer to valid object

Definition at line 76 of file JTriggerTestkit.hh.

  {
    p->enabled         =  getRandom<bool>();
 
    p->pmts.clear();
 
    for (int i = getRandom<int>(1, 10); i != 0; --i) {
      p->pmts.push_back(JPMTIdentifier_t(getRandom<int>(-1, 100),
                                         getRandom<int>(-1,  30)));
    }
  }

randomize() [5/5]

void JTRIGGER::randomize ( JTriggerParameters * p )

inline

Randomize trigger parameters.

Parameters

p	pointer to valid object

Definition at line 94 of file JTriggerTestkit.hh.

  {
    p->highRateVeto_Hz = getRandom<double>(1.0e3, 1.0e4, 1.0);
    p->L2Min           = getRandom<int>(2, 3);
    p->ctMin           = getRandom<double>( -1.0,  +1.0, 0.1);
    p->TMaxLocal_ns    = getRandom<double>( 10.0,  20.0, 1.0);
    p->TMaxEvent_ns    = getRandom<double>(100.0, 999.0, 1.0);
    p->numberOfBins    = getRandom<int>(100, 1000);
    p->combineL1       = getRandom<bool>();
 
    p->trigger3DMuon   = getRandom<JTrigger3DMuon_t  ::JParameters>();
    p->trigger3DShower = getRandom<JTrigger3DShower_t::JParameters>();
    p->triggerMXShower = getRandom<JTriggerMXShower_t::JParameters>();
    p->triggerNB       = getRandom<JTriggerNB_t      ::JParameters>();
 
    p->writeSummary    = getRandom<long long int>(0, 100);
    p->writeL0         = getRandom<long long int>(0, 100);
    p->writeL1         = getRandom<long long int>(0, 100);
    p->writeL2         = getRandom<long long int>(0, 100);
    p->writeSN         = getRandom<long long int>(0, 100);
  }

getTimeRange() [2/3]

JTimeRange JTRIGGER::getTimeRange ( const JTriggerParameters & parameters )

inline

Get time range of snapshot.

Parameters

parameters

trigger parameters

Returns

time range [ns]

Definition at line 40 of file JTriggerToolkit.hh.

  {
    return JTimeRange(-parameters.TMaxEvent_ns, 
                      +parameters.TMaxEvent_ns);
  }

getTimeRange() [3/3]

JTimeRange JTRIGGER::getTimeRange ( const JTriggerNB_t::JParameters & parameters )

inline

Get time range of snapshot.

Parameters

parameters

trigger parameters

Returns

time range [ns]

Definition at line 52 of file JTriggerToolkit.hh.

  {
    using namespace JPP;
 
    return JTimeRange(0.0, parameters.DMax_m * getIndexOfRefraction() * getInverseSpeedOfLight());
  }

getDAQStatus() [1/2]

bool JTRIGGER::getDAQStatus ( const JDAQFrameStatus & frame, const JStatus & status )

inline

Test status of DAQ.

The DAQ test passes if the assembly of UDP packets is complete.
The test can be bypassed using the PMT control status.

Parameters

frame	data frame status
status	PMT control status

Returns

true if test passes; else false

Definition at line 70 of file JTriggerToolkit.hh.

  {
    return ((status.has(UDP_COUNTER_DISABLE) || (frame.getUDPNumberOfReceivedPackets() == frame.getUDPMaximalSequenceNumber() + 1))  &&
            (status.has(UDP_TRAILER_DISABLE) || (frame.hasUDPTrailer())));
  }

getDAQStatus() [2/2]

bool JTRIGGER::getDAQStatus ( const JDAQFrameStatus & frame, const JModule & module, const int pmt )

inline

Test status of DAQ.

The DAQ test passes if the assembly of UDP packets is complete.
The test can be bypassed using the PMT control status.

Parameters

frame	data frame status
module	module
pmt	PMT number

Returns

true if test passes; else false

Definition at line 88 of file JTriggerToolkit.hh.

  {
    return getDAQStatus(frame, module.getPMT(pmt));
  }

getPMTStatus() [1/3]

bool JTRIGGER::getPMTStatus ( const JStatus & status )

inline

Test status of PMT.

The PMT test passes if it is not disabled.

Parameters

status

PMT control status

Returns

true if test passes; else false

Definition at line 102 of file JTriggerToolkit.hh.

  {
    return !status.has(PMT_DISABLE);
  }

getPMTStatus() [2/3]

bool JTRIGGER::getPMTStatus ( const JDAQFrameStatus & frame, const JStatus & status, const int pmt )

inline

Test status of PMT.

The PMT test passes if it is not disabled and no high-rate veto or FIFO (almost) full.
The test can be bypassed using the PMT control status.

Parameters

frame	data frame
status	PMT control status
pmt	PMT number

Returns

true if test passes; else false

Definition at line 119 of file JTriggerToolkit.hh.

  {
    return ((status.has(HIGH_RATE_VETO_DISABLE) || !frame.testHighRateVeto(pmt))   &&
            (status.has(FIFO_FULL_DISABLE)      || !frame.testFIFOStatus  (pmt))   &&
            (getPMTStatus(status)));
  }

getPMTStatus() [3/3]

bool JTRIGGER::getPMTStatus ( const JDAQFrameStatus & frame, const JModule & module, const int pmt )

inline

Test status of PMT.

The PMT test passes if it is not disabled and no high-rate veto or FIFO (almost) full.
The test can be bypassed using the PMT control status.

Parameters

frame	data frame
module	module
pmt	PMT number

Returns

true if test passes; else false

Definition at line 138 of file JTriggerToolkit.hh.

  {
    return getPMTStatus(frame, module.getPMT(pmt), pmt);
  }

getRate()

double JTRIGGER::getRate ( const JDAQSummaryFrame & frame, const int pmt, const double factor = 1.0 )

inline

Get corrected rate of PMT.

The measured rate is corrected for the possible loss of UDP packets.

Parameters

frame	data frame
pmt	PMT number
factor	scaling factor

Returns

rate x scaling factor [Hz]

Definition at line 154 of file JTriggerToolkit.hh.

  {
    double rate_Hz = frame.getRate(pmt, factor);
 
    // correct measured rate for UDP packet loss
 
    const int n1  =  frame.getUDPNumberOfReceivedPackets();
    const int n2  =  frame.getUDPMaximalSequenceNumber  ();
 
    if (n1 < n2 + 1) {
      rate_Hz *= (double) (n2 + 1) / (double) n1;
    }
 
    return rate_Hz;
  }

Variable Documentation

MAXIMAL_FRAME_SIZE

int JTRIGGER::MAXIMAL_FRAME_SIZE = std::numeric_limits<int>::max()

static

Maximal frame size.

Definition at line 35 of file JChecksum.hh.

checksum

const JChecksum JTRIGGER::checksum

static

Function object to perform check-sum of raw data.

Definition at line 200 of file JChecksum.hh.

getRiseTime

const JGetRiseTime JTRIGGER::getRiseTime

static

Function object for rise time evaluation.

Definition at line 313 of file JGetRiseTime.hh.

getNumberOfModules

const JModuleCounter JTRIGGER::getNumberOfModules

static

Function object to count unique modules.

Definition at line 67 of file JModuleCounter.hh.

NUMBER_OF_PMT_BITS

const unsigned int JTRIGGER::NUMBER_OF_PMT_BITS = 31

static

Number of PMT bits.

Definition at line 35 of file JPMTMask.hh.