casacore::LattStatsSpecialize Class Reference

#include <LattStatsSpecialize.h>

Static Public Member Functions
static void	accumulate (Double &nPts, Double &sum, Double &mean, Double &nvariance, Double &variance, Double &sumSq, Float &dataMin, Float &dataMax, Int &minPos, Int &maxPos, Bool &minMaxInit, const Bool fixedMinMax, const Float datum, const uInt &pos, const Float useIt)
	!!! WARNING !!! BOTH accumulate() METHODS ARE DEPRECATED AND NO LONGER USED BY CASACORE NOR CASA.
static void	accumulate (DComplex &nPts, DComplex &sum, DComplex &mean, DComplex &nvariance, DComplex &variance, DComplex &sumSq, Complex &dataMin, Complex &dataMax, const Int &minPos, const Int &maxPos, Bool &minMaxInit, const Bool fixedMinMax, const Complex datum, const uInt &pos, const Complex useIt)
static Bool	hasSomePoints (Double npts)
static Bool	hasSomePoints (DComplex npts)
static void	setUseItTrue (Float &useIt)
static void	setUseItTrue (Complex &useIt)
static Float	usePixelInc (Float dMin, Float dMax, Float datum)
static Complex	usePixelInc (Complex dMin, Complex dMax, Complex datum)
static Float	usePixelExc (Float dMin, Float dMax, Float datum)
static Complex	usePixelExc (Complex dMin, Complex dMax, Complex datum)
static Double	getMean (Double sum, Double n)
static DComplex	getMean (DComplex sum, DComplex n)
static Double	getVariance (Double sum, Double sumsq, Double n)
static DComplex	getVariance (DComplex sum, DComplex sumsq, DComplex n)
static Double	getSigma (Double sum, Double sumsq, Double n)
static DComplex	getSigma (DComplex sum, DComplex sumsq, DComplex n)
static Double	getSigma (Double var)
static DComplex	getSigma (DComplex var)
static Double	getRms (Double sumsq, Double n)
static DComplex	getRms (DComplex sumsq, DComplex n)
static Float	min (Float v1, Float v2)
static Complex	min (Complex v1, Complex v2)
static Float	max (Float v1, Float v2)
static Complex	max (Complex v1, Complex v2)
static Float	getNodeScalarValue (const LatticeExprNode &node, Float)
static Complex	getNodeScalarValue (const LatticeExprNode &node, Complex)
static Bool	setIncludeExclude (String &errorMessage, Vector< Float > &range, Bool &noInclude, Bool &noExclude, const Vector< Float > &include, const Vector< Float > &exclude)
static Bool	setIncludeExclude (String &errorMessage, Vector< Complex > &range, Bool &noInclude, Bool &noExclude, const Vector< Complex > &include, const Vector< Complex > &exclude)
static Bool	minMax (Float &dataMin, Float &dataMax, const MaskedLattice< Float > *pLattice, const Vector< Float > &range, Bool noInclude, Bool noExclude)
static Bool	minMax (Complex &dataMin, Complex &dataMax, const MaskedLattice< Complex > *pLattice, const Vector< Complex > &range, Bool noInclude, Bool noExclude)

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Synopsis

Motivation

Definition at line 69 of file LattStatsSpecialize.h.

Member Function Documentation

static void casacore::LattStatsSpecialize::accumulate	(	DComplex &	nPts,
		DComplex &	sum,
		DComplex &	mean,
		DComplex &	nvariance,
		DComplex &	variance,
		DComplex &	sumSq,
		Complex &	dataMin,
		Complex &	dataMax,
		const Int &	minPos,
		const Int &	maxPos,
		Bool &	minMaxInit,
		const Bool	fixedMinMax,
		const Complex	datum,
		const uInt &	pos,
		const Complex	useIt
	)			`[static]`

static void casacore::LattStatsSpecialize::accumulate	(	Double &	nPts,
		Double &	sum,
		Double &	mean,
		Double &	nvariance,
		Double &	variance,
		Double &	sumSq,
		Float &	dataMin,
		Float &	dataMax,
		Int &	minPos,
		Int &	maxPos,
		Bool &	minMaxInit,
		const Bool	fixedMinMax,
		const Float	datum,
		const uInt &	pos,
		const Float	useIt
	)			`[static]`

!!! WARNING !!! BOTH accumulate() METHODS ARE DEPRECATED AND NO LONGER USED BY CASACORE NOR CASA.

THESE METHODS WILL BE REMOVED IN THE NEAR FUTURE. PLEASE MODIFY EXISTING CODE WHICH USES THEM. CURRENT STATISTIC CLASSES MAY BE FOUND IN scimath/Mathematics.

in this version we maintain a running mean and variance to avoid catastrophic round-off issues that can happen in some cases, CAS-2226. Removing old versions in which these quantities were not accumulated - dmehring 2011mar01

static DComplex casacore::LattStatsSpecialize::getMean	(	DComplex	sum,
		DComplex	n
	)			`[static]`

static Double casacore::LattStatsSpecialize::getMean	(	Double	sum,
		Double	n
	)			`[static]`

static Complex casacore::LattStatsSpecialize::getNodeScalarValue	(	const LatticeExprNode &	node,
		Complex
	)			`[static]`

static Float casacore::LattStatsSpecialize::getNodeScalarValue	(	const LatticeExprNode &	node,
		Float
	)			`[static]`

static DComplex casacore::LattStatsSpecialize::getRms	(	DComplex	sumsq,
		DComplex	n
	)			`[static]`

static Double casacore::LattStatsSpecialize::getRms	(	Double	sumsq,
		Double	n
	)			`[static]`

static DComplex casacore::LattStatsSpecialize::getSigma ( DComplex var ) [static]

static Double casacore::LattStatsSpecialize::getSigma ( Double var ) [static]

static DComplex casacore::LattStatsSpecialize::getSigma	(	DComplex	sum,
		DComplex	sumsq,
		DComplex	n
	)			`[static]`

static Double casacore::LattStatsSpecialize::getSigma	(	Double	sum,
		Double	sumsq,
		Double	n
	)			`[static]`

static DComplex casacore::LattStatsSpecialize::getVariance	(	DComplex	sum,
		DComplex	sumsq,
		DComplex	n
	)			`[static]`

static Double casacore::LattStatsSpecialize::getVariance	(	Double	sum,
		Double	sumsq,
		Double	n
	)			`[static]`

static Bool casacore::LattStatsSpecialize::hasSomePoints ( DComplex npts ) [static]

static Bool casacore::LattStatsSpecialize::hasSomePoints ( Double npts ) [static]

static Complex casacore::LattStatsSpecialize::max	(	Complex	v1,
		Complex	v2
	)			`[static]`

static Float casacore::LattStatsSpecialize::max	(	Float	v1,
		Float	v2
	)			`[static]`

static Complex casacore::LattStatsSpecialize::min	(	Complex	v1,
		Complex	v2
	)			`[static]`

static Float casacore::LattStatsSpecialize::min	(	Float	v1,
		Float	v2
	)			`[static]`

static Bool casacore::LattStatsSpecialize::minMax	(	Complex &	dataMin,
		Complex &	dataMax,
		const MaskedLattice< Complex > *	pLattice,
		const Vector< Complex > &	range,
		Bool	noInclude,
		Bool	noExclude
	)			`[static]`

static Bool casacore::LattStatsSpecialize::minMax	(	Float &	dataMin,
		Float &	dataMax,
		const MaskedLattice< Float > *	pLattice,
		const Vector< Float > &	range,
		Bool	noInclude,
		Bool	noExclude
	)			`[static]`

static Bool casacore::LattStatsSpecialize::setIncludeExclude	(	String &	errorMessage,
		Vector< Complex > &	range,
		Bool &	noInclude,
		Bool &	noExclude,
		const Vector< Complex > &	include,
		const Vector< Complex > &	exclude
	)			`[static]`

static Bool casacore::LattStatsSpecialize::setIncludeExclude	(	String &	errorMessage,
		Vector< Float > &	range,
		Bool &	noInclude,
		Bool &	noExclude,
		const Vector< Float > &	include,
		const Vector< Float > &	exclude
	)			`[static]`

static void casacore::LattStatsSpecialize::setUseItTrue ( Complex & useIt ) [static]

static void casacore::LattStatsSpecialize::setUseItTrue ( Float & useIt ) [static]

static Complex casacore::LattStatsSpecialize::usePixelExc	(	Complex	dMin,
		Complex	dMax,
		Complex	datum
	)			`[static]`

static Float casacore::LattStatsSpecialize::usePixelExc	(	Float	dMin,
		Float	dMax,
		Float	datum
	)			`[static]`

static Complex casacore::LattStatsSpecialize::usePixelInc	(	Complex	dMin,
		Complex	dMax,
		Complex	datum
	)			`[static]`

static Float casacore::LattStatsSpecialize::usePixelInc	(	Float	dMin,
		Float	dMax,
		Float	datum
	)			`[static]`

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

casacore/lattices/LatticeMath/LattStatsSpecialize.h