casa::ImageHistogramsCalculator Class Reference

This class computes histograms of image pixel values. More...

#include <ImageHistogramsCalculator.h>

Inheritance diagram for casa::ImageHistogramsCalculator:

List of all members.

Public Member Functions
	ImageHistogramsCalculator ()
	ImageHistogramsCalculator (const SPCIIF image, const Record *const &regionPtr, const String &mask)
	ImageHistogramsCalculator (const ImageHistogramsCalculator &other)
	~ImageHistogramsCalculator ()
ImageHistogramsCalculator &	operator= (const ImageHistogramsCalculator &other)
Record	compute () const
String	getClass () const
void	setAxes (const vector< uInt > &axes)
	set cursor axes
void	setCumulative (Bool b)
	should the histogram be cumulative
void	setDisk (Bool b)
	If true, force the storage lattice to be written to disk.
void	setDoLog10 (Bool b)
	If true, the counts should be returned as log10 of the actual counts.
void	setIncludeRange (const vector< double > &r)
	set include range
void	setListStats (Bool b)
	If true list stats to logger.
void	setNBins (uInt n)
	set number of bins
Static Public Attributes
static const String	CLASS_NAME
Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Bool	_supportsMultipleRegions () const
Private Attributes
Bool	_disk
Bool	_cumulative
Bool	_listStats
Bool	_doLog10
vector< uInt >	_axes
uInt	_nbins
vector< double >	_includeRange

---

Detailed Description

This class computes histograms of image pixel values.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

This class computes histograms of image pixel values.

Synopsis

This class computes histograms of image pixel values.

Example

Motivation

users like histograms.

Definition at line 68 of file ImageHistogramsCalculator.h.

---

Constructor & Destructor Documentation

casa::ImageHistogramsCalculator::ImageHistogramsCalculator

(

)

casa::ImageHistogramsCalculator::ImageHistogramsCalculator	(	const SPCIIF	image,
		const Record *const &	regionPtr,
		const String &	mask
	)

casa::ImageHistogramsCalculator::ImageHistogramsCalculator

(

const ImageHistogramsCalculator &

other

)

casa::ImageHistogramsCalculator::~ImageHistogramsCalculator

(

)

---

Member Function Documentation

vector<Coordinate::Type> casa::ImageHistogramsCalculator::_getNecessaryCoordinates

(

)

const [inline, protected, virtual]

Represents the minimum set of coordinates necessary for the task to function.

Implements casa::ImageTask< Float >.

Definition at line 118 of file ImageHistogramsCalculator.h.

CasacRegionManager::StokesControl casa::ImageHistogramsCalculator::_getStokesControl

(

)

const [inline, protected, virtual]

Implements casa::ImageTask< Float >.

Definition at line 114 of file ImageHistogramsCalculator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

Bool casa::ImageHistogramsCalculator::_supportsMultipleRegions

(

)

const [inline, protected, virtual]

Reimplemented from casa::ImageTask< Float >.

Definition at line 122 of file ImageHistogramsCalculator.h.

References casacore::True.

Record casa::ImageHistogramsCalculator::compute

(

)

const

String casa::ImageHistogramsCalculator::getClass

(

)

const [inline, virtual]

Implements casa::ImageTask< Float >.

Definition at line 88 of file ImageHistogramsCalculator.h.

References CLASS_NAME.

ImageHistogramsCalculator& casa::ImageHistogramsCalculator::operator=

(

const ImageHistogramsCalculator &

other

)

void casa::ImageHistogramsCalculator::setAxes

(

const vector< uInt > &

axes

)

[inline]

set cursor axes

Definition at line 91 of file ImageHistogramsCalculator.h.

References _axes.

void casa::ImageHistogramsCalculator::setCumulative

(

Bool

b

)

[inline]

should the histogram be cumulative

Definition at line 94 of file ImageHistogramsCalculator.h.

References _cumulative.

void casa::ImageHistogramsCalculator::setDisk

(

Bool

b

)

[inline]

If true, force the storage lattice to be written to disk.

Definition at line 97 of file ImageHistogramsCalculator.h.

References _disk.

void casa::ImageHistogramsCalculator::setDoLog10

(

Bool

b

)

[inline]

If true, the counts should be returned as log10 of the actual counts.

Definition at line 100 of file ImageHistogramsCalculator.h.

References _doLog10.

void casa::ImageHistogramsCalculator::setIncludeRange

(

const vector< double > &

r

)

[inline]

set include range

Definition at line 103 of file ImageHistogramsCalculator.h.

References _includeRange.

void casa::ImageHistogramsCalculator::setListStats

(

Bool

b

)

[inline]

If true list stats to logger.

Definition at line 106 of file ImageHistogramsCalculator.h.

References _listStats.

void casa::ImageHistogramsCalculator::setNBins

(

uInt

n

)

[inline]

set number of bins

Definition at line 109 of file ImageHistogramsCalculator.h.

References _nbins.

---

Member Data Documentation

vector<uInt> casa::ImageHistogramsCalculator::_axes [private]

Definition at line 129 of file ImageHistogramsCalculator.h.

Referenced by setAxes().

Bool casa::ImageHistogramsCalculator::_cumulative [private]

Definition at line 126 of file ImageHistogramsCalculator.h.

Referenced by setCumulative().

Bool casa::ImageHistogramsCalculator::_disk [private]

Definition at line 125 of file ImageHistogramsCalculator.h.

Referenced by setDisk().

Bool casa::ImageHistogramsCalculator::_doLog10 [private]

Definition at line 128 of file ImageHistogramsCalculator.h.

Referenced by setDoLog10().

vector<double> casa::ImageHistogramsCalculator::_includeRange [private]

Definition at line 131 of file ImageHistogramsCalculator.h.

Referenced by setIncludeRange().

Bool casa::ImageHistogramsCalculator::_listStats [private]

Definition at line 127 of file ImageHistogramsCalculator.h.

Referenced by setListStats().

uInt casa::ImageHistogramsCalculator::_nbins [private]

Definition at line 130 of file ImageHistogramsCalculator.h.

Referenced by setNBins().

const String casa::ImageHistogramsCalculator::CLASS_NAME [static]

Definition at line 71 of file ImageHistogramsCalculator.h.

Referenced by getClass().

---

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

• code/imageanalysis/ImageAnalysis/ImageHistogramsCalculator.h