Base class for SPEC 2DS optical array probe on a USB interface. More...

#include <TwoD_Processing.h>

Inheritance diagram for nidas::dynld::raf::TwoD_Processing:

[legend]

Classes
class	Particle

Public Member Functions
	TwoD_Processing ()

virtual	~TwoD_Processing ()

virtual int	NumberOfDiodes () const =0
	Number of diodes in the probe array.

float	getResolution () const
	The probe resolution in meters.

unsigned int	getResolutionMicron () const
	The probe resolution in micrometers.

Protected Member Functions
virtual void	processParticleSlice (Particle &p, const unsigned char *slice)
	Process a slice and update the Particle struct area, edgeTouch, width and height.

virtual void	countParticle (const Particle &p, float resolutionUsec)
	Look at particle stats/info and decide whether to accept or reject.

virtual bool	acceptThisParticle1D (const Particle &p) const
	Accept/reject criteria are in these functions.

virtual bool	acceptThisParticle2D (const Particle &p) const

virtual void	createSamples (dsm_time_t nextTimeTag, std::list< const Sample * > &results) throw ()
	Send derived data and reset.

virtual void	clearData ()
	Clear size_dist arrays.

void	saveBuffer (const unsigned char cp, const unsigned char eod)
	In case of mis-aligned data, we may need to save some bytes at the end of an image block to pre-pend to the next block.

void	setupBuffer (const unsigned char cp, const unsigned char eod)
	Derived Classes should call this at the beginning of processing an image block.

Protected Attributes
unsigned int	_numImages
	Number of image blocks processed by driver at time of last printStatus.

long long	_lastStatusTime
	Time of last printStatus.

float	_resolutionMeters
	Probe resolution in meters.

unsigned int	_resolutionMicron
	Probe resolution in micrometers.

dsm_sample_id_t	_1dcID

dsm_sample_id_t	_2dcID

unsigned int *	_size_dist_1D
	Arrays for size-distribution histograms.

unsigned int *	_size_dist_2D

float	_dead_time
	Amount of time probe was inactive or amount of time consumed by rejected particles.

unsigned int	_totalRecords
	Statistics variables for processRecord().

unsigned int	_totalParticles

unsigned int	_rejected1D_Cntr

unsigned int	_rejected2D_Cntr

unsigned int	_overLoadSliceCount

unsigned int	_overSizeCount_2D

unsigned int	_misAligned

unsigned int	_suspectSlices

unsigned int	_recordsPerSecond

unsigned int	_totalPixelsShadowed
	total # of pixels shadoweded in the time period. per second...

dsm_time_t	_prevTime
	Time from previous record.

long long	_histoEndTime
	The end time of the current histogram.

float	_twoDAreaRejectRatio
	Area of particle rejection ratio.

Particle	_particle
	Current particle information.

int	_nextraValues
	If XML file has a variable RPS (records per second) defined, then _nextravalues will be 2, otherwise 1.

unsigned char *	_saveBuffer
	The saved buffer.

int	_savedBytes
	How many bytes were last saved.

int	_savedAlloc
	Size of the saved buffer.

Private Member Functions
	TwoD_Processing (const TwoD_Processing &)
	No copying.

TwoD_Processing &	operator= (const TwoD_Processing &)
	No copying.

Detailed Description

Base class for SPEC 2DS optical array probe on a USB interface.

Perhaps can be split out into a base class and sub-classes for 2DS & HVPS.

Constructor & Destructor Documentation

◆ TwoD_Processing() [1/2]

TwoD_Processing::TwoD_Processing ( )

◆ ~TwoD_Processing()

TwoD_Processing::~TwoD_Processing ( )

virtual

References _misAligned, _overLoadSliceCount, _overSizeCount_2D, _rejected1D_Cntr, _rejected2D_Cntr, _saveBuffer, _size_dist_1D, _size_dist_2D, _suspectSlices, _totalParticles, and _totalRecords.

◆ TwoD_Processing() [2/2]

nidas::dynld::raf::TwoD_Processing::TwoD_Processing ( const TwoD_Processing & )

private

No copying.

Member Function Documentation

◆ acceptThisParticle1D()

bool TwoD_Processing::acceptThisParticle1D ( const Particle & p ) const

protectedvirtual

Accept/reject criteria are in these functions.

Parameters

p	is particle info class.

Returns: boolean whether the particle should be rejected.

References _twoDAreaRejectRatio, nidas::dynld::raf::TwoD_Processing::Particle::area, nidas::dynld::raf::TwoD_Processing::Particle::dofReject, nidas::dynld::raf::TwoD_Processing::Particle::edgeTouch, nidas::dynld::raf::TwoD_Processing::Particle::height, and nidas::dynld::raf::TwoD_Processing::Particle::width.

Referenced by countParticle().

◆ acceptThisParticle2D()

bool TwoD_Processing::acceptThisParticle2D ( const Particle & p ) const

protectedvirtual

References _twoDAreaRejectRatio, nidas::dynld::raf::TwoD_Processing::Particle::area, nidas::dynld::raf::TwoD_Processing::Particle::dofReject, nidas::dynld::raf::TwoD_Processing::Particle::edgeTouch, nidas::dynld::raf::TwoD_Processing::Particle::height, and nidas::dynld::raf::TwoD_Processing::Particle::width.

Referenced by countParticle().

◆ clearData()

void TwoD_Processing::clearData ( )

protectedvirtual

Clear size_dist arrays.

References _dead_time, _recordsPerSecond, _size_dist_1D, _size_dist_2D, _totalPixelsShadowed, nidas::core::getSample(), and NumberOfDiodes().

Referenced by nidas::dynld::raf::TwoD_USB::init(), and nidas::dynld::raf::TwoDS::init().

