casa::ImageStatsCalculator Class Reference

#include <ImageStatsCalculator.h>

Inheritance diagram for casa::ImageStatsCalculator:

Public Types
enum	PreferredClassicalAlgorithm { TILED_APPLY, STATS_FRAMEWORK, AUTO }
	Top level class used for statistics calculations. More...
Public Member Functions
	ImageStatsCalculator (const SPCIIF image, const Record *const &regionPtr, const String &maskInp, Bool beVerboseDuringConstruction=False)
	~ImageStatsCalculator ()
Record	calculate ()
void	configureChauvenet (Double zscore, Int maxIterations)
void	configureClassical (PreferredClassicalAlgorithm p)
void	configureFitToHalf (FitToHalfStatisticsData::CENTER centerType, FitToHalfStatisticsData::USE_DATA useData, Double centerValue)
	configure fit to half algorithm
void	configureHingesFences (Double f)
	configure hinges-fences algorithm
void	forceNewStorage ()
String	getClass () const
void	setAxes (const Vector< Int > &axes)
void	setDisk (Bool d)
void	setIncludePix (const Vector< Float > &inc)
	Set range of pixel values to include in the calculation.
void	setExcludePix (const Vector< Float > &exc)
	Set range of pixel values to exclude from the calculation.
void	setList (Bool l)
	List stats to logger? If you want no logging you should set this to False in addition to calling setVerbosity().
void	setRobust (Bool r)
void	setVerbose (Bool v)
Record	statistics (vector< 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.
Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
vector < OutputDestinationChecker::OutputStruct >	_getOutputStruct ()
vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Bool	_hasLogfileSupport () const
	by default, derived classes are configured to have no log file support.
Bool	_supportsMultipleRegions () const
Private Member Functions
String	_configureAlgorithm ()
void	_reportDetailedStats (const SHARED_PTR< const ImageInterface< Float > > tempIm, const Record &retval)
Static Private Member Functions
static Bool	_haveRegionsChanged (ImageRegion pNewRegionRegion, ImageRegion pNewMaskRegion, ImageRegion pOldRegionRegion, ImageRegion pOldMaskRegion)
	moved from ImageAnalysis See if the combination of the 'region' and 'mask' ImageRegions have changed
Private Attributes
std::unique_ptr < ImageStatistics< Float > >	_statistics
CountedPtr< ImageRegion >	_oldStatsRegion
CountedPtr< ImageRegion >	_oldStatsMask
Vector< Int >	_axes
Vector< Float >	_includepix
Vector< Float >	_excludepix
Bool	_list
Bool	_disk
Bool	_robust
Bool	_verbose
LatticeStatistics< Float >::AlgConf	_algConf
SHARED_PTR< const SubImage < Float > >	_subImage
PreferredClassicalAlgorithm	_prefClassStatsAlg
Static Private Attributes
static const String	_class

Detailed Description

Definition at line 43 of file ImageStatsCalculator.h.

Member Enumeration Documentation

enum casa::ImageStatsCalculator::PreferredClassicalAlgorithm

Top level class used for statistics calculations.

Etymology

Image statistics calculator

Synopsis

Top level class used for statistics calculations

Enumerator:

TILED_APPLY	old algorithm
STATS_FRAMEWORK	new algorithm
AUTO	decide based on size and number of steps needed for stats

Definition at line 64 of file ImageStatsCalculator.h.

Constructor & Destructor Documentation

casa::ImageStatsCalculator::ImageStatsCalculator	(	const SPCIIF	image,
		const Record *const &	regionPtr,
		const String &	maskInp,
		Bool	beVerboseDuringConstruction = `False`
	)

casa::ImageStatsCalculator::~ImageStatsCalculator ( )

Member Function Documentation

String casa::ImageStatsCalculator::_configureAlgorithm ( ) [private]

vector<Coordinate::Type> casa::ImageStatsCalculator::_getNecessaryCoordinates ( ) const [inline, protected, virtual]

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

Implements casa::ImageTask< Float >.

Definition at line 141 of file ImageStatsCalculator.h.

vector<OutputDestinationChecker::OutputStruct> casa::ImageStatsCalculator::_getOutputStruct ( ) [inline, protected, virtual]

Reimplemented from casa::ImageTask< Float >.

Definition at line 137 of file ImageStatsCalculator.h.

CasacRegionManager::StokesControl casa::ImageStatsCalculator::_getStokesControl ( ) const [inline, protected, virtual]

Implements casa::ImageTask< Float >.

Definition at line 133 of file ImageStatsCalculator.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

Bool casa::ImageStatsCalculator::_hasLogfileSupport ( ) const [inline, protected, virtual]

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

Reimplemented from casa::ImageTask< Float >.

Definition at line 145 of file ImageStatsCalculator.h.

References casacore::True.

static Bool casa::ImageStatsCalculator::_haveRegionsChanged	(	ImageRegion *	pNewRegionRegion,
		ImageRegion *	pNewMaskRegion,
		ImageRegion *	pOldRegionRegion,
		ImageRegion *	pOldMaskRegion
	)			`[static, private]`

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

void casa::ImageStatsCalculator::_reportDetailedStats	(	const SHARED_PTR< const ImageInterface< Float > >	tempIm,
		const Record &	retval
	)			`[private]`

Bool casa::ImageStatsCalculator::_supportsMultipleRegions ( ) const [inline, protected, virtual]

Reimplemented from casa::ImageTask< Float >.

Definition at line 147 of file ImageStatsCalculator.h.

References casacore::True.

Record casa::ImageStatsCalculator::calculate ( )

void casa::ImageStatsCalculator::configureChauvenet	(	Double	zscore,
		Int	maxIterations
	)

void casa::ImageStatsCalculator::configureClassical ( PreferredClassicalAlgorithm p )

void casa::ImageStatsCalculator::configureFitToHalf	(	FitToHalfStatisticsData::CENTER	centerType,
		FitToHalfStatisticsData::USE_DATA	useData,
		Double	centerValue
	)

configure fit to half algorithm

void casa::ImageStatsCalculator::configureHingesFences ( Double f )

configure hinges-fences algorithm

void casa::ImageStatsCalculator::forceNewStorage ( ) [inline]

Definition at line 98 of file ImageStatsCalculator.h.

References _statistics.

String casa::ImageStatsCalculator::getClass ( ) const [inline, virtual]

Implements casa::ImageTask< Float >.

Definition at line 100 of file ImageStatsCalculator.h.

References _class.

void casa::ImageStatsCalculator::setAxes ( const Vector< Int > & axes ) [inline]

Definition at line 102 of file ImageStatsCalculator.h.

References _axes.

void casa::ImageStatsCalculator::setDisk ( Bool d )

void casa::ImageStatsCalculator::setExcludePix ( const Vector< Float > & exc ) [inline]

Set range of pixel values to exclude from the calculation.

Should be a two element Vector

Definition at line 114 of file ImageStatsCalculator.h.

References _excludepix.

void casa::ImageStatsCalculator::setIncludePix ( const Vector< Float > & inc ) [inline]

Set range of pixel values to include in the calculation.

Should be a two element Vector

Definition at line 110 of file ImageStatsCalculator.h.

References _includepix.

void casa::ImageStatsCalculator::setList ( Bool l ) [inline]

List stats to logger? If you want no logging you should set this to False in addition to calling setVerbosity().

Definition at line 118 of file ImageStatsCalculator.h.

References _list.

void casa::ImageStatsCalculator::setRobust ( Bool r )

void casa::ImageStatsCalculator::setVerbose ( Bool v )

Record casa::ImageStatsCalculator::statistics ( vector< 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.