Displays histograms of regions from an image. More...

#include <ImageHistograms.h>

Inheritance diagram for casa::ImageHistograms< T >:

Public Member Functions
	ImageHistograms (const casacore::ImageInterface< T > &image, casacore::LogIO &os, casacore::Bool showProgress=true, casacore::Bool forceDisk=false)
	Constructor takes the image and a `casacore::LogIO` object for logging. More...

	ImageHistograms (const casacore::ImageInterface< T > &image, casacore::Bool showProgress=true, casacore::Bool forceDisk=false)
	Constructor takes the image only. More...

	ImageHistograms (const ImageHistograms< T > &other)
	Copy constructor (copy semantics) More...

virtual	~ImageHistograms ()
	Destructor. More...

ImageHistograms< T > &	operator= (const ImageHistograms< T > &other)
	Assignment operator (copy semantics) More...

casacore::Bool	setNewImage (const casacore::ImageInterface< T > &image)
	Set a new image. More...

Public Member Functions inherited from casacore::LatticeHistograms< T >
	LatticeHistograms (const MaskedLattice< T > &lattice, LogIO &os, Bool showProgress=True, Bool forceDisk=False)
	Constructor takes the MaskedLattice and a `LogIO` object for logging. More...

	LatticeHistograms (const MaskedLattice< T > &lattice, Bool showProgress=True, Bool forceDisk=False)
	Constructor takes the MaskedLattice only. More...

	LatticeHistograms (const LatticeHistograms< T > &other)
	Copy constructor (copy semantics) More...

virtual	~LatticeHistograms ()
	Destructor. More...

LatticeHistograms< T > &	operator= (const LatticeHistograms< T > &other)
	Assignment operator (copy semantics) More...

Bool	setAxes (const Vector< Int > &cursorAxes)
	Set the cursor axes (0 relative). More...

Bool	setNBins (const uInt &nBins)
	Set the number of bins for the histogram. More...

Bool	setIncludeRange (const Vector< T > &include)
	Specify a pixel intensity range for which all pixels in that range are included. More...

Bool	setGaussian (const Bool &doGauss)
	Specify that a Gaussian overlay should be plotted on the histogram. More...

Bool	setForm (const Bool &doLog, const Bool &doCumu)
	Specify the form of the histogram. More...

Bool	setStatsList (const Bool &doList)
	This function allows you to control whether some statistics of the data that contributed to the histogram are written to the output stream. More...

Bool	setPlotting (PGPlotter &plotter, const Vector< Int > &nxy)
	This function sets the name of the PGPLOT plotting device and the number of subplots in x and y per page. More...

Bool	display ()
	Display the histograms by plotting them. More...

void	closePlotting ()
	CLose the plotter. More...

Vector< Int >	displayAxes () const
	Return the display axes. More...

Bool	getHistograms (Array< T > &values, Array< T > &counts)
	This function retrieves the histograms into `Array`. More...

Bool	getHistograms (Array< T > &values, Array< T > &counts, Array< Vector< T > > &stats)
	in this version, the set of stats for each histogram is also returned. More...

Bool	getHistogram (Vector< T > &values, Vector< T > &counts, const IPosition &pos, const Bool posInLattice=False)
	This function retrieves the histogram at the specified location into `Vectors`. More...

void	resetError ()
	Reset argument error condition. More...

String	errorMessage () const
	Recover last error message. More...

Bool	setNewLattice (const MaskedLattice< T > &lattice)
	Set a MaskedLattice. More...

Private Member Functions
virtual casacore::String	writeCoordinates (const casacore::IPosition &histPos) const
	Make a string with pixel and world coordinates of display axes. More...

Private Attributes
casacore::LogIO	os_p

const casacore::ImageInterface < T > *	pInImage_p

Additional Inherited Members
Protected Member Functions inherited from casacore::LatticeHistograms< T >
IPosition	locHistInLattice (const IPosition &histPosition, Bool relativeToParent=True) const
	Given a location in the histogram storage lattice, convert those locations on the non-histogram axis (the first one) relative to the parent or current lattice. More...

Protected Attributes inherited from casacore::LatticeHistograms< T >
LogIO	os_p
	These things are protected only so that they are available to ImageHistograms which inherits from LatticeHistograms. More...

Bool	goodParameterStatus_p

Vector< Int >	cursorAxes_p

Vector< Int >	displayAxes_p

String	error_p

Detailed Description

template<class T>
class casa::ImageHistograms< T >

Displays histograms of regions from an image.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

ImageInterface
LatticeHistograms

Etymology

This is a class designed to display histograms from images

Synopsis

This class enable you to display and/or retrieve histograms 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 histograms are displayed as a function of location of the axes not used to evaluate the histograms over. The axes which you evaluate the histograms over are called the cursor axes, the others are called the display axwes.

