ROCsoft: nxyter::NxDataSummary Class Reference

Data container for nXYTER data distribution parameters. More...

#include <NxDataSummary.h>

Collaboration diagram for nxyter::NxDataSummary:

Collaboration graph

Public Member Functions
	NxDataSummary ()
	Constructor with full addressing path information.
virtual	~NxDataSummary ()
void	clear ()
	Clear all values.
void	analyse (DistFuncArray &fda)
	Analyse the DistFuncArray dfa and store the distribution parameters.
int	numEntries (int cha) const
	Returns number of entries for channel cha.
int	full (int cha) const
	Returns 'full' flag for channel cha.
float	getMedian (int cha) const
	Returns median for channel cha.
float	getWidth50 (int cha) const
	Returns 25-75 width (FWHM) for channel cha.
float	getWidth80 (int cha) const
	Returns 10-90 width for channel cha.
float	getMin (int cha) const
	Returns lowest value found for channel cha.
float	getMax (int cha) const
	Returns highest value found for channel cha.
void	print (std::ostream &os, int nxnum=0) const
	Print to stream os.
Protected Attributes
std::vector< int >	fNumEntries
	number entries
std::vector< bool >	fFull
	df full flag was set
std::vector< float >	fMedian
	median
std::vector< float >	fWidth50
	width 25-75
std::vector< float >	fWidth80
	width 10-90
std::vector< float >	fMin
	min entry
std::vector< float >	fMax
	max entry

Detailed Description

Data container for nXYTER data distribution parameters.

Definition at line 17 of file NxDataSummary.h.

Constructor & Destructor Documentation

nxyter::NxDataSummary::NxDataSummary ( )

Constructor with full addressing path information.

Definition at line 24 of file NxDataSummary.cxx.

nxyter::NxDataSummary::~NxDataSummary ( ) [virtual]

Definition at line 37 of file NxDataSummary.cxx.

Member Function Documentation

void nxyter::NxDataSummary::analyse ( DistFuncArray & dfa )

Analyse the DistFuncArray dfa and store the distribution parameters.

This method inspects the DistFuncArray dfa and determines for each of the 128 channels

number of entries
whether the 'full' flag was set
median value of distribution
25-75 width (FWHM)
10-90 width
lowest value found for channel
highest value found for channel

These parameters can be retrieved with the accessors numEntries(), full(), getMedian(), getWidth50(), getWidth80(), getMin(), and getMax().

Definition at line 74 of file NxDataSummary.cxx.

References fFull, fMax, fMedian, fMin, fNumEntries, fWidth50, fWidth80, and nxyter::DistFuncArray::numEntries().

Referenced by nxyter::FebUtil::acquireTestPulserData(), nxyter::FebUtil::acquireTestTriggerData(), cmd_idsigch(), and cmd_printdata().

void nxyter::NxDataSummary::clear ( )

Clear all values.

Definition at line 44 of file NxDataSummary.cxx.

References fFull, fMax, fMedian, fMin, fNumEntries, fWidth50, and fWidth80.

int nxyter::NxDataSummary::full ( int cha ) const [inline]

Returns 'full' flag for channel cha.

Definition at line 39 of file NxDataSummary.h.

References fFull.

Referenced by cmd_scanadclat(), and print().

float nxyter::NxDataSummary::getMax ( int cha ) const [inline]

Returns highest value found for channel cha.

Definition at line 59 of file NxDataSummary.h.

References fMax.

Referenced by cmd_scanadclat(), and print().

float nxyter::NxDataSummary::getMedian ( int cha ) const [inline]

Returns median for channel cha.

Definition at line 43 of file NxDataSummary.h.

References fMedian.

Referenced by cmd_idsigch(), cmd_scanadclat(), cmd_scanvbiasf(), get_vbiass_data(), and print().

float nxyter::NxDataSummary::getMin ( int cha ) const [inline]

Returns lowest value found for channel cha.

Definition at line 55 of file NxDataSummary.h.

References fMin.

Referenced by cmd_scanadclat(), and print().

float nxyter::NxDataSummary::getWidth50 ( int cha ) const [inline]

Returns 25-75 width (FWHM) for channel cha.

Definition at line 47 of file NxDataSummary.h.

References fWidth50.

Referenced by cmd_scanadclat(), cmd_scanvbiasf(), get_vbiass_data(), and print().

float nxyter::NxDataSummary::getWidth80 ( int cha ) const [inline]

Returns 10-90 width for channel cha.

Definition at line 51 of file NxDataSummary.h.

References fWidth80.

Referenced by cmd_scanadclat(), and print().

int nxyter::NxDataSummary::numEntries ( int cha ) const [inline]

Returns number of entries for channel cha.

Definition at line 35 of file NxDataSummary.h.

References fNumEntries.

Referenced by cmd_scanadclat(), cmd_scanvbiasf(), get_vbiass_data(), and print().

void nxyter::NxDataSummary::print	(	std::ostream &	os,
		int	nxnum = `0`
	)			const

Print to stream os.

Definition at line 90 of file NxDataSummary.cxx.

References full(), getMax(), getMedian(), getMin(), getWidth50(), getWidth80(), and numEntries().

Referenced by cmd_printdata(), cmd_scanvbiasf(), and get_vbiass_data().

Field Documentation

std::vector<bool> nxyter::NxDataSummary::fFull [protected]

df full flag was set

Definition at line 20 of file NxDataSummary.h.

Referenced by analyse(), clear(), and full().

std::vector<float> nxyter::NxDataSummary::fMax [protected]

max entry

Definition at line 25 of file NxDataSummary.h.

Referenced by analyse(), clear(), and getMax().

std::vector<float> nxyter::NxDataSummary::fMedian [protected]

median

Definition at line 21 of file NxDataSummary.h.

Referenced by analyse(), clear(), and getMedian().

std::vector<float> nxyter::NxDataSummary::fMin [protected]

min entry

Definition at line 24 of file NxDataSummary.h.

Referenced by analyse(), clear(), and getMin().

std::vector<int> nxyter::NxDataSummary::fNumEntries [protected]

number entries

Definition at line 19 of file NxDataSummary.h.

Referenced by analyse(), clear(), and numEntries().

std::vector<float> nxyter::NxDataSummary::fWidth50 [protected]

width 25-75

Definition at line 22 of file NxDataSummary.h.

Referenced by analyse(), clear(), and getWidth50().

std::vector<float> nxyter::NxDataSummary::fWidth80 [protected]

width 10-90

Definition at line 23 of file NxDataSummary.h.

Referenced by analyse(), clear(), and getWidth80().

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

include/nxyter/NxDataSummary.h (r4864/r612)
roclib/src_nxyter/NxDataSummary.cxx (r4864/r4112)