casa::ImagePrimaryBeamCorrector Class Reference

#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 ()
	ImagePrimaryBeamCorrector (const SPCIIF image, const SPCIIF 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 SPCIIF 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
SPIIF	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
void	_checkPBSanity ()
Private Attributes
SPIIF	_pbImage
Float	_cutoff
Mode	_mode
Bool	_useCutoff
Static Private Attributes
static const String	_class

Detailed Description

Definition at line 38 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 66 of file ImagePrimaryBeamCorrector.h.

Constructor & Destructor Documentation

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector ( )

casa::ImagePrimaryBeamCorrector::ImagePrimaryBeamCorrector	(	const SPCIIF	image,
		const SPCIIF	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 SPCIIF	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
	)