For example, consider an image cube (call the axes xyz or [0,1,2]). You could display histograms from xy planes (cursor axes [0,1]) as a function of z (display axes [2]). Or you could retrieve histograms from the z axis (cursor axes [2]) for each [x,y] location (display axes [0,1]).

The hard work is done by casacore::LatticeHistograms which this class (clumsily) inherits. It generates a "storage lattice" into which it writes the histograms. It is from this storage image that the plotting and retrieval arrays are drawn. The storage image is either in core or on disk depending upon its size (if > 10% of memory given by.aipsrc system.resources.memory then it goes into a disk-based casacore::PagedArray). If on disk, the storage image is deleted when the ImageHistograms object destructs.

See casacore::LatticeHistograms for most of the useful public interface. ImageHistograms exists only so that it can write some world coordinate information to the plots and logger.

Tip: Note that for complex images, real and imaginary are treated independently; They are binned and plotted separately;

Tip: If you ignore return error statuses from the functions that set the state of the class, the internal status of the class is set to bad; This means it will just keep on returning error conditions until you explicitly recover the situation; A message describing the last error condition can be recovered with function errorMessage;

Example

// Construct casacore::PagedImage from file name
 
 casacore::PagedImage<casacore::Float> inImage(inName);
 
// Construct histogram object
 
 casacore::LogOrigin or("myClass", "myFunction(...)", WHERE);
 casacore::LogIO os(or);
 ImageHistograms<casacore::Float> histo(inImage, os);
 
// Set cursor axes to see statistics of yz planes (0 relative)
 
 casacore::Vector<casacore::Int> cursorAxes(2)
 cursorAxes(0) = 1;
 cursorAxes(1) = 2;
 if (!histo.setAxes(cursorAxes)) return 1;
 
// Set to list and plot mean, sigma and rms
 
 if (!histo.setList(true)) return 1;
 casacore::String device = "/xs";
 casacore::Vector<casacore::Int> nxy(2);
 nxy(0) = 3;
 nxy(1) = 3;
 if (!histo.setPlotting(device, nxy)) return 1;
 
// Now activate actual listing and plotting
 
 if (!histo.display ()) return 1;
 
// Retrieve histograms into array
 
 casacore::Array<casacore::Float> values, counts;
 if (!histo.getHistograms(values, counts)) return 1;

In this example, a casacore::PagedImage is constructed. We set the cursor axes to be the y and z axes so we make a histogram of each yz plane as a function of x location on the device "/xs" (no longer supported) with 9 subplots per page. After the plotting we also retrieve the histograms into an array.

Motivation

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

To Do

Make ascii listing of histograms as well as plots if desired

Definition at line 163 of file ImageHistograms.h.

Constructor & Destructor Documentation

template<class T>

casa::ImageHistograms< T >::ImageHistograms	(	const casacore::ImageInterface< T > &	image,
		casacore::LogIO &	os,
		casacore::Bool	showProgress = `true`,
		casacore::Bool	forceDisk = `false`
	)

Constructor takes the image and a casacore::LogIO object for logging.

You can also 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>

casa::ImageHistograms< T >::ImageHistograms	(	const casacore::ImageInterface< T > &	image,
		casacore::Bool	showProgress = `true`,
		casacore::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 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>

casa::ImageHistograms< T >::ImageHistograms ( const ImageHistograms< T > & other )

Copy constructor (copy semantics)

template<class T>

virtual casa::ImageHistograms< T >::~ImageHistograms ( )

virtual

Destructor.

Member Function Documentation

template<class T>

ImageHistograms<T>& casa::ImageHistograms< T >::operator= ( const ImageHistograms< T > & other )

Assignment operator (copy semantics)

template<class T>

casacore::Bool casa::ImageHistograms< T >::setNewImage ( const casacore::ImageInterface< T > & image )

Set a new image.

A return value of false indicates the image had an invalid type or that the internal status of the class is bad.

template<class T>

virtual casacore::String casa::ImageHistograms< T >::writeCoordinates ( const casacore::IPosition & histPos ) const

privatevirtual

Make a string with pixel and world coordinates of display axes.

Reimplemented from casacore::LatticeHistograms< T >.

Member Data Documentation

template<class T>

casacore::LogIO casa::ImageHistograms< T >::os_p

private

Definition at line 198 of file ImageHistograms.h.

template<class T>

const casacore::ImageInterface<T>* casa::ImageHistograms< T >::pInImage_p

private

Definition at line 199 of file ImageHistograms.h.

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

casa/code/imageanalysis/ImageAnalysis/ImageHistograms.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageHistograms< T >

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ImageHistograms< T >