◆ countParticle()

void TwoD_Processing::countParticle	(	const Particle &	p,
		float	resolutionUsec )

protectedvirtual

Look at particle stats/info and decide whether to accept or reject.

Parameters

p	is the particle information.
resolutionUsec	is the current probe clocking rate.

References _overSizeCount_2D, _rejected1D_Cntr, _rejected2D_Cntr, _size_dist_1D, _size_dist_2D, _totalPixelsShadowed, acceptThisParticle1D(), acceptThisParticle2D(), nidas::dynld::raf::TwoD_Processing::Particle::area, nidas::util::endlog(), nidas::core::getSample(), nidas::dynld::raf::TwoD_Processing::Particle::height, LOG_VERBOSE, NumberOfDiodes(), nidas::dynld::raf::stream_histogram(), and nidas::dynld::raf::TwoD_Processing::Particle::width.

Referenced by nidas::dynld::raf::TwoD64_USB::processImageRecord().

◆ createSamples()

void TwoD_Processing::createSamples	(	dsm_time_t	nextTimeTag,
		std::list< const Sample * > &	results )
throw	(	)

protectedvirtual

Send derived data and reset.

The process() method for image data is to build size-distribution histograms for 1 second of data and then send that.

Parameters

results	is the output results.
nextTimeTag	is the timetag of a sample that is past the end of the current histogram period. The end

References nidas::core::getSample(), and USECS_PER_SEC.

Referenced by nidas::dynld::raf::TwoDS::processImageRecord(), and nidas::dynld::raf::TwoD64_USB::processImageRecord().

◆ getResolution()

float nidas::dynld::raf::TwoD_Processing::getResolution ( ) const

inline

The probe resolution in meters.

Probe resolution is also the diameter of the each diode. Typical values are 25 for the 2DC and 200 micrometers for the 2DP.

Returns: The probe resolution in meters.

References _resolutionMeters.

Referenced by nidas::dynld::raf::TwoD_USB::Tap2DToTAS(), nidas::dynld::raf::TwoD_USB::Tap2DToTAS(), and nidas::dynld::raf::TwoD_USB::TASToTap2D().

◆ getResolutionMicron()

unsigned int nidas::dynld::raf::TwoD_Processing::getResolutionMicron ( ) const

inline

The probe resolution in micrometers.

Probe resolution is also the diameter of the each diode. Typical values are 25 for the 2DC and 200 micrometers for the 2DP.

Returns: The probe resolution in micrometers.

References _resolutionMicron.

Referenced by nidas::dynld::raf::TwoD64_USB::processImageRecord(), and nidas::dynld::raf::TwoD64_USB_v3::TASToTap2D().

◆ NumberOfDiodes()

virtual int nidas::dynld::raf::TwoD_Processing::NumberOfDiodes ( ) const

pure virtual

Number of diodes in the probe array.

This is also the bits-per-slice value. Traditional 2D probes have 32 diodes, the HVPS has 128 and the Fast2DC has 64.

Returns: the number of bits per data slice.

Implemented in nidas::dynld::raf::TwoD32_USB, nidas::dynld::raf::TwoD64_USB, and nidas::dynld::raf::TwoDS.

Referenced by clearData(), countParticle(), nidas::dynld::raf::TwoD_USB::init(), and processParticleSlice().

◆ operator=()

TwoD_Processing & nidas::dynld::raf::TwoD_Processing::operator= ( const TwoD_Processing & )

private

No copying.

◆ processParticleSlice()

void TwoD_Processing::processParticleSlice	(	Particle &	p,
		const unsigned char *	slice )

protectedvirtual

Process a slice and update the Particle struct area, edgeTouch, width and height.

Parameters

p	is particle info class.
slice	is a pointer to the start of the slice, in big-endian and uncomplemented.

References nidas::dynld::raf::TwoD_Processing::Particle::area, nidas::dynld::raf::TwoD_Processing::Particle::edgeTouch, nidas::core::getSample(), nidas::dynld::raf::TwoD_Processing::Particle::height, NumberOfDiodes(), and nidas::dynld::raf::TwoD_Processing::Particle::width.

Referenced by nidas::dynld::raf::TwoDS::processImageRecord(), and nidas::dynld::raf::TwoD64_USB::processImageRecord().

◆ saveBuffer()

void TwoD_Processing::saveBuffer	(	const unsigned char *	cp,
		const unsigned char *	eod )

protected

In case of mis-aligned data, we may need to save some bytes at the end of an image block to pre-pend to the next block.

Parameters

cp	Pointer to next byte in the image block to be saved.
eod	Pointer to one-past-the-end of the image block. If cp is equal to eod, then nothing is saved, and this function does not need to be called.

References _saveBuffer, _savedAlloc, _savedBytes, and nidas::core::getSample().

Referenced by nidas::dynld::raf::TwoDS::processImageRecord(), and nidas::dynld::raf::TwoD64_USB::processImageRecord().

◆ setupBuffer()

void TwoD_Processing::setupBuffer	(	const unsigned char **	cp,
		const unsigned char **	eod )

protected

Derived Classes should call this at the beginning of processing an image block.

If bytes were saved from the end of the last image block, then the pointers are adjusted to point to a new buffer that contains the saved and the new data.

Parameters

cp	Pointer to pointer of first slice in the new image block to be processed, after the TAS word.
eod	Pointer to pointer to one-past-the-end of the image block.

References _saveBuffer, _savedAlloc, _savedBytes, and nidas::core::getSample().

Referenced by nidas::dynld::raf::TwoDS::processImageRecord(), and nidas::dynld::raf::TwoD64_USB::processImageRecord().