Data storage class for rate measurements of all PMTs in one module. More...

#include <JDAQSummaryFrame.hh>

Inheritance diagram for KM3NETDAQ::JDAQSummaryFrame:

Public Types
typedef JDAQRate::JRate_t	JRate_t

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

	JDAQSummaryFrame (const JDAQModuleIdentifier &id)
	Constructor. More...

	JDAQSummaryFrame (const JDAQSuperFrame &input)
	Constructor. More...

const JDAQRate &	operator[] (const int tdc) const
	Get DAQ rate of given PMT. More...

JDAQRate &	operator[] (const int tdc)
	Get DAQ rate of given PMT. More...

JRate_t	getValue (const int tdc) const
	Get value. More...

double	getRate (const int tdc, const double factor=1.0) const
	Get count rate. More...

double	getWeight (const int tdc, const double factor=1.0) const
	Get weight. More...

void	setRate (const int tdc, const double rate_Hz)
	Set count rate. More...

	ClassDefNV (JDAQSummaryFrame, 2)

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

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

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

	ClassDefNV (JDAQModuleIdentifier, 1)

const JDAQFrameStatus &	getDAQFrameStatus () const
	Get DAQ frame status. More...

void	setDAQFrameStatus (const JDAQFrameStatus &status)
	Set DAQ frame status. More...

int	getDAQStatus () const
	Get DAQ status. More...

int	getStatus () const
	Get TDC and White Rabbit status. More...

int	getFIFOStatus () const
	Get FIFO status. More...

bool	testDAQStatus () const
	Test DAQ status of packets. More...

bool	testStatus () const
	Test TDC and White Rabbit status. More...

int	getUDPNumberOfReceivedPackets () const
	Get number of received UDP packets. More...

int	getUDPMaximalSequenceNumber () const
	Get maximal sequence number of UDP packet. More...

bool	testWhiteRabbitStatus () const
	Test White Rabbit status. More...

bool	testTDCStatus () const
	Test TDC status. More...

bool	testHighRateVeto () const
	Test high-rate veto status. More...

bool	testHighRateVeto (const int tdc) const
	Test high-rate veto status. More...

int	countHighRateVeto () const
	Count high-rate veto status. More...

bool	testFIFOStatus () const
	Test FIFO status. More...

bool	testFIFOStatus (const int tdc) const
	Test FIFO status. More...

int	countFIFOStatus () const
	Count FIFO status. More...

int	countActiveChannels () const
	Count active channels. More...

bool	hasUDPTrailer () const
	Get UDP trailer status. More...

void	setHighRateVeto (const int tdc, const bool value)
	Set high-rate veto. More...

	ClassDefNV (JDAQFrameStatus, 1)

Static Public Member Functions
static const JDAQFrameStatus &	getInstance ()
	Get reference to unique instance of this class object. More...

Static Public Attributes
static int	ROOT_IO_VERSION = -1
	Streamer version of JDAQSummaryslice as obtained from ROOT file. More...

Protected Attributes
JDAQRate	data [NUMBER_OF_PMTS]

int	id

int	daq

int	status

int	fifo

int	status_3

int	status_4

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...

JReader &	operator>> (JReader &, JDAQSummaryFrame &)
	Read DAQ summary frame from input. More...

JWriter &	operator<< (JWriter &, const JDAQSummaryFrame &)
	Write DAQ summary frame to output. More...

Detailed Description

Data storage class for rate measurements of all PMTs in one module.

Definition at line 332 of file JDAQSummaryFrame.hh.

Member Typedef Documentation

◆ JRate_t

typedef JDAQRate::JRate_t KM3NETDAQ::JDAQSummaryFrame::JRate_t

Definition at line 338 of file JDAQSummaryFrame.hh.

Constructor & Destructor Documentation

◆ JDAQSummaryFrame() [1/3]

KM3NETDAQ::JDAQSummaryFrame::JDAQSummaryFrame ( )

inline

Default constructor.

Definition at line 347 of file JDAQSummaryFrame.hh.

                        :
       JDAQModuleIdentifier(),
       JDAQFrameStatus()
     {}

◆ JDAQSummaryFrame() [2/3]

KM3NETDAQ::JDAQSummaryFrame::JDAQSummaryFrame ( const JDAQModuleIdentifier & id )

inline

Constructor.

Parameters

id	module identifier

