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

#include <ImageHistogramsCalculator.h>

Inheritance diagram for casa::ImageHistogramsCalculator< T >:

Public Member Functions
	ImageHistogramsCalculator ()=delete

	ImageHistogramsCalculator (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask)

	ImageHistogramsCalculator (const ImageHistogramsCalculator &other)=delete

	~ImageHistogramsCalculator ()

ImageHistogramsCalculator &	operator= (const ImageHistogramsCalculator &other)=delete

casacore::Record	compute () const

casacore::String	getClass () const

void	setAxes (const std::vector< casacore::uInt > &axes)
	set cursor axes More...

void	setCumulative (casacore::Bool b)
	should the histogram be cumulative More...

void	setDisk (casacore::Bool b)
	If true, force the storage lattice to be written to disk. More...

void	setDoLog10 (casacore::Bool b)
	If true, the counts should be returned as log10 of the actual counts. More...

void	setIncludeRange (const std::vector< double > &r)
	set include range More...

void	setListStats (casacore::Bool b)
	If true list stats to logger. More...

void	setNBins (casacore::uInt n)
	set number of bins More...

Public Member Functions inherited from casa::ImageTask< T >
virtual	~ImageTask ()

void	setStretch (const casacore::Bool stretch)

void	setLogfile (const casacore::String &lf)
	tacitly does nothing if `lf` is the empty string. More...

void	setLogfileAppend (const casacore::Bool a)

void	setRegion (const casacore::Record &region)

void	setMask (const casacore::String &mask)

void	setVerbosity (Verbosity verbosity)

void	addHistory (const std::vector< std::pair< casacore::String, casacore::String > > &msgs) const
	These messages will appear in the product image history upon the call to _prepareOutputImage(). More...

void	addHistory (const casacore::LogOrigin &origin, const casacore::String &msg) const

void	addHistory (const casacore::LogOrigin &origin, const std::vector< casacore::String > &msgs) const

void	addHistory (const casacore::LogOrigin &origin, const casacore::String &taskname, const std::vector< casacore::String > &paramNames, const std::vector< casac::variant > &paramValues) const
	This adds standard history messages regarding the task that was run and input parameters used. More...

void	suppressHistoryWriting (casacore::Bool b)
	suppress writing the history on _prepareOutputImage() call. More...

std::vector< std::pair < casacore::String, casacore::String > >	getHistory ()
	get the history associated with the task. More...

void	setDropDegen (casacore::Bool d)

Static Public Attributes
static const casacore::String	CLASS_NAME

Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const

std::vector < casacore::Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function. More...

casacore::Bool	_supportsMultipleRegions () const

Protected Member Functions inherited from casa::ImageTask< T >
	ImageTask (const SPCIIT image, const casacore::String &region, const casacore::Record *const &regionPtr, const casacore::String &box, const casacore::String &chanInp, const casacore::String &stokes, const casacore::String &maskInp, const casacore::String &outname, casacore::Bool overwrite)
	if `outname` is empty, no image will be written if `overwrite` is True, if image already exists it will be removed if `overwrite` is False, if image already exists exception will be thrown More...

	ImageTask (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &mask, const casacore::String &outname, casacore::Bool overwrite)

virtual std::vector < OutputDestinationChecker::OutputStruct >	_getOutputStruct ()

virtual void	_construct (casacore::Bool verbose=true)
	does the lion's share of constructing the object, ie checks validity of inputs, etc. More...

const SPCIIT	_getImage () const

const casacore::String &	_getMask () const

const casacore::Record *	_getRegion () const

void	_setStokes (const casacore::String &stokes)

const casacore::String &	_getStokes () const

const casacore::String &	_getChans () const

const casacore::String &	_getOutname () const

casacore::Bool	_isPVImage () const
	Is the attached image a position-velocity (PV) image? More...

void	_removeExistingOutfileIfNecessary () const

void	_removeExistingFileIfNecessary (const casacore::String &filename, const casacore::Bool overwrite, casacore::Bool warnOnly=false) const
	if warnOnly is true, log a warning message if file exists and overwrite is true, else throw an exception. More...

casacore::String	_summaryHeader () const

const std::shared_ptr < casacore::LogIO >	_getLog () const

virtual casacore::Bool	_hasLogfileSupport () const
	by default, derived classes are configured to have no log file support. More...

casacore::Bool	_getStretch () const

Bool	_getSuppressHistory () const

const std::shared_ptr< LogFile >	_getLogFile () const

casacore::Bool	_writeLogfile (const casacore::String &output, const casacore::Bool open=true, const casacore::Bool close=true)

casacore::Bool	_openLogfile ()

void	_closeLogfile () const

virtual casacore::Bool	_supportsMultipleBeams () const
	does this task support images with multiple beams? false means it never does. More...

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Array< T > const values, const casacore::ArrayLattice< casacore::Bool > const mask=nullptr, const casacore::IPosition const outShape=nullptr, const casacore::CoordinateSystem const coordsys=nullptr, const casacore::String *const outname=nullptr, casacore::Bool overwrite=false, casacore::Bool dropDegen=false) const
	If outname != NULL, use the value supplied. More...

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, casacore::Bool dropDegen=false) const

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::String &outname, casacore::Bool overwrite, casacore::Bool warnOnly) const
	if warnOnly is true, only log a warning message if the file exists and overwrite is true, else throw an excepction More...

SPIIT	_prepareOutputImage (const casacore::ImageInterface< T > &image, const casacore::Lattice< T > &data) const
	data are copied to the output image from the `data` lattice. More...

