casa::ImageCollapser< T > Class Template Reference

#include <ImageCollapser.h>

Inheritance diagram for casa::ImageCollapser< T >:

List of all members.

Public Member Functions
	ImageCollapser (const String &aggString, SPCIIT image, const Record *const regionRec, const String &maskInp, const IPosition &axes, Bool invertAxesSelection, const String &outname, Bool overwrite)
	Top level interface which allows collapsing of images along a single axis. An aggregate method (average, sum, etc) is applied to the collapsed pixels.
	ImageCollapser (const SPCIIT image, const IPosition &axes, Bool invertAxesSelection, const ImageCollapserData::AggregateType aggregateType, const String &outname, Bool overwrite)
	~ImageCollapser ()
SPIIT	collapse () const
	perform the collapse and return the resulting image.
String	getClass () const
Static Public Member Functions
static const map< uInt, T(*	funcMap ())(const Array< T > &)> *
Protected Member Functions
CasacRegionManager::StokesControl	_getStokesControl () const
std::vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
Bool	_supportsMultipleRegions () const
Private Member Functions
	ImageCollapser ()
	disallow default constructor
void	_invert ()
void	_finishConstruction ()
void	_doMedian (SPCIIT image, TempImage< T > &outImage) const
	necessary to improve performance
void	_attachOutputMask (TempImage< T > &outImage, const Array< Bool > &outMask) const
Static Private Member Functions
static void	_zeroNegatives (Array< T > &arr)
static const map< uInt, T(*	_getFuncMap ())(const Array< T > &)> &
Private Attributes
Bool	_invertAxesSelection
IPosition	_axes
ImageCollapserData::AggregateType	_aggType
Static Private Attributes
static map< uInt, T(*)(const Array< T > &)>	_funcMap

---

Detailed Description

template<class T>
class casa::ImageCollapser< T >

Definition at line 15 of file ImageCollapser.h.

---

Constructor & Destructor Documentation

template<class T >

casa::ImageCollapser< T >::ImageCollapser	(	const String &	aggString,
		SPCIIT	image,
		const Record *const	regionRec,
		const String &	maskInp,
		const IPosition &	axes,
		Bool	invertAxesSelection,
		const String &	outname,
		Bool	overwrite
	)

Top level interface which allows collapsing of images along a single axis. An aggregate method (average, sum, etc) is applied to the collapsed pixels.

Etymology

Collapses image.

Synopsis

High level interface for collapsing an image along a single axis.

Example

 ImageCollapser collapser(...);
 collapser.collapse();

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

template<class T >

casa::ImageCollapser< T >::ImageCollapser	(	const SPCIIT	image,
		const IPosition &	axes,
		Bool	invertAxesSelection,
		const ImageCollapserData::AggregateType	aggregateType,
		const String &	outname,
		Bool	overwrite
	)

template<class T >

casa::ImageCollapser< T >::~ImageCollapser

(

)

[inline]

Definition at line 66 of file ImageCollapser.h.

template<class T >

casa::ImageCollapser< T >::ImageCollapser

(

)

[private]

disallow default constructor

---

Member Function Documentation

template<class T >

void casa::ImageCollapser< T >::_attachOutputMask	(	TempImage< T > &	outImage,
		const Array< Bool > &	outMask
	)			const [private]

template<class T >

void casa::ImageCollapser< T >::_doMedian	(	SPCIIT	image,
		TempImage< T > &	outImage
	)			const [private]

necessary to improve performance

template<class T >

void casa::ImageCollapser< T >::_finishConstruction

(

)

[private]

template<class T >

static const map<uInt, T (* casa::ImageCollapser< T >::_getFuncMap

(

)

const [static, private]

template<class T >

std::vector<Coordinate::Type> casa::ImageCollapser< T >::_getNecessaryCoordinates

(

)

const [inline, protected, virtual]

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

Implements casa::ImageTask< T >.

Definition at line 80 of file ImageCollapser.h.

template<class T >

CasacRegionManager::StokesControl casa::ImageCollapser< T >::_getStokesControl

(

)

const [inline, protected, virtual]

Implements casa::ImageTask< T >.

Definition at line 76 of file ImageCollapser.h.

References casa::CasacRegionManager::USE_ALL_STOKES.

template<class T >

void casa::ImageCollapser< T >::_invert

(

)

[private]

template<class T >

Bool casa::ImageCollapser< T >::_supportsMultipleRegions

(

)

const [inline, protected, virtual]

Reimplemented from casa::ImageTask< T >.

Definition at line 84 of file ImageCollapser.h.

References casacore::True.

template<class T >

static void casa::ImageCollapser< T >::_zeroNegatives

(

Array< T > &

arr

)

[static, private]

template<class T >

SPIIT casa::ImageCollapser< T >::collapse

(

)

const

perform the collapse and return the resulting image.

template<class T >

static const map<uInt, T (* casa::ImageCollapser< T >::funcMap

(

)

const [static]

template<class T >

String casa::ImageCollapser< T >::getClass

(

)

const [inline, virtual]

Implements casa::ImageTask< T >.

Definition at line 73 of file ImageCollapser.h.

References casa::name(), and String.

---

Member Data Documentation

template<class T >

ImageCollapserData::AggregateType casa::ImageCollapser< T >::_aggType [private]

Definition at line 89 of file ImageCollapser.h.

template<class T >

IPosition casa::ImageCollapser< T >::_axes [private]

Definition at line 88 of file ImageCollapser.h.

template<class T >

map<uInt, T (*)(const Array<T>&)> casa::ImageCollapser< T >::_funcMap [static, private]

Definition at line 91 of file ImageCollapser.h.

template<class T >

Bool casa::ImageCollapser< T >::_invertAxesSelection [private]

Definition at line 87 of file ImageCollapser.h.

---

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

• code/imageanalysis/ImageAnalysis/ImageCollapser.h