#include <ImageStatsCalculator.h>

Inheritance diagram for casa::ImageStatsCalculator< T >:

Public Member Functions
	ImageStatsCalculator (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &maskInp, casacore::Bool beVerboseDuringConstruction=false)
	Top level class used for statistics calculations. More...

	~ImageStatsCalculator ()

casacore::Record	calculate ()

void	forceNewStorage ()

casacore::String	getClass () const

void	setAxes (const casacore::Vector< casacore::Int > &axes)

void	setDisk (casacore::Bool d)

void	setIncludePix (const casacore::Vector< T > &inc)
	Set range of pixel values to include in the calculation. More...

void	setExcludePix (const casacore::Vector< T > &exc)
	Set range of pixel values to exclude from the calculation. More...

void	setList (casacore::Bool l)
	casacore::List stats to logger? If you want no logging you should set this to false in addition to calling setVerbosity() More...

void	setRobust (casacore::Bool r)

void	setVerbose (casacore::Bool v)

casacore::Record	statistics (std::vector< casacore::String > *const &messageStore=0)
	moved from ImageAnalysis if messageStore != 0, log messages, stripped of time stampe and priority, will also be placed in this parameter and returned to caller for eg logging to file. More...

Public Member Functions inherited from casa::ImageStatsBase< T >
	ImageStatsBase ()=delete
	This adds configuration methods for statistics classes. More...

	~ImageStatsBase ()

void	configureBiweight (casacore::Int maxIter)

void	configureChauvenet (casacore::Double zscore, casacore::Int maxIterations)

void	configureClassical (ImageStatsData::PreferredClassicalAlgorithm p)

void	configureFitToHalf (casacore::FitToHalfStatisticsData::CENTER centerType, casacore::FitToHalfStatisticsData::USE_DATA useData, casacore::Double centerValue)
	configure fit to half algorithm More...

void	configureHingesFences (casacore::Double f)
	configure hinges-fences algorithm 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 String	SIGMA

Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const

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

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

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

casacore::Bool	_supportsMultipleRegions () const

Protected Member Functions inherited from casa::ImageStatsBase< T >
	ImageStatsBase (const SPCIIT image, const casacore::Record *const &regionPtr, const casacore::String &maskInp, const casacore::String &outname="", casacore::Bool overwrite=false)

casacore::String	_configureAlgorithm ()

std::unique_ptr < casacore::ImageStatistics< T > > &	_getImageStats ()

StatisticsData::ALGORITHM	_getAlgorithm () const

AlgConf	_getAlgConf () const

void	_resetStats (ImageStatistics< T > *stat=nullptr)

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 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

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 Member Functions
void	_logStartup (std::vector< String > *const &messageStore, const String &alg, const casacore::IPosition &blc, const casacore::IPosition &trc, const casacore::String &blcf, const casacore::String trcf) const

void	_reportDetailedStats (const std::shared_ptr< const casacore::ImageInterface< T >> tempIm, const casacore::Record &retval)

template<class U >
void	_removePlanes (Array< U > &arr, uInt axis, const std::set< uInt > &planes) const

void	_sanitizeDueToRegionSelection (Record &retval) const
	remove values for which there were no points, CAS-10183 More...

Static Private Member Functions
static casacore::Bool	_haveRegionsChanged (casacore::ImageRegion newRegion, casacore::ImageRegion newMask, casacore::ImageRegion oldRegion, casacore::ImageRegion oldMask)
	moved from ImageAnalysis See if the combination of the 'region' and 'mask' ImageRegions have changed More...

Private Attributes
casacore::CountedPtr < casacore::ImageRegion >	_oldStatsRegion

casacore::CountedPtr < casacore::ImageRegion >	_oldStatsMask

casacore::Vector< casacore::Int >	_axes

casacore::Vector< T >	_includepix

casacore::Vector< T >	_excludepix

casacore::Bool	_list

casacore::Bool	_disk

casacore::Bool	_robust

casacore::Bool	_verbose

std::shared_ptr< const casacore::SubImage< T > >	_subImage

Static Private Attributes
static const casacore::String	_class

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::ImageStatsCalculator< T >

Definition at line 42 of file ImageStatsCalculator.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageStatsCalculator< T >::ImageStatsCalculator	(	const SPCIIT	image,
		const casacore::Record *const &	regionPtr,
		const casacore::String &	maskInp,
		casacore::Bool	beVerboseDuringConstruction = `false`
	)

Top level class used for statistics calculations.

Etymology

Image statistics calculator

Synopsis

Top level class used for statistics calculations

template<class T >

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

Member Function Documentation

template<class T >

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

