Data structure for triggered hit. More...

#include <JTriggeredHit.hh>

Inheritance diagram for JTRIGGER::JTriggeredHit:

Public Member Functions
	JTriggeredHit ()
	Default constructor. More...

	JTriggeredHit (const JDAQPMTIdentifier &pmt, const JHit &hit, const JDAQTriggerMask &mask)
	Constructor. More...

template<class JHit_t >
	JTriggeredHit (const JHit_t &hit, const JDAQTriggerMask &mask)
	Constructor. More...

const JDAQPMTIdentifier &	getPMTIdentifier () const
	Get PMT identifier. More...

void	setPMTIdentifier (const JDAQPMTIdentifier &pmt)
	Set PMT identifier. More...

int	getPMTAddress () const
	Get PMT identifier. More...

	ClassDefNV (JDAQPMTIdentifier, 1)

	ClassDefNV (JDAQModuleIdentifier, 1)

const JDAQModuleIdentifier &	getModuleIdentifier () const
	Get Module identifier. More...

void	setModuleIdentifier (const JDAQModuleIdentifier &module)
	Set Module identifier. More...

int	getModuleID () const
	Get module identifier. More...

const JHit &	getHit () const
	Get hit. More...

	operator double () const
	Type conversion. More...

double	getT () const
	Get calibrated time of hit. More...

double	getToT () const
	Get calibrated time over threshold of hit. More...

double	getT1 () const
	Get leading edge of hit. More...

double	getT2 () const
	Get trailing edge of hit. More...

void	join (const JHit &hit)
	Join hit. More...

const JDAQTriggerMask &	getDAQTriggerMask () const
	Get DAQ trigger mask. More...

JTriggerMask_t	getTriggerMask () const
	Get trigger mask. More...

void	setDAQTriggerMask (const JDAQTriggerMask &mask)
	Set trigger mask. More...

void	setTriggerMask (const JTriggerMask_t mask)
	Set trigger mask. More...

JDAQTriggerMask &	addTriggerMask (const JDAQTriggerMask &mask)
	Add trigger bit pattern. More...

bool	hasTriggerMask (const JDAQTriggerMask &mask) const
	Has trigger bit pattern. More...

JDAQTriggerMask &	addTriggerBit (const unsigned int bit)
	Add trigger bit. More...

bool	hasTriggerBit (const unsigned int bit) const
	Check trigger bit. More...

std::string	toString () const
	Convert trigger mask. More...

	ClassDef (JDAQTriggerMask, 1)

Static Public Member Functions
static bool	compare (const JDAQPMTIdentifier &first, const JDAQPMTIdentifier &second)
	Compare PMT identifiers. More...

static bool	getSlewing ()
	Get slewing option. More...

static void	setSlewing (const bool slewing)
	Set slewing option. More...

static JDAQTriggerMask	valueOf (const std::string &buffer)
	Extract trigger mask. More...

Static Protected Member Functions
static bool &	get_slewing ()
	Get reference to slewing parameter. More...

Protected Attributes
int	address

int	id

double	t
	time of leading edge [ns] More...

double	tot
	time-over-threshold [ns] More...

JTriggerMask_t	trigger_mask

Detailed Description

Data structure for triggered hit.

Definition at line 27 of file JTriggeredHit.hh.

Constructor & Destructor Documentation

◆ JTriggeredHit() [1/3]

JTRIGGER::JTriggeredHit::JTriggeredHit ( )

inline

Default constructor.

Definition at line 36 of file JTriggeredHit.hh.

                     :
       JDAQPMTIdentifier(),
       JHit             (),
       JDAQTriggerMask  ()
     {}

◆ JTriggeredHit() [2/3]

JTRIGGER::JTriggeredHit::JTriggeredHit	(	const JDAQPMTIdentifier &	pmt,
		const JHit &	hit,
		const JDAQTriggerMask &	mask
	)

inline

Constructor.

Parameters

pmt	PMT identifier
hit	hit
mask	trigger mask

