#include <WeightTableFilter1DBuilder.hh>

Inheritance diagram for npstat::WeightTableFilter1DBuilder:

Public Member Functions
	WeightTableFilter1DBuilder (const double weight, unsigned weightLen, const unsigned char exclusionMask=0, unsigned exclusionMaskLen=0, bool excludeCentralPoint=false)

virtual unsigned	centralWeightLength () const

virtual bool	keepAllFilters () const

virtual OrthoPoly1D *	makeOrthoPoly (unsigned maxDegree, unsigned binnum, unsigned datalen, unsigned *filterCenter) const

Public Member Functions inherited from npstat::OrthoPolyFilter1DBuilder
virtual PolyFilter1D *	makeFilter (const double *taper, unsigned maxDegree, unsigned binnum, unsigned datalen) const

Public Member Functions inherited from npstat::AbsFilter1DBuilder
virtual double	lastBandwidthFactor () const

Detailed Description

This class will construct a local polynomial filter out of an arbitrary sampled even weight function.

Constructor & Destructor Documentation

◆ WeightTableFilter1DBuilder()

npstat::WeightTableFilter1DBuilder::WeightTableFilter1DBuilder	(	const double *	weight,
		unsigned	weightLen,
		const unsigned char *	exclusionMask = `0`,
		unsigned	exclusionMaskLen = `0`,
		bool	excludeCentralPoint = `false`
	)

The constructor arguments are as follows:

weight – Tabulated weight function, in equidistant steps, in the order of increasing x. The first value corresponds to x = 0, the second to x + step, etc. The weight is assumed to be symmetric around 0.

weightLen – The length of the "weight" array.

exclusionMask – Set values of "exclusionMask" != 0 if corresponding data points have to be excluded when weights are generated. If no exclusions are necessary, just leave this array as NULL.

exclusionMaskLen – Length of the "exclusionMask" array. If it is not 0 then it must coinside with the "datalen" argument given to all future invocations of the "makeFilter" method.

excludeCentralPoint – If "true", the central point of the weight will be set to zero. This can be useful for certain types of cross validation calculations.

Member Function Documentation

◆ centralWeightLength()

virtual unsigned npstat::WeightTableFilter1DBuilder::centralWeightLength ( ) const

inlinevirtual

Length of the filter constructed at a point deeply inside the density support region

Implements npstat::AbsFilter1DBuilder.

◆ keepAllFilters()

virtual bool npstat::WeightTableFilter1DBuilder::keepAllFilters ( ) const

inlinevirtual

Should we keep all filters or can we assume that filters deeply inside the density support region are identical?

Implements npstat::AbsFilter1DBuilder.

◆ makeOrthoPoly()

virtual OrthoPoly1D* npstat::WeightTableFilter1DBuilder::makeOrthoPoly	(	unsigned	maxDegree,
		unsigned	binnum,
		unsigned	datalen,
		unsigned *	filterCenter
	)		const

virtual

Build the orthogonal polynomial system that can later be used to construct filters with different tapers. This is constructed on the heap and later must be deleted.

Implements npstat::OrthoPolyFilter1DBuilder.

Reimplemented in npstat::NonmodifyingFilter1DBuilder.

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

stat/WeightTableFilter1DBuilder.hh