casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Types | Private Member Functions | Private Attributes
casa::MFMSCleanImageSkyModel Class Reference

Image Sky Model implementing the MultiScale, MultiField Clean algorithm. More...

#include <MFMSCleanImageSkyModel.h>

Inheritance diagram for casa::MFMSCleanImageSkyModel:
casa::MFCleanImageSkyModel casa::CleanImageSkyModel casa::ImageSkyModel casa::SkyModel casa::Iterate

List of all members.

Public Member Functions

 MFMSCleanImageSkyModel ()
 Create a MFMSCleanImageSkyModel with 4 scales, stoplargenegatives == 2, stoppointmode==-1.
 MFMSCleanImageSkyModel (const Int nscales, const Int stoplargenegatives=2, const Int stoppointmode=-1, const Float smallScaleBias=0.6)
 Create a MFMSCleanImageSkyModel with nScales, we figure out what they are Also: stoplargenegatives controls if we stop the cycle when the largest component goes negative; stoppointmode controls how many of the smallest component must be hit consecutively before we stop that cycle (-1 ==> don't stop)
 MFMSCleanImageSkyModel (const Vector< Float > &useScaleSize, const Int stoplargenegatives=2, const Int stoppointmode=-1, const Float smallScaleBias=0.6)
 Create a MFMSCleanImageSkyModel, you provide the scale sizes, IN PIXELS for example: Vector<Float> scales(4); scales(0) = 0.0; scales(1) = 3.0; scales(2) = 10.0; scales(3) = 30.0;.
 ~MFMSCleanImageSkyModel ()
 destructor
virtual Bool solve (SkyEquation &me)
 Solve for this SkyModel.

Private Types

enum  Scale_Method {
  NSCALES,
  USERVECTOR
}
 set the scales void setScales(LatticeCleaner<Float>& cleaner); More...

Private Member Functions

void getScales ()
 Chattily get the scales into userScaleSizes_p, doing some calculation if necessary.

Private Attributes

Scale_Method method_p
uInt nscales_p
Vector< FloatuserScaleSizes_p
LatticeCleanProgressprogress_p
Int stopLargeNegatives_p
 parameter to stop the cycle (for the first N cycles) if you get a negative on the largest scale; To disable, use < 0
Int stopPointMode_p
 parameter which stops the cycle if you hit the smallest scale this many consecutive times; if < 0, don't stop for this
Float smallScaleBias_p

Detailed Description

Image Sky Model implementing the MultiScale, MultiField Clean algorithm.

Intended use:

Public interface

Prerequisite

Etymology

MFMSCleanImageSkyModel implements the MultiScale, MultiField Clean algorithm. It is derived from MFCleanImageSkyModel .

Synopsis

The MF Clean is an FFT-based clean algorithm. Cleaning is split into major and minor cycles. In a minor cycle, the image is cleaned using an approximate PSF and the MultiScale clean algorithm. In the major cycle, a fully correct subtraction the of cleanned emission from the visibilities on a pointing-by-pointing bassis is performed.

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 81 of file MFMSCleanImageSkyModel.h.


Member Enumeration Documentation

set the scales void setScales(LatticeCleaner<Float>& cleaner);

Enumerator:
NSCALES 
USERVECTOR 

Definition at line 119 of file MFMSCleanImageSkyModel.h.


Constructor & Destructor Documentation

Create a MFMSCleanImageSkyModel with 4 scales, stoplargenegatives == 2, stoppointmode==-1.

casa::MFMSCleanImageSkyModel::MFMSCleanImageSkyModel ( const Int  nscales,
const Int  stoplargenegatives = 2,
const Int  stoppointmode = -1,
const Float  smallScaleBias = 0.6 
)

Create a MFMSCleanImageSkyModel with nScales, we figure out what they are Also: stoplargenegatives controls if we stop the cycle when the largest component goes negative; stoppointmode controls how many of the smallest component must be hit consecutively before we stop that cycle (-1 ==> don't stop)

casa::MFMSCleanImageSkyModel::MFMSCleanImageSkyModel ( const Vector< Float > &  useScaleSize,
const Int  stoplargenegatives = 2,
const Int  stoppointmode = -1,
const Float  smallScaleBias = 0.6 
)

Create a MFMSCleanImageSkyModel, you provide the scale sizes, IN PIXELS for example: Vector<Float> scales(4); scales(0) = 0.0; scales(1) = 3.0; scales(2) = 10.0; scales(3) = 30.0;.

destructor


Member Function Documentation

Chattily get the scales into userScaleSizes_p, doing some calculation if necessary.

Solve for this SkyModel.

Reimplemented from casa::MFCleanImageSkyModel.


Member Data Documentation

Definition at line 120 of file MFMSCleanImageSkyModel.h.

Definition at line 122 of file MFMSCleanImageSkyModel.h.

Reimplemented from casa::MFCleanImageSkyModel.

Definition at line 125 of file MFMSCleanImageSkyModel.h.

Definition at line 136 of file MFMSCleanImageSkyModel.h.

parameter to stop the cycle (for the first N cycles) if you get a negative on the largest scale; To disable, use < 0

Definition at line 130 of file MFMSCleanImageSkyModel.h.

parameter which stops the cycle if you hit the smallest scale this many consecutive times; if < 0, don't stop for this

Definition at line 134 of file MFMSCleanImageSkyModel.h.

Definition at line 123 of file MFMSCleanImageSkyModel.h.


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