Image Sky Model: Image-based Model for the Sky Brightness. More...

#include <ImageSkyModel.h>

Inheritance diagram for casa::ImageSkyModel:

Public Member Functions
	ImageSkyModel (const Int maxNumModels=1)
	Empty constructor.
void	setMaxNumberModels (const Int maxNumModels)
	ImageSkyModel (const ImageSkyModel &sm)
	Copy constructor.
virtual Bool	add (ComponentList &compList)
	Add a componentlist.
virtual Bool	updatemodel (ComponentList &compList)
	update componentlist
virtual Int	add (ImageInterface< Float > &image, const Int maxNumXfr=100)
	Add an image.
virtual Bool	updatemodel (const Int thismodel, ImageInterface< Float > &image)
	update model image...you have to have added it before...nmodels_p held has to be bigger that image here its left to the caller to make sure the image is conformant...otherwise you are in trouble.
virtual Bool	addResidual (Int image, ImageInterface< Float > &residual)
	Add a residual image.
virtual	~ImageSkyModel ()
	Destructor.
ImageSkyModel &	operator= (const ImageSkyModel &other)
	Assignment operator.
virtual Int	numberOfModels ()
	Number of models contained.
virtual Int	numberOfTaylorTerms ()
	MFS : Number of taylor terms per model.
virtual Bool	calculateCoeffResiduals ()
	MFS : In-place coefficient residual calculations.
virtual Bool	calculateAlphaBeta (const Vector< String > &, const Vector< String > &)
	MFS : Calculate restored alpha and beta.
virtual Double	getReferenceFrequency ()
	MFS : Reference Frequency.
virtual Int	getTaylorIndex (Int index)
	MFS : Index of Taylor term in array of nmodels x ntaylorterms virtual Int getTaylorIndex(Int index){return 0;}.
Bool	isSolveable (Int model=0)
	Is this model solveable?
Bool	free (Int model=0)
	Free and fix the model (returns previous status).
Bool	fix (Int model=0)
virtual void	initializeGradients ()
	Initialize for gradient search.
virtual void	finalizeGradients ()
	Finalize for gradient search.
Bool	hasComponentList ()
	Does this have a component list?
Bool	isEmpty (Int model=0)
	Is this model empty.
virtual ComponentList &	componentList ()
	Return the component list.
ImageInterface< Float > &	image (Int model=0)
	Return actual images to be used by SkyEquation.
