More...

#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)
	in this version we maintain a running mean and variance to avoid catastrophic round-off issues that can happen in some cases, CAS-2226.
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 casa::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]`

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 void casa::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 Double casa::LattStatsSpecialize::getMean	(	Double	sum,
		Double	n
	)		`[static]`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

casacore/lattices/Lattices/LattStatsSpecialize.h