casa::ImageCollapserData Class Reference

#include <ImageCollapserData.h>

Public Types
enum	AggregateType {   MAX,   MEAN,   MEDIAN,   MIN,   NPTS,   RMS,   STDDEV,   SUM,   VARIANCE,   ZERO,   FLUX,   SQRTSUM,   SQRTSUM_NPIX,   SQRTSUM_NPIX_BEAM,   MADM,   XMADM,   UNKNOWN }
	Non-templated data related bits for ImageCollapser. More...

Public Member Functions
	ImageCollapserData ()=delete
	ImageCollapserData (const ImageCollapserData &)=delete
ImageCollapserData	operator= (const ImageCollapserData &) const =delete
	~ImageCollapserData ()
	destructor More...

Static Public Member Functions
static AggregateType	aggregateType (const casacore::String &aggString)
static std::shared_ptr< const std::set< AggregateType > >	aggTypesSupportedDegenAxes ()
static std::shared_ptr< const std::map< casacore::uInt, casacore::String > >	funcNameMap ()
static std::shared_ptr< const std::map< casacore::uInt, casacore::String > >	minMatchMap ()

Static Private Attributes
static std::shared_ptr < std::map< casacore::uInt, casacore::String > >	_funcNameMap
static std::shared_ptr < std::map< casacore::uInt, casacore::String > >	_minMatchMap
static std::shared_ptr < std::set< AggregateType > >	_degenAxesSupported

Detailed Description

Definition at line 16 of file ImageCollapserData.h.

Member Enumeration Documentation

enum casa::ImageCollapserData::AggregateType

Non-templated data related bits for ImageCollapser.

Etymology

casacore::Data for ImageCollapser.

Synopsis

Example

Enumerator
MAX
MEAN
MEDIAN
MIN
NPTS
RMS
STDDEV
SUM
VARIANCE
ZERO	set all pixels in output image to 0
FLUX
SQRTSUM	SQRTSUM and MEANSQRT are bizarre statistics, but ImageAnalysis::getFreqProfile() supported this for the GUI profiler, so sadly, we must support them here. I actually suspect the intent was for the sums in these to be the sum of the squares, at least that's what the comments in ImageAnalysis::getFreqProfile() seemed to imply, but they were implemented as straight sums, so I followed the implementation because there is no design or requirements doc to draw from. What a surprise. the square root of the sum, sqrt(sum)
SQRTSUM_NPIX	the square root of the sum divided by the number of pixels, sqrt(sum)/npix
SQRTSUM_NPIX_BEAM	the square root of the sum divided by the number of pixels per beam, sqrt(sum)/(beam_area/pixel_area) Yes that's how it was implemented in ImageAnalysis::getFreqProfile().
MADM	median absolute devation from mean
XMADM	madm * 1/Phi^-1
UNKNOWN

Definition at line 42 of file ImageCollapserData.h.

Constructor & Destructor Documentation

casa::ImageCollapserData::ImageCollapserData ( )

delete

casa::ImageCollapserData::ImageCollapserData ( const ImageCollapserData &  )

delete

casa::ImageCollapserData::~ImageCollapserData ( )

inline

destructor

Definition at line 83 of file ImageCollapserData.h.

Member Function Documentation

static AggregateType casa::ImageCollapserData::aggregateType ( const casacore::String &  aggString )

static

static std::shared_ptr<const std::set<AggregateType> > casa::ImageCollapserData::aggTypesSupportedDegenAxes ( )

static

static std::shared_ptr<const std::map<casacore::uInt, casacore::String> > casa::ImageCollapserData::funcNameMap ( )

static

static std::shared_ptr<const std::map<casacore::uInt, casacore::String> > casa::ImageCollapserData::minMatchMap ( )

static

ImageCollapserData casa::ImageCollapserData::operator= ( const ImageCollapserData &  ) const

delete

Member Data Documentation

std::shared_ptr<std::set<AggregateType> > casa::ImageCollapserData::_degenAxesSupported

staticprivate

Definition at line 97 of file ImageCollapserData.h.

std::shared_ptr<std::map<casacore::uInt, casacore::String> > casa::ImageCollapserData::_funcNameMap

staticprivate

Definition at line 95 of file ImageCollapserData.h.

std::shared_ptr<std::map<casacore::uInt, casacore::String> > casa::ImageCollapserData::_minMatchMap

staticprivate

Definition at line 95 of file ImageCollapserData.h.

---

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

• casa/code/imageanalysis/ImageAnalysis/ImageCollapserData.h