Definition at line 358 of file JDAQSummaryFrame.hh.

                                                      :
       JDAQModuleIdentifier(id),
       JDAQFrameStatus(JDAQFrameStatus::getInstance())
     {}

◆ JDAQSummaryFrame() [3/3]

KM3NETDAQ::JDAQSummaryFrame::JDAQSummaryFrame ( const JDAQSuperFrame & input )

inline

Constructor.

Note that normally the rate is set to the number of hits per unit frame time but if either the high-rate veto or FIFO (almost) full bit is on, the rate is set to the number of hits divided by the time of the last hit.

Parameters

input super frame

Definition at line 373 of file JDAQSummaryFrame.hh.

                                                   :
       JDAQModuleIdentifier(input.getModuleID()),
       JDAQFrameStatus     (input.getDAQFrameStatus())
     {
       using namespace std;
  
       typedef JDAQHit::JPMT_t  JPMT_t;
       typedef JDAQHit::JTDC_t  JTDC_t;
  
       vector<int> counter(numeric_limits<JPMT_t>::max(), 0);
  
       int n = input.size();
       
       for (JDAQSuperFrame::const_iterator i = input.begin(); n != 0; --n, ++i) {
         ++counter[i->getPMT()];
       }
  
       for (int i = 0; i != NUMBER_OF_PMTS; ++i) {
         data[i].setValue(counter[i], getFrameTime());
       }
       
       if (input.testHighRateVeto() || input.testFIFOStatus()) {
  
         // determine last hit for each PMT
  
         vector<JTDC_t> limit(numeric_limits<JPMT_t>::max(), 0);
  
         int n = input.size();
  
         for (JDAQSuperFrame::const_iterator i = input.begin(); n != 0; --n, ++i) {
           if (i->getT() > limit[i->getPMT()]) {
             limit[i->getPMT()] = i->getT();
           }
         }
         
         for (int i = 0; i != NUMBER_OF_PMTS; ++i) {
           if (input.testHighRateVeto(i) || input.testFIFOStatus(i)) {
             if (limit[i] != 0) {
               data[i].setValue((double) counter[i] * 1.0e9 / (double) limit[i]);
             }
           }
         }
       }
     }

Member Function Documentation

◆ operator[]() [1/2]

const JDAQRate& KM3NETDAQ::JDAQSummaryFrame::operator[] ( const int tdc ) const

inline

Get DAQ rate of given PMT.

Parameters

tdc TDC

Returns: JDAQRate

Definition at line 425 of file JDAQSummaryFrame.hh.

     {
       if (tdc >= 0 && tdc < NUMBER_OF_PMTS)
         return data[tdc];
       else
         throw JDAQException("TDC out of range.");
     }

◆ operator[]() [2/2]

JDAQRate& KM3NETDAQ::JDAQSummaryFrame::operator[] ( const int tdc )

inline

Get DAQ rate of given PMT.

Parameters

tdc TDC

Returns: JDAQRate

Definition at line 440 of file JDAQSummaryFrame.hh.

     {
       if (tdc >= 0 && tdc < NUMBER_OF_PMTS)
         return data[tdc];
       else
         throw JDAQException("TDC out of range.");
     }

◆ getValue()

JRate_t KM3NETDAQ::JDAQSummaryFrame::getValue ( const int tdc ) const

inline

Get value.

Parameters

tdc TDC

Returns: value

Definition at line 455 of file JDAQSummaryFrame.hh.

     {
       return data[tdc].getValue();
     }

◆ getRate()

double KM3NETDAQ::JDAQSummaryFrame::getRate	(	const int	tdc,
		const double	factor = `1.0`
	)		const

inline

Get count rate.

Parameters

tdc	TDC
factor	scaling factor

Returns: rate x scaling factor [Hz]

Definition at line 468 of file JDAQSummaryFrame.hh.

     {
       return data[tdc].getRate() * factor;
     }

◆ getWeight()

double KM3NETDAQ::JDAQSummaryFrame::getWeight	(	const int	tdc,
		const double	factor = `1.0`
	)		const

inline

Get weight.

Parameters

tdc	TDC
factor	scaling factor

Returns: weight / scaling factor [Hz^-1]

Definition at line 481 of file JDAQSummaryFrame.hh.

     {
       return data[tdc].getWeight() / factor;
     }

◆ setRate()

void KM3NETDAQ::JDAQSummaryFrame::setRate	(	const int	tdc,
		const double	rate_Hz
	)

inline

Set count rate.

Parameters

tdc	TDC
rate_Hz	rate [Hz]

