casa::WFCleanImageSkyModel Class Reference

WF Image Sky Model: Image Sky Model implementing the WF Clean algorithm. More...

#include <WFCleanImageSkyModel.h>

Inheritance diagram for casa::WFCleanImageSkyModel:

Public Member Functions
	WFCleanImageSkyModel ()
virtual	~WFCleanImageSkyModel ()
	WFCleanImageSkyModel (const Int nfacets, Bool largeMemory=False)
virtual Int	add (ImageInterface< Float > &image, const Int maxNumXfr=100)
	Add an image.
virtual Bool	addResidual (Int image, ImageInterface< Float > &residual)
	Add a residual image.
virtual Bool	addMask (Int image, ImageInterface< Float > &mask)
	Add an mask.
virtual Bool	solve (SkyEquation &me)
	Solve for this SkyModel.
virtual ImageInterface< Float > &	getResidual (Int physImageID)
	This will return for model 0 the main residual image i.e nxn facets.
Protected Member Functions
SubImage< Float > *	makeFacet (Int facet, ImageInterface< Float > &image)
	void makeApproxPSFs(SkyEquation& se);
Bool	makeSlicers (const Int facet, const IPosition &imageShape, IPosition &facetShape, Slicer &imageSlicer)
	Make the slicers.
Protected Attributes
Int	nfacets_p
	Number of facets.
Private Attributes
CountedPtr< ImageInterface < Float > >	imageImage_p
CountedPtr< ImageInterface < Float > >	residualImage_p
CountedPtr< ImageInterface < Float > >	maskImage_p
Int	facets_p
Bool	largeMem_p
Block< CountedPtr< SubImage < Float > > >	facetImages_p
	Here we store the facets for the various images: Model, Mask and Residual.
Block< CountedPtr< SubImage < Float > > >	facetMaskImages_p
Block< CountedPtr< SubImage < Float > > >	facetResidualImages_p

Detailed Description

WF Image Sky Model: Image Sky Model implementing the WF Clean algorithm.

Intended use:

Public interface

Prerequisite

ImageSkyModel module
MFCleanImageSkyModel module

Etymology

WFCleanImageSkyModel implements the WF Clean algorithm. It is derived from MFCleanImageSkyModel .

Synopsis

The WF Clean is an FFT-based clean algorithm. Cleaning is split into major and minor cycles. In a minor cycle, the brightest pixels are cleaned using only the strongest sidelobes (and main lobe) of the PSF. In the major cycle, a fully correct subtraction of the PSF is done for all points accumulated in the minor cycle using an FFT-based convolution for speed.

The WF Clean is implemented using the MFCleanImageSkyModel class.

Masking is optionally performed using a mask image: only points where the mask is non-zero are cleaned. If no mask is specified all points in the inner quarter of the image are cleaned.

Example

See the example for SkyModel .

Motivation

Definition at line 85 of file WFCleanImageSkyModel.h.

Constructor & Destructor Documentation

casa::WFCleanImageSkyModel::WFCleanImageSkyModel ( )

virtual casa::WFCleanImageSkyModel::~WFCleanImageSkyModel ( ) [virtual]

casa::WFCleanImageSkyModel::WFCleanImageSkyModel	(	const Int	nfacets,
		Bool	largeMemory = `False`
	)

Member Function Documentation

virtual Int casa::WFCleanImageSkyModel::add	(	ImageInterface< Float > &	image,
		const Int	maxNumXfr = `100`
	)			`[virtual]`

Add an image.

maxNumXfr is the maximum Number of transfer functions that we might want to associate with this image.

Reimplemented from casa::MFCleanImageSkyModel.

virtual Bool casa::WFCleanImageSkyModel::addMask	(	Int	image,
		ImageInterface< Float > &	mask
	)			`[virtual]`

Add an mask.

Reimplemented from casa::MFCleanImageSkyModel.

virtual Bool casa::WFCleanImageSkyModel::addResidual	(	Int	image,
		ImageInterface< Float > &	residual
	)			`[virtual]`

Add a residual image.

Reimplemented from casa::MFCleanImageSkyModel.

virtual ImageInterface<Float>& casa::WFCleanImageSkyModel::getResidual ( Int physImageID ) [virtual]

This will return for model 0 the main residual image i.e nxn facets.

Reimplemented from casa::ImageSkyModel.

SubImage<Float>* casa::WFCleanImageSkyModel::makeFacet	(	Int	facet,
		ImageInterface< Float > &	image
	)			`[protected]`

void makeApproxPSFs(SkyEquation& se);

Make a facet

Bool casa::WFCleanImageSkyModel::makeSlicers	(	const Int	facet,
		const IPosition &	imageShape,
		IPosition &	facetShape,
		Slicer &	imageSlicer
	)			`[protected]`