npstat::AbsMarginalSmootherBase Class Reference

Inheritance diagram for npstat::AbsMarginalSmootherBase:

Public Member Functions
	AbsMarginalSmootherBase (unsigned nbins, double xmin, double xmax, const char *axisLabel=0)
void	setAxisLabel (const char *axisLabel)
unsigned	nBins () const
double	xMin () const
double	xMax () const
double	binWidth () const
const std::string &	getAxisLabel () const
gs::AbsArchive *	getArchive () const
const std::string &	getArchiveCategory () const
double	lastBandwidth () const
void	setArchive (gs::AbsArchive *ar, const char *category=0)
void	unsetArchive ()
template<typename Numeric >
const HistoND< double > &	smooth (const std::vector< Numeric > &inputPoints, double minValue=-std::numeric_limits< double >::max(), double maxValue=std::numeric_limits< double >::max(), double *bandwidthUsed=0)
template<typename Numeric >
const HistoND< double > &	smooth (unsigned long uniqueId, unsigned dimNumber, const std::vector< Numeric > &inputPoints, double minValue=-std::numeric_limits< double >::max(), double maxValue=std::numeric_limits< double >::max(), double *bandwidthUsed=0)
template<typename Numeric >
const HistoND< double > &	weightedSmooth (const std::vector< std::pair< Numeric, double > > &inputPoints, double minValue=-std::numeric_limits< double >::max(), double maxValue=std::numeric_limits< double >::max(), double *bandwidthUsed=0)
template<typename Numeric >
const HistoND< double > &	weightedSmooth (unsigned long uniqueId, unsigned multivariatePointDimNumber, const std::vector< std::pair< Numeric, double > > &inputPoints, double minValue=-std::numeric_limits< double >::max(), double maxValue=std::numeric_limits< double >::max(), double *bandwidthUsed=0)

Constructor & Destructor Documentation

AbsMarginalSmootherBase()

npstat::AbsMarginalSmootherBase::AbsMarginalSmootherBase	(	unsigned	nbins,
		double	xmin,
		double	xmax,
		const char *	axisLabel = 0
	)

Constructor takes binning parameters for the internal histogram

Member Function Documentation

lastBandwidth()

double npstat::AbsMarginalSmootherBase::lastBandwidth ( ) const

inline

The bandwidth used by the most recent "smooth" or "weightedSmooth" call

nBins()

unsigned npstat::AbsMarginalSmootherBase::nBins ( ) const

inline

Simple inspector of the object properties

setArchive()

void npstat::AbsMarginalSmootherBase::setArchive	(	gs::AbsArchive *	ar,
		const char *	category = 0
	)

Set the archive for storing original and smoothed histograms

smooth() [1/2]

template<typename Numeric >

const HistoND<double>& npstat::AbsMarginalSmootherBase::smooth	(	const std::vector< Numeric > &	inputPoints,
		double	minValue = -std::numeric_limits< double >::max(),
		double	maxValue = std::numeric_limits< double >::max(),
		double *	bandwidthUsed = 0
	)

Smoothing function for unweighted samples. The region used for smoothing will be defined by the overlap of the intervals [minValue, maxValue) and [xMin(), xMax()).

smooth() [2/2]

template<typename Numeric >

const HistoND<double>& npstat::AbsMarginalSmootherBase::smooth	(	unsigned long	uniqueId,
		unsigned	dimNumber,
		const std::vector< Numeric > &	inputPoints,
		double	minValue = -std::numeric_limits< double >::max(),
		double	maxValue = std::numeric_limits< double >::max(),
		double *	bandwidthUsed = 0
	)

Smoothing function for unweighted samples. The region used for smoothing will be defined by the overlap of the intervals [minValue, maxValue) and [xMin(), xMax()). Parameters "uniqueId" and "dimNumber" are used for identification purposes only – they will be used to create the item name in the archive if the archive is set.

unsetArchive()

void npstat::AbsMarginalSmootherBase::unsetArchive ( )

inline

Stop storing histograms

weightedSmooth() [1/2]

template<typename Numeric >

const HistoND<double>& npstat::AbsMarginalSmootherBase::weightedSmooth	(	const std::vector< std::pair< Numeric, double > > &	inputPoints,
		double	minValue = -std::numeric_limits< double >::max(),
		double	maxValue = std::numeric_limits< double >::max(),
		double *	bandwidthUsed = 0
	)

Smoothing function for weighted samples. The region used for smoothing will be defined by the overlap of the intervals [minValue, maxValue) and [xMin(), xMax()).

weightedSmooth() [2/2]

template<typename Numeric >

const HistoND<double>& npstat::AbsMarginalSmootherBase::weightedSmooth	(	unsigned long	uniqueId,
		unsigned	multivariatePointDimNumber,
		const std::vector< std::pair< Numeric, double > > &	inputPoints,
		double	minValue = -std::numeric_limits< double >::max(),
		double	maxValue = std::numeric_limits< double >::max(),
		double *	bandwidthUsed = 0
	)

Smoothing function for weighted samples. The region used for smoothing will be defined by the overlap of the intervals [minValue, maxValue) and [xMin(), xMax()). Parameters "uniqueId" and "multivariatePointDimNumber" are used for identification purposes only – they will be used to create the item name in the archive if the archive is set.

---

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

• stat/AbsMarginalSmootherBase.hh