Definition at line 493 of file JDAQSummaryFrame.hh.

     {
       return data[tdc].setValue(rate_Hz);
     }

◆ ClassDefNV() [1/3]

KM3NETDAQ::JDAQSummaryFrame::ClassDefNV	(	JDAQSummaryFrame	,
		2
	)

◆ 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;
     }

◆ ClassDefNV() [2/3]

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

inherited

◆ getInstance()

static const JDAQFrameStatus& KM3NETDAQ::JDAQFrameStatus::getInstance ( )

inlinestaticinherited

Get reference to unique instance of this class object.

This instance has default values which correspond to a valid DAQ frame status.

Returns: reference to this class object

Definition at line 65 of file JDAQFrameStatus.hh.

     {
       static const JDAQFrameStatus status(DAQ_UDP_RECEIVED_PACKETS.write(2) | DAQ_UDP_SEQUENCE_NUMBER.write(1),
                                           DAQ_WHITE_RABBIT.write(1),
                                           DAQ_FIFO.write(0) | DAQ_UDP_TRAILER.write(1));
  
       return status;
     }

◆ getDAQFrameStatus()

const JDAQFrameStatus& KM3NETDAQ::JDAQFrameStatus::getDAQFrameStatus ( ) const

inlineinherited

Get DAQ frame status.

Returns: DAQ frame status

Definition at line 80 of file JDAQFrameStatus.hh.

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

◆ setDAQFrameStatus()

void KM3NETDAQ::JDAQFrameStatus::setDAQFrameStatus ( const JDAQFrameStatus & status )

inlineinherited

Set DAQ frame status.

Parameters

status DAQ frame status

Definition at line 91 of file JDAQFrameStatus.hh.

     {
       static_cast<JDAQFrameStatus&>(*this) = status;
     }

◆ getDAQStatus()

int KM3NETDAQ::JDAQFrameStatus::getDAQStatus ( ) const

inlineinherited

Get DAQ status.

Returns: DAQ status

Definition at line 102 of file JDAQFrameStatus.hh.

     { 
       return this->daq;
     }

◆ getStatus()

int KM3NETDAQ::JDAQFrameStatus::getStatus ( ) const

inlineinherited

Get TDC and White Rabbit status.

Returns: status

Definition at line 113 of file JDAQFrameStatus.hh.

     { 
       return this->status;
     }

◆ getFIFOStatus()

int KM3NETDAQ::JDAQFrameStatus::getFIFOStatus ( ) const

inlineinherited

Get FIFO status.

Returns: FIFO status

Definition at line 124 of file JDAQFrameStatus.hh.

     { 
       return this->fifo;
     }

◆ testDAQStatus()

bool KM3NETDAQ::JDAQFrameStatus::testDAQStatus ( ) const

inlineinherited

Test DAQ status of packets.

Returns: true if okay; else false

Definition at line 135 of file JDAQFrameStatus.hh.

     { 
       return (getUDPNumberOfReceivedPackets() == (getUDPMaximalSequenceNumber() + 1)) && hasUDPTrailer();
     }

◆ testStatus()

bool KM3NETDAQ::JDAQFrameStatus::testStatus ( ) const

inlineinherited

Test TDC and White Rabbit status.

Returns: true if okay; else false

Definition at line 146 of file JDAQFrameStatus.hh.

     { 
       return testWhiteRabbitStatus() && testTDCStatus();
     }

◆ getUDPNumberOfReceivedPackets()

int KM3NETDAQ::JDAQFrameStatus::getUDPNumberOfReceivedPackets ( ) const

inlineinherited

Get number of received UDP packets.

Returns: UDP received packets

Definition at line 157 of file JDAQFrameStatus.hh.

     { 
       return DAQ_UDP_RECEIVED_PACKETS.read(this->daq);
     }

◆ getUDPMaximalSequenceNumber()

int KM3NETDAQ::JDAQFrameStatus::getUDPMaximalSequenceNumber ( ) const

inlineinherited

Get maximal sequence number of UDP packet.

Returns: UDP sequence number

Definition at line 168 of file JDAQFrameStatus.hh.

     { 
       return DAQ_UDP_SEQUENCE_NUMBER.read(this->daq);
     }

◆ testWhiteRabbitStatus()

bool KM3NETDAQ::JDAQFrameStatus::testWhiteRabbitStatus ( ) const

inlineinherited

Test White Rabbit status.

