casacore::ImageStatistics< T > Class Template Reference

Displays various statistics from an image. More...

#include <ImageStatistics.h>

Inheritance diagram for casacore::ImageStatistics< T >:

Public Member Functions
	ImageStatistics (const ImageInterface< T > &image, LogIO &os, Bool showProgress=True, Bool forceDisk=False)
	Constructor takes the image and a `LogIO` object for logging.
	ImageStatistics (const ImageInterface< T > &image, Bool showProgress=True, Bool forceDisk=False)
	Constructor takes the image only.
	ImageStatistics (const ImageStatistics< T > &other)
	Copy constructor.
virtual	~ImageStatistics ()
	Destructor.
ImageStatistics< T > &	operator= (const ImageStatistics< T > &other)
	Assignment operator.
Bool	setNewImage (const ImageInterface< T > &image)
	Set a new ImageInterface object.
void	setPrecision (Int precision)
void	setBlc (const IPosition &blc)
IPosition	getBlc () const
Int	getPrecision () const
void	showRobust (const Bool show)
	list robust statistics? Should be called before display()
void	recordMessages (const Bool rm)
vector< String >	getMessages ()
void	clearMessages ()
void	setListStats (Bool b)
Protected Types
typedef NumericTraits< T > ::PrecisionType	AccumType
Protected Member Functions
virtual Bool	_canDoFlux () const
	Virtual Functions.
Private Member Functions
virtual void	getLabels (String &higherOrder, String &xAxis, const IPosition &dPos) const
	Virtual functions.
virtual Bool	_getBeamArea (Array< Double > &beamArea, String &msg) const
	Get beam area in pixels if possible.
virtual void	listMinMax (ostringstream &osMin, ostringstream &osMax, Int oWidth, DataType type)
	List min and max with world coordinates.
virtual Bool	listStats (Bool hasBeam, const IPosition &dPos, const Matrix< AccumType > &ord)
	List the statistics.
virtual void	displayStats (AccumType nPts, AccumType sum, AccumType median, AccumType medAbsDevMed, AccumType quartile, AccumType sumSq, AccumType mean, AccumType var, AccumType rms, AccumType sigma, AccumType dMin, AccumType dMax, AccumType q1, AccumType q3)
Quantum< AccumType >	_flux (Bool &isFluxDensity, AccumType sum, Double beamAreaInPixels) const
	If `isFluxDensity` is False, then the computed value is a flux (ie flux density integrated over a spectral extent).
Bool	_computeFlux (Array< AccumType > &flux, const Array< AccumType > &npts, const Array< AccumType > &sum)
Bool	_computeFlux (Quantum< AccumType > &flux, AccumType sum, const IPosition &pos, Bool posInLattice)
Private Attributes
LogIO	os_p
	Data.
const ImageInterface< T > *	pInImage_p
IPosition	blc_
Int	precision_
Bool	_showRobust
Bool	_recordMessages
Bool	_listStats
vector< String >	_messages

Detailed Description

template<class T>
class casacore::ImageStatistics< T >

Displays various statistics from an image.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

LatticeStatistics (base class)
ImageInterface

Etymology

This is a class designed to display and retrieve statistics from images

Synopsis

This class enable you to display and/or retrieve statistics evaluated over specified regions from an image. The dimension of the region is arbitrary, but the size of each dimension is always the size of the corresponding image axis. The statistics are displayed as a function of location of the axes not used to evaluate the statistics over. The axes which you evaluate the statistics over are called the cursor axes, the others are called the display axes.

This class is derived from the class LatticeStatistics which does all the work. This class only adds some extra capability in terms of logging world (rather than pixel) coordinates and computing the synthesized beam area, if there is one. There are just a few virtual functions for you to over-ride. These are rather specialized, they are not part of a general polymorphic interface, just a way to separate the Lattice and Image functionality out.

See LatticeStatistics for details and examples.

Motivation

The generation of statistical information from an image is a basic and necessary capability.

To Do

Deal with complex images at least for statistics retrieval if not plotting.
Retrieve statistics at specified location of display axes
Standard errors on statistical quantities
Median, other more exotic statistics. Life made difficult by accumulation image approach

Definition at line 99 of file ImageStatistics.h.

Member Typedef Documentation

template<class T>

typedef NumericTraits<T>::PrecisionType casacore::ImageStatistics< T >::AccumType [protected]

Reimplemented from casacore::LatticeStatistics< T >.

Definition at line 157 of file ImageStatistics.h.

Constructor & Destructor Documentation

template<class T>

casacore::ImageStatistics< T >::ImageStatistics	(	const ImageInterface< T > &	image,
		LogIO &	os,
		Bool	showProgress = `True`,
		Bool	forceDisk = `False`
	)

Constructor takes the image and a LogIO object for logging.

You can specify whether you want to see progress meters or not. You can force the storage image to be disk based, otherwise the decision for core or disk is taken for you.

template<class T>

casacore::ImageStatistics< T >::ImageStatistics	(	const ImageInterface< T > &	image,
		Bool	showProgress = `True`,
		Bool	forceDisk = `False`
	)

Constructor takes the image only.

In the absence of a logger you get no messages. This includes error messages and potential listing of the statistics. You can specify whether you want to see progress meters or not. You can force the storage image to be disk based, otherwise the decision for core or disk is taken for you.

template<class T>

casacore::ImageStatistics< T >::ImageStatistics ( const ImageStatistics< T > & other )

Copy constructor.

Copy semantics are followed. Therefore any storage image that has already been created for other is copied to *this

template<class T>

virtual casacore::ImageStatistics< T >::~ImageStatistics ( ) [virtual]

Destructor.

Member Function Documentation

template<class T>

virtual Bool casacore::ImageStatistics< T >::_canDoFlux ( ) const [protected, virtual]

Virtual Functions.

See implementation to figure it all out !

FIXME The indirect dependence of this class on ImageInterface related issues (eg flux density) breaks encapsulation. All the ImageInterface related code should be encapsulated in ImageStatistics. Unfortunately, that requires significantly more time than I have atm. A return value of False means that the object in question cannot compute flux density values. The default implementation returns False.

Reimplemented from casacore::LatticeStatistics< T >.

template<class T>

Bool casacore::ImageStatistics< T >::_computeFlux	(	Quantum< AccumType > &	flux,
		AccumType	sum,
		const IPosition &	pos,
		Bool	posInLattice
	)			`[private, virtual]`

Reimplemented from casacore::LatticeStatistics< T >.

template<class T>

Bool casacore::ImageStatistics< T >::_computeFlux	(	Array< AccumType > &	flux,
		const Array< AccumType > &	npts,
		const Array< AccumType > &	sum
	)			`[private, virtual]`

Reimplemented from casacore::LatticeStatistics< T >.

template<class T>

Quantum<AccumType> casacore::ImageStatistics< T >::_flux	(	Bool &	isFluxDensity,
		AccumType	sum,
		Double	beamAreaInPixels
	)			const `[private, virtual]`

If isFluxDensity is False, then the computed value is a flux (ie flux density integrated over a spectral extent).

Reimplemented from casacore::LatticeStatistics< T >.

template<class T>

virtual Bool casacore::ImageStatistics< T >::_getBeamArea	(	Array< Double > &	beamArea,
		String &	msg
	)			const `[private, virtual]`

Get beam area in pixels if possible.

Return False if the beam area could not be calculated.

template<class T>

void casacore::ImageStatistics< T >::clearMessages ( ) [inline]

Definition at line 152 of file ImageStatistics.h.

References casacore::ImageStatistics< T >::_messages.

template<class T>

virtual void casacore::ImageStatistics< T >::displayStats	(	AccumType	nPts,
		AccumType	sum,
		AccumType	median,
		AccumType	medAbsDevMed,
		AccumType	quartile,
		AccumType	sumSq,
		AccumType	mean,
		AccumType	var,
		AccumType	rms,
		AccumType	sigma,
		AccumType	dMin,
		AccumType	dMax,
		AccumType	q1,
		AccumType	q3
	)			`[private, virtual]`