Definition at line 50 of file JTriggeredHit.hh.

                                                  :
       JDAQPMTIdentifier(pmt),
       JHit             (hit),
       JDAQTriggerMask  (mask)
     {}

◆ JTriggeredHit() [3/3]

template<class JHit_t >

JTRIGGER::JTriggeredHit::JTriggeredHit	(	const JHit_t &	hit,
		const JDAQTriggerMask &	mask
	)

inline

Constructor.

Parameters

hit	hit
mask	trigger mask

Definition at line 66 of file JTriggeredHit.hh.

                                                :
       JDAQPMTIdentifier(hit.getPMTIdentifier()),
       JHit             (hit.getHit()),
       JDAQTriggerMask  (mask)
     {}

Member Function Documentation

◆ getPMTIdentifier()

const JDAQPMTIdentifier& KM3NETDAQ::JDAQPMTIdentifier::getPMTIdentifier ( ) const

inlineinherited

Get PMT identifier.

Returns: PMT identifier

Definition at line 56 of file JDAQPMTIdentifier.hh.

     { 
       return *this; 
     }

◆ setPMTIdentifier()

void KM3NETDAQ::JDAQPMTIdentifier::setPMTIdentifier ( const JDAQPMTIdentifier & pmt )

inlineinherited

Set PMT identifier.

Parameters

pmt	PMT identifier

Definition at line 67 of file JDAQPMTIdentifier.hh.

     { 
       *this = pmt;
     }

◆ getPMTAddress()

int KM3NETDAQ::JDAQPMTIdentifier::getPMTAddress ( ) const

inlineinherited

Get PMT identifier.

Returns: PMT identifier

Definition at line 78 of file JDAQPMTIdentifier.hh.

     { 
       return address;
     }

◆ compare()

static bool KM3NETDAQ::JDAQPMTIdentifier::compare	(	const JDAQPMTIdentifier &	first,
		const JDAQPMTIdentifier &	second
	)

inlinestaticinherited

Compare PMT identifiers.

The comparison is applied to the module identifer and to the PMT address. If the module identifier or PMT address is -1, the corresponding comparison evaluates to true.

Parameters

first	PMT identifier
second	PMT identifier

Returns: true if first PMT equal second PMT; else false

Definition at line 126 of file JDAQPMTIdentifier.hh.

     {
       return ((first .getModuleIdentifier() == second.getModuleIdentifier() ||
                first .getModuleIdentifier() == -1                           ||
                second.getModuleIdentifier() == -1)                          &&
               (first .getPMTAddress()       == second.getPMTAddress()       ||
                first .getPMTAddress()       == -1                           ||
                second.getPMTAddress()       == -1));
     }

◆ ClassDefNV() [1/2]

KM3NETDAQ::JDAQPMTIdentifier::ClassDefNV	(	JDAQPMTIdentifier	,
		1
	)

inherited

◆ ClassDefNV() [2/2]

KM3NETDAQ::JDAQModuleIdentifier::ClassDefNV	(	JDAQModuleIdentifier	,
		1
	)

inherited

◆ getModuleIdentifier()

const JDAQModuleIdentifier& KM3NETDAQ::JDAQModuleIdentifier::getModuleIdentifier ( ) const

inlineinherited

Get Module identifier.

Returns: Module identifier

Definition at line 50 of file JDAQModuleIdentifier.hh.

     { 
       return *this; 
     }

◆ setModuleIdentifier()

void KM3NETDAQ::JDAQModuleIdentifier::setModuleIdentifier ( const JDAQModuleIdentifier & module )

inlineinherited

Set Module identifier.

Parameters

module Module identifier

Definition at line 61 of file JDAQModuleIdentifier.hh.

     { 
       *this = module;
     }

◆ getModuleID()

int KM3NETDAQ::JDAQModuleIdentifier::getModuleID ( ) const

inlineinherited

Get module identifier.

Returns: module identifier

Definition at line 72 of file JDAQModuleIdentifier.hh.

     { 
       return id;
     }

◆ getHit()

const JHit& JTRIGGER::JHit::getHit ( ) const

inlineinherited

Get hit.

Returns: hit

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

     {
       return static_cast<const JHit&>(*this);
     }

◆ getSlewing()

static bool JTRIGGER::JHit::getSlewing ( )

inlinestaticinherited

Get slewing option.

Returns: slewing option

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

     {
       return get_slewing();
     }

◆ setSlewing()

static void JTRIGGER::JHit::setSlewing ( const bool slewing )

inlinestaticinherited

Set slewing option.

Parameters

slewing slewing option

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

     {
       get_slewing() = slewing;
     }

◆ operator double()

JTRIGGER::JHit::operator double ( ) const

inlineinherited

Type conversion.

Returns: time [ns]

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

     { 
       return t;
     }

◆ getT()

double JTRIGGER::JHit::getT ( ) const

inlineinherited

Get calibrated time of hit.

Returns: time [ns]

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

     { 
       if (!getSlewing())
         return t;
       else
         return t - getRiseTime(tot);
     }

◆ getToT()

double JTRIGGER::JHit::getToT ( ) const

inlineinherited

Get calibrated time over threshold of hit.

Returns: time over threshold [ns]

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

     { 
       return tot;
     }

◆ getT1()

double JTRIGGER::JHit::getT1 ( ) const

inlineinherited

Get leading edge of hit.

Note that no slewing correction is applied.

Returns: time [ns]

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

     { 
       return t;
     }

◆ getT2()

double JTRIGGER::JHit::getT2 ( ) const

inlineinherited

Get trailing edge of hit.

Note that no slewing correction is applied.

Returns: time [ns]

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

     { 
       return t + tot;
     }

◆ join()

void JTRIGGER::JHit::join ( const JHit & hit )

inlineinherited

Join hit.

Note that:

leading edge of this hit is maintained;
time over threshold of this hit is set to the difference between the trailing edge of given hit and leading edge of this hit;

Parameters

hit hit

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

     {
       this->tot = hit.getT2() - this->getT1(); 
     }

◆ get_slewing()

static bool& JTRIGGER::JHit::get_slewing ( )

inlinestaticprotectedinherited

Get reference to slewing parameter.

Returns: reference to slewing parameter

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

     {
       static bool slewing = true;
  
       return slewing;
     }

◆ getDAQTriggerMask()

const JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::getDAQTriggerMask ( ) const

inlineinherited

Get DAQ trigger mask.

Returns: DAQ trigger mask

Definition at line 95 of file JDAQTriggerMask.hh.

     {
       return static_cast<const JDAQTriggerMask&>(*this);
     }

◆ getTriggerMask()

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::getTriggerMask ( ) const

inlineinherited

Get trigger mask.

Returns: trigger mask

Definition at line 106 of file JDAQTriggerMask.hh.

     {
       return trigger_mask;
     }

◆ setDAQTriggerMask()

void KM3NETDAQ::JDAQTriggerMask::setDAQTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 117 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask.trigger_mask;
     }

◆ setTriggerMask()

void KM3NETDAQ::JDAQTriggerMask::setTriggerMask ( const JTriggerMask_t mask )

inlineinherited

Set trigger mask.

Parameters

mask	trigger mask

Definition at line 128 of file JDAQTriggerMask.hh.

     {
       trigger_mask = mask;
     }

◆ addTriggerMask()

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerMask ( const JDAQTriggerMask & mask )

inlineinherited

Add trigger bit pattern.

Parameters

mask	trigger mask

Returns: trigger mask

Definition at line 140 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= mask.trigger_mask;
  
       return *this;
     }

◆ hasTriggerMask()

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerMask ( const JDAQTriggerMask & mask ) const

inlineinherited

Has trigger bit pattern.

Parameters

mask	trigger mask

Returns: true if one of the bits is set; else false

Definition at line 154 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & mask.trigger_mask;
     }

◆ addTriggerBit()

JDAQTriggerMask& KM3NETDAQ::JDAQTriggerMask::addTriggerBit ( const unsigned int bit )

inlineinherited

Add trigger bit.

Parameters

bit	trigger bit

Returns: trigger mask

Definition at line 166 of file JDAQTriggerMask.hh.

     {
       trigger_mask |= KM3NETDAQ::getTriggerMask(bit);
  
       return *this;
     }

◆ hasTriggerBit()

bool KM3NETDAQ::JDAQTriggerMask::hasTriggerBit ( const unsigned int bit ) const

inlineinherited

Check trigger bit.

Parameters

bit	trigger bit

Returns: true if bit is set; else false

Definition at line 180 of file JDAQTriggerMask.hh.

     {
       return trigger_mask & KM3NETDAQ::getTriggerMask(bit);
     }

◆ valueOf()

static JDAQTriggerMask KM3NETDAQ::JDAQTriggerMask::valueOf ( const std::string & buffer )

inlinestaticinherited

Extract trigger mask.

Parameters

buffer trigger bit pattern (i.e. sequence of '0' and '1').

Returns: trigger mask

Definition at line 192 of file JDAQTriggerMask.hh.

     {
       JDAQTriggerMask trigger_mask;
  
       unsigned int bit = 0;
  
       for (std::string::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (*i == '1') {
           trigger_mask.addTriggerBit(bit);
         }
       }
  
       return trigger_mask;
     }

◆ toString()

std::string KM3NETDAQ::JDAQTriggerMask::toString ( ) const

inlineinherited

Convert trigger mask.

Returns: trigger bit pattern (i.e. sequence of '0' and '1').

Definition at line 213 of file JDAQTriggerMask.hh.

     {
       std::string buffer(NUMBER_OF_TRIGGER_BITS, '0');
  
       unsigned int bit = 0;
  
       for (std::string::reverse_iterator i = buffer.rbegin(); i != buffer.rend() && bit != NUMBER_OF_TRIGGER_BITS; ++i, ++bit) {
         if (hasTriggerBit(bit)) {
           *i = '1';
         }
       }
  
       return buffer;
     }

◆ ClassDef()

KM3NETDAQ::JDAQTriggerMask::ClassDef	(	JDAQTriggerMask	,
		1
	)

inherited

Member Data Documentation

◆ address

int KM3NETDAQ::JDAQPMTIdentifier::address

protectedinherited

Definition at line 141 of file JDAQPMTIdentifier.hh.

◆ id

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

◆ t

double JTRIGGER::JHit::t

protectedinherited

time of leading edge [ns]

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

◆ tot

double JTRIGGER::JHit::tot

protectedinherited

time-over-threshold [ns]

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

◆ trigger_mask

JTriggerMask_t KM3NETDAQ::JDAQTriggerMask::trigger_mask

protectedinherited

Definition at line 267 of file JDAQTriggerMask.hh.

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

JTriggeredHit.hh

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JTriggeredHit() [1/3]

◆ JTriggeredHit() [2/3]

◆ JTriggeredHit() [3/3]

Member Function Documentation

◆ getPMTIdentifier()

◆ setPMTIdentifier()

◆ getPMTAddress()

◆ compare()

◆ ClassDefNV() [1/2]

◆ ClassDefNV() [2/2]

◆ getModuleIdentifier()

◆ setModuleIdentifier()

◆ getModuleID()

◆ getHit()

◆ getSlewing()

◆ setSlewing()

◆ operator double()

◆ getT()

◆ getToT()

◆ getT1()

◆ getT2()

◆ join()

◆ get_slewing()

◆ getDAQTriggerMask()

◆ getTriggerMask()

◆ setDAQTriggerMask()

◆ setTriggerMask()

◆ addTriggerMask()

◆ hasTriggerMask()

◆ addTriggerBit()

◆ hasTriggerBit()

◆ valueOf()

◆ toString()

◆ ClassDef()

Member Data Documentation

◆ address

◆ id

◆ t

◆ tot

◆ trigger_mask