Returns: true if okay; else false

Definition at line 179 of file JDAQFrameStatus.hh.

     {
       return DAQ_WHITE_RABBIT.has(this->status);
     }

◆ testTDCStatus()

bool KM3NETDAQ::JDAQFrameStatus::testTDCStatus ( ) const

inlineinherited

Test TDC status.

Returns: true if okay; else false

Definition at line 190 of file JDAQFrameStatus.hh.

     { 
       return !testHighRateVeto();
     }

◆ testHighRateVeto() [1/2]

bool KM3NETDAQ::JDAQFrameStatus::testHighRateVeto ( ) const

inlineinherited

Test high-rate veto status.

Returns: true if one of the TDCs is high-rate vetoed; else false

Definition at line 201 of file JDAQFrameStatus.hh.

     {
       return DAQ_TDC.has(this->status);
     }

◆ testHighRateVeto() [2/2]

bool KM3NETDAQ::JDAQFrameStatus::testHighRateVeto ( const int tdc ) const

inlineinherited

Test high-rate veto status.

Parameters

tdc TDC

Returns: true if TDC is high-rate vetoed; else false

Definition at line 213 of file JDAQFrameStatus.hh.

     {
       return JBit(tdc).has(this->status);
     }

◆ countHighRateVeto()

int KM3NETDAQ::JDAQFrameStatus::countHighRateVeto ( ) const

inlineinherited

Count high-rate veto status.

Returns: number of the TDCs with high-rate veto

Definition at line 224 of file JDAQFrameStatus.hh.

     {
       int n = 0;
  
       if (testHighRateVeto()) {
         for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
           if (JBit(pmt).has(this->status)) {
             ++n;
           }
         }
       }
       
       return n;
     }

◆ testFIFOStatus() [1/2]

bool KM3NETDAQ::JDAQFrameStatus::testFIFOStatus ( ) const

inlineinherited

Test FIFO status.

Returns: true if one of the TDCs has FIFO almost full; else false

Definition at line 245 of file JDAQFrameStatus.hh.

     { 
       return DAQ_FIFO.has(this->fifo);
     }

◆ testFIFOStatus() [2/2]

bool KM3NETDAQ::JDAQFrameStatus::testFIFOStatus ( const int tdc ) const

inlineinherited

Test FIFO status.

Parameters

tdc TDC

Returns: true if FIFO is almost full; else false

Definition at line 257 of file JDAQFrameStatus.hh.

     {
       return JBit(tdc).has(this->fifo);
     }

◆ countFIFOStatus()

int KM3NETDAQ::JDAQFrameStatus::countFIFOStatus ( ) const

inlineinherited

Count FIFO status.

Returns: number of the TDCs with FIFO almost full

Definition at line 268 of file JDAQFrameStatus.hh.

     {
       int n = 0;
  
       if (testFIFOStatus()) {
         for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
           if (JBit(pmt).has(this->fifo)) {
             ++n;
           }
         }
       }
  
       return n;
     }

◆ countActiveChannels()

int KM3NETDAQ::JDAQFrameStatus::countActiveChannels ( ) const

inlineinherited

Count active channels.

Returns: number of TDCs without high rate veto or FIFO almost full

Definition at line 287 of file JDAQFrameStatus.hh.

     {
       int n = NUMBER_OF_PMTS;
  
       if (testHighRateVeto() || testFIFOStatus()) {
         for (int pmt = 0; pmt != NUMBER_OF_PMTS; ++pmt) {
           if ( JBit(pmt).has(this->status) || JBit(pmt).has(this->fifo) ) {
             --n;
           }
         }
       }
  
       return n;
  
     }

◆ hasUDPTrailer()

bool KM3NETDAQ::JDAQFrameStatus::hasUDPTrailer ( ) const

inlineinherited

Get UDP trailer status.

Returns: true if UDP trailer present; else false

Definition at line 309 of file JDAQFrameStatus.hh.

     {
       return DAQ_UDP_TRAILER.has(this->fifo);
     }

◆ setHighRateVeto()

void KM3NETDAQ::JDAQFrameStatus::setHighRateVeto	(	const int	tdc,
		const bool	value
	)

inlineinherited

Set high-rate veto.

Parameters

tdc	TDC
value	value

Definition at line 321 of file JDAQFrameStatus.hh.

     {
       JBit(tdc).set(this->status, value);
     }

◆ ClassDefNV() [3/3]