inlineprotectedvirtual

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

Implements casa::ImageTask< T >.

Definition at line 122 of file ImageStatsCalculator.h.

template<class T >

std::vector<OutputDestinationChecker::OutputStruct> casa::ImageStatsCalculator< T >::_getOutputStruct ( )

inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 118 of file ImageStatsCalculator.h.

template<class T >

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

inlineprotectedvirtual

Implements casa::ImageTask< T >.

Definition at line 114 of file ImageStatsCalculator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

casacore::Bool casa::ImageStatsCalculator< T >::_hasLogfileSupport ( ) const

inlineprotectedvirtual

by default, derived classes are configured to have no log file support.

Reimplemented from casa::ImageTask< T >.

Definition at line 126 of file ImageStatsCalculator.h.

template<class T >

static casacore::Bool casa::ImageStatsCalculator< T >::_haveRegionsChanged	(	casacore::ImageRegion *	newRegion,
		casacore::ImageRegion *	newMask,
		casacore::ImageRegion *	oldRegion,
		casacore::ImageRegion *	oldMask
	)

staticprivate

moved from ImageAnalysis See if the combination of the 'region' and 'mask' ImageRegions have changed

template<class T >

void casa::ImageStatsCalculator< T >::_logStartup	(	std::vector< String > *const &	messageStore,
		const String &	alg,
		const casacore::IPosition &	blc,
		const casacore::IPosition &	trc,
		const casacore::String &	blcf,
		const casacore::String	trcf
	)		const

private

template<class T >

template<class U >

void casa::ImageStatsCalculator< T >::_removePlanes	(	Array< U > &	arr,
		uInt	axis,
		const std::set< uInt > &	planes
	)		const

private

template<class T >

void casa::ImageStatsCalculator< T >::_reportDetailedStats	(	const std::shared_ptr< const casacore::ImageInterface< T >>	tempIm,
		const casacore::Record &	retval
	)

private

template<class T >

void casa::ImageStatsCalculator< T >::_sanitizeDueToRegionSelection ( Record & retval ) const

private

remove values for which there were no points, CAS-10183

template<class T >

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

inlineprotectedvirtual

Reimplemented from casa::ImageTask< T >.

Definition at line 128 of file ImageStatsCalculator.h.

template<class T >

casacore::Record casa::ImageStatsCalculator< T >::calculate ( )

template<class T >

void casa::ImageStatsCalculator< T >::forceNewStorage ( )

inline

Definition at line 73 of file ImageStatsCalculator.h.

References casa::ImageStatsBase< T >::_resetStats().

template<class T >

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

inlinevirtual

Implements casa::ImageTask< T >.

Definition at line 75 of file ImageStatsCalculator.h.

References casa::ImageStatsCalculator< T >::_class.

template<class T >

void casa::ImageStatsCalculator< T >::setAxes ( const casacore::Vector< casacore::Int > & axes )

inline

Definition at line 77 of file ImageStatsCalculator.h.

References casa::ImageStatsCalculator< T >::_axes, casacore::Vector< T >::assign(), and casacore::GenSort< T >::sort().

template<class T >

void casa::ImageStatsCalculator< T >::setDisk ( casacore::Bool d )

template<class T >

void casa::ImageStatsCalculator< T >::setExcludePix ( const casacore::Vector< T > & exc )

inline

Set range of pixel values to exclude from the calculation.

Should be a two element Vector

Definition at line 91 of file ImageStatsCalculator.h.

References casa::ImageStatsCalculator< T >::_excludepix.

template<class T >

void casa::ImageStatsCalculator< T >::setIncludePix ( const casacore::Vector< T > & inc )

inline

Set range of pixel values to include in the calculation.

Should be a two element Vector

Definition at line 85 of file ImageStatsCalculator.h.

References casa::ImageStatsCalculator< T >::_includepix.

template<class T >

void casa::ImageStatsCalculator< T >::setList ( casacore::Bool l )

inline

casacore::List stats to logger? If you want no logging you should set this to false in addition to calling setVerbosity()

Definition at line 97 of file ImageStatsCalculator.h.

References casa::ImageStatsCalculator< T >::_list.

template<class T >

void casa::ImageStatsCalculator< T >::setRobust ( casacore::Bool r )

template<class T >

void casa::ImageStatsCalculator< T >::setVerbose ( casacore::Bool v )

template<class T >

casacore::Record casa::ImageStatsCalculator< T >::statistics ( std::vector< casacore::String > *const & messageStore = 0 )

moved from ImageAnalysis if messageStore != 0, log messages, stripped of time stampe and priority, will also be placed in this parameter and returned to caller for eg logging to file.