Verbosity	_getVerbosity () const

casacore::Bool	_getOverwrite () const

virtual casacore::Bool	_mustHaveSquareDirectionPixels () const

casacore::Bool	_getDropDegen () const

template<class U >
void	_doHistory (std::shared_ptr< casacore::ImageInterface< U >> &image) const

void	_reportOldNewImageShapes (const ImageInterface< T > &out) const

void	_reportOldNewImageShapes (const IPosition &outShape) const

Private Attributes
casacore::Bool	_disk

casacore::Bool	_cumulative

casacore::Bool	_listStats

casacore::Bool	_doLog10

std::vector< casacore::uInt >	_axes

casacore::uInt	_nbins

std::vector< double >	_includeRange

Additional Inherited Members
Public Types inherited from casa::ImageTask< T >
enum	Verbosity { QUIET, WHISPER, LOW, NORMAL, HIGH, NOISY, DEAFENING }
	Virtual base class for image analysis tasks. More...

Static Protected Member Functions inherited from casa::ImageTask< T >
static void	_copyMask (casacore::Lattice< casacore::Bool > &mask, const casacore::ImageInterface< T > &image)

static void	_copyData (casacore::Lattice< T > &data, const casacore::Lattice< T > &image)

Detailed Description

template<class T>
class casa::ImageHistogramsCalculator< T >

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

template<class T >

casa::ImageHistogramsCalculator< T >::ImageHistogramsCalculator ( )

delete

template<class T >

casa::ImageHistogramsCalculator< T >::ImageHistogramsCalculator	(	const SPCIIT	image,
		const casacore::Record *const &	regionPtr,
		const casacore::String &	mask
	)

template<class T >

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

delete

template<class T >

casa::ImageHistogramsCalculator< T >::~ImageHistogramsCalculator ( )

Member Function Documentation

template<class T >

std::vector<casacore::Coordinate::Type> casa::ImageHistogramsCalculator< T >::_getNecessaryCoordinates ( ) const

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 119 of file ImageHistogramsCalculator.h.

template<class T >

CasacRegionManager::StokesControl casa::ImageHistogramsCalculator< T >::_getStokesControl ( ) const

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 115 of file ImageHistogramsCalculator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

casacore::Bool casa::ImageHistogramsCalculator< T >::_supportsMultipleRegions ( ) const

inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 123 of file ImageHistogramsCalculator.h.

template<class T >

casacore::Record casa::ImageHistogramsCalculator< T >::compute ( ) const

template<class T >

casacore::String casa::ImageHistogramsCalculator< T >::getClass ( ) const

inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 90 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::CLASS_NAME.

template<class T >

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

delete

template<class T >

void casa::ImageHistogramsCalculator< T >::setAxes ( const std::vector< casacore::uInt > & axes )

inline

set cursor axes

Definition at line 93 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_axes.

template<class T >

void casa::ImageHistogramsCalculator< T >::setCumulative ( casacore::Bool b )

inline

should the histogram be cumulative

Definition at line 96 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_cumulative.

template<class T >

void casa::ImageHistogramsCalculator< T >::setDisk ( casacore::Bool b )

inline

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

Definition at line 99 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_disk.

template<class T >

void casa::ImageHistogramsCalculator< T >::setDoLog10 ( casacore::Bool b )

inline

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

Definition at line 102 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_doLog10.

template<class T >

void casa::ImageHistogramsCalculator< T >::setIncludeRange ( const std::vector< double > & r )

inline

set include range

Definition at line 105 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_includeRange.

template<class T >

void casa::ImageHistogramsCalculator< T >::setListStats ( casacore::Bool b )

inline

If true list stats to logger.

Definition at line 108 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_listStats.

template<class T >

void casa::ImageHistogramsCalculator< T >::setNBins ( casacore::uInt n )

inline

set number of bins

Definition at line 111 of file ImageHistogramsCalculator.h.

References casa::ImageHistogramsCalculator< T >::_nbins.

Member Data Documentation

template<class T >

std::vector<casacore::uInt> casa::ImageHistogramsCalculator< T >::_axes

private

Definition at line 130 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setAxes().

template<class T >

casacore::Bool casa::ImageHistogramsCalculator< T >::_cumulative

private

Definition at line 127 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setCumulative().

template<class T >

casacore::Bool casa::ImageHistogramsCalculator< T >::_disk

private

Definition at line 126 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setDisk().

template<class T >

casacore::Bool casa::ImageHistogramsCalculator< T >::_doLog10

private

Definition at line 129 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setDoLog10().

template<class T >

std::vector<double> casa::ImageHistogramsCalculator< T >::_includeRange

private

Definition at line 132 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setIncludeRange().

template<class T >

casacore::Bool casa::ImageHistogramsCalculator< T >::_listStats

private

Definition at line 128 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setListStats().

template<class T >

casacore::uInt casa::ImageHistogramsCalculator< T >::_nbins

private

Definition at line 131 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::setNBins().

template<class T >

const casacore::String casa::ImageHistogramsCalculator< T >::CLASS_NAME

static

Definition at line 71 of file ImageHistogramsCalculator.h.

Referenced by casa::ImageHistogramsCalculator< T >::getClass().

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

casa/code/imageanalysis/ImageAnalysis/ImageHistogramsCalculator.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casa::ImageHistogramsCalculator< T >

Intended use:

Review Status

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class casa::ImageHistogramsCalculator< T >