KM3NETDAQ::JDAQFrameStatus::ClassDefNV	(	JDAQFrameStatus	,
		1
	)

inherited

Friends And Related Function Documentation

◆ getSizeof

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns: number of bytes

◆ operator>>

JReader& operator>>	(	JReader &	in,
		JDAQSummaryFrame &	summary
	)

friend

Read DAQ summary frame from input.

Parameters

in	reader
summary	DAQ summary frame

Returns: reader

Definition at line 37 of file JDAQSummaryFrameIO.hh.

   {
     in >> static_cast<JDAQModuleIdentifier&>(summary);
     in >> static_cast<JDAQFrameStatus&>     (summary);
  
     in.read((char*) summary.data, NUMBER_OF_PMTS * sizeof(JDAQRate::JRate_t));
  
     return in;
   }

◆ operator<<

JWriter& operator<<	(	JWriter &	out,
		const JDAQSummaryFrame &	summary
	)

friend

Write DAQ summary frame to output.

Parameters

out	writer
summary	DAQ summary frame

Returns: writer

Definition at line 55 of file JDAQSummaryFrameIO.hh.

   {
     out << static_cast<const JDAQModuleIdentifier&>(summary);
     out << static_cast<const JDAQFrameStatus&>     (summary);
  
     out.write((char*) summary.data, NUMBER_OF_PMTS * sizeof(JDAQRate::JRate_t));
  
     return out;
   }

Member Data Documentation

◆ ROOT_IO_VERSION

int KM3NETDAQ::JDAQSummaryFrame::ROOT_IO_VERSION = -1

static

Streamer version of JDAQSummaryslice as obtained from ROOT file.

Author: mdejong

Definition at line 499 of file JDAQSummaryFrame.hh.

◆ data

JDAQRate KM3NETDAQ::JDAQSummaryFrame::data[NUMBER_OF_PMTS]

protected

Definition at line 507 of file JDAQSummaryFrame.hh.

◆ id

int KM3NETDAQ::JDAQModuleIdentifier::id

protectedinherited

Definition at line 112 of file JDAQModuleIdentifier.hh.

◆ daq

int KM3NETDAQ::JDAQFrameStatus::daq

protectedinherited

Definition at line 330 of file JDAQFrameStatus.hh.

◆ status

int KM3NETDAQ::JDAQFrameStatus::status

protectedinherited

Definition at line 331 of file JDAQFrameStatus.hh.

◆ fifo

int KM3NETDAQ::JDAQFrameStatus::fifo

protectedinherited

Definition at line 332 of file JDAQFrameStatus.hh.

◆ status_3

int KM3NETDAQ::JDAQFrameStatus::status_3

protectedinherited

Definition at line 333 of file JDAQFrameStatus.hh.

◆ status_4

int KM3NETDAQ::JDAQFrameStatus::status_4

protectedinherited

Definition at line 334 of file JDAQFrameStatus.hh.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ JRate_t

Constructor & Destructor Documentation

◆ JDAQSummaryFrame() [1/3]

◆ JDAQSummaryFrame() [2/3]

◆ JDAQSummaryFrame() [3/3]

Member Function Documentation

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ getValue()

◆ getRate()

◆ getWeight()

◆ setRate()

◆ ClassDefNV() [1/3]

◆ getModuleIdentifier()

◆ setModuleIdentifier()

◆ getModuleID()

◆ ClassDefNV() [2/3]

◆ getInstance()

◆ getDAQFrameStatus()

◆ setDAQFrameStatus()

◆ getDAQStatus()

◆ getStatus()

◆ getFIFOStatus()

◆ testDAQStatus()

◆ testStatus()

◆ getUDPNumberOfReceivedPackets()

◆ getUDPMaximalSequenceNumber()

◆ testWhiteRabbitStatus()

◆ testTDCStatus()

◆ testHighRateVeto() [1/2]

◆ testHighRateVeto() [2/2]

◆ countHighRateVeto()

◆ testFIFOStatus() [1/2]

◆ testFIFOStatus() [2/2]

◆ countFIFOStatus()

◆ countActiveChannels()

◆ hasUDPTrailer()

◆ setHighRateVeto()

◆ ClassDefNV() [3/3]

Friends And Related Function Documentation

◆ getSizeof

◆ operator>>

◆ operator<<

Member Data Documentation

◆ ROOT_IO_VERSION

◆ data

◆ id

◆ daq

◆ status

◆ fifo

◆ status_3

◆ status_4