simthlib::HistogramPipeT< seqT > Class Template Reference

#include <miscdevices.h>

Inheritance diagram for simthlib::HistogramPipeT< seqT >:

[legend]List of all members.

Public Member Functions
	HistogramPipeT (int deviceID, simth::DeviceSystemIntf *system, const simth::PropertyList &pl)
void	process ()
void	updateInputLengths ()
void	updateOutputLengths ()
void	print (std::ostream &os) const

---

Detailed Description

template<class seqT>
class simthlib::HistogramPipeT< seqT >

Class for reading data values and collecting them into a histogram.

This class only collects the histogram data but does not display anything. The current status (level of all bins) is given in the simth::ModSeq output interface. This means for actual display of the collected values, connect a DisplayPipe to the output interface of this block.

Parameters in configuration file:

data_type: The data type of the input sequence. Currently supported are simth::ModSeq, simth::PhaseSeq, simth::BitSeq, and simth::ModIndSeq.

left: (double value) Leftmost bin of the interval to count values (default: -5).

right: (double value) Rightmost bin of the interval to count values (default: 5).

bins: (integer) Number of bins in total (default: 10). Alternatively used to 'width'.

width: (double value) Width of each bin. Alternatively used to bins. If both bins and width is specified, an error is thrown.

bins_at_center: (boolean) If set to true (default), the bins are specified by their center. This means that the left/right values above specify the center of the leftmost/rightmost bin instead of the actual left/right limit of the interval. If bins_at_center is set to false, bins are specified by their (left) edges, and the left/right values specify the actual limit of the interval.

ignore_outside: (boolean) If set to false (default), values outside the interval are added to the outmost bins. If set to true, values outside the interval are ignored.

---

Constructor & Destructor Documentation

template<class seqT> simthlib::HistogramPipeT< seqT >::HistogramPipeT (  int  deviceID, simth::DeviceSystemIntf *  system, const simth::PropertyList &  pl )

Constructor. Parameters: deviceID  simth::Device ID for parent class. system  Pointer to system for parent class. pl  PropertyList of this device

---

Member Function Documentation

template<class seqT> void simthlib::HistogramPipeT< seqT >::print (  std::ostream &  os  )  const [virtual]

Reimplemented from simth::Device.

template<class seqT> void simthlib::HistogramPipeT< seqT >::process (   )  [virtual]

Implements simth::Device.

template<class seqT> void simthlib::HistogramPipeT< seqT >::updateInputLengths (   )  [virtual]

Implements simth::Device.

template<class seqT> void simthlib::HistogramPipeT< seqT >::updateOutputLengths (   )  [virtual]

Implements simth::Device.

---