A simple, nearest-point resampler, for generating merged samples from variables from one or more sample sources. More...

#include <NearestResampler.h>

Inheritance diagram for nidas::core::NearestResampler:

[legend]

Public Member Functions
	NearestResampler (const std::vector< const Variable * > &vars, bool nansVariable=true)
	Constructor. More...

	NearestResampler (const std::vector< Variable * > &vars, bool nansVariable=true)

	~NearestResampler ()

SampleSource *	getRawSampleSource ()
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...

SampleSource *	getProcessedSampleSource ()
	Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...

std::list< const SampleTag * >	getSampleTags () const
	Get the SampleTag of my merged output sample. More...

SampleTagIterator	getSampleTagIterator () const
	Implementation of SampleSource::getSampleTagIterator(). More...

void	addSampleClient (SampleClient *client) throw ()
	Implementation of SampleSource::addSampleClient(). More...

void	removeSampleClient (SampleClient *client) throw ()
	Remove a SampleClient from this SampleSource. More...

void	addSampleClientForTag (SampleClient client, const SampleTag ) throw ()
	Add a Client for a given SampleTag. More...

void	removeSampleClientForTag (SampleClient client, const SampleTag ) throw ()
	Remove a SampleClient for a given SampleTag from this SampleSource. More...

int	getClientCount () const throw ()
	How many SampleClients are currently in my list. More...

const SampleStats &	getSampleStats () const

void	connect (SampleSource *src) throw (nidas::util::InvalidParameterException)
	Connect the resampler to a SampleSource. More...

void	disconnect (SampleSource *src) throw ()

bool	receive (const Sample *s) throw ()
	Implementation of SampleClient::receive(). More...

void	flush () throw ()
	Implementation of Resampler::flush(). More...

Private Member Functions
void	ctorCommon (const std::vector< const Variable * > &vars, bool nansVariable)
	Common tasks of constructors. More...

void	addSampleTag (const SampleTag *tag) throw ()
	Add a SampleTag to this SampleSource. More...

void	removeSampleTag (const SampleTag *tag) throw ()

NearestResampler &	operator= (const NearestResampler &)
	No assignment. More...

	NearestResampler (const NearestResampler &x)
	No copy. More...

Private Attributes
SampleSourceSupport	_source

SampleTag	_outSample

std::vector< Variable * >	_reqVars
	Requested variables. More...

std::map< Variable *, unsigned int >	_outVarIndices
	Index of each requested output variable in the output sample. More...

std::map< dsm_sample_id_t, std::vector< unsigned int > >	_inmap
	For each input sample, first index of variable data values to be read. More...

std::map< dsm_sample_id_t, std::vector< unsigned int > >	_lenmap
	For each input sample, length of variables to read. More...

std::map< dsm_sample_id_t, std::vector< unsigned int > >	_outmap
	For each input sample, index into output sample of each variable. More...

unsigned int	_ndataValues

unsigned int	_outlen

unsigned int	_master

int	_nmaster

dsm_time_t *	_prevTT

dsm_time_t *	_nearTT

float *	_prevData

float *	_nearData

int *	_samplesSinceMaster

std::map< dsm_sample_id_t, unsigned int >	_ttOutOfOrder

bool	_debug

Detailed Description

A simple, nearest-point resampler, for generating merged samples from variables from one or more sample sources.

The first variable added to NearestResample with the addVariable() method becomes the "master" variable. The time tags of the master variable become the output sample time tags, and values of other variables are merged into the output sample by associating those values with the nearest time tag to the master times.

The only requirement is that the samples which are fed to the receive() method should be sorted in time. It they aren't sorted some data will be lost. NearestResampler does not need to know sampling rates, and the sampling rates of the input variables, including the master variable, may vary.

Constructor & Destructor Documentation

NearestResampler::NearestResampler	(	const std::vector< const Variable * > &	vars,
		bool	nansVariable = `true`
	)

Constructor.

References ctorCommon().

NearestResampler::NearestResampler	(	const std::vector< Variable * > &	vars,
		bool	nansVariable = `true`
	)

References ctorCommon().

NearestResampler::~NearestResampler ( )

References _nearData, _nearTT, _prevData, _prevTT, _reqVars, and _samplesSinceMaster.

nidas::core::NearestResampler::NearestResampler ( const NearestResampler & x )

private

No copy.

Member Function Documentation

void nidas::core::NearestResampler::addSampleClient	(	SampleClient *	client	)
throw	(
	)

inlinevirtual

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::addSampleClient().

void nidas::core::NearestResampler::addSampleClientForTag	(	SampleClient *	client,
		const SampleTag *
	)
throw	(
	)

inlinevirtual

Add a Client for a given SampleTag.

Implementation of SampleSource::addSampleClient().

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::addSampleClient().

void nidas::core::NearestResampler::addSampleTag	(	const SampleTag *	tag	)
throw	(
	)

inlineprivatevirtual

Add a SampleTag to this SampleSource.

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::addSampleTag().

Referenced by ctorCommon().

void NearestResampler::connect	(	SampleSource *	src	)
throw	(	nidas::util::InvalidParameterException
	)

virtual

Connect the resampler to a SampleSource.

Implements nidas::core::Resampler.

References nidas::core::SampleTag::getDataIndex(), nidas::core::SampleTag::getId(), nidas::core::Variable::getLength(), nidas::core::Variable::getName(), nidas::core::Variable::getNameWithoutSite(), nidas::core::Variable::getStation(), nidas::core::SampleTag::getVariableIterator(), nidas::core::VariableIterator::hasNext(), nidas::core::VariableIterator::next(), and WLOG.

void NearestResampler::ctorCommon	(	const std::vector< const Variable * > &	vars,
		bool	nansVariable
	)

private

Common tasks of constructors.

Referenced by NearestResampler().

void NearestResampler::disconnect	(	SampleSource *	src	)
throw	(
	)

virtual

Implements nidas::core::Resampler.

void NearestResampler::flush	(	)
throw	(
	)

virtual

Implementation of Resampler::flush().

Send out whatever samples are available.

Implements nidas::core::Resampler.

References _master, _ndataValues, _nearData, _nearTT, _nmaster, _outlen, _outSample, _prevData, _prevTT, _samplesSinceMaster, _source, nidas::core::SampleSourceSupport::distribute(), nidas::core::floatNAN, nidas::core::SampleT< DataT >::getDataPtr(), nidas::core::SampleTag::getId(), nidas::core::Sample::setId(), and nidas::core::Sample::setTimeTag().

int nidas::core::NearestResampler::getClientCount	(	)	const
throw	(
	)

inlinevirtual

How many SampleClients are currently in my list.

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::getClientCount().

SampleSource* nidas::core::NearestResampler::getProcessedSampleSource ( )

inlinevirtual

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of processed samples.

Implements nidas::core::SampleSource.

References _source.

SampleSource* nidas::core::NearestResampler::getRawSampleSource ( )

inlinevirtual

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of raw samples.

Implements nidas::core::SampleSource.

const SampleStats& nidas::core::NearestResampler::getSampleStats ( ) const

inlinevirtual

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::getSampleStats().

SampleTagIterator nidas::core::NearestResampler::getSampleTagIterator ( ) const

inlinevirtual

Implementation of SampleSource::getSampleTagIterator().

Implements nidas::core::SampleSource.

References _source, and nidas::core::SampleSourceSupport::getSampleTagIterator().

std::list<const SampleTag*> nidas::core::NearestResampler::getSampleTags ( ) const

inlinevirtual