#include <ImagePrimaryBeamCorrector.h>

Inheritance diagram for casa::ImagePrimaryBeamCorrector:

Public Types
enum	Mode { MULTIPLY, DIVIDE }
	Top level interface for primary beam correction. More...
Public Member Functions
	ImagePrimaryBeamCorrector (const ImageInterface< Float > const &image, const ImageInterface< Float > const &pbImage, const Record *const &regionPtr, const String &region, const String &box, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite, const Float cutoff, const Bool useCutoff, const Mode mode)
	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 Only one of `regionPtr` or `region<src> should be specified.`
	ImagePrimaryBeamCorrector (const ImageInterface< Float > const &image, const Array< Float > &pbArray, const Record const &regionPtr, const String &region, const String &box, const String &chanInp, const String &stokes, const String &maskInp, const String &outname, const Bool overwrite, const Float cutoff, const Bool useCutoff, const Mode mode)
	~ImagePrimaryBeamCorrector ()
	destructor
ImageInterface< Float > *	correct (const Bool wantReturn) const
	perform the correction.
String	getClass () const
Protected Member Functions
vector< Coordinate::Type >	_getNecessaryCoordinates () const
	Represents the minimum set of coordinates necessary for the task to function.
CasacRegionManager::StokesControl	_getStokesControl () const
Private Member Functions
	ImagePrimaryBeamCorrector ()
void	_checkPBSanity ()
Private Attributes
std::auto_ptr< ImageInterface < Float > >	_pbImage
Float	_cutoff
Mode	_mode
Bool	_useCutoff
Static Private Attributes
static const String	_class

Detailed Description

Definition at line 40 of file ImagePrimaryBeamCorrector.h.

Member Enumeration Documentation

enum casa::ImagePrimaryBeamCorrector::Mode

Top level interface for primary beam correction.

Etymology

Collapses image.

Synopsis

High level interface for primary beam correction.

Example

            ImagePrimaryBeamCorrector corrector(...);
            corrector.correct();

Enumerator:

MULTIPLY
DIVIDE

Definition at line 68 of file ImagePrimaryBeamCorrector.h.

Constructor & Destructor Documentation

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector	(	const ImageInterface< Float > *const &	image,
		const ImageInterface< Float > *const &	pbImage,
		const Record *const &	regionPtr,
		const String &	region,
		const String &	box,
		const String &	chanInp,
		const String &	stokes,
		const String &	maskInp,
		const String &	outname,
		const Bool	overwrite,
		const Float	cutoff,
		const Bool	useCutoff,
		const Mode	mode
	)

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 Only one of regionPtr or region<src> should be specified.

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector	(	const ImageInterface< Float > *const &	image,
		const Array< Float > &	pbArray,
		const Record *const &	regionPtr,
		const String &	region,
		const String &	box,
		const String &	chanInp,
		const String &	stokes,
		const String &	maskInp,
		const String &	outname,
		const Bool	overwrite,
		const Float	cutoff,
		const Bool	useCutoff,
		const Mode	mode
	)

casa::ImagePrimaryBeamCorrector::~ImagePrimaryBeamCorrector ( )

destructor

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector ( ) [private]

Member Function Documentation

void casa::ImagePrimaryBeamCorrector::_checkPBSanity ( ) [private]

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

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

Implements casa::ImageTask.

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

Implements casa::ImageTask.

ImageInterface<Float>* casa::ImagePrimaryBeamCorrector::correct ( const Bool wantReturn ) const

perform the correction.

If <src>wantReturn is True, return a pointer to the collapsed image. The returned pointer is created via new(); it is the caller's responsibility to delete the returned pointer. If wantReturn is False, a NULL pointer is returned and pointer deletion is performed internally.

String casa::ImagePrimaryBeamCorrector::getClass ( ) const [virtual]

Implements casa::ImageTask.