casa::CEMemImageSkyModel Class Reference

Image Sky Model for the Cornwell-Evens maximum entropy algorithm. More...

#include <CEMemImageSkyModel.h>

Inheritance diagram for casa::CEMemImageSkyModel:

List of all members.

Public Member Functions
	CEMemImageSkyModel (Float sigma, Float targetFlux, Bool constrainFlux, const Vector< String > &priors, const String &entropy)
	constructor
	~CEMemImageSkyModel ()
	destructor
virtual Bool	solve (SkyEquation &me)
	Solve for this SkyModel.
void	setSigma (const Float targetSigma)
	Set control parameters which are different from Clean:
void	setTargetFlux (const Float targetFlux)
void	setConstrainTargetFlux (const Bool constrainFlux)
void	setPrior (const Vector< String > &prior)
void	setEntropy (const String &ent)
Float	sigma ()
	Get the various control parameters which are different from Clean:
Float	targetFlux ()
Bool	constrainFlux ()
Vector< String >	prior ()
String	entropy ()
Protected Member Functions
Bool	initializeModel ()
Protected Attributes
Float	itsSigma
Float	itsTargetFlux
Bool	itsConstrainFlux
Vector< String >	itsPrior
String	itsEntropy
Bool	itsInitializeModel
CEMemProgress *	itsProgress

---

Detailed Description

Image Sky Model for the Cornwell-Evens maximum entropy algorithm.

Intended use:

Public interface

Prerequisite

• ImageSkyModel class
• CEMemModel class

Etymology

CEMemImageSkyModel implements the Cornwell-Evens MEM algorithm. It is derived from CleanImageSkyModel .

Synopsis

We need to add more stuff here.

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 CleanImageSkyModel .

Motivation

Definition at line 79 of file CEMemImageSkyModel.h.

---

Constructor & Destructor Documentation

casa::CEMemImageSkyModel::CEMemImageSkyModel	(	Float	sigma,
		Float	targetFlux,
		Bool	constrainFlux,
		const Vector< String > &	priors,
		const String &	entropy
	)

constructor

casa::CEMemImageSkyModel::~CEMemImageSkyModel

(

)

destructor

---

Member Function Documentation

Bool casa::CEMemImageSkyModel::constrainFlux

(

)

[inline]

Definition at line 108 of file CEMemImageSkyModel.h.

References itsConstrainFlux.

Referenced by setConstrainTargetFlux().

String casa::CEMemImageSkyModel::entropy

(

)

[inline]

Definition at line 110 of file CEMemImageSkyModel.h.

References itsEntropy.

Bool casa::CEMemImageSkyModel::initializeModel

(

)

[inline, protected]

Definition at line 115 of file CEMemImageSkyModel.h.

References itsInitializeModel.

Vector<String> casa::CEMemImageSkyModel::prior

(

)

[inline]

Definition at line 109 of file CEMemImageSkyModel.h.

References itsPrior.

Referenced by setPrior().

void casa::CEMemImageSkyModel::setConstrainTargetFlux

(

const Bool

constrainFlux

)

[inline]

Definition at line 99 of file CEMemImageSkyModel.h.

References constrainFlux(), and itsConstrainFlux.

void casa::CEMemImageSkyModel::setEntropy

(

const String &

ent

)

[inline]

Definition at line 101 of file CEMemImageSkyModel.h.

References itsEntropy.

void casa::CEMemImageSkyModel::setPrior

(

const Vector< String > &

prior

)

[inline]

Definition at line 100 of file CEMemImageSkyModel.h.

References itsPrior, and prior().

void casa::CEMemImageSkyModel::setSigma

(

const Float

targetSigma

)

[inline]

Set control parameters which are different from Clean:

Definition at line 97 of file CEMemImageSkyModel.h.

References itsSigma.

void casa::CEMemImageSkyModel::setTargetFlux

(

const Float

targetFlux

)

[inline]

Definition at line 98 of file CEMemImageSkyModel.h.

References itsTargetFlux, and targetFlux().

Float casa::CEMemImageSkyModel::sigma

(

)

[inline]

Get the various control parameters which are different from Clean:

Definition at line 106 of file CEMemImageSkyModel.h.

References itsSigma.

virtual Bool casa::CEMemImageSkyModel::solve

(

SkyEquation &

me

)

[virtual]

Solve for this SkyModel.

Reimplemented from casa::ImageSkyModel.

Reimplemented in casa::MFCEMemImageSkyModel.

Float casa::CEMemImageSkyModel::targetFlux

(

)

[inline]

Definition at line 107 of file CEMemImageSkyModel.h.

References itsTargetFlux.

Referenced by setTargetFlux().

---

Member Data Documentation

Bool casa::CEMemImageSkyModel::itsConstrainFlux [protected]

Definition at line 119 of file CEMemImageSkyModel.h.

Referenced by constrainFlux(), and setConstrainTargetFlux().

String casa::CEMemImageSkyModel::itsEntropy [protected]

Definition at line 121 of file CEMemImageSkyModel.h.

Referenced by entropy(), and setEntropy().

Bool casa::CEMemImageSkyModel::itsInitializeModel [protected]

Definition at line 122 of file CEMemImageSkyModel.h.

Referenced by initializeModel().

Vector<String> casa::CEMemImageSkyModel::itsPrior [protected]

Definition at line 120 of file CEMemImageSkyModel.h.

Referenced by prior(), and setPrior().

CEMemProgress* casa::CEMemImageSkyModel::itsProgress [protected]

Definition at line 124 of file CEMemImageSkyModel.h.

Float casa::CEMemImageSkyModel::itsSigma [protected]

Definition at line 117 of file CEMemImageSkyModel.h.

Referenced by setSigma(), and sigma().

Float casa::CEMemImageSkyModel::itsTargetFlux [protected]

Definition at line 118 of file CEMemImageSkyModel.h.

Referenced by setTargetFlux(), and targetFlux().

---

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

• code/synthesis/MeasurementComponents/CEMemImageSkyModel.h