KM3NETDAQ::JDAQRate Class Reference

Data storage class for rate measurement of one PMT. More...

#include <JDAQSummaryFrame.hh>

Public Types
typedef unsigned char	JRate_t

Public Member Functions
	JDAQRate ()
	Default constructor.
JRate_t	getValue () const
	Get value.
void	setValue (const int numberOfHits, const double frameTime_ns)
	Set value.
void	setValue (const double rate_Hz)
	Set value.
double	getRate () const
	Get count rate.
double	getWeight () const
	Get weight.
JDAQRate &	mul (const double factor)
	Scale rate.
JDAQRate &	div (const double factor)
	Scale rate.
bool	is_valid () const
	Check validity of rate.

Static Public Member Functions
static double	getMinimalRate ()
	Get minimal rate (below this, value is set to zero)
static double	getMaximalRate ()
	Get maximal rate (above this, value is set to maximum)
static JRate_t	getValue (const int numberOfHits, const double frameTime_ns)
	Get value.
static JRate_t	getValue (const double rate_Hz)
	Get value.
static double	getRate (const JRate_t value)
	Get count rate.
static double	getWeight (const JRate_t value)
	Get weight.
static int	getN ()
	Get number of bins.
static const double *	getData (const double factor=1.0)
	Get abscissa values.

Protected Attributes
JRate_t	value

Static Private Member Functions
static const double	getFactor ()
	Get conversion factor.
static double	get_rate (const double value)
	Get count rate.

Friends
class	JDAQSummaryFrame

Detailed Description

Data storage class for rate measurement of one PMT.

Note that the rate value is compressed. The number of bins and corresponding abscissa values can be obtained with
methods JDAQRare::getN and JDAQRate::getData, respectively.

Definition at line 36 of file JDAQSummaryFrame.hh.

Member Typedef Documentation

JRate_t

unsigned char KM3NETDAQ::JDAQRate::JRate_t

Definition at line 42 of file JDAQSummaryFrame.hh.

Constructor & Destructor Documentation

JDAQRate()

KM3NETDAQ::JDAQRate::JDAQRate ( )

inline

Default constructor.

Definition at line 171 of file JDAQSummaryFrame.hh.

               :
      value(0)
    {}

Member Function Documentation

getMinimalRate()

static double KM3NETDAQ::JDAQRate::getMinimalRate ( )

inlinestatic

Get minimal rate (below this, value is set to zero)

Returns

rate [Hz]

Definition at line 50 of file JDAQSummaryFrame.hh.

    {
      return 2.0e3;
    }

getMaximalRate()

static double KM3NETDAQ::JDAQRate::getMaximalRate ( )

inlinestatic

Get maximal rate (above this, value is set to maximum)

Returns

rate [Hz]

Definition at line 61 of file JDAQSummaryFrame.hh.

    {
      return 2.0e6;
    }

getValue() [1/3]

static JRate_t KM3NETDAQ::JDAQRate::getValue ( const int numberOfHits, const double frameTime_ns )

inlinestatic

Get value.

Parameters

numberOfHits	number of hits
frameTime_ns	frame time [ns]

Returns

value

Definition at line 74 of file JDAQSummaryFrame.hh.

    {
      return getValue(numberOfHits * 1.0e9 / frameTime_ns);
    }

getValue() [2/3]

static JRate_t KM3NETDAQ::JDAQRate::getValue ( const double rate_Hz )

inlinestatic

Get value.

Parameters

rate_Hz

rate [Hz]

Returns

value

Definition at line 86 of file JDAQSummaryFrame.hh.

    {
      if      (rate_Hz <= getMinimalRate())
        return 0;
      else if (rate_Hz >= getMaximalRate())
        return std::numeric_limits<JRate_t>::max();
      else
        return (JRate_t) (log(rate_Hz/getMinimalRate()) / getFactor() + 0.5);
    }

getRate() [1/2]

static double KM3NETDAQ::JDAQRate::getRate ( const JRate_t value )

inlinestatic

Get count rate.

Parameters

value

value

Returns

rate [Hz]

Definition at line 103 of file JDAQSummaryFrame.hh.

    {
      if (value == 0)
        return 0.0;
      else
        return get_rate(value);
    }

getWeight() [1/2]

static double KM3NETDAQ::JDAQRate::getWeight ( const JRate_t value )

inlinestatic

Get weight.

Parameters

value

value

Returns

weight [Hz^-1]

Definition at line 118 of file JDAQSummaryFrame.hh.

    {
      double W = 1.0;
      
      if      (value == 0)
        W = get_rate(0.5)   - getMinimalRate();
      else if (value == std::numeric_limits<JRate_t>::max())
        W = getMaximalRate() - get_rate(std::numeric_limits<JRate_t>::max() - 0.5);
      else
        W = get_rate((double) value + 0.5) - get_rate((double) value - 0.5);
 
      return 1.0 / W;
    }

getN()

static int KM3NETDAQ::JDAQRate::getN ( )

inlinestatic

Get number of bins.

Returns

number of bins

Definition at line 138 of file JDAQSummaryFrame.hh.

    {
      return (int) std::numeric_limits<JRate_t>::max() + 1;
    }

getData()

static const double * KM3NETDAQ::JDAQRate::getData ( const double factor = 1.0 )

inlinestatic

Get abscissa values.

Parameters

factor

scaling factor

Returns

abscissa values

Definition at line 150 of file JDAQSummaryFrame.hh.

    {
      static std::vector<double> buffer;
 
      buffer.clear();
 
      buffer.push_back(getMinimalRate() * factor);
 
      for (int i = 1; i != JDAQRate::getN(); ++i) {
        buffer.push_back(get_rate(i - 0.5) * factor);
      }
      
      buffer.push_back(getMaximalRate() * factor);
 
      return buffer.data();
    }

getValue() [3/3]

JRate_t KM3NETDAQ::JDAQRate::getValue ( ) const

inline

Get value.

Returns

value

Definition at line 181 of file JDAQSummaryFrame.hh.

    {
      return value;
    }

setValue() [1/2]

void KM3NETDAQ::JDAQRate::setValue ( const int numberOfHits, const double frameTime_ns )

inline

Set value.

Parameters

numberOfHits	number of hits
frameTime_ns	frame time [ns]

Definition at line 193 of file JDAQSummaryFrame.hh.

    {
      value = getValue(numberOfHits, frameTime_ns);
    }

setValue() [2/2]

void KM3NETDAQ::JDAQRate::setValue ( const double rate_Hz )

inline

Set value.

Parameters

rate_Hz

rate [Hz]

Definition at line 204 of file JDAQSummaryFrame.hh.

    {
      value = getValue(rate_Hz);
    }

getRate() [2/2]

double KM3NETDAQ::JDAQRate::getRate ( ) const

inline

Get count rate.

Returns

rate [Hz]

Definition at line 215 of file JDAQSummaryFrame.hh.

    {
      return getRate(value);
    }

getWeight() [2/2]

double KM3NETDAQ::JDAQRate::getWeight ( ) const

inline

Get weight.

Returns

weight [Hz^-1]

Definition at line 226 of file JDAQSummaryFrame.hh.

    {
      return getWeight(value);
    }

mul()

JDAQRate & KM3NETDAQ::JDAQRate::mul ( const double factor )

inline

Scale rate.

Parameters

factor

multiplication factor

Returns

this rate

Definition at line 238 of file JDAQSummaryFrame.hh.

    {
      setValue(getRate() * factor);
      
      return *this;
    }

div()

JDAQRate & KM3NETDAQ::JDAQRate::div ( const double factor )

inline

Scale rate.

Parameters

factor

multiplication factor

Returns

this rate

Definition at line 252 of file JDAQSummaryFrame.hh.

    {
      setValue(getRate() / factor);
      
      return *this;
    }

is_valid()

bool KM3NETDAQ::JDAQRate::is_valid ( ) const

inline

Check validity of rate.

The rate is considered valid if it is between the minimal and the maximal rate.

Returns

true if valid; else false

Definition at line 266 of file JDAQSummaryFrame.hh.

    {
      return (value != 0 && value != std::numeric_limits<JRate_t>::max());
    }

getFactor()

static const double KM3NETDAQ::JDAQRate::getFactor ( )

inlinestaticprivate

Get conversion factor.

Returns

factor

Definition at line 282 of file JDAQSummaryFrame.hh.

    {
      return std::log(getMaximalRate() / getMinimalRate()) / std::numeric_limits<JRate_t>::max();
    }

get_rate()

static double KM3NETDAQ::JDAQRate::get_rate ( const double value )

inlinestaticprivate

Get count rate.

Parameters

value

value

Returns

rate [Hz]

Definition at line 294 of file JDAQSummaryFrame.hh.

    {
      return getMinimalRate() * std::exp(value * getFactor());
    }

Friends And Related Symbol Documentation

JDAQSummaryFrame

friend class JDAQSummaryFrame

friend

Definition at line 39 of file JDAQSummaryFrame.hh.

Member Data Documentation

value

JRate_t KM3NETDAQ::JDAQRate::value

protected

Definition at line 273 of file JDAQSummaryFrame.hh.

---

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

• JDAQSummaryFrame.hh