ImageInterface< Complex > &	cImage (Int model=0)
	Complex image (needed for e.g.
ImageInterface< Complex > &	XFR (Int model=0, Int numXFR=0)
	Complex XFR.
ImageInterface< Float > &	PSF (Int model=0)
	PSF.
ImageInterface< Float > &	gS (Int model=0)
	Gradient of chi-squared wrt pixels.
ImageInterface< Float > &	residual (Int model=0)
ImageInterface< Float > &	ggS (Int model=0)
	Grad Grad chi-squared wrt pixels (diagonal elements only)
ImageInterface< Float > &	fluxScale (Int model=0)
	if (doFluxScale(mod)) image(mod) * fluxScale(mod) gives actual brightness distribution
ImageInterface< Float > &	work (Int model=0)
	Work image.
ImageInterface< Float > &	deltaImage (Int model=0)
	Increment in the image.
Bool	doFluxScale (Int model=0)
	tells if this model needs to be multiplied by a flux scale image
void	mandateFluxScale (Int model=0)
	require use of flux scale image
Bool	hasXFR (Int model=0)
void	addStatistics (Float sumwt, Float chisq)
	Add to Sum weights, Chi-Squared.
Matrix< Float > &	weight (Int model=0)
	Weight per model (channels, polarizations)
virtual Bool	solve (SkyEquation &me)
	Solve for this SkyModel: This replaces the image with the residual image.
Bool	solveResiduals (SkyEquation &me, Bool modelToMS=False)
	Solve explicitly for the residuals: same as solve for this class modelToMs determines if predicted vis is put in the MODEL_DATA column.
virtual void	makeApproxPSFs (SkyEquation &se)
	Make the approximate PSFs needed for each model.
virtual ImageInterface< Float > &	getResidual (Int model=0)
	Get current residual image: this is either that image specified via addResidual, or a scratch image.
ImageBeamSet &	beam (Int model=0)
	Return the fitted beam for each model.
void	setPGPlotter (PGPlotter &pgp)
	Set PGPlotter to be used.
void	setCycleFactor (float x)
	This is the factor by which you multiply the worst outer sidelobe by to get the threshold for the current cycle.
void	setCycleSpeedup (float x)
	Cycle threshold will double in this number of iterations (ie, use a large number if you don't want cycle threshold to inch up)
void	setCycleMaxPsfFraction (float x)
	Yet another control for the minor cycle threshold.
void	setDisplayProgress (const Bool display)
	Set the variable that switches on the progress display.
void	setDataPolFrame (StokesImageUtil::PolRep datapolrep)
	Set a variable to indicate the polarization frame in the data (circular or linear).
virtual Int	getModelIndex (uInt field, uInt)
Static Public Member Functions
template<class M >
static TempImage< M > *	getTempImage (const TiledShape &imgShp, const CoordinateSystem &imgCoords, const uInt nMouthsToFeed=1)
	Tries to return a pointer to a TempImage (allocated with new, so remember to use delete) with the given shape and CoordinateSystem.
Protected Member Functions
Bool	makeNewtonRaphsonStep (SkyEquation &se, Bool incremental=False, Bool modelToMS=False)
	Make Newton Raphson step internally.
PGPlotter *	getPGPlotter ()
	Get PGPlotter to be used.
LogSink &	logSink ()
Long	cacheSize (Int model)
Protected Attributes
Int	maxnmodels_p
Int	nmodels_p
Int	nfields_p
	MFS.
Int	maxNumXFR_p
Float	sumwt_p
Float	chisq_p
ComponentList *	componentList_p
	ComponentList.
Vector< String >	imageNames_p
	Images.
PtrBlock< ImageInterface < Float > * >	image_p
	Everything here can be just interface.
PtrBlock< ImageInterface < Float > * >	residual_p
PtrBlock< ImageInterface < Complex > * >	cimage_p
	We actually create these.
PtrBlock< ImageInterface < Complex > * >	cxfr_p
PtrBlock< ImageInterface < Float > * >	residualImage_p
PtrBlock< ImageInterface < Float > * >	gS_p
PtrBlock< ImageInterface < Float > * >	psf_p
PtrBlock< ImageInterface < Float > * >	ggS_p
PtrBlock< ImageInterface < Float > * >	fluxScale_p
	if (doFluxScale_p), image_p * fluxScale_p gives the true brightness
PtrBlock< ImageInterface < Float > * >	work_p
PtrBlock< ImageInterface < Float > * >	deltaimage_p
Block< Bool >	solve_p
Block< Bool >	doFluxScale_p
PtrBlock< Matrix< Float > * >	weight_p
PtrBlock< ImageBeamSet * >	beam_p
LogSink	logSink_p
PGPlotter *	pgplotter_p
Bool	displayProgress_p
Float	cycleFactor_p
	This is the factor by which you multiply the worst outer sidelobe by to get the threshold for the current cycle.
Float	cycleSpeedup_p
	Cycle threshold will double in this number of iterations (ie, use a large number if you don't want cycle threshold to inch up)
Float	cycleMaxPsfFraction_p
	Cycle threshold = maxResidual x min(Max-Psf-Fraction , cyclefactor x maxpsfsidelobe)
Bool	donePSF_p
	If PSF is done..should not redo it.
Bool	modified_p
	check if model has been modified especially for continuing a deconvolution
StokesImageUtil::PolRep	dataPolRep_p
	Parameter to indicate the polaraization type of the data (circular or linear) Required by cImage() to decide shapes.
Bool	workDirOnNFS_p

Detailed Description

Image Sky Model: Image-based Model for the Sky Brightness.

Intended use:

Public interface

Prerequisite

SkyModel class
SkyEquation class
ImageInterface class
PagedImage class
MeasurementComponents module
VisSet class

Etymology

ImageSkyModel describes an interface for Models to be used in the SkyEquation. It is derived from SkyModel .

Synopsis

A ImageSkyModel contains a number of separate models. The interface to SkyEquation is via an image per model. SkyEquation uses this image to calculate Fourier transforms, etc. Some (most) SkyModels are solvable: the SkyEquation can be used by the SkyModel to return gradients with respect to itself (via the image interface). Thus for a SkyModel to solve for itself, it calls the SkyEquation methods to get gradients of chi-squared with respect to the image pixel values (thus returning an image: basically a residual image). The SkyModel then uses these gradients as appropriate to update itself.

Example

See the example for SkyModel .

Motivation

The properties of a model of the sky must be described for the SkyEquation .

To Do

Multiple images in SkyModel
ComponentModel

Definition at line 93 of file ImageSkyModel.h.

Constructor & Destructor Documentation

casa::ImageSkyModel::ImageSkyModel ( const Int maxNumModels = 1 )

Empty constructor.

casa::ImageSkyModel::ImageSkyModel ( const ImageSkyModel & sm )

Copy constructor.

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

Destructor.

Member Function Documentation

virtual Bool casa::ImageSkyModel::add ( ComponentList & compList ) [virtual]

Add a componentlist.

Reimplemented in casa::CleanImageSkyModel.

virtual Int casa::ImageSkyModel::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 in casa::CleanImageSkyModel, casa::WFCleanImageSkyModel, casa::MFCleanImageSkyModel, and casa::CSCleanImageSkyModel.

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

Add a residual image.

Reimplemented in casa::WFCleanImageSkyModel, casa::MFCleanImageSkyModel, and casa::CSCleanImageSkyModel.

void casa::ImageSkyModel::addStatistics	(	Float	sumwt,
		Float	chisq
	)		`[inline, virtual]`

Add to Sum weights, Chi-Squared.

virtual Bool casa::ImageSkyModel::calculateAlphaBeta	(	const Vector< String > &	,
		const Vector< String > &
	)		`[inline, virtual]`

virtual Int casa::ImageSkyModel::getModelIndex	(	uInt	field,
		uInt
	)		`[inline, virtual]`

static TempImage<M>* casa::ImageSkyModel::getTempImage	(	const TiledShape &	imgShp,
		const CoordinateSystem &	imgCoords,
		const uInt	nMouthsToFeed = `1`
	)		`[static]`

imgShp
imgCoords
nMouthsToFeed,:	If > 1 it is taken as a hint that it should leave room for nMouthsToFeed - 1 more TempImages.

Bool casa::ImageSkyModel::makeNewtonRaphsonStep	(	SkyEquation &	se,
		Bool	incremental = `False`,
		Bool	modelToMS = `False`
	)		`[protected]`

Bool casa::ImageSkyModel::solveResiduals	(	SkyEquation &	me,
		Bool	modelToMS = `False`
	)

virtual Bool casa::ImageSkyModel::updatemodel	(	const Int	thismodel,
		ImageInterface< Float > &	image
	)		`[virtual]`

ImageInterface<Complex>& casa::ImageSkyModel::XFR	(	Int	model = `0`,
		Int	numXFR = `0`
	)		`